1 .\" Copyright (c) 2011 Tim Kientzle
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .Dt ARCHIVE_READ_OPTIONS 3
31 .Nm archive_read_set_filter_option ,
32 .Nm archive_read_set_format_option ,
33 .Nm archive_read_set_option ,
34 .Nm archive_read_set_options
35 .Nd functions controlling options for reading archives
39 .Fo archive_read_set_filter_option
40 .Fa "struct archive *"
41 .Fa "const char *module"
42 .Fa "const char *option"
43 .Fa "const char *value"
46 .Fo archive_read_set_format_option
47 .Fa "struct archive *"
48 .Fa "const char *module"
49 .Fa "const char *option"
50 .Fa "const char *value"
53 .Fo archive_read_set_option
54 .Fa "struct archive *"
55 .Fa "const char *module"
56 .Fa "const char *option"
57 .Fa "const char *value"
60 .Fo archive_read_set_options
61 .Fa "struct archive *"
62 .Fa "const char *options"
65 These functions provide a way for libarchive clients to configure
66 specific read modules.
67 .Bl -tag -width indent
69 .Fn archive_read_set_filter_option ,
70 .Fn archive_read_set_format_option
72 Specifies an option that will be passed to currently-registered
73 filters (including decompression filters) or format readers.
81 these functions will do nothing and
90 is not, these functions will do nothing and
101 will be provided to the filter or reader named
103 The return value will be that of the module.
104 If there is no such module,
115 will be provided to every registered module.
116 If any module returns
118 this value will be returned immediately.
121 will be returned if any module accepts the option, and
126 .Fn archive_read_set_option
129 .Fn archive_read_set_format_option ,
131 .Fn archive_read_set_filter_option .
132 If either function returns
137 Otherwise, greater of the two values will be returned.
140 .Fn archive_read_set_options
143 is a comma-separated list of options.
150 will be returned immediately.
153 .Fn archive_read_set_option
154 with each option in turn.
156 .Fn archive_read_set_option
160 will be returned immediately.
162 Individual options have one of the following forms:
163 .Bl -tag -compact -width indent
165 The option/value pair will be provided to every module.
166 Modules that do not accept an option with this name will ignore it.
168 The option will be provided to every module with a value of
171 The option will be provided to every module with a NULL value.
172 .It Ar module:option=value , Ar module:option , Ar module:!option
173 As above, but the corresponding option and value will be provided
174 only to modules whose name matches
180 .Bl -tag -compact -width indent
182 .Bl -tag -compact -width indent
184 Support Joliet extensions.
185 Defaults to enabled, use
189 Support RockRidge extensions.
190 Defaults to enabled, use
197 Detailed error codes and textual descriptions are available from the
200 .Fn archive_error_string
206 .Xr archive_write_set_options 3 ,