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