|
Packit Service |
1d0348 |
.TH ARCHIVE_READ_OPTIONS 3 "February 2, 2012" ""
|
|
Packit Service |
1d0348 |
.SH NAME
|
|
Packit Service |
1d0348 |
.ad l
|
|
Packit Service |
1d0348 |
\fB\%archive_read_set_filter_option\fP,
|
|
Packit Service |
1d0348 |
\fB\%archive_read_set_format_option\fP,
|
|
Packit Service |
1d0348 |
\fB\%archive_read_set_option\fP,
|
|
Packit Service |
1d0348 |
\fB\%archive_read_set_options\fP
|
|
Packit Service |
1d0348 |
\- functions controlling options for reading archives
|
|
Packit Service |
1d0348 |
.SH LIBRARY
|
|
Packit Service |
1d0348 |
.ad l
|
|
Packit Service |
1d0348 |
Streaming Archive Library (libarchive, -larchive)
|
|
Packit Service |
1d0348 |
.SH SYNOPSIS
|
|
Packit Service |
1d0348 |
.ad l
|
|
Packit Service |
1d0348 |
.br
|
|
Packit Service |
1d0348 |
\fIint\fP
|
|
Packit Service |
1d0348 |
.br
|
|
Packit Service |
1d0348 |
\fB\%archive_read_set_filter_option\fP(\fI\%struct\ archive\ *\fP, \fI\%const\ char\ *module\fP, \fI\%const\ char\ *option\fP, \fI\%const\ char\ *value\fP);
|
|
Packit Service |
1d0348 |
.br
|
|
Packit Service |
1d0348 |
\fIint\fP
|
|
Packit Service |
1d0348 |
.br
|
|
Packit Service |
1d0348 |
\fB\%archive_read_set_format_option\fP(\fI\%struct\ archive\ *\fP, \fI\%const\ char\ *module\fP, \fI\%const\ char\ *option\fP, \fI\%const\ char\ *value\fP);
|
|
Packit Service |
1d0348 |
.br
|
|
Packit Service |
1d0348 |
\fIint\fP
|
|
Packit Service |
1d0348 |
.br
|
|
Packit Service |
1d0348 |
\fB\%archive_read_set_option\fP(\fI\%struct\ archive\ *\fP, \fI\%const\ char\ *module\fP, \fI\%const\ char\ *option\fP, \fI\%const\ char\ *value\fP);
|
|
Packit Service |
1d0348 |
.br
|
|
Packit Service |
1d0348 |
\fIint\fP
|
|
Packit Service |
1d0348 |
.br
|
|
Packit Service |
1d0348 |
\fB\%archive_read_set_options\fP(\fI\%struct\ archive\ *\fP, \fI\%const\ char\ *options\fP);
|
|
Packit Service |
1d0348 |
.SH DESCRIPTION
|
|
Packit Service |
1d0348 |
.ad l
|
|
Packit Service |
1d0348 |
These functions provide a way for libarchive clients to configure
|
|
Packit Service |
1d0348 |
specific read modules.
|
|
Packit Service |
1d0348 |
.RS 5
|
|
Packit Service |
1d0348 |
.TP
|
|
Packit Service |
1d0348 |
\fB\%archive_read_set_filter_option\fP(),
|
|
Packit Service |
1d0348 |
\fB\%archive_read_set_format_option\fP()
|
|
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 |
.PP
|
|
Packit Service |
1d0348 |
If
|
|
Packit Service |
1d0348 |
\fIoption\fP
|
|
Packit Service |
1d0348 |
and
|
|
Packit Service |
1d0348 |
\fIvalue\fP
|
|
Packit Service |
1d0348 |
are both
|
|
Packit Service |
1d0348 |
.BR NULL,
|
|
Packit Service |
1d0348 |
these functions will do nothing and
|
|
Packit Service |
1d0348 |
\fBARCHIVE_OK\fP
|
|
Packit Service |
1d0348 |
will be returned.
|
|
Packit Service |
1d0348 |
If
|
|
Packit Service |
1d0348 |
\fIoption\fP
|
|
Packit Service |
1d0348 |
is
|
|
Packit Service |
1d0348 |
.BR NULL
|
|
Packit Service |
1d0348 |
but
|
|
Packit Service |
1d0348 |
\fIvalue\fP
|
|
Packit Service |
1d0348 |
is not, these functions will do nothing and
|
|
Packit Service |
1d0348 |
\fBARCHIVE_FAILED\fP
|
|
Packit Service |
1d0348 |
will be returned.
|
|
Packit Service |
1d0348 |
.PP
|
|
Packit Service |
1d0348 |
If
|
|
Packit Service |
1d0348 |
\fImodule\fP
|
|
Packit Service |
1d0348 |
is not
|
|
Packit Service |
1d0348 |
.BR NULL,
|
|
Packit Service |
1d0348 |
\fIoption\fP
|
|
Packit Service |
1d0348 |
and
|
|
Packit Service |
1d0348 |
\fIvalue\fP
|
|
Packit Service |
1d0348 |
will be provided to the filter or reader named
|
|
Packit Service |
1d0348 |
\fImodule\fP.
|
|
Packit Service |
1d0348 |
The return value will be that of the module.
|
|
Packit Service |
1d0348 |
If there is no such module,
|
|
Packit Service |
1d0348 |
\fBARCHIVE_FAILED\fP
|
|
Packit Service |
1d0348 |
will be returned.
|
|
Packit Service |
1d0348 |
.PP
|
|
Packit Service |
1d0348 |
If
|
|
Packit Service |
1d0348 |
\fImodule\fP
|
|
Packit Service |
1d0348 |
is
|
|
Packit Service |
1d0348 |
.BR NULL,
|
|
Packit Service |
1d0348 |
\fIoption\fP
|
|
Packit Service |
1d0348 |
and
|
|
Packit Service |
1d0348 |
\fIvalue\fP
|
|
Packit Service |
1d0348 |
will be provided to every registered module.
|
|
Packit Service |
1d0348 |
If any module returns
|
|
Packit Service |
1d0348 |
\fBARCHIVE_FATAL\fP,
|
|
Packit Service |
1d0348 |
this value will be returned immediately.
|
|
Packit Service |
1d0348 |
Otherwise,
|
|
Packit Service |
1d0348 |
\fBARCHIVE_OK\fP
|
|
Packit Service |
1d0348 |
will be returned if any module accepts the option, and
|
|
Packit Service |
1d0348 |
\fBARCHIVE_FAILED\fP
|
|
Packit Service |
1d0348 |
in all other cases.
|
|
Packit Service |
1d0348 |
.TP
|
|
Packit Service |
1d0348 |
\fB\%archive_read_set_option\fP()
|
|
Packit Service |
1d0348 |
Calls
|
|
Packit Service |
1d0348 |
\fB\%archive_read_set_format_option\fP(),
|
|
Packit Service |
1d0348 |
then
|
|
Packit Service |
1d0348 |
\fB\%archive_read_set_filter_option\fP().
|
|
Packit Service |
1d0348 |
If either function returns
|
|
Packit Service |
1d0348 |
\fBARCHIVE_FATAL\fP,
|
|
Packit Service |
1d0348 |
\fBARCHIVE_FATAL\fP
|
|
Packit Service |
1d0348 |
will be returned
|
|
Packit Service |
1d0348 |
immediately.
|
|
Packit Service |
1d0348 |
Otherwise, greater of the two values will be returned.
|
|
Packit Service |
1d0348 |
.TP
|
|
Packit Service |
1d0348 |
\fB\%archive_read_set_options\fP()
|
|
Packit Service |
1d0348 |
\fIoptions\fP
|
|
Packit Service |
1d0348 |
is a comma-separated list of options.
|
|
Packit Service |
1d0348 |
If
|
|
Packit Service |
1d0348 |
\fIoptions\fP
|
|
Packit Service |
1d0348 |
is
|
|
Packit Service |
1d0348 |
.BR NULL
|
|
Packit Service |
1d0348 |
or empty,
|
|
Packit Service |
1d0348 |
\fBARCHIVE_OK\fP
|
|
Packit Service |
1d0348 |
will be returned immediately.
|
|
Packit Service |
1d0348 |
.PP
|
|
Packit Service |
1d0348 |
Calls
|
|
Packit Service |
1d0348 |
\fB\%archive_read_set_option\fP()
|
|
Packit Service |
1d0348 |
with each option in turn.
|
|
Packit Service |
1d0348 |
If any
|
|
Packit Service |
1d0348 |
\fB\%archive_read_set_option\fP()
|
|
Packit Service |
1d0348 |
call returns
|
|
Packit Service |
1d0348 |
\fBARCHIVE_FATAL\fP,
|
|
Packit Service |
1d0348 |
\fBARCHIVE_FATAL\fP
|
|
Packit Service |
1d0348 |
will be returned immediately.
|
|
Packit Service |
1d0348 |
.PP
|
|
Packit Service |
1d0348 |
Individual options have one of the following forms:
|
|
Packit Service |
1d0348 |
.RS 5
|
|
Packit Service |
1d0348 |
.TP
|
|
Packit Service |
1d0348 |
\fIoption=value\fP
|
|
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 ignore it.
|
|
Packit Service |
1d0348 |
.TP
|
|
Packit Service |
1d0348 |
\fIoption\fP
|
|
Packit Service |
1d0348 |
The option will be provided to every module with a value of
|
|
Packit Service |
1d0348 |
``1''.
|
|
Packit Service |
1d0348 |
.TP
|
|
Packit Service |
1d0348 |
\fI!option\fP
|
|
Packit Service |
1d0348 |
The option will be provided to every module with a NULL value.
|
|
Packit Service |
1d0348 |
.TP
|
|
Packit Service |
1d0348 |
\fImodule:option=value\fP, \fImodule:option\fP, \fImodule:!option\fP
|
|
Packit Service |
1d0348 |
As above, but the corresponding option and value will be provided
|
|
Packit Service |
1d0348 |
only to modules whose name matches
|
|
Packit Service |
1d0348 |
\fImodule\fP.
|
|
Packit Service |
1d0348 |
.RE
|
|
Packit Service |
1d0348 |
.RE
|
|
Packit Service |
1d0348 |
.SH OPTIONS
|
|
Packit Service |
1d0348 |
.ad l
|
|
Packit Service |
1d0348 |
.RS 5
|
|
Packit Service |
1d0348 |
.TP
|
|
Packit Service |
1d0348 |
Format iso9660
|
|
Packit Service |
1d0348 |
.RS 5
|
|
Packit Service |
1d0348 |
.TP
|
|
Packit Service |
1d0348 |
\fBjoliet\fP
|
|
Packit Service |
1d0348 |
Support Joliet extensions.
|
|
Packit Service |
1d0348 |
Defaults to enabled, use
|
|
Packit Service |
1d0348 |
\fB!joliet\fP
|
|
Packit Service |
1d0348 |
to disable.
|
|
Packit Service |
1d0348 |
.TP
|
|
Packit Service |
1d0348 |
\fBrockridge\fP
|
|
Packit Service |
1d0348 |
Support RockRidge extensions.
|
|
Packit Service |
1d0348 |
Defaults to enabled, use
|
|
Packit Service |
1d0348 |
\fB!rockridge\fP
|
|
Packit Service |
1d0348 |
to disable.
|
|
Packit Service |
1d0348 |
.RE
|
|
Packit Service |
1d0348 |
.TP
|
|
Packit Service |
1d0348 |
Format tar
|
|
Packit Service |
1d0348 |
.RS 5
|
|
Packit Service |
1d0348 |
.TP
|
|
Packit Service |
1d0348 |
\fBcompat-2x\fP
|
|
Packit Service |
1d0348 |
Libarchive 2.x incorrectly encoded Unicode filenames on
|
|
Packit Service |
1d0348 |
some platforms.
|
|
Packit Service |
1d0348 |
This option mimics the libarchive 2.x filename handling
|
|
Packit Service |
1d0348 |
so that such archives can be read correctly.
|
|
Packit Service |
1d0348 |
.TP
|
|
Packit Service |
1d0348 |
\fBhdrcharset\fP
|
|
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 |
.TP
|
|
Packit Service |
1d0348 |
\fBmac-ext\fP
|
|
Packit Service |
1d0348 |
Support Mac OS metadata extension that records data in special
|
|
Packit Service |
1d0348 |
files beginning with a period and underscore.
|
|
Packit Service |
1d0348 |
Defaults to enabled on Mac OS, disabled on other platforms.
|
|
Packit Service |
1d0348 |
Use
|
|
Packit Service |
1d0348 |
\fB!mac-ext\fP
|
|
Packit Service |
1d0348 |
to disable.
|
|
Packit Service |
1d0348 |
.TP
|
|
Packit Service |
1d0348 |
\fBread_concatenated_archives\fP
|
|
Packit Service |
1d0348 |
Ignore zeroed blocks in the archive, which occurs when multiple tar archives
|
|
Packit Service |
1d0348 |
have been concatenated together. Without this option, only the contents of
|
|
Packit Service |
1d0348 |
the first concatenated archive would be read.
|
|
Packit Service |
1d0348 |
.RE
|
|
Packit Service |
1d0348 |
.RE
|
|
Packit Service |
1d0348 |
.SH ERRORS
|
|
Packit Service |
1d0348 |
.ad l
|
|
Packit Service |
1d0348 |
Detailed error codes and textual descriptions are available from the
|
|
Packit Service |
1d0348 |
\fB\%archive_errno\fP()
|
|
Packit Service |
1d0348 |
and
|
|
Packit Service |
1d0348 |
\fB\%archive_error_string\fP()
|
|
Packit Service |
1d0348 |
functions.
|
|
Packit Service |
1d0348 |
.SH SEE ALSO
|
|
Packit Service |
1d0348 |
.ad l
|
|
Packit Service |
1d0348 |
\fBtar\fP(1),
|
|
Packit Service |
1d0348 |
\fBlibarchive\fP(3),
|
|
Packit Service |
1d0348 |
\fBarchive_write_set_options\fP(3),
|
|
Packit Service |
1d0348 |
\fBarchive_read\fP(3)
|