File: archive_write_set_options.3.html

package info (click to toggle)
libarchive 3.0.4-3%2Bwheezy1
links: PTS, VCS
area: main
in suites: wheezy
size: 14,640 kB
sloc: ansic: 114,310; sh: 12,235; makefile: 967; awk: 734
file content (530 lines) | stat: -rw-r--r-- 18,401 bytes
<!-- Creator     : groff version 1.19.2 -->
<!-- CreationDate: Tue Mar 27 21:04:08 2012 -->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta name="generator" content="groff -Thtml, see www.gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<meta name="Content-Style" content="text/css">
<style type="text/css">
       p     { margin-top: 0; margin-bottom: 0; }
       pre   { margin-top: 0; margin-bottom: 0; }
       table { margin-top: 0; margin-bottom: 0; }
</style>
<title></title>
</head>
<body>

<hr>


<p valign="top">ARCHIVE_WRITE_OPTIONS(3) BSD Library
Functions Manual ARCHIVE_WRITE_OPTIONS(3)</p>

<p style="margin-top: 1em" valign="top"><b>NAME</b></p>


<p style="margin-left:8%;"><b>archive_write_set_filter_option</b>,
<b>archive_write_set_format_option</b>,
<b>archive_write_set_option</b>,
<b>archive_write_set_options</b> &mdash; functions
controlling options for reading archives</p>

<p style="margin-top: 1em" valign="top"><b>LIBRARY</b></p>

<p style="margin-left:8%;">Streaming Archive Library
(libarchive, -larchive)</p>


<p style="margin-top: 1em" valign="top"><b>SYNOPSIS</b></p>

<p style="margin-left:8%;"><i>int</i></p>


<p valign="top"><b>archive_write_set_filter_option</b>(<i>struct&nbsp;archive&nbsp;*</i>,
<i>const&nbsp;char&nbsp;*module</i>,
<i>const&nbsp;char&nbsp;*option</i>,
<i>const&nbsp;char&nbsp;*value</i>);</p>

<p style="margin-left:8%; margin-top: 1em"><i>int</i></p>


<p valign="top"><b>archive_write_set_format_option</b>(<i>struct&nbsp;archive&nbsp;*</i>,
<i>const&nbsp;char&nbsp;*module</i>,
<i>const&nbsp;char&nbsp;*option</i>,
<i>const&nbsp;char&nbsp;*value</i>);</p>

<p style="margin-left:8%; margin-top: 1em"><i>int</i></p>


<p valign="top"><b>archive_write_set_option</b>(<i>struct&nbsp;archive&nbsp;*</i>,
<i>const&nbsp;char&nbsp;*module</i>,
<i>const&nbsp;char&nbsp;*option</i>,
<i>const&nbsp;char&nbsp;*value</i>);</p>

<p style="margin-left:8%; margin-top: 1em"><i>int</i></p>


<p valign="top"><b>archive_write_set_options</b>(<i>struct&nbsp;archive&nbsp;*</i>,
<i>const&nbsp;char&nbsp;*options</i>);</p>


<p style="margin-top: 1em" valign="top"><b>DESCRIPTION</b></p>

<p style="margin-left:8%;">These functions provide a way
for libarchive clients to configure specific write
modules.</p>


<p style="margin-top: 1em" valign="top"><b>archive_write_set_filter_option</b>(),
<b>archive_write_set_format_option</b>()</p>

<p style="margin-left:20%;">Specifies an option that will
be passed to currently-registered filters (including
decompression filters) or format readers.</p>

<p style="margin-left:20%; margin-top: 1em">If
<i>option</i> and <i>value</i> are both NULL, these
functions will do nothing and <b>ARCHIVE_OK</b> will be
returned. If <i>option</i> is NULL but <i>value</i> is not,
these functions will do nothing and <b>ARCHIVE_FAILED</b>
will be returned.</p>

