|
Packit Service |
1d0348 |
ARCHIVE_READ_OPTIONS(3) BSD Library Functions Manual ARCHIVE_READ_OPTIONS(3)
|
|
Packit Service |
1d0348 |
|
|
Packit Service |
1d0348 |
NAME
|
|
Packit Service |
1d0348 |
archive_read_set_filter_option, archive_read_set_format_option,
|
|
Packit Service |
1d0348 |
archive_read_set_option, archive_read_set_options — functions controlling
|
|
Packit Service |
1d0348 |
options for reading archives
|
|
Packit Service |
1d0348 |
|
|
Packit Service |
1d0348 |
LIBRARY
|
|
Packit Service |
1d0348 |
Streaming Archive Library (libarchive, -larchive)
|
|
Packit Service |
1d0348 |
|
|
Packit Service |
1d0348 |
SYNOPSIS
|
|
Packit Service |
1d0348 |
int
|
|
Packit Service |
1d0348 |
archive_read_set_filter_option(struct archive *, const char *module,
|
|
Packit Service |
1d0348 |
const char *option, const char *value);
|
|
Packit Service |
1d0348 |
|
|
Packit Service |
1d0348 |
int
|
|
Packit Service |
1d0348 |
archive_read_set_format_option(struct archive *, const char *module,
|
|
Packit Service |
1d0348 |
const char *option, const char *value);
|
|
Packit Service |
1d0348 |
|
|
Packit Service |
1d0348 |
int
|
|
Packit Service |
1d0348 |
archive_read_set_option(struct archive *, const char *module,
|
|
Packit Service |
1d0348 |
const char *option, const char *value);
|
|
Packit Service |
1d0348 |
|
|
Packit Service |
1d0348 |
int
|
|
Packit Service |
1d0348 |
archive_read_set_options(struct archive *, const char *options);
|
|
Packit Service |
1d0348 |
|
|
Packit Service |
1d0348 |
DESCRIPTION
|
|
Packit Service |
1d0348 |
These functions provide a way for libarchive clients to configure spe‐
|
|
Packit Service |
1d0348 |
cific read modules.
|
|
Packit Service |
1d0348 |
|
|
Packit Service |
1d0348 |
archive_read_set_filter_option(), archive_read_set_format_option()
|
|
Packit Service |
1d0348 |
Specifies an option that will be passed to currently-registered
|
|
Packit Service |
1d0348 |
filters (including decompression filters) or format readers.
|
|
Packit Service |
1d0348 |
|
|
Packit Service |
1d0348 |
If option and value are both NULL, these functions will do noth‐
|
|
Packit Service |
1d0348 |
ing and ARCHIVE_OK will be returned. If option is NULL but value
|
|
Packit Service |
1d0348 |
is not, these functions will do nothing and ARCHIVE_FAILED will
|
|
Packit Service |
1d0348 |
be returned.
|
|
Packit Service |
1d0348 |
|
|
Packit Service |
1d0348 |
If module is not NULL, option and value will be provided to the
|
|
Packit Service |
1d0348 |
filter or reader named module. The return value will be that of
|
|
Packit Service |
1d0348 |
the module. If there is no such module, ARCHIVE_FAILED will be
|
|
Packit Service |
1d0348 |
returned.
|
|
Packit Service |
1d0348 |
|
|
Packit Service |
1d0348 |
If module is NULL, option and value will be provided to every
|
|
Packit Service |
1d0348 |
registered module. If any module returns ARCHIVE_FATAL, this
|
|
Packit Service |
1d0348 |
value will be returned immediately. Otherwise, ARCHIVE_OK will
|
|
Packit Service |
1d0348 |
be returned if any module accepts the option, and ARCHIVE_FAILED
|
|
Packit Service |
1d0348 |
in all other cases.
|
|
Packit Service |
1d0348 |
|
|
Packit Service |
1d0348 |
archive_read_set_option()
|
|
Packit Service |
1d0348 |
Calls archive_read_set_format_option(), then
|
|
Packit Service |
1d0348 |
archive_read_set_filter_option(). If either function returns
|
|
Packit Service |
1d0348 |
ARCHIVE_FATAL, ARCHIVE_FATAL will be returned immediately. Oth‐
|
|
Packit Service |
1d0348 |
erwise, greater of the two values will be returned.
|
|
Packit Service |
1d0348 |
|
|
Packit Service |
1d0348 |
archive_read_set_options()
|
|
Packit Service |
1d0348 |
options is a comma-separated list of options. If options is NULL
|
|
Packit Service |
1d0348 |
or empty, ARCHIVE_OK will be returned immediately.
|
|
Packit Service |
1d0348 |
|
|
Packit Service |
1d0348 |
Calls archive_read_set_option() with each option in turn. If any
|
|
Packit Service |
1d0348 |
archive_read_set_option() call returns ARCHIVE_FATAL,
|
|
Packit Service |
1d0348 |
ARCHIVE_FATAL will be returned immediately.
|
|
Packit Service |
1d0348 |
|
|
Packit Service |
1d0348 |
Individual options have one of the following forms:
|
|
Packit Service |
1d0348 |
option=value
|
|
Packit Service |
1d0348 |
The option/value pair will be provided to every module.
|
|
Packit Service |
1d0348 |
Modules that do not accept an option with this name will
|
|
Packit Service |
1d0348 |
ignore it.
|
|
Packit Service |
1d0348 |
option The option will be provided to every module with a value
|
|
Packit Service |
1d0348 |
of “1”.
|
|
Packit Service |
1d0348 |
!option
|
|
Packit Service |
1d0348 |
The option will be provided to every module with a NULL
|
|
Packit Service |
1d0348 |
value.
|
|
Packit Service |
1d0348 |
module:option=value, module:option, module:!option
|
|
Packit Service |
1d0348 |
As above, but the corresponding option and value will be
|
|
Packit Service |
1d0348 |
provided only to modules whose name matches module.
|
|
Packit Service |
1d0348 |
|
|
Packit Service |
1d0348 |
OPTIONS
|
|
Packit Service |
1d0348 |
Format iso9660
|
|
Packit Service |
1d0348 |
joliet Support Joliet extensions. Defaults to enabled, use
|
|
Packit Service |
1d0348 |
!joliet to disable.
|
|
Packit Service |
1d0348 |
rockridge
|
|
Packit Service |
1d0348 |
Support RockRidge extensions. Defaults to enabled, use
|
|
Packit Service |
1d0348 |
!rockridge to disable.
|
|
Packit Service |
1d0348 |
Format tar
|
|
Packit Service |
1d0348 |
compat-2x
|
|
Packit Service |
1d0348 |
Libarchive 2.x incorrectly encoded Unicode filenames on
|
|
Packit Service |
1d0348 |
some platforms. This option mimics the libarchive 2.x
|
|
Packit Service |
1d0348 |
filename handling so that such archives can be read cor‐
|
|
Packit Service |
1d0348 |
rectly.
|
|
Packit Service |
1d0348 |
hdrcharset
|
|
Packit Service |
1d0348 |
The value is used as a character set name that will be
|
|
Packit Service |
1d0348 |
used when translating filenames.
|
|
Packit Service |
1d0348 |
mac-ext
|
|
Packit Service |
1d0348 |
Support Mac OS metadata extension that records data in
|
|
Packit Service |
1d0348 |
special files beginning with a period and underscore.
|
|
Packit Service |
1d0348 |
Defaults to enabled on Mac OS, disabled on other plat‐
|
|
Packit Service |
1d0348 |
forms. Use !mac-ext to disable.
|
|
Packit Service |
1d0348 |
read_concatenated_archives
|
|
Packit Service |
1d0348 |
Ignore zeroed blocks in the archive, which occurs when
|
|
Packit Service |
1d0348 |
multiple tar archives have been concatenated together.
|
|
Packit Service |
1d0348 |
Without this option, only the contents of the first con‐
|
|
Packit Service |
1d0348 |
catenated archive would be read.
|
|
Packit Service |
1d0348 |
|
|
Packit Service |
1d0348 |
ERRORS
|
|
Packit Service |
1d0348 |
Detailed error codes and textual descriptions are available from the
|
|
Packit Service |
1d0348 |
archive_errno() and archive_error_string() functions.
|
|
Packit Service |
1d0348 |
|
|
Packit Service |
1d0348 |
SEE ALSO
|
|
Packit Service |
1d0348 |
tar(1), libarchive(3), archive_write_set_options(3), archive_read(3)
|
|
Packit Service |
1d0348 |
|
|
Packit Service |
1d0348 |
BSD February 2, 2012 BSD
|