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
|
<!-- Creator : groff version 1.23.0 -->
<!-- CreationDate: Mon Jan 5 10:42:44 2026 -->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta name="generator" content="groff -Thtml, see www.gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<meta name="Content-Style" content="text/css">
<style type="text/css">
p { margin-top: 0; margin-bottom: 0; vertical-align: top }
pre { margin-top: 0; margin-bottom: 0; vertical-align: top }
table { margin-top: 0; margin-bottom: 0; vertical-align: top }
h1 { text-align: center }
</style>
<title></title>
</head>
<body>
<hr>
<p><i>ARCHIVE_READ_OPTIONS</i>(3) Library Functions Manual
<i>ARCHIVE_READ_OPTIONS</i>(3)</p>
<p style="margin-top: 1em"><b>NAME</b></p>
<p style="margin-left:9%;">archive_read_set_filter_option,
archive_read_set_format_option, archive_read_set_option,
archive_read_set_options — functions controlling
options for reading archives</p>
<p style="margin-top: 1em"><b>LIBRARY</b></p>
<p style="margin-left:9%;">Streaming Archive Library
(libarchive, -larchive)</p>
<p style="margin-top: 1em"><b>SYNOPSIS</b></p>
<p style="margin-left:9%;"><i>int</i></p>
<p><b>archive_read_set_filter_option</b>(<i>struct archive *</i>,
<i>const char *module</i>,
<i>const char *option</i>,
<i>const char *value</i>);</p>
<p style="margin-left:9%; margin-top: 1em"><i>int</i></p>
<p><b>archive_read_set_format_option</b>(<i>struct archive *</i>,
<i>const char *module</i>,
<i>const char *option</i>,
<i>const char *value</i>);</p>
<p style="margin-left:9%; margin-top: 1em"><i>int</i></p>
<p><b>archive_read_set_option</b>(<i>struct archive *</i>,
<i>const char *module</i>,
<i>const char *option</i>,
<i>const char *value</i>);</p>
<p style="margin-left:9%; margin-top: 1em"><i>int</i></p>
<p><b>archive_read_set_options</b>(<i>struct archive *</i>,
<i>const char *options</i>);</p>
<p style="margin-top: 1em"><b>DESCRIPTION</b></p>
<p style="margin-left:9%;">These functions provide a way
for libarchive clients to configure specific read
modules.</p>
<p style="margin-top: 1em"><b>archive_read_set_filter_option</b>(),
<b>archive_read_set_format_option</b>()</p>
<p style="margin-left:19%;">Specifies an option that will
be passed to currently-registered filters (including
decompression filters) or format readers.</p>
<p style="margin-left:19%; margin-top: 1em">If
<i>option</i> and <i>value</i> are both NULL, these
functions will do nothing and <b>ARCHIVE_OK</b> will be
returned. If <i>option</i> is NULL but <i>value</i> is not,
these functions will do nothing and <b>ARCHIVE_FAILED</b>
will be returned.</p>
<p style="margin-left:19%; margin-top: 1em">If
<i>module</i> is not NULL, <i>option</i> and <i>value</i>
will be provided to the filter or reader named
<i>module</i>. The return value will be that of the module.
If there is no such module, <b>ARCHIVE_FAILED</b> will be
returned.</p>
<p style="margin-left:19%; margin-top: 1em">If
<i>module</i> is NULL, <i>option</i> and <i>value</i> will
be provided to every registered module. If any module
returns <b>ARCHIVE_FATAL</b>, this value will be returned
immediately. Otherwise, <b>ARCHIVE_OK</b> will be returned
if any module accepts the option, and <b>ARCHIVE_FAILED</b>
in all other cases.</p>
<p style="margin-top: 1em"><b>archive_read_set_option</b>()</p>
<p style="margin-left:19%;">Calls
<b>archive_read_set_format_option</b>(), then
<b>archive_read_set_filter_option</b>(). If either function
returns <b>ARCHIVE_FATAL</b>, <b>ARCHIVE_FATAL</b> will be
returned immediately. Otherwise, greater of the two values
will be returned.</p>
<p style="margin-top: 1em"><b>archive_read_set_options</b>()</p>
<p style="margin-left:19%;"><i>options</i> is a
comma-separated list of options. If <i>options</i> is NULL
or empty, <b>ARCHIVE_OK</b> will be returned
immediately.</p>
<p style="margin-left:19%; margin-top: 1em">Calls
<b>archive_read_set_option</b>() with each option in turn.
If any <b>archive_read_set_option</b>() call returns
<b>ARCHIVE_FATAL</b>, <b>ARCHIVE_FATAL</b> will be returned
immediately.</p>
<p style="margin-left:19%; margin-top: 1em">Individual
options have one of the following forms:</p>
<p><i>option=value</i></p>
<p style="margin-left:29%;">The option/value pair will be
provided to every module. Modules that do not accept an
option with this name will ignore it.</p>
<p><i>option</i></p>
<p style="margin-left:29%; margin-top: 1em">The option will
be provided to every module with a value of
“1”.</p>
<p><i>!option</i></p>
<p style="margin-left:29%;">The option will be provided to
every module with a NULL value.</p>
<p><i>module:option=value</i>, <i>module:option</i>,
<i>module:!option</i></p>
<p style="margin-left:29%;">As above, but the corresponding
option and value will be provided only to modules whose name
matches <i>module</i>.</p>
<p style="margin-top: 1em"><b>OPTIONS</b> <br>
Format cab <b><br>
hdrcharset</b></p>
<p style="margin-left:29%;">The value is used as a
character set name that will be used when translating file
names.</p>
<p>Format cpio <b><br>
compat-2x</b></p>
<p style="margin-left:29%;">Libarchive 2.x incorrectly
encoded Unicode filenames on some platforms. This option
mimics the libarchive 2.x filename handling so that such
archives can be read correctly.</p>
<p><b>hdrcharset</b></p>
<p style="margin-left:29%;">The value is used as a
character set name that will be used when translating file
names.</p>
<p><b>pwb</b></p>
<p style="margin-left:29%; margin-top: 1em">When reading a
binary CPIO archive, assume that it is in the original PWB
cpio format, and handle file mode bits accordingly. The
default is to assume v7 format.</p>
<p>Format iso9660 <b><br>
joliet</b></p>
<p style="margin-left:29%; margin-top: 1em">Support Joliet
extensions. Defaults to enabled, use <b>!joliet</b> to
disable.</p>
<p><b>rockridge</b></p>
<p style="margin-left:29%;">Support RockRidge extensions.
Defaults to enabled, use <b>!rockridge</b> to disable.</p>
<p>Format lha <b><br>
hdrcharset</b></p>
<p style="margin-left:29%;">The value is used as a
character set name that will be used when translating file
names.</p>
<p>Format mtree <b><br>
checkfs</b></p>
<p style="margin-left:29%;">Allow reading information
missing from the mtree from the file system. Disabled by
default.</p>
<p>Format rar <b><br>
hdrcharset</b></p>
<p style="margin-left:29%;">The value is used as a
character set name that will be used when translating file
names.</p>
<p>Format tar <b><br>
compat-2x</b></p>
<p style="margin-left:29%;">Libarchive 2.x incorrectly
encoded Unicode filenames on some platforms. This option
mimics the libarchive 2.x filename handling so that such
archives can be read correctly.</p>
<p><b>hdrcharset</b></p>
<p style="margin-left:29%;">The value is used as a
character set name that will be used when translating file
names.</p>
<p><b>mac-ext</b></p>
<p style="margin-left:29%;">Support Mac OS metadata
extension that records data in special files beginning with
a period and underscore. Defaults to enabled on Mac OS,
disabled on other platforms. Use <b>!mac-ext</b> to
disable.</p>
<p><b>read_concatenated_archives</b></p>
<p style="margin-left:29%;">Ignore zeroed blocks in the
archive, which occurs when multiple tar archives have been
concatenated together. Without this option, only the
contents of the first concatenated archive would be
read.</p>
<p>Format zip <b><br>
compat-2x</b></p>
<p style="margin-left:29%;">Libarchive 2.x incorrectly
encoded Unicode filenames on some platforms. This option
mimics the libarchive 2.x filename handling so that such
archives can be read correctly.</p>
<p><b>hdrcharset</b></p>
<p style="margin-left:29%;">The value is used as a
character set name that will be used when translating file
names.</p>
<p><b>ignorecrc32</b></p>
<p style="margin-left:29%;">Skip the CRC32 check. Mostly
used for testing.</p>
<p><b>mac-ext</b></p>
<p style="margin-left:29%;">Support Mac OS metadata
extension that records data in special files beginning with
a period and underscore. Defaults to enabled on Mac OS,
disabled on other platforms. Use <b>!mac-ext</b> to
disable.</p>
<p style="margin-top: 1em"><b>ERRORS</b></p>
<p style="margin-left:9%;">Detailed error codes and textual
descriptions are available from the <b>archive_errno</b>()
and <b>archive_error_string</b>() functions.</p>
<p style="margin-top: 1em"><b>SEE ALSO</b></p>
<p style="margin-left:9%;"><i>tar</i>(1),
<i>archive_read</i>(3), <i>archive_write_set_options</i>(3),
<i>libarchive</i>(3) Debian January 31, 2020
<i>ARCHIVE_READ_OPTIONS</i>(3)</p>
<hr>
</body>
</html>
|