<p style="margin-left:20%; margin-top: 1em">If
<i>module</i> is not NULL, <i>option</i> and <i>value</i>
will be provided to the filter or reader named
<i>module</i>. The return value will be that of the module.
If there is no such module, <b>ARCHIVE_FAILED</b> will be
returned.</p>

<p style="margin-left:20%; margin-top: 1em">If
<i>module</i> is NULL, <i>option</i> and <i>value</i> will
be provided to every registered module. If any module
returns <b>ARCHIVE_FATAL</b>, this value will be returned
immediately. Otherwise, <b>ARCHIVE_OK</b> will be returned
if any module accepts the option, and <b>ARCHIVE_FAILED</b>
in all other cases.</p>


<p style="margin-top: 1em" valign="top"><b>archive_write_set_option</b>()</p>

<p style="margin-left:20%;">Calls
<b>archive_write_set_format_option</b>(), then
<b>archive_write_set_filter_option</b>(). If either function
returns <b>ARCHIVE_FATAL</b>, <b>ARCHIVE_FATAL</b> will be
returned immediately. Otherwise, greater of the two values
will be returned.</p>


<p style="margin-top: 1em" valign="top"><b>archive_write_set_options</b>()</p>

<p style="margin-left:20%;"><i>options</i> is a
comma-separated list of options. If <i>options</i> is NULL
or empty, <b>ARCHIVE_OK</b> will be returned
immediately.</p>

<p style="margin-left:20%; margin-top: 1em">Individual
options have one of the following forms:</p>

<p valign="top"><i>option=value</i></p>

<p style="margin-left:32%;">The option/value pair will be
provided to every module. Modules that do not accept an
option with this name will ignore it.</p>

<p valign="top"><i>option</i></p>

<p style="margin-left:32%; margin-top: 1em">The option will
be provided to every module with a value of
&lsquo;&lsquo;1&rsquo;&rsquo;.</p>

<p valign="top"><i>!option</i></p>

<p style="margin-left:32%;">The option will be provided to
every module with a NULL value.</p>

<p valign="top"><i>module:option=value</i>,
<i>module:option</i>, <i>module:!option</i></p>

<p style="margin-left:32%;">As above, but the corresponding
option and value will be provided only to modules whose name
matches <i>module</i>.</p>

<p style="margin-top: 1em" valign="top"><b>OPTIONS</b> <br>
Filter gzip <b><br>
compression-level</b></p>

<p style="margin-left:32%;">The value is interpreted as a
decimal integer specifying the gzip compression level.</p>

<p valign="top">Filter xz <b><br>
compression-level</b></p>

<p style="margin-left:32%;">The value is interpreted as a
decimal integer specifying the compression level.</p>

<p valign="top">Format mtree <b><br>
cksum</b>, <b>device</b>, <b>flags</b>, <b>gid</b>,
<b>gname</b>, <b>indent</b>, <b>link</b>, <b>md5</b>,
<b>mode</b>, <b>nlink</b>, <b>rmd160</b>, <b>sha1</b>,
<b>sha256</b>, <b>sha384</b>, <b>sha512</b>, <b>size</b>,
<b>time</b>, <b>uid</b>, <b>uname</b></p>

<p style="margin-left:32%;">Enable a particular keyword in
the mtree output. Prefix with an exclamation mark to disable
the corresponding keyword. The default is equivalent to
&lsquo;&lsquo;device, flags, gid, gname, link, mode, nlink,
size, time, type, uid, uname&rsquo;&rsquo;.</p>

<p valign="top"><b>all</b></p>

<p style="margin-left:32%; margin-top: 1em">Enables all of
the above keywords.</p>

<p valign="top"><b>use-set</b></p>

<p style="margin-left:32%;">Enables generation of
<b>/set</b> lines that specify default values for the
following files and/or directories.</p>

<p valign="top"><b>indent</b></p>

<p style="margin-left:32%; margin-top: 1em">XXX needs
explanation XXX</p>

<p valign="top">Format iso9660 - volume metadata</p>

<p style="margin-left:20%;">These options are used to set
standard ISO9660 metadata.</p>

