Changes between Version 15 and Version 16 of UserDocs/ReadInZip

Timestamp:

Oct 2, 2017, 5:21:14 PM (7 years ago)

Author:

Mike Taves

Comment:

modify title (since there are other archive formats now supported); fixed-formatting for code

UserDocs/ReadInZip

@@ -1 @@
-= Reading a GDAL dataset in a .gz file or a .zip archive = 
+= Reading a GDAL or OGR datasets in archive files = 
 
 == Summary ==
@@ -6 +6 @@
 The archive formats that are handled are single gzip'ed file (ending with .gz) and ZIP archives (ending with .zip).
 
-This is implemented as 2 virtual file systems (like /vsimem for 
-example), /vsigzip and /vsizip. From .zip files only read-only access is supported, while the /vsigzip driver supports read and sequential write.
+This is implemented as 2 virtual file systems (like `/vsimem` for 
+example), `/vsigzip` and `/vsizip`. From .zip files only read-only access is supported, while the `/vsigzip` driver supports read and sequential write.
 Note that performance will not be very impressive, as random access inside gzip data is slow by nature, although some optimizations have been made to make it faster and generally usable ("snapshots" of the gzip state are taken from time to time, so that further access to a given offset inside the file just needs to restart decompression from the nearest snapshot)
 
@@ -21 +21 @@
 were path/to/the/file.gz is relative or absolute.
 
-If the path is absolute, it should begin with a / on a Unix-like OS (or C:\ on Windows), so the line looks like /vsigzip//home/gdal/...
+If the path is absolute, it should begin with a `/` on a Unix-like OS (or `C:\` on Windows), so the line looks like `/vsigzip//home/gdal/...`
 
 The first time that a .gz file is read, a small .gz.properties file will be 
@@ -27 +27 @@
 following opening of that dataset much faster.
 
-A VSIStatL("/vsigzip/...") call will return the uncompressed size of the file.
+A `VSIStatL("/vsigzip/...")` call will return the uncompressed size of the file.
 
 The special file handler is [http://gdal.org/cpl__vsi_8h.html#3cde09f204df6f417653b7af4761178e VSIInstallGZipFileHandler ()]
@@ -40 +40 @@
 the relative path to the file inside the archive.
 
-If the path is absolute, it should begin with a / on a Unix-like OS (or C:\ on Windows), so the line looks like /vsizip//home/gdal/...
+If the path is absolute, it should begin with a `/` on a Unix-like OS (or `C:\` on Windows), so the line looks like `/vsizip//home/gdal/...`
 
-For example gdalinfo /vsizip/myarchive.zip/subdir1/file1.tif
+For example `gdalinfo /vsizip/myarchive.zip/subdir1/file1.tif`
 
 The ReadDir() method is implemented for the .zip archives, so a driver will be 
@@ -49 +49 @@
 file and all its NITF tiles.
 
-A VSIStatL("/vsizip/...") call will return the uncompressed size of the file.
+A `VSIStatL("/vsizip/...")` call will return the uncompressed size of the file.
 Directories inside the ZIP file can be distinguished from regular files with
 the VSI_ISDIR(stat.st_mode) macro as for regular file systems.
 
 Small syntaxic sugar : if the .zip file contains only one file located at its 
-root, just mentionning "/vsizip/path/to/the/file.zip" will work.
+root, just mentionning `/vsizip/path/to/the/file.zip` will work.
 
 The special file handler is [http://gdal.org/cpl__vsi_8h.html#884fac3cd6be2c09deb807e959d78b3a VSIInstallZipFileHandler ()]
@@ -61 +61 @@
 
 Since GDAL 1.8.0, it is possible to access a file inside a .tar (uncompressed) or
-a .tar.gz/.tgz (compressed) archive. The syntax is very similar to the /vsizip case :
+a .tar.gz/.tgz (compressed) archive. The syntax is very similar to the `/vsizip` case :
 
 {{{
@@ -112 +112 @@
   * EHdr
 
-The full list can be obtained by looking at the driver marked with 'v' when running 'gdalinfo --formats'
+The full list can be obtained by looking at the driver marked with 'v' when running `gdalinfo --formats`
 
 = vsicurl - to read from HTTP or FTP files (partial downloading) =