Manpages - archive_read_set_options.3

Streaming Archive Library (libarchive, -larchive)

These functions provide a way for libarchive clients to configure specific read modules.

Specifies an option that will be passed to currently-registered filters (including decompression filters) or format readers.

If

and

are both

these functions will do nothing and

will be returned. If

is

but

is not, these functions will do nothing and

will be returned.

If

is not

and

will be provided to the filter or reader named

The return value will be that of the module. If there is no such module,

will be returned.

If

is

and

will be provided to every registered module. If any module returns

this value will be returned immediately. Otherwise,

will be returned if any module accepts the option, and

in all other cases.

Calls

then

If either function returns

will be returned immediately. Otherwise, greater of the two values will be returned.

is a comma-separated list of options. If

is

or empty,

will be returned immediately.

Calls

with each option in turn. If any

call returns

will be returned immediately.

Individual options have one of the following forms:

The option/value pair will be provided to every module. Modules that do not accept an option with this name will ignore it.

The option will be provided to every module with a value of

The option will be provided to every module with a NULL value.

As above, but the corresponding option and value will be provided only to modules whose name matches

The value is used as a character set name that will be used when translating file names.

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.

The value is used as a character set name that will be used when translating file names.

When reading a binary CPIO archive, assume that it is in the original PWB cpio format, and handle file mode bits accordingly. The default is to assume v7 format.

Support Joliet extensions. Defaults to enabled, use

to disable.

Support RockRidge extensions. Defaults to enabled, use

to disable.

The value is used as a character set name that will be used when translating file names.

Allow reading information missing from the mtree from the file system. Disabled by default.

The value is used as a character set name that will be used when translating file names.

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.

The value is used as a character set name that will be used when translating file names.

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

to disable.

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.

Detailed error codes and textual descriptions are available from the

and

functions.