1SOZIP(1)                             GDAL                             SOZIP(1)
2
3
4

NAME

6       sozip - Generate a seek-optimized (SOZip) file.
7
8       New in version 3.7.
9
10

SYNOPSIS

12          sozip [--quiet|--verbose]
13                [[-g|--grow] | [--overwrite]]
14                [-r|--recurse-paths]
15                [-j|--junk-paths]
16                [-l|--list]
17                [--optimize-from=<input.zip>]
18                [--validate]
19                [--enable-sozip=auto/yes/no]
20                [--sozip-chunk-size=value]
21                [--sozip-min-file-size=value]
22                [--content-type=value]
23                zip_filename [filename]*
24

DESCRIPTION

26       The sozip utility can be used to:
27
28       • create a SOZip (Seek-Optimized ZIP) file
29
30       • append files to an existing ZIP/SOZip file
31
32       • list the contents of a ZIP/SOZip file
33
34       • validate a SOZip file
35
36       • convert an existing Zip file in a SOZip optimized one
37
38       --quiet
39              Quiet  mode. No progress message is emitted on the standard out‐
40              put.
41
42       --verbose
43              Verbose mode.
44
45       -g
46
47       --grow Grow an existing zip file with  the  content  of  the  specified
48              filename(s).   This  is  the  default  mode of the utility. This
49              switch is here for compatibility with Info-ZIP zip utility
50
51       --overwrite
52              Overwrite the target zip file if it already exists.
53
54       -l
55
56       --list List the files contained in the zip file in an output similar to
57              Info-ZIP  unzip utility, but with the addition of a column indi‐
58              cating whether each file is seek-optimized.
59
60       --validate
61              Validates a SOZip file. Baseline ZIP validation  is  done  in  a
62              light  way,  limited to being able to browse through ZIP records
63              with the InfoZIP-based ZIP reader used by GDAL.  But  validation
64              of the SOZip-specific aspects is done in a more thoroughful way.
65
66       -j
67
68       --junk-paths
69              Store  just the name of a saved file (junk the path), and do not
70              store directory names. By default, sozip  will  store  the  full
71              path (relative to the current directory).
72
73       --optimize-from=<input.zip>
74              Re-process  {input.zip}  to generate a SOZip-optimized .zip. Op‐
75              tions       --enable-sozip,        --sozip-chunk-size        and
76              --sozip-min-file-size may be used in that mode.
77
78       --enable-sozip=auto/yes/no
79              In auto mode, a file is seek-optimized only if its size is above
80              the value of --sozip-chunk-size.  In yes mode, all  input  files
81              will  be  seek-optimized.   In  no  mode, no input files will be
82              seek-optimized.
83
84       --sozip-chunk-size
85              Chunk size for a seek-optimized file. Defaults to  32768  bytes.
86              The  value  is  specified in bytes, or K and M suffix can be re‐
87              spectively used to specify a value in kilo-bytes or mega-bytes.
88
89       --sozip-min-file-size
90              Minimum file size to decide if a file should be  seek-optimized,
91              in --enable-sozip=auto mode. Defaults to 1 MB byte. The value is
92              specified in bytes, or K, M or G suffix can be respectively used
93              to specify a value in kilo-bytes, mega-bytes or giga-bytes.
94
95       --content-type=<value>
96              Store  the  Content-Type for the file being added as a key-value
97              pair in the extra field extension  'KV'  (0x564b)  dedicated  to
98              storing key-value pair metadata
99
100       <zip_filename>
101              Filename of the zip file to create/append to/list.
102
103       <filename>
104              Filename of the file to add.
105

MULTITHREADING

107       The  GDAL_NUM_THREADS  configuration option can be set to ALL_CPUS or a
108       integer value to specify the number of threads to  use  for  SOZip-com‐
109       pressed files. Defaults to ALL_CPUS.
110

C API

112       Functionality of this utility can be done from C with CPLAddFileInZip()
113       or VSICopyFile().
114

EXAMPLES

116       Create a, potentially seek-optimized, ZIP  file  with  the  content  of
117       my.gpkg:
118
119          sozip my.gpkg.zip my.gpkg
120
121       Create  a,  potentially  seek-optimized, ZIP file from the content of a
122       source directory:
123
124          sozip -r my.gpkg.zip source_dir/
125
126       Create a, potentially seek-optimized, ZIP file  from  an  existing  ZIP
127       file.
128
129          sozip --convert-from=in.zip out.zip
130
131       List  the contents of a ZIP file and display which files are seek-opti‐
132       mized:
133
134          sozip -l my.gpkg.zip
135
136       Validates a SOZip file:
137
138          sozip --validate my.gpkg.zip
139

AUTHOR

141       Even Rouault <even.rouault@spatialys.com>
142
144       1998-2023
145
146
147
148
149                                 Oct 30, 2023                         SOZIP(1)
Impressum