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
|
ARCHIVE_READ_OPTIONS(3) manual page
== NAME ==
'''archive_read_set_filter_option''',
'''archive_read_set_format_option''',
'''archive_read_set_option''',
'''archive_read_set_options'''
- functions controlling options for reading archives
== LIBRARY ==
Streaming Archive Library (libarchive, -larchive)
== SYNOPSIS ==
<br>
''int''
<br>
'''archive_read_set_filter_option'''(''struct archive *'', ''const char *module'', ''const char *option'', ''const char *value'');
<br>
''int''
<br>
'''archive_read_set_format_option'''(''struct archive *'', ''const char *module'', ''const char *option'', ''const char *value'');
<br>
''int''
<br>
'''archive_read_set_option'''(''struct archive *'', ''const char *module'', ''const char *option'', ''const char *value'');
<br>
''int''
<br>
'''archive_read_set_options'''(''struct archive *'', ''const char *options'');
== DESCRIPTION ==
These functions provide a way for libarchive clients to configure
specific read modules.
<dl>
<dt>
'''archive_read_set_filter_option'''(),
'''archive_read_set_format_option'''()
</dt> <dd>
Specifies an option that will be passed to currently-registered
filters (including decompression filters) or format readers.
If
''option''
and
''value''
are both
NULL,
these functions will do nothing and
'''ARCHIVE_OK'''
will be returned.
If
''option''
is
NULL
but
''value''
is not, these functions will do nothing and
'''ARCHIVE_FAILED'''
will be returned.
If
''module''
is not
NULL,
''option''
and
''value''
will be provided to the filter or reader named
''module''.
The return value will be that of the module.
If there is no such module,
'''ARCHIVE_FAILED'''
will be returned.
If
''module''
is
NULL,
''option''
and
''value''
will be provided to every registered module.
If any module returns
'''ARCHIVE_FATAL''',
this value will be returned immediately.
Otherwise,
'''ARCHIVE_OK'''
will be returned if any module accepts the option, and
'''ARCHIVE_FAILED'''
in all other cases.
</dd><dt>
'''archive_read_set_option'''()
</dt> <dd>
Calls
'''archive_read_set_format_option'''(),
then
'''archive_read_set_filter_option'''().
If either function returns
'''ARCHIVE_FATAL''',
'''ARCHIVE_FATAL'''
will be returned
immediately.
Otherwise, greater of the two values will be returned.
</dd><dt>
'''archive_read_set_options'''()
</dt> <dd>
''options''
is a comma-separated list of options.
If
''options''
is
NULL
or empty,
'''ARCHIVE_OK'''
will be returned immediately.
Calls
'''archive_read_set_option'''()
with each option in turn.
If any
'''archive_read_set_option'''()
call returns
'''ARCHIVE_FATAL''',
'''ARCHIVE_FATAL'''
will be returned immediately.
Individual options have one of the following forms:
<dl>
<dt>''option=value''</dt><dd>
The option/value pair will be provided to every module.
Modules that do not accept an option with this name will ignore it.
</dd><dt>''option''</dt><dd>
The option will be provided to every module with a value of
"1".
</dd><dt>''!option''</dt><dd>
The option will be provided to every module with a NULL value.
</dd><dt>''module:option=value'', ''module:option'', ''module:!option''</dt><dd>
As above, but the corresponding option and value will be provided
only to modules whose name matches
''module''.
</dd></dl>
</dd></dl>
== OPTIONS ==
<dl>
<dt>Format iso9660</dt><dd>
<dl>
<dt>'''joliet'''</dt><dd>
Support Joliet extensions.
Defaults to enabled, use
'''!joliet'''
to disable.
</dd><dt>'''rockridge'''</dt><dd>
Support RockRidge extensions.
Defaults to enabled, use
'''!rockridge'''
to disable.
</dd></dl>
</dd><dt>Format tar</dt><dd>
<dl>
<dt>'''compat-2x'''</dt><dd>
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.
</dd><dt>'''hdrcharset'''</dt><dd>
The value is used as a character set name that will be
used when translating filenames.
</dd><dt>'''mac-ext'''</dt><dd>
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
'''!mac-ext'''
to disable.
</dd><dt>'''read_concatenated_archives'''</dt><dd>
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.
</dd></dl>
</dd></dl>
== ERRORS ==
Detailed error codes and textual descriptions are available from the
'''archive_errno'''()
and
'''archive_error_string'''()
functions.
== SEE ALSO ==
[[ManPageBsdtar1]],
[[ManPageibarchive3]],
[[ManPagerchiveriteetptions3]],
[[ManPagerchiveead3]]
|