<p valign="top"><b>abstract-file</b>=<i>filename</i></p>

<p style="margin-left:32%;">The file with the specified
name will be identified in the ISO9660 metadata as holding
the abstract for this volume. Default: none.</p>

<p valign="top"><b>application-id</b>=<i>filename</i></p>

<p style="margin-left:32%;">The file with the specified
name will be identified in the ISO9660 metadata as holding
the application identifier for this volume. Default:
none.</p>

<p valign="top"><b>biblio-file</b>=<i>filename</i></p>

<p style="margin-left:32%;">The file with the specified
name will be identified in the ISO9660 metadata as holding
the bibliography for this volume. Default: none.</p>

<p valign="top"><b>copyright-file</b>=<i>filename</i></p>

<p style="margin-left:32%;">The file with the specified
name will be identified in the ISO9660 metadata as holding
the copyright for this volume. Default: none.</p>

<p valign="top"><b>publisher</b>=<i>filename</i></p>

<p style="margin-left:32%;">The file with the specified
name will be identified in the ISO9660 metadata as holding
the publisher information for this volume. Default:
none.</p>

<p valign="top"><b>volume-id</b>=<i>string</i></p>

<p style="margin-left:32%;">The specified string will be
used as the Volume Identifier in the ISO9660 metadata. It is
limited to 32 bytes. Default: none.</p>

<p valign="top">Format iso9660 - boot support</p>

<p style="margin-left:20%;">These options are used to make
an ISO9660 image that can be directly booted on various
systems.</p>

<p valign="top"><b>boot</b>=<i>filename</i></p>

<p style="margin-left:32%;">The file matching this name
will be used as the El Torito boot image file.</p>

<p valign="top"><b>boot-catalog</b>=<i>name</i></p>

<p style="margin-left:32%;">The name that will be used for
the El Torito boot catalog. Default: <i>boot.catalog</i></p>

<p valign="top"><b>boot-info-table</b></p>

<p style="margin-left:32%;">The boot image file provided by
the <b>boot</b>=<i>filename</i> option will be edited with
appropriate boot information in bytes 8 through 64. Default:
disabled</p>


<p valign="top"><b>boot-load-seg</b>=<i>hexadecimal-number</i></p>

<p style="margin-left:32%;">The load segment for a
no-emulation boot image.</p>


<p valign="top"><b>boot-load-size</b>=<i>decimal-number</i></p>

<p style="margin-left:32%;">The number of
&quot;virtual&quot; 512-byte sectors to be loaded from a
no-emulation boot image. Some very old BIOSes can only load
very small images, setting this value to 4 will often allow
such BIOSes to load the first part of the boot image (which
will then need to be intelligent enough to load the rest of
itself). This should not be needed unless you are trying to
support systems with very old BIOSes. This defaults to the
full size of the image.</p>

<p valign="top"><b>boot-type</b>=<i>value</i></p>

<p style="margin-left:32%;">Specifies the boot semantics
used by the El Torito boot image: If the <i>value</i> is
<b>fd</b>, then the boot image is assumed to be a bootable
floppy image. If the <i>value</i> is <b>hd</b>, then the the
boot image is assumed to be a bootable hard disk image. If
the <i>value</i> is <b>no-emulation</b>, the boot image is
used without floppy or hard disk emulation. If the boot
image is exactly 1.2MB, 1.44MB, or 2.88MB, then the default
is <b>fd</b>, otherwise the default is
<b>no-emulation.</b></p>

<p valign="top">Format iso9660 - filename and size
extensions</p>

<p style="margin-left:20%;">Various extensions to the base
ISO9660 format.</p>

<p valign="top"><b>allow-ldots</b></p>

<p style="margin-left:32%;">If enabled, allows filenames to
begin with a leading period. If disabled, filenames that
begin with a leading period will have that period replaced
by an underscore character in the standard ISO9660
namespace. This does not impact names stored in the
Rockridge or Joliet extension area. Default: disabled.</p>

<p valign="top"><b>allow-lowercase</b></p>

<p style="margin-left:32%;">If enabled, allows filenames to
contain lowercase characters. If disabled, filenames will be
forced to uppercase. This does not impact names stored in
the Rockridge or Joliet extension area. Default:
disabled.</p>

<p valign="top"><b>allow-multidot</b></p>

<p style="margin-left:32%;">If enabled, allows filenames to
contain multiple period characters, in violation of the
ISO9660 specification. If disabled, additional periods will
be converted to underscore characters. This does not impact
names stored in the Rockridge or Joliet extension area.
Default: disabled.</p>

<p valign="top"><b>allow-period</b></p>

<p style="margin-left:32%;">If enabled, allows filenames to
contain trailing period characters, in violation of the
ISO9660 specification. If disabled,trailing periods will be
converted to underscore characters. This does not impact
names stored in the Rockridge or Joliet extension area.
Default: disabled.</p>

<p valign="top"><b>allow-pvd-lowercase</b></p>

<p style="margin-left:32%;">If enabled, the Primary Volume
Descriptor may contain lowercase ASCII characters, in
violation of the ISO9660 specification. If disabled,
characters will be converted to uppercase ASCII. Default:
disabled.</p>

<p valign="top"><b>allow-sharp-tilde</b></p>

<p style="margin-left:32%;">If enabled, sharp and tilde
characters will be permitted in filenames, in violation if
the ISO9660 specification. If disabled, such characters will
be converted to underscore characters. Default:
disabled.</p>

<p valign="top"><b>allow-vernum</b></p>

<p style="margin-left:32%;">If enabled, version numbers
will be included with files. If disabled, version numbers
will be suppressed, in violation of the ISO9660 standard.
This does not impact names stored in the Rockridge or Joliet
extension area. Default: enabled.</p>

<p valign="top"><b>iso-level</b></p>

<p style="margin-left:32%;">This enables support for file
size and file name extensions in the core ISO9660 area. The
name extensions specified here do not affect the names
stored in the Rockridge or Joliet extension areas.</p>

<p valign="top"><b>iso-level=1</b></p>

<p style="margin-left:45%;">The most compliant form of
ISO9660 image. Filenames are limited to 8.3 uppercase
format, directory names are limited to 8 uppercase
characters, files are limited to 4 GiB, the complete ISO9660
image cannot exceed 4 GiB.</p>

<p valign="top"><b>iso-level=2</b></p>

<p style="margin-left:45%;">Filenames are limited to 30
uppercase characters with a 30-character extension,
directory names are limited to 30 characters, files are
limited to 4 GiB.</p>

<p valign="top"><b>iso-level=3</b></p>

<p style="margin-left:45%;">As with <b>iso-level=2</b>,
except that files may exceed 4 GiB.</p>

<p valign="top"><b>iso-level=4</b></p>

<p style="margin-left:45%;">As with <b>iso-level=3</b>,
except that filenames may be up to 193 characters and may
include arbitrary 8-bit characters.</p>

<p valign="top"><b>joliet</b></p>


<p style="margin-left:32%; margin-top: 1em">Microsoft&rsquo;s
Joliet extensions store a completely separate set of
directory information about each file. In particular, this
information includes Unicode filenames of up to 255
characters. Default: enabled.</p>

<p valign="top"><b>limit-depth</b></p>

<p style="margin-left:32%;">If enabled, libarchive will use
directory relocation records to ensure that no pathname
exceeds the ISO9660 limit of 8 directory levels. If
disabled, no relocation will occur. Default: enabled.</p>

<p valign="top"><b>limit-dirs</b></p>

<p style="margin-left:32%;">If enabled, libarchive will
cause an error if there are more than 65536 directories. If
disabled, there is no limit on the number of directories.
Default: enabled</p>

<p valign="top"><b>pad</b></p>

<p style="margin-left:32%; margin-top: 1em">If enabled, 300
kiB of zero bytes will be appended to the end of the
archive. Default: enabled</p>

<p valign="top"><b>relaxed-filenames</b></p>

<p style="margin-left:32%;">If enabled, all 7-bit ASCII
characters are permitted in filenames (except lowercase
characters unless <b>allow-lowercase</b> is also specified).
This violates ISO9660 standards. This does not impact names
stored in the Rockridge or Joliet extension area. Default:
disabled.</p>

<p valign="top"><b>rockridge</b></p>

<p style="margin-left:32%;">The Rockridge extensions store
an additional set of POSIX-style file information with each
file, including mtime, atime, ctime, permissions, and long
filenames with arbitrary 8-bit characters. These extensions
also support symbolic links and other POSIX file types.
Default: enabled.</p>

<p valign="top">Format iso9660 - zisofs support</p>

<p style="margin-left:20%;">The zisofs extensions permit
each file to be independently compressed using a
gzip-compatible compression. This can provide significant
size savings, but requires the reading system to have
support for these extensions. These extensions are disabled
by default.</p>

<p valign="top"><b>compression-level</b>=number</p>

<p style="margin-left:32%;">The compression level used by
the deflate compressor. Ranges from 0 (least effort) to 9
(most effort). Default: 6</p>

<p valign="top"><b>zisofs</b></p>

<p style="margin-left:32%; margin-top: 1em">Synonym for
<b>zisofs=direct</b>.</p>

<p valign="top"><b>zisofs=direct</b></p>

<p style="margin-left:32%;">Compress each file in the
archive. Unlike <b>zisofs=indirect</b>, this is handled
entirely within libarchive and does not require a separate
utility. For best results, libarchive tests each file and
will store the file uncompressed if the compression does not
actually save any space. In particular, files under 2k will
never be compressed. Note that boot image files are never
compressed.</p>

<p valign="top"><b>zisofs=indirect</b></p>

<p style="margin-left:32%;">Recognizes files that have
already been compressed with the <b>mkzftree</b> utility and
sets up the necessary file metadata so that readers will
correctly identify these as zisofs-compressed files.</p>

<p valign="top"><b>zisofs-exclude</b>=<i>filename</i></p>

<p style="margin-left:32%;">Specifies a filename that
should not be compressed when using <b>zisofs=direct</b>.
This option can be provided multiple times to suppress
compression on many files.</p>


<p style="margin-top: 1em" valign="top"><b>EXAMPLES</b></p>

<p style="margin-left:8%;">The following example creates an
archive write handle to create a gzip-compressed ISO9660
format image. The two options here specify that the ISO9660
archive will use <i>kernel.img</i> as the boot image for El
Torito booting, and that the gzip compressor should use the
maximum compression level.</p>

<p style="margin-left:17%; margin-top: 1em">a =
archive_write_new(); <br>
archive_write_add_filter_gzip(a); <br>
archive_write_set_format_iso9660(a); <br>
archive_write_set_options(a,
&quot;boot=kernel.img,compression=9&quot;); <br>
archive_write_open_filename(a, filename, blocksize);</p>

<p style="margin-top: 1em" valign="top"><b>ERRORS</b></p>

<p style="margin-left:8%;">Detailed error codes and textual
descriptions are available from the <b>archive_errno</b>()
and <b>archive_error_string</b>() functions.</p>

<p style="margin-top: 1em" valign="top"><b>SEE ALSO</b></p>

<p style="margin-left:8%;">tar(1), libarchive(3),
archive_read_set_options(3), archive_write(3)</p>

<p style="margin-top: 1em" valign="top"><b>HISTORY</b></p>

<p style="margin-left:8%;">The <b>libarchive</b> library
first appeared in FreeBSD&nbsp;5.3.</p>

<p style="margin-top: 1em" valign="top"><b>AUTHORS</b></p>

<p style="margin-left:8%;">The options support for
libarchive was originally implemented by Michihiro
NAKAJIMA.</p>

<p style="margin-top: 1em" valign="top"><b>BUGS</b></p>

<p style="margin-left:8%;">BSD February&nbsp;2, 2012
BSD</p>
<hr>
</body>
</html>