1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
|
<!DOCTYPE html>
<html>
<!-- This is an automatically generated file. Do not edit.
libzip.mdoc -- general overview of available functions
Copyright (C) 2005-2024 Dieter Baron and Thomas Klausner
This file is part of libzip, a library to manipulate ZIP archives.
The authors can be contacted at <info@libzip.org>
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in
the documentation and/or other materials provided with the
distribution.
3. The names of the authors may not be used to endorse or promote
products derived from this software without specific prior
written permission.
THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS
OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-->
<head>
<meta charset="utf-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<link rel="stylesheet" href="../nih-man.css" type="text/css" media="all"/>
<title>LIBZIP(3)</title>
</head>
<body>
<table class="head">
<tr>
<td class="head-ltitle">LIBZIP(3)</td>
<td class="head-vol">Library Functions Manual</td>
<td class="head-rtitle">LIBZIP(3)</td>
</tr>
</table>
<div class="manual-text">
<section class="Sh">
<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
<p class="Pp"><code class="Nm">libzip</code> — <span class="Nd">library
for manipulating zip archives</span></p>
</section>
<section class="Sh">
<h1 class="Sh" id="LIBRARY"><a class="permalink" href="#LIBRARY">LIBRARY</a></h1>
<p class="Pp">libzip (-lzip)</p>
</section>
<section class="Sh">
<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
<p class="Pp"><code class="In">#include
<<a class="In">zip.h</a>></code></p>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
<p class="Pp"><code class="Nm">libzip</code> is a library for reading, creating,
and modifying zip archives.</p>
<p class="Pp">The main design criteria for <code class="Nm">libzip</code>
were:</p>
<ul class="Bl-bullet Bl-compact">
<li>Maintain a stable API without breaking backwards compatibility.</li>
<li>Do not create corrupt files, even in case of errors.</li>
<li>Do not delete data.</li>
<li>Be efficient.</li>
</ul>
<p class="Pp">For this reason, when modifying zip archives,
<code class="Nm">libzip</code> writes to a temporary file and replaces the
original zip archive atomically.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="GENERAL_NOTES"><a class="permalink" href="#GENERAL_NOTES">GENERAL
NOTES</a></h1>
<p class="Pp">When adding files to an archive, the file data is only read when
the new archive is written. Therefore all files added must remain valid
until the archive is closed with
<a class="Xr" href="zip_close.html">zip_close(3)</a> or
<a class="Xr" href="zip_discard.html">zip_discard(3)</a>.</p>
<p class="Pp">Unless explicitly documented, functions should not be passed
<code class="Dv">NULL</code> pointers as arguments.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="DATA_TYPES"><a class="permalink" href="#DATA_TYPES">DATA
TYPES</a></h1>
<p class="Pp">These data types correspond to central concepts in
<code class="Nm">libzip</code>. Most of them are private, meaning you can't
allocate them or access their members directly. This allows extending the
structures in the future without breaking compatibility.</p>
<section class="Ss">
<h2 class="Ss" id="zip_t"><a class="permalink" href="#zip_t">zip_t</a></h2>
<p class="Pp">This type represents an opened archive. See
<a class="Xr" href="zip.html">zip(5)</a>.</p>
</section>
<section class="Ss">
<h2 class="Ss" id="zip_file_t"><a class="permalink" href="#zip_file_t">zip_file_t</a></h2>
<p class="Pp">This type represents a file from an archive that has been opened
for reading. See <a class="Xr" href="zip_file.html">zip_file(5)</a>.</p>
</section>
<section class="Ss">
<h2 class="Ss" id="zip_source_t"><a class="permalink" href="#zip_source_t">zip_source_t</a></h2>
<p class="Pp">This type represents a source (or destination) of data. It is used
in <code class="Nm">libzip</code> for providing data when adding or
replacing files, accessing data from a file inside an archive, and the data
for the archive as a whole. See
<a class="Xr" href="zip_source.html">zip_source(5)</a>.</p>
</section>
<section class="Ss">
<h2 class="Ss" id="zip_error_t"><a class="permalink" href="#zip_error_t">zip_error_t</a></h2>
<p class="Pp">This type represents information about an error. Its type can be
checked against pre-defined constants and it can be converted to a human
readable string. See
<a class="Xr" href="zip_error.html">zip_error(5)</a>.</p>
</section>
</section>
<section class="Sh">
<h1 class="Sh" id="FILE_NAMES"><a class="permalink" href="#FILE_NAMES">FILE
NAMES</a></h1>
<section class="Ss">
<h2 class="Ss" id="Encoding"><a class="permalink" href="#Encoding">Encoding</a></h2>
<p class="Pp">Names of files in the host file system are expected in UTF-8
encoding. On Windows, variants for ASCII and UTF-16 are also available.</p>
<p class="Pp">Names of files inside archives are by default expected in UTF-8
encoding. Other encodings can be requested by using the flags
<code class="Dv">ZIP_FL_ENC_CP437</code> and
<code class="Dv">ZIP_FL_ENC_RAW</code>.</p>
<p class="Pp">For details see the relevant man pages.</p>
</section>
<section class="Ss">
<h2 class="Ss" id="Directory_Separator"><a class="permalink" href="#Directory_Separator">Directory
Separator</a></h2>
<p class="Pp">The zip format requires the use of forward slash
(‘/’) as directory separator. Since backslash
(‘\’) can be part of a valid file name on Unix systems,
<code class="Nm">libzip</code> does not automatically convert them, even on
Windows. It is the responsibility of the programmer to ensure that all
directory separators are passed as forward slashes to
<code class="Nm">libzip</code>.</p>
</section>
</section>
<section class="Sh">
<h1 class="Sh" id="THREAD_SAFETY"><a class="permalink" href="#THREAD_SAFETY">THREAD
SAFETY</a></h1>
<p class="Pp">In general, different zip archives opened by
<code class="Nm">libzip</code> are independent of each other and can be used
by parallel-running threads without locking. If you want to use an archive
from multiple threads, you have to synchronize access to it yourself. If you
use an archive as a source for
<a class="Xr" href="zip_file_add.html">zip_file_add(3)</a> or
<a class="Xr" href="zip_file_replace.html">zip_file_replace(3)</a>, access
to the target archive must be synchronized with access to the source archive
as well.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="READING_ZIP_ARCHIVES"><a class="permalink" href="#READING_ZIP_ARCHIVES">READING
ZIP ARCHIVES</a></h1>
<section class="Ss">
<h2 class="Ss" id="Open_Archive"><a class="permalink" href="#Open_Archive">Open
Archive</a></h2>
<ul class="Bl-bullet Bl-compact">
<li><a class="Xr" href="zip_open.html">zip_open(3)</a></li>
<li><a class="Xr" href="zip_open_from_source.html">zip_open_from_source(3)</a></li>
<li><a class="Xr" href="zip_fdopen.html">zip_fdopen(3)</a></li>
</ul>
</section>
<section class="Ss">
<h2 class="Ss" id="Get_Archive_Attributes"><a class="permalink" href="#Get_Archive_Attributes">Get
Archive Attributes</a></h2>
<ul class="Bl-bullet Bl-compact">
<li><a class="Xr" href="zip_get_archive_comment.html">zip_get_archive_comment(3)</a></li>
<li><a class="Xr" href="zip_get_archive_flag.html">zip_get_archive_flag(3)</a></li>
<li><a class="Xr" href="zip_get_num_entries.html">zip_get_num_entries(3)</a></li>
</ul>
</section>
<section class="Ss">
<h2 class="Ss" id="Find_Files"><a class="permalink" href="#Find_Files">Find
Files</a></h2>
<ul class="Bl-bullet Bl-compact">
<li><a class="Xr" href="zip_name_locate.html">zip_name_locate(3)</a></li>
</ul>
</section>
<section class="Ss">
<h2 class="Ss" id="Read_Files"><a class="permalink" href="#Read_Files">Read
Files</a></h2>
<ul class="Bl-bullet Bl-compact">
<li><a class="Xr" href="zip_fopen.html">zip_fopen(3)</a></li>
<li><a class="Xr" href="zip_fopen_encrypted.html">zip_fopen_encrypted(3)</a></li>
<li><a class="Xr" href="zip_fopen_index.html">zip_fopen_index(3)</a></li>
<li><a class="Xr" href="zip_fopen_index_encrypted.html">zip_fopen_index_encrypted(3)</a></li>
<li><a class="Xr" href="zip_fread.html">zip_fread(3)</a></li>
<li><a class="Xr" href="zip_file_is_seekable.html">zip_file_is_seekable(3)</a></li>
<li><a class="Xr" href="zip_fseek.html">zip_fseek(3)</a> (uncompressed files
only)</li>
<li><a class="Xr" href="zip_ftell.html">zip_ftell(3)</a></li>
<li><a class="Xr" href="zip_fclose.html">zip_fclose(3)</a></li>
</ul>
</section>
<section class="Ss">
<h2 class="Ss" id="Close_Archive"><a class="permalink" href="#Close_Archive">Close
Archive</a></h2>
<ul class="Bl-bullet Bl-compact">
<li><a class="Xr" href="zip_close.html">zip_close(3)</a></li>
</ul>
</section>
<section class="Ss">
<h2 class="Ss" id="Get_File_Attributes"><a class="permalink" href="#Get_File_Attributes">Get
File Attributes</a></h2>
<ul class="Bl-bullet Bl-compact">
<li><a class="Xr" href="zip_stat.html">zip_stat(3)</a></li>
<li><a class="Xr" href="zip_file_get_comment.html">zip_file_get_comment(3)</a></li>
<li><a class="Xr" href="zip_file_get_external_attributes.html">zip_file_get_external_attributes(3)</a></li>
<li><a class="Xr" href="zip_get_name.html">zip_get_name(3)</a></li>
</ul>
</section>
<section class="Ss">
<h2 class="Ss" id="Miscellaneous"><a class="permalink" href="#Miscellaneous">Miscellaneous</a></h2>
<ul class="Bl-bullet Bl-compact">
<li><a class="Xr" href="zip_compression_method_supported.html">zip_compression_method_supported(3)</a></li>
<li><a class="Xr" href="zip_encryption_method_supported.html">zip_encryption_method_supported(3)</a></li>
<li><a class="Xr" href="zip_set_default_password.html">zip_set_default_password(3)</a></li>
</ul>
</section>
</section>
<section class="Sh">
<h1 class="Sh" id="CREATING/MODIFYING_ZIP_ARCHIVES"><a class="permalink" href="#CREATING/MODIFYING_ZIP_ARCHIVES">CREATING/MODIFYING
ZIP ARCHIVES</a></h1>
<section class="Ss">
<h2 class="Ss" id="Create/Open_Archive"><a class="permalink" href="#Create/Open_Archive">Create/Open
Archive</a></h2>
<ul class="Bl-bullet Bl-compact">
<li><a class="Xr" href="zip_open.html">zip_open(3)</a></li>
</ul>
</section>
<section class="Ss">
<h2 class="Ss" id="Add/Change_Files_and_Directories"><a class="permalink" href="#Add/Change_Files_and_Directories">Add/Change
Files and Directories</a></h2>
<ul class="Bl-bullet Bl-compact">
<li><a class="Xr" href="zip_dir_add.html">zip_dir_add(3)</a></li>
<li><a class="Xr" href="zip_file_add.html">zip_file_add(3)</a></li>
<li><a class="Xr" href="zip_file_replace.html">zip_file_replace(3)</a></li>
<li><a class="Xr" href="zip_file_set_comment.html">zip_file_set_comment(3)</a></li>
<li><a class="Xr" href="zip_file_set_dostime.html">zip_file_set_dostime(3)</a></li>
<li><a class="Xr" href="zip_file_set_external_attributes.html">zip_file_set_external_attributes(3)</a></li>
<li><a class="Xr" href="zip_file_set_encryption.html">zip_file_set_encryption(3)</a></li>
<li><a class="Xr" href="zip_file_set_mtime.html">zip_file_set_mtime(3)</a></li>
<li><a class="Xr" href="zip_set_file_compression.html">zip_set_file_compression(3)</a></li>
<li><a class="Xr" href="zip_source_buffer.html">zip_source_buffer(3)</a></li>
<li><a class="Xr" href="zip_source_file.html">zip_source_file(3)</a></li>
<li><a class="Xr" href="zip_source_filep.html">zip_source_filep(3)</a></li>
<li><a class="Xr" href="zip_source_zip.html">zip_source_zip(3)</a></li>
</ul>
</section>
<section class="Ss">
<h2 class="Ss" id="Rename_Files"><a class="permalink" href="#Rename_Files">Rename
Files</a></h2>
<ul class="Bl-bullet Bl-compact">
<li><a class="Xr" href="zip_rename.html">zip_rename(3)</a></li>
</ul>
</section>
<section class="Ss">
<h2 class="Ss" id="Delete_Files"><a class="permalink" href="#Delete_Files">Delete
Files</a></h2>
<ul class="Bl-bullet Bl-compact">
<li><a class="Xr" href="zip_delete.html">zip_delete(3)</a></li>
</ul>
</section>
<section class="Ss">
<h2 class="Ss" id="Revert_Changes"><a class="permalink" href="#Revert_Changes">Revert
Changes</a></h2>
<ul class="Bl-bullet Bl-compact">
<li><a class="Xr" href="zip_unchange.html">zip_unchange(3)</a></li>
<li><a class="Xr" href="zip_unchange_all.html">zip_unchange_all(3)</a></li>
<li><a class="Xr" href="zip_unchange_archive.html">zip_unchange_archive(3)</a></li>
</ul>
</section>
<section class="Ss">
<h2 class="Ss" id="Read/Modify_Extra_Fields"><a class="permalink" href="#Read/Modify_Extra_Fields">Read/Modify
Extra Fields</a></h2>
<ul class="Bl-bullet Bl-compact">
<li><a class="Xr" href="zip_file_extra_field_delete.html">zip_file_extra_field_delete(3)</a></li>
<li><a class="Xr" href="zip_file_extra_field_delete_by_id.html">zip_file_extra_field_delete_by_id(3)</a></li>
<li><a class="Xr" href="zip_file_extra_field_get.html">zip_file_extra_field_get(3)</a></li>
<li><a class="Xr" href="zip_file_extra_field_get_by_id.html">zip_file_extra_field_get_by_id(3)</a></li>
<li><a class="Xr" href="zip_file_extra_field_set.html">zip_file_extra_field_set(3)</a></li>
<li><a class="Xr" href="zip_file_extra_fields_count.html">zip_file_extra_fields_count(3)</a></li>
<li><a class="Xr" href="zip_file_extra_fields_count_by_id.html">zip_file_extra_fields_count_by_id(3)</a></li>
</ul>
</section>
<section class="Ss">
<h2 class="Ss" id="Close_Archive_(Writing)"><a class="permalink" href="#Close_Archive_(Writing)">Close
Archive (Writing)</a></h2>
<ul class="Bl-bullet Bl-compact">
<li><a class="Xr" href="zip_close.html">zip_close(3)</a></li>
<li><a class="Xr" href="zip_discard.html">zip_discard(3)</a></li>
</ul>
</section>
<section class="Ss">
<h2 class="Ss" id="Miscellaneous_(Writing)"><a class="permalink" href="#Miscellaneous_(Writing)">Miscellaneous
(Writing)</a></h2>
<ul class="Bl-bullet Bl-compact">
<li><a class="Xr" href="zip_file_attributes_init.html">zip_file_attributes_init(3)</a></li>
<li><a class="Xr" href="zip_libzip_version.html">zip_libzip_version(3)</a></li>
<li><a class="Xr" href="zip_register_cancel_callback_with_state.html">zip_register_cancel_callback_with_state(3)</a></li>
<li><a class="Xr" href="zip_register_progress_callback_with_state.html">zip_register_progress_callback_with_state(3)</a></li>
<li><a class="Xr" href="zip_set_archive_comment.html">zip_set_archive_comment(3)</a></li>
<li><a class="Xr" href="zip_set_archive_flag.html">zip_set_archive_flag(3)</a></li>
<li><a class="Xr" href="zip_source.html">zip_source(5)</a></li>
</ul>
</section>
</section>
<section class="Sh">
<h1 class="Sh" id="SOURCES"><a class="permalink" href="#SOURCES">SOURCES</a></h1>
<section class="Ss">
<h2 class="Ss" id="Create_Source"><a class="permalink" href="#Create_Source">Create
Source</a></h2>
<ul class="Bl-bullet Bl-compact">
<li><a class="Xr" href="zip_source_buffer.html">zip_source_buffer(3)</a></li>
<li><a class="Xr" href="zip_source_file.html">zip_source_file(3)</a></li>
<li><a class="Xr" href="zip_source_filep.html">zip_source_filep(3)</a></li>
<li><a class="Xr" href="zip_source_function.html">zip_source_function(3)</a></li>
<li><a class="Xr" href="zip_source_layered.html">zip_source_layered(3)</a></li>
<li><a class="Xr" href="zip_source_zip.html">zip_source_zip(3)</a></li>
</ul>
</section>
<section class="Ss">
<h2 class="Ss" id="Using_Source"><a class="permalink" href="#Using_Source">Using
Source</a></h2>
<ul class="Bl-bullet Bl-compact">
<li><a class="Xr" href="zip_file_add.html">zip_file_add(3)</a></li>
<li><a class="Xr" href="zip_file_replace.html">zip_file_replace(3)</a></li>
<li><a class="Xr" href="zip_open_from_source.html">zip_open_from_source(3)</a></li>
</ul>
</section>
<section class="Ss">
<h2 class="Ss" id="Implementing_Source"><a class="permalink" href="#Implementing_Source">Implementing
Source</a></h2>
<ul class="Bl-bullet Bl-compact">
<li><a class="Xr" href="zip_source_pass_to_lower_layer.html">zip_source_pass_to_lower_layer(3)</a></li>
</ul>
</section>
<section class="Ss">
<h2 class="Ss" id="Source_Life_Cycle"><a class="permalink" href="#Source_Life_Cycle">Source
Life Cycle</a></h2>
<ul class="Bl-bullet Bl-compact">
<li><a class="Xr" href="zip_source_free.html">zip_source_free(3)</a></li>
<li><a class="Xr" href="zip_source_keep.html">zip_source_keep(3)</a></li>
</ul>
</section>
</section>
<section class="Sh">
<h1 class="Sh" id="ERROR_HANDLING"><a class="permalink" href="#ERROR_HANDLING">ERROR
HANDLING</a></h1>
<ul class="Bl-bullet Bl-compact">
<li><a class="Xr" href="zip_error_strerror.html">zip_error_strerror(3)</a></li>
<li><a class="Xr" href="zip_strerror.html">zip_strerror(3)</a></li>
<li><a class="Xr" href="zip_file_strerror.html">zip_file_strerror(3)</a></li>
<li><a class="Xr" href="zip_file_get_error.html">zip_file_get_error(3)</a></li>
<li><a class="Xr" href="zip_get_error.html">zip_get_error(3)</a></li>
<li><a class="Xr" href="zip_error_init_with_code.html">zip_error_init_with_code(3)</a></li>
<li><a class="Xr" href="zip_error_set.html">zip_error_set(3)</a></li>
<li><a class="Xr" href="zip_error_set_from_source.html">zip_error_set_from_source(3)</a></li>
<li><a class="Xr" href="zip_error_system_type.html">zip_error_system_type(3)</a></li>
<li><a class="Xr" href="zip_errors.html">zip_errors(3)</a></li>
</ul>
</section>
<section class="Sh">
<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1>
<p class="Pp"><span class="An">Dieter Baron</span>
<<a class="Mt" href="mailto:dillo@nih.at">dillo@nih.at</a>> and
<span class="An">Thomas Klausner</span>
<<a class="Mt" href="mailto:wiz@gatalith.at">wiz@gatalith.at</a>></p>
</section>
</div>
<table class="foot">
<tr>
<td class="foot-date">May 5, 2025</td>
<td class="foot-os">NiH</td>
</tr>
</table>
</body>
</html>
|
