.\" Man page generated from reStructuredText. . . .nr rst2man-indent-level 0 . .de1 rstReportMargin \\$1 \\n[an-margin] level \\n[rst2man-indent-level] level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] - \\n[rst2man-indent0] \\n[rst2man-indent1] \\n[rst2man-indent2] .. .de1 INDENT .\" .rstReportMargin pre: . RS \\$1 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] . nr rst2man-indent-level +1 .\" .rstReportMargin post: .. .de UNINDENT . RE .\" indent \\n[an-margin] .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] .nr rst2man-indent-level -1 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. .TH "GDAL-VSI-SOZIP" "1" "May 06, 2025" "" "GDAL" .SH NAME gdal-vsi-sozip \- SOZIP (Seek-Optimized ZIP) related commands. .sp Added in version 3.11. .SH DESCRIPTION .sp The \fBgdal vsi sozip\fP utility can be used to: .INDENT 0.0 .IP \(bu 2 create a \fI\%SOZip (Seek\-Optimized ZIP)\fP file .IP \(bu 2 append files to an existing ZIP/SOZip file .IP \(bu 2 list the contents of a ZIP/SOZip file .IP \(bu 2 validate a SOZip file .IP \(bu 2 convert an existing Zip file into a SOZip optimized one .UNINDENT .SH SYNOPSIS .INDENT 0.0 .INDENT 3.5 .sp .EX Usage: gdal vsi sozip [OPTIONS] where is one of: \- create: Create a Seek\-optimized ZIP (SOZIP) file. \- list: List content of a ZIP file, with SOZIP related information. \- optimize: Create a Seek\-optimized ZIP (SOZIP) file from a regular ZIP file. \- validate: Validate a ZIP file, possibly using SOZIP optimization. Common Options: \-h, \-\-help Display help message and exit \-\-json\-usage Display usage as JSON document and exit \-\-config = Configuration option [may be repeated] .EE .UNINDENT .UNINDENT .SH "GDAL VSI SOZIP CREATE" .SS Description .sp Adds one or several files to a new or existing zip file. .SS Synopsis .INDENT 0.0 .INDENT 3.5 .sp .EX Usage: gdal vsi sozip create [OPTIONS] Create a Seek\-optimized ZIP (SOZIP) file. Positional arguments: \-i, \-\-input Input filenames [may be repeated] [required] \-o, \-\-output Output ZIP filename [required] Common Options: \-h, \-\-help Display help message and exit \-\-json\-usage Display usage as JSON document and exit \-\-config = Configuration option [may be repeated] \-\-progress Display progress bar Options: \-\-overwrite Whether overwriting existing output is allowed \-r, \-\-recursive Travels the directory structure of the specified directories recursively \-j, \-\-junk\-paths, \-\-no\-paths Store just the name of a saved file, and do not store directory names \-\-enable\-sozip Whether to automatically/systematically/never apply the SOZIP optimization. ENABLE\-SOZIP=auto|yes|no (default: auto) \-\-sozip\-chunk\-size Chunk size for a seek\-optimized file (default: 32768) \-\-sozip\-min\-file\-size Minimum file size to decide if a file should be seek\-optimized (default: 1 MB) \-\-content\-type Store the Content\-Type of the file being added. \-q, \-\-quiet Quiet mode .EE .UNINDENT .UNINDENT .SS Options .INDENT 0.0 .TP .B \-i, \-\-input Input filenames. Required. Several file names or directory names accepted. .UNINDENT .INDENT 0.0 .TP .B \-o, \-\-output Output ZIP filename. Required. Must have a \fB\&.zip\fP extension .UNINDENT .INDENT 0.0 .TP .B \-\-overwrite Whether overwriting existing output is allowed. .UNINDENT .INDENT 0.0 .TP .B \-r, \-\-recursive Travels the directory structure of the specified directories recursively. .UNINDENT .INDENT 0.0 .TP .B \-j, \-\-junk\-paths, \-\-no\-paths Store just the name of a saved file (junk the path), and do not store directory names. By default, sozip will store the full path (relative to the current directory). .UNINDENT .INDENT 0.0 .TP .B \-\-enable\-sozip auto|yes|no In \fBauto\fP mode, a file is seek\-optimized only if its size is above the value of \fI\%\-\-sozip\-min\-file\-size\fP\&. In \fByes\fP mode, all input files will be seek\-optimized. In \fBno\fP mode, no input files will be seek\-optimized. .UNINDENT .INDENT 0.0 .TP .B \-\-sozip\-chunk\-size Chunk size for a seek\-optimized file. Defaults to 32768 bytes. The value is specified in bytes, or \fBK\fP and \fBM\fP suffix (optionally preceded by a space) can be respectively used to specify a value in kilo\-bytes or mega\-bytes. .UNINDENT .INDENT 0.0 .TP .B \-\-sozip\-min\-file\-size Minimum file size to decide if a file should be seek\-optimized, in \-\-enable\-sozip=auto mode. Defaults to 1 MB byte. The value is specified in bytes, or \fBK\fP, \fBM\fP or \fBG\fP suffix (optionally preceded by a space) can be respectively used to specify a value in kilo\-bytes, mega\-bytes or giga\-bytes. .UNINDENT .INDENT 0.0 .TP .B \-\-content\-type Store the Content\-Type for the file being added as a key\-value pair in the extra field extension \(aqKV\(aq (0x564b) dedicated to storing key\-value pair metadata .UNINDENT .INDENT 0.0 .TP .B \-q, \-\-quiet Do not output any informative message (only errors). .UNINDENT .SS Multithreading .sp The \fI\%GDAL_NUM_THREADS\fP configuration option can be set to \fBALL_CPUS\fP or a integer value to specify the number of threads to use for SOZip\-compressed files. Defaults to \fBALL_CPUS\fP\&. .SS Examples .SS Example 1: Create a, potentially seek\-optimized, ZIP file with the content of my.gpkg .INDENT 0.0 .INDENT 3.5 .sp .EX gdal vsi sozip create my.gpkg my.gpkg.zip .EE .UNINDENT .UNINDENT .SS Example 2: Create a, potentially seek\-optimized, ZIP file from the content of a source directory: .INDENT 0.0 .INDENT 3.5 .sp .EX gdal vsi sozip create \-r source_dir/ my.gpkg.zip .EE .UNINDENT .UNINDENT .SH "GDAL VSI SOZIP OPTIMIZE" .SS Description .sp Create a new zip file from the content of an existing one, possibly applying SOZip optimization when relevant. .SS Synopsis .INDENT 0.0 .INDENT 3.5 .sp .EX Usage: gdal vsi sozip optimize [OPTIONS] Create a Seek\-optimized ZIP (SOZIP) file from a regular ZIP file. Positional arguments: \-i, \-\-input Input ZIP filename [required] \-o, \-\-output Output ZIP filename [required] Common Options: \-h, \-\-help Display help message and exit \-\-json\-usage Display usage as JSON document and exit \-\-config = Configuration option [may be repeated] \-\-progress Display progress bar Options: \-\-overwrite Whether overwriting existing output is allowed \-\-enable\-sozip Whether to automatically/systematically/never apply the SOZIP optimization. ENABLE\-SOZIP=auto|yes|no (default: auto) \-\-sozip\-chunk\-size Chunk size for a seek\-optimized file (default: 32768) \-\-sozip\-min\-file\-size Minimum file size to decide if a file should be seek\-optimized (default: 1 MB) \-q, \-\-quiet Quiet mode .EE .UNINDENT .UNINDENT .SS Options .INDENT 0.0 .TP .B \-i, \-\-input Input ZIP filename. Required. .UNINDENT .INDENT 0.0 .TP .B \-o, \-\-output Output ZIP filename. Required. Must have a \fB\&.zip\fP extension .UNINDENT .INDENT 0.0 .TP .B \-\-overwrite Whether overwriting existing output is allowed. .UNINDENT .INDENT 0.0 .TP .B \-\-enable\-sozip auto|yes|no In \fBauto\fP mode, a file is seek\-optimized only if its size is above the value of \fI\%\-\-sozip\-chunk\-size\fP\&. In \fByes\fP mode, all input files will be seek\-optimized. In \fBno\fP mode, no input files will be seek\-optimized. .UNINDENT .INDENT 0.0 .TP .B \-\-sozip\-chunk\-size Chunk size for a seek\-optimized file. Defaults to 32768 bytes. The value is specified in bytes, or K and M suffix can be respectively used to specify a value in kilo\-bytes or mega\-bytes. .UNINDENT .INDENT 0.0 .TP .B \-\-sozip\-min\-file\-size Minimum file size to decide if a file should be seek\-optimized, in \-\-enable\-sozip=auto mode. Defaults to 1 MB byte. The value is specified in bytes, or K, M or G suffix can be respectively used to specify a value in kilo\-bytes, mega\-bytes or giga\-bytes. .UNINDENT .INDENT 0.0 .TP .B \-q, \-\-quiet Do not output any informative message (only errors). .UNINDENT .SS Multithreading .sp The \fI\%GDAL_NUM_THREADS\fP configuration option can be set to \fBALL_CPUS\fP or a integer value to specify the number of threads to use for SOZip\-compressed files. Defaults to \fBALL_CPUS\fP\&. .SS Examples .SS Example 3: Create a, potentially seek\-optimized, ZIP file \fBsozip_optimized.zip\fP from an existing ZIP file \fBin.zip\fP\&. .INDENT 0.0 .INDENT 3.5 .sp .EX gdal vsi sozip optimize in.zip sozip_optimized.zip .EE .UNINDENT .UNINDENT .SH "GDAL VSI SOZIP LIST" .SS Description .sp List the files contained in the zip file in an output similar to Info\-ZIP \fBunzip\fP utility, but with the addition of a column indicating whether each file is seek\-optimized. .SS Synopsis .INDENT 0.0 .INDENT 3.5 .sp .EX Usage: gdal vsi sozip list [OPTIONS] List content of a ZIP file, with SOZIP related information. Positional arguments: \-i, \-\-input Input ZIP filename [required] Common Options: \-h, \-\-help Display help message and exit \-\-json\-usage Display usage as JSON document and exit \-\-config = Configuration option [may be repeated] .EE .UNINDENT .UNINDENT .SS Options .INDENT 0.0 .TP .B \-i, \-\-input Input ZIP filename. Required. .UNINDENT .SS Examples .SS Example 4: List contents of \fBmy.zip\fP\&. .INDENT 0.0 .INDENT 3.5 .sp .EX gdal vsi sozip list my.zip .EE .UNINDENT .UNINDENT .SH "GDAL VSI SOZIP VALIDATE" .SS Description .sp Validates a SOZip file. Baseline ZIP validation is done in a light way, limited to being able to browse through ZIP records with the InfoZIP\-based ZIP reader used by GDAL. But validation of the SOZip\-specific aspects is done in a more thorougful way. .SS Synopsis .INDENT 0.0 .INDENT 3.5 .sp .EX Usage: gdal vsi sozip list [OPTIONS] List content of a ZIP file, with SOZIP related information. Positional arguments: \-i, \-\-input Input ZIP filename [required] Common Options: \-h, \-\-help Display help message and exit \-\-json\-usage Display usage as JSON document and exit \-\-config = Configuration option [may be repeated] .EE .UNINDENT .UNINDENT .SS Options .INDENT 0.0 .TP .B \-i, \-\-input Input ZIP filename. Required. .UNINDENT .INDENT 0.0 .TP .B \-q, \-\-quiet Do not output any informative message (only errors). .UNINDENT .INDENT 0.0 .TP .B \-v, \-\-verbose Turn on verbose mode. .UNINDENT .SS Examples .SS Example 5: Validate \fBmy.zip\fP\&. .INDENT 0.0 .INDENT 3.5 .sp .EX gdal vsi sozip validate my.zip .EE .UNINDENT .UNINDENT .SH AUTHOR Even Rouault .SH COPYRIGHT 1998-2025 .\" Generated by docutils manpage writer. .