|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
"http://www.w3.org/TR/html4/loose.dtd">
|
|
Packit |
08bd4c |
<html>
|
|
Packit |
08bd4c |
<head>
|
|
Packit |
08bd4c |
<meta name="generator" content="groff -Thtml, see www.gnu.org">
|
|
Packit |
08bd4c |
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
|
|
Packit |
08bd4c |
<meta name="Content-Style" content="text/css">
|
|
Packit |
08bd4c |
<style type="text/css">
|
|
Packit |
08bd4c |
p { margin-top: 0; margin-bottom: 0; vertical-align: top }
|
|
Packit |
08bd4c |
pre { margin-top: 0; margin-bottom: 0; vertical-align: top }
|
|
Packit |
08bd4c |
table { margin-top: 0; margin-bottom: 0; vertical-align: top }
|
|
Packit |
08bd4c |
h1 { text-align: center }
|
|
Packit |
08bd4c |
</style>
|
|
Packit |
08bd4c |
<title></title>
|
|
Packit |
08bd4c |
</head>
|
|
Packit |
08bd4c |
<body>
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
ARCHIVE_READ_OPTIONS(3) BSD Library Functions Manual
|
|
Packit |
08bd4c |
ARCHIVE_READ_OPTIONS(3)
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
NAME
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
archive_read_set_filter_option,
|
|
Packit |
08bd4c |
archive_read_set_format_option,
|
|
Packit |
08bd4c |
archive_read_set_option,
|
|
Packit |
08bd4c |
archive_read_set_options — functions
|
|
Packit |
08bd4c |
controlling options for reading archives
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
LIBRARY
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
Streaming Archive Library
|
|
Packit |
08bd4c |
(libarchive, -larchive)
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
SYNOPSIS
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
int
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
archive_read_set_filter_option(struct archive *,
|
|
Packit |
08bd4c |
const char *module,
|
|
Packit |
08bd4c |
const char *option,
|
|
Packit |
08bd4c |
const char *value);
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
int
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
archive_read_set_format_option(struct archive *,
|
|
Packit |
08bd4c |
const char *module,
|
|
Packit |
08bd4c |
const char *option,
|
|
Packit |
08bd4c |
const char *value);
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
int
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
archive_read_set_option(struct archive *,
|
|
Packit |
08bd4c |
const char *module,
|
|
Packit |
08bd4c |
const char *option,
|
|
Packit |
08bd4c |
const char *value);
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
int
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
archive_read_set_options(struct archive *,
|
|
Packit |
08bd4c |
const char *options);
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
DESCRIPTION
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
These functions provide a way
|
|
Packit |
08bd4c |
for libarchive clients to configure specific read
|
|
Packit |
08bd4c |
modules.
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
archive_read_set_filter_option(),
|
|
Packit |
08bd4c |
archive_read_set_format_option()
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
Specifies an option that will
|
|
Packit |
08bd4c |
be passed to currently-registered filters (including
|
|
Packit |
08bd4c |
decompression filters) or format readers.
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
If
|
|
Packit |
08bd4c |
option and value are both NULL, these
|
|
Packit |
08bd4c |
functions will do nothing and ARCHIVE_OK will be
|
|
Packit |
08bd4c |
returned. If option is NULL but value is not,
|
|
Packit |
08bd4c |
these functions will do nothing and ARCHIVE_FAILED
|
|
Packit |
08bd4c |
will be returned.
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
If
|
|
Packit |
08bd4c |
module is not NULL, option and value
|
|
Packit |
08bd4c |
will be provided to the filter or reader named
|
|
Packit |
08bd4c |
module. The return value will be that of the module.
|
|
Packit |
08bd4c |
If there is no such module, ARCHIVE_FAILED will be
|
|
Packit |
08bd4c |
returned.
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
If
|
|
Packit |
08bd4c |
module is NULL, option and value will
|
|
Packit |
08bd4c |
be provided to every registered module. If any module
|
|
Packit |
08bd4c |
returns ARCHIVE_FATAL, this value will be returned
|
|
Packit |
08bd4c |
immediately. Otherwise, ARCHIVE_OK will be returned
|
|
Packit |
08bd4c |
if any module accepts the option, and ARCHIVE_FAILED
|
|
Packit |
08bd4c |
in all other cases.
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
archive_read_set_option()
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
Calls
|
|
Packit |
08bd4c |
archive_read_set_format_option(), then
|
|
Packit |
08bd4c |
archive_read_set_filter_option(). If either function
|
|
Packit |
08bd4c |
returns ARCHIVE_FATAL, ARCHIVE_FATAL will be
|
|
Packit |
08bd4c |
returned immediately. Otherwise, greater of the two values
|
|
Packit |
08bd4c |
will be returned.
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
archive_read_set_options()
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
options is a
|
|
Packit |
08bd4c |
comma-separated list of options. If options is NULL
|
|
Packit |
08bd4c |
or empty, ARCHIVE_OK will be returned
|
|
Packit |
08bd4c |
immediately.
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
Calls
|
|
Packit |
08bd4c |
archive_read_set_option() with each option in turn.
|
|
Packit |
08bd4c |
If any archive_read_set_option() call returns
|
|
Packit |
08bd4c |
ARCHIVE_FATAL, ARCHIVE_FATAL will be returned
|
|
Packit |
08bd4c |
immediately.
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
Individual
|
|
Packit |
08bd4c |
options have one of the following forms:
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
option=value
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
The option/value pair will be
|
|
Packit |
08bd4c |
provided to every module. Modules that do not accept an
|
|
Packit |
08bd4c |
option with this name will ignore it.
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
option
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
The option will
|
|
Packit |
08bd4c |
be provided to every module with a value of
|
|
Packit |
08bd4c |
’’1’’.
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
!option
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
The option will be provided to
|
|
Packit |
08bd4c |
every module with a NULL value.
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
module:option=value, module:option,
|
|
Packit |
08bd4c |
module:!option
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
As above, but the corresponding
|
|
Packit |
08bd4c |
option and value will be provided only to modules whose name
|
|
Packit |
08bd4c |
matches module.
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
OPTIONS
|
|
Packit |
08bd4c |
Format iso9660
|
|
Packit |
08bd4c |
joliet
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
Support Joliet
|
|
Packit |
08bd4c |
extensions. Defaults to enabled, use !joliet to
|
|
Packit |
08bd4c |
disable.
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
rockridge
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
Support RockRidge extensions.
|
|
Packit |
08bd4c |
Defaults to enabled, use !rockridge to disable.
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
Format tar
|
|
Packit |
08bd4c |
compat-2x
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
Libarchive 2.x incorrectly
|
|
Packit |
08bd4c |
encoded Unicode filenames on some platforms. This option
|
|
Packit |
08bd4c |
mimics the libarchive 2.x filename handling so that such
|
|
Packit |
08bd4c |
archives can be read correctly.
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
hdrcharset
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
The value is used as a
|
|
Packit |
08bd4c |
character set name that will be used when translating
|
|
Packit |
08bd4c |
filenames.
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
mac-ext
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
Support Mac OS metadata
|
|
Packit |
08bd4c |
extension that records data in special files beginning with
|
|
Packit |
08bd4c |
a period and underscore. Defaults to enabled on Mac OS,
|
|
Packit |
08bd4c |
disabled on other platforms. Use !mac-ext to
|
|
Packit |
08bd4c |
disable.
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
read_concatenated_archives
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
Ignore zeroed blocks in the
|
|
Packit |
08bd4c |
archive, which occurs when multiple tar archives have been
|
|
Packit |
08bd4c |
concatenated together. Without this option, only the
|
|
Packit |
08bd4c |
contents of the first concatenated archive would be
|
|
Packit |
08bd4c |
read.
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
ERRORS
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
Detailed error codes and textual
|
|
Packit |
08bd4c |
descriptions are available from the archive_errno()
|
|
Packit |
08bd4c |
and archive_error_string() functions.
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
SEE ALSO
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
tar(1), libarchive(3),
|
|
Packit |
08bd4c |
archive_write_set_options(3), archive_read(3)
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
BSD
|
|
Packit |
08bd4c |
February 2, 2012 BSD
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
</body>
|
|
Packit |
08bd4c |
</html>
|