forked from nih-at/libzip
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathlibzip.html
206 lines (203 loc) · 11.8 KB
/
libzip.html
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
<!DOCTYPE html>
<html>
<!-- This is an automatically generated file. Do not edit.
libzip.mdoc -- general overview of available functions
Copyright (C) 2005-2017 Dieter Baron and Thomas Klausner
This file is part of libzip, a library to manipulate ZIP archives.
The authors can be contacted at <[email protected]>
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"/>
<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">
<h1 class="Sh" title="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
<code class="Nm" title="Nm">libzip</code> —
<div class="Nd" title="Nd">library for manipulating zip archives</div>
<h1 class="Sh" title="Sh" id="LIBRARY"><a class="permalink" href="#LIBRARY">LIBRARY</a></h1>
libzip (-lzip)
<h1 class="Sh" title="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
<code class="In" title="In">#include
<<a class="In" title="In">zip.h</a>></code>
<h1 class="Sh" title="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
<code class="Nm" title="Nm">libzip</code> is a library for reading, creating,
and modifying zip archives.
<div class="Pp"></div>
The main design criteria for <code class="Nm" title="Nm">libzip</code> were:
<ul class="Bl-bullet Bl-compact">
<li>Do not create corrupt files, even in case of errors.</li>
<li>Do not delete data.</li>
<li>Be efficient.</li>
</ul>
<div class="Pp"></div>
For this reason, when modifying zip archives,
<code class="Nm" title="Nm">libzip</code> writes to a temporary file and
replaces the original zip archive atomically.
<div class="Pp"></div>
Below there are two sections listing functions: one for how to read from zip
archives and one for how to create/modify them.
<h1 class="Sh" title="Sh" id="READING_ZIP_ARCHIVES"><a class="permalink" href="#READING_ZIP_ARCHIVES">READING
ZIP ARCHIVES</a></h1>
<h2 class="Ss" title="Ss" id="open_archive"><a class="permalink" href="#open_archive">open
archive</a></h2>
<ul class="Bl-bullet Bl-compact">
<li><a class="Xr" title="Xr" href="zip_open.html">zip_open(3)</a></li>
<li><a class="Xr" title="Xr" href="zip_fdopen.html">zip_fdopen(3)</a></li>
</ul>
<h2 class="Ss" title="Ss" id="find_files"><a class="permalink" href="#find_files">find
files</a></h2>
<ul class="Bl-bullet Bl-compact">
<li><a class="Xr" title="Xr" href="zip_name_locate.html">zip_name_locate(3)</a></li>
</ul>
<h2 class="Ss" title="Ss" id="read_files"><a class="permalink" href="#read_files">read
files</a></h2>
<ul class="Bl-bullet Bl-compact">
<li><a class="Xr" title="Xr" href="zip_fopen.html">zip_fopen(3)</a></li>
<li><a class="Xr" title="Xr" href="zip_fopen_encrypted.html">zip_fopen_encrypted(3)</a></li>
<li><a class="Xr" title="Xr" href="zip_fopen_index.html">zip_fopen_index(3)</a></li>
<li><a class="Xr" title="Xr" href="zip_fopen_index_encrypted.html">zip_fopen_index_encrypted(3)</a></li>
<li><a class="Xr" title="Xr" href="zip_fread.html">zip_fread(3)</a></li>
<li><a class="Xr" title="Xr" href="zip_fseek.html">zip_fseek(3)</a>
(uncompressed files only)</li>
<li><a class="Xr" title="Xr" href="zip_ftell.html">zip_ftell(3)</a>
(uncompressed files only)</li>
<li><a class="Xr" title="Xr" href="zip_fclose.html">zip_fclose(3)</a></li>
</ul>
<h2 class="Ss" title="Ss" id="close_archive"><a class="permalink" href="#close_archive">close
archive</a></h2>
<ul class="Bl-bullet Bl-compact">
<li><a class="Xr" title="Xr" href="zip_close.html">zip_close(3)</a></li>
<li><a class="Xr" title="Xr" href="zip_discard.html">zip_discard(3)</a></li>
</ul>
<h2 class="Ss" title="Ss" id="miscellaneous"><a class="permalink" href="#miscellaneous">miscellaneous</a></h2>
<ul class="Bl-bullet Bl-compact">
<li><a class="Xr" title="Xr" href="zip_stat.html">zip_stat(3)</a></li>
<li><a class="Xr" title="Xr" href="zip_file_get_comment.html">zip_file_get_comment(3)</a></li>
<li><a class="Xr" title="Xr" href="zip_file_get_external_attributes.html">zip_file_get_external_attributes(3)</a></li>
<li><a class="Xr" title="Xr" href="zip_get_archive_comment.html">zip_get_archive_comment(3)</a></li>
<li><a class="Xr" title="Xr" href="zip_get_archive_flag.html">zip_get_archive_flag(3)</a></li>
<li><a class="Xr" title="Xr" href="zip_get_name.html">zip_get_name(3)</a></li>
<li><a class="Xr" title="Xr" href="zip_get_num_entries.html">zip_get_num_entries(3)</a></li>
<li><a class="Xr" title="Xr" href="zip_set_default_password.html">zip_set_default_password(3)</a></li>
</ul>
<h1 class="Sh" title="Sh" id="CREATING/MODIFYING_ZIP_ARCHIVES"><a class="permalink" href="#CREATING/MODIFYING_ZIP_ARCHIVES">CREATING/MODIFYING
ZIP ARCHIVES</a></h1>
<h2 class="Ss" title="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" title="Xr" href="zip_open.html">zip_open(3)</a></li>
</ul>
<h2 class="Ss" title="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" title="Xr" href="zip_dir_add.html">zip_dir_add(3)</a></li>
<li><a class="Xr" title="Xr" href="zip_file_add.html">zip_file_add(3)</a></li>
<li><a class="Xr" title="Xr" href="zip_file_replace.html">zip_file_replace(3)</a></li>
<li><a class="Xr" title="Xr" href="zip_file_set_comment.html">zip_file_set_comment(3)</a></li>
<li><a class="Xr" title="Xr" href="zip_file_set_external_attributes.html">zip_file_set_external_attributes(3)</a></li>
<li><a class="Xr" title="Xr" href="zip_file_set_encryption.html">zip_file_set_encryption(3)</a></li>
<li><a class="Xr" title="Xr" href="zip_file_set_mtime.html">zip_file_set_mtime(3)</a></li>
<li><a class="Xr" title="Xr" href="zip_set_file_compression.html">zip_set_file_compression(3)</a></li>
<li><a class="Xr" title="Xr" href="zip_source_buffer.html">zip_source_buffer(3)</a></li>
<li><a class="Xr" title="Xr" href="zip_source_file.html">zip_source_file(3)</a></li>
<li><a class="Xr" title="Xr" href="zip_source_filep.html">zip_source_filep(3)</a></li>
<li><a class="Xr" title="Xr" href="zip_source_free.html">zip_source_free(3)</a></li>
<li><a class="Xr" title="Xr" href="zip_source_function.html">zip_source_function(3)</a></li>
<li><a class="Xr" title="Xr" href="zip_source_zip.html">zip_source_zip(3)</a></li>
</ul>
<h2 class="Ss" title="Ss" id="rename_files"><a class="permalink" href="#rename_files">rename
files</a></h2>
<ul class="Bl-bullet Bl-compact">
<li><a class="Xr" title="Xr" href="zip_rename.html">zip_rename(3)</a></li>
</ul>
<h2 class="Ss" title="Ss" id="delete_files"><a class="permalink" href="#delete_files">delete
files</a></h2>
<ul class="Bl-bullet Bl-compact">
<li><a class="Xr" title="Xr" href="zip_delete.html">zip_delete(3)</a></li>
</ul>
<h2 class="Ss" title="Ss" id="revert_changes"><a class="permalink" href="#revert_changes">revert
changes</a></h2>
<ul class="Bl-bullet Bl-compact">
<li><a class="Xr" title="Xr" href="zip_unchange.html">zip_unchange(3)</a></li>
<li><a class="Xr" title="Xr" href="zip_unchange_all.html">zip_unchange_all(3)</a></li>
<li><a class="Xr" title="Xr" href="zip_unchange_archive.html">zip_unchange_archive(3)</a></li>
</ul>
<h2 class="Ss" title="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" title="Xr" href="zip_file_extra_field_by_id.html">zip_file_extra_field_by_id(3)</a></li>
<li><a class="Xr" title="Xr" href="zip_file_extra_field_delete.html">zip_file_extra_field_delete(3)</a></li>
<li><a class="Xr" title="Xr" href="zip_file_extra_field_delete_by_id.html">zip_file_extra_field_delete_by_id(3)</a></li>
<li><a class="Xr" title="Xr" href="zip_file_extra_field_get.html">zip_file_extra_field_get(3)</a></li>
<li><a class="Xr" title="Xr" href="zip_file_extra_field_set.html">zip_file_extra_field_set(3)</a></li>
<li><a class="Xr" title="Xr" href="zip_file_extra_fields_count.html">zip_file_extra_fields_count(3)</a></li>
<li><a class="Xr" title="Xr" href="zip_file_extra_fields_count_by_id.html">zip_file_extra_fields_count_by_id(3)</a></li>
</ul>
<h2 class="Ss" title="Ss" id="close_archive"><a class="permalink" href="#close_archive">close
archive</a></h2>
<ul class="Bl-bullet Bl-compact">
<li><a class="Xr" title="Xr" href="zip_close.html">zip_close(3)</a></li>
</ul>
<h2 class="Ss" title="Ss" id="miscellaneous"><a class="permalink" href="#miscellaneous">miscellaneous</a></h2>
<ul class="Bl-bullet Bl-compact">
<li><a class="Xr" title="Xr" href="zip_libzip_version.html">zip_libzip_version(3)</a></li>
<li><a class="Xr" title="Xr" href="zip_register_progress_callback_with_state.html">zip_register_progress_callback_with_state(3)</a></li>
<li><a class="Xr" title="Xr" href="zip_set_archive_comment.html">zip_set_archive_comment(3)</a></li>
<li><a class="Xr" title="Xr" href="zip_set_archive_flag.html">zip_set_archive_flag(3)</a></li>
<li><a class="Xr" title="Xr" href="zip_source.html">zip_source(3)</a></li>
</ul>
<h1 class="Sh" title="Sh" id="ERROR_HANDLING"><a class="permalink" href="#ERROR_HANDLING">ERROR
HANDLING</a></h1>
<ul class="Bl-bullet Bl-compact">
<li><a class="Xr" title="Xr" href="zip_error_to_str.html">zip_error_to_str(3)</a></li>
<li><a class="Xr" title="Xr" href="zip_strerror.html">zip_strerror(3)</a></li>
<li><a class="Xr" title="Xr" href="zip_file_strerror.html">zip_file_strerror(3)</a></li>
<li><a class="Xr" title="Xr" href="zip_error_get.html">zip_error_get(3)</a></li>
<li><a class="Xr" title="Xr" href="zip_error_get_sys_type.html">zip_error_get_sys_type(3)</a></li>
<li><a class="Xr" title="Xr" href="zip_errors.html">zip_errors(3)</a></li>
</ul>
<h1 class="Sh" title="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1>
<span class="An" title="An">Dieter Baron</span>
<<a class="Mt" title="Mt" href="mailto:[email protected]">[email protected]</a>>
and <span class="An" title="An">Thomas Klausner</span>
<<a class="Mt" title="Mt" href="mailto:[email protected]">[email protected]</a>></div>
<table class="foot">
<tr>
<td class="foot-date">December 18, 2017</td>
<td class="foot-os">NetBSD 8.99.16</td>
</tr>
</table>
</body>
</html>