Imported Upstream version 3.3.1
[platform/upstream/libarchive.git] / doc / html / archive_write_format.3.html
index b0f8068..901a4e4 100644 (file)
@@ -1,5 +1,5 @@
-<!-- Creator     : groff version 1.21 -->
-<!-- CreationDate: Sat Feb  9 12:24:06 2013 -->
+<!-- Creator     : groff version 1.22.3 -->
+<!-- CreationDate: Sat Feb 25 11:22:05 2017 -->
 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
 "http://www.w3.org/TR/html4/loose.dtd">
 <html>
@@ -26,12 +26,31 @@ ARCHIVE_WRITE_FORMAT(3)</p>
 <p style="margin-top: 1em"><b>NAME</b></p>
 
 
-<p style="margin-left:6%;"><b>archive_write_set_format_cpio</b>,
+<p style="margin-left:6%;"><b>archive_write_set_format</b>,
+<b>archive_write_set_format_7zip</b>,
+<b>archive_write_set_format_ar</b>,
+<b>archive_write_set_format_ar_bsd</b>,
+<b>archive_write_set_format_ar_svr4</b>,
+<b>archive_write_set_format_by_name</b>,
+<b>archive_write_set_format_cpio</b>,
+<b>archive_write_set_format_cpio_newc</b>,
+<b>archive_write_set_format_filter_by_ext</b>,
+<b>archive_write_set_format_filter_by_ext_def</b>,
+<b>archive_write_set_format_gnutar</b>,
+<b>archive_write_set_format_iso9660</b>,
+<b>archive_write_set_format_mtree</b>,
+<b>archive_write_set_format_mtree_classic</b>,
+<b>archive_write_set_format_mtree_default</b>,
 <b>archive_write_set_format_pax</b>,
 <b>archive_write_set_format_pax_restricted</b>,
+<b>archive_write_set_format_raw</b>,
 <b>archive_write_set_format_shar</b>,
 <b>archive_write_set_format_shar_dump</b>,
-<b>archive_write_set_format_ustar</b> &mdash; functions for
+<b>archive_write_set_format_ustar</b>,
+<b>archive_write_set_format_v7tar</b>,
+<b>archive_write_set_format_warc</b>,
+<b>archive_write_set_format_xar</b>,
+<b>archive_write_set_format_zip</b>, &mdash; functions for
 creating archives</p>
 
 <p style="margin-top: 1em"><b>LIBRARY</b></p>
@@ -47,11 +66,76 @@ creating archives</p>
 <p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
 
 
+<p style="margin-left:12%;"><b>archive_write_set_format</b>(<i>struct&nbsp;archive&nbsp;*</i>,
+<i>int&nbsp;code</i>);</p>
+
+<p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
+
+
+<p style="margin-left:12%;"><b>archive_write_set_format_7zip</b>(<i>struct&nbsp;archive&nbsp;*</i>);</p>
+
+<p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
+
+
+<p style="margin-left:12%;"><b>archive_write_set_format_ar</b>(<i>struct&nbsp;archive&nbsp;*</i>);</p>
+
+<p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
+
+
+<p style="margin-left:12%;"><b>archive_write_set_format_ar_bsd</b>(<i>struct&nbsp;archive&nbsp;*</i>);</p>
+
+<p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
+
+
+<p style="margin-left:12%;"><b>archive_write_set_format_ar_svr4</b>(<i>struct&nbsp;archive&nbsp;*</i>);</p>
+
+<p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
+
+
+<p style="margin-left:12%;"><b>archive_write_set_format_by_name</b>(<i>struct&nbsp;archive&nbsp;*</i>,
+<i>const&nbsp;char&nbsp;*name</i>);</p>
+
+<p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
+
+
 <p style="margin-left:12%;"><b>archive_write_set_format_cpio</b>(<i>struct&nbsp;archive&nbsp;*</i>);</p>
 
 <p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
 
 
+<p style="margin-left:12%;"><b>archive_write_set_format_cpio_newc</b>(<i>struct&nbsp;archive&nbsp;*</i>);</p>
+
+<p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
+
+
+<p style="margin-left:12%;"><b>archive_write_set_format_filter_by_ext</b>(<i>struct&nbsp;archive&nbsp;*</i>,
+<i>const&nbsp;char&nbsp;*filename</i>);</p>
+
+<p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
+
+
+<p style="margin-left:12%;"><b>archive_write_set_format_filter_by_ext_def</b>(<i>struct&nbsp;archive&nbsp;*</i>,
+<i>const&nbsp;char&nbsp;*filename</i>,
+<i>const&nbsp;char&nbsp;*def_ext</i>);</p>
+
+<p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
+
+
+<p style="margin-left:12%;"><b>archive_write_set_format_gnutar</b>(<i>struct&nbsp;archive&nbsp;*</i>);</p>
+
+<p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
+
+
+<p style="margin-left:12%;"><b>archive_write_set_format_iso9660</b>(<i>struct&nbsp;archive&nbsp;*</i>);</p>
+
+<p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
+
+
+<p style="margin-left:12%;"><b>archive_write_set_format_mtree</b>(<i>struct&nbsp;archive&nbsp;*</i>);</p>
+
+<p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
+
+
 <p style="margin-left:12%;"><b>archive_write_set_format_pax</b>(<i>struct&nbsp;archive&nbsp;*</i>);</p>
 
 <p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
@@ -62,6 +146,11 @@ creating archives</p>
 <p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
 
 
+<p style="margin-left:12%;"><b>archive_write_set_format_raw</b>(<i>struct&nbsp;archive&nbsp;*</i>);</p>
+
+<p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
+
+
 <p style="margin-left:12%;"><b>archive_write_set_format_shar</b>(<i>struct&nbsp;archive&nbsp;*</i>);</p>
 
 <p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
@@ -74,27 +163,82 @@ creating archives</p>
 
 <p style="margin-left:12%;"><b>archive_write_set_format_ustar</b>(<i>struct&nbsp;archive&nbsp;*</i>);</p>
 
+<p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
+
+
+<p style="margin-left:12%;"><b>archive_write_set_format_v7tar</b>(<i>struct&nbsp;archive&nbsp;*</i>);</p>
+
+<p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
+
+
+<p style="margin-left:12%;"><b>archive_write_set_format_warc</b>(<i>struct&nbsp;archive&nbsp;*</i>);</p>
+
+<p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
+
+
+<p style="margin-left:12%;"><b>archive_write_set_format_xar</b>(<i>struct&nbsp;archive&nbsp;*</i>);</p>
+
+<p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
+
+
+<p style="margin-left:12%;"><b>archive_write_set_format_zip</b>(<i>struct&nbsp;archive&nbsp;*</i>);</p>
+
 <p style="margin-top: 1em"><b>DESCRIPTION</b></p>
 
 <p style="margin-left:6%;">These functions set the format
 that will be used for the archive.</p>
 
 <p style="margin-left:6%; margin-top: 1em">The library can
-write POSIX octet-oriented cpio format archives,
-POSIX-standard &rsquo;&rsquo;pax interchange&rsquo;&rsquo;
-format archives, traditional
-&rsquo;&rsquo;shar&rsquo;&rsquo; archives, enhanced
-&rsquo;&rsquo;dump&rsquo;&rsquo; shar archives that store a
-variety of file attributes and handle binary files, and
-POSIX-standard &rsquo;&rsquo;ustar&rsquo;&rsquo; archives.
-The pax interchange format is a backwards-compatible tar
-format that adds key/value attributes to each entry and
-supports arbitrary filenames, linknames, uids, sizes, etc.
-&rsquo;&rsquo;Restricted pax interchange
-format&rsquo;&rsquo; is the library default; this is the
-same as pax format, but suppresses the pax extended header
-for most normal files. In most cases, this will result in
-ordinary ustar archives.</p>
+write a variety of common archive formats.</p>
+
+
+<p style="margin-top: 1em"><b>archive_write_set_format</b>()</p>
+
+<p style="margin-left:17%;">Sets the format based on the
+format code (see <i>archive.h</i> for the full list of
+format codes). In particular, this can be used in
+conjunction with <b>archive_format</b>() to create a new
+archive with the same format as an existing archive.</p>
+
+
+<p style="margin-top: 1em"><b>archive_write_set_format_by_name</b>()</p>
+
+<p style="margin-left:17%;">Sets the corresponding format
+based on the common name.</p>
+
+
+<p style="margin-top: 1em"><b>archive_write_set_format_filter_by_ext</b>(),
+<b>archive_write_set_format_filter_by_ext_def</b>()</p>
+
+<p style="margin-left:17%;">Sets both filters and format
+based on the output filename. Supported extensions: .7z,
+.zip, .jar, .cpio, .iso, .a, .ar, .tar, .tgz, .tar.gz,
+.tar.bz2, .tar.xz</p>
+
+
+<p style="margin-top: 1em"><b>archive_write_set_format_7zip</b>()
+<b>archive_write_set_format_ar_bsd</b>(),
+<b>archive_write_set_format_ar_svr4</b>(),
+<b>archive_write_set_format_cpio</b>()
+<b>archive_write_set_format_cpio_newc</b>()
+<b>archive_write_set_format_gnutar</b>()
+<b>archive_write_set_format_iso9660</b>()
+<b>archive_write_set_format_mtree</b>()
+<b>archive_write_set_format_mtree_classic</b>()
+<b>archive_write_set_format_pax</b>()
+<b>archive_write_set_format_pax_restricted</b>()
+<b>archive_write_set_format_raw</b>()
+<b>archive_write_set_format_shar</b>()
+<b>archive_write_set_format_shar_dump</b>()
+<b>archive_write_set_format_ustar</b>()
+<b>archive_write_set_format_v7tar</b>()
+<b>archive_write_set_format_warc</b>()
+<b>archive_write_set_format_xar</b>()
+<b>archive_write_set_format_zip</b>()</p>
+
+<p style="margin-left:17%;">Set the format as specified.
+More details on the formats supported by libarchive can be
+found in the libarchive-formats(5) manual page.</p>
 
 <p style="margin-top: 1em"><b>RETURN VALUES</b></p>
 
@@ -111,10 +255,10 @@ and <b>archive_error_string</b>() functions.</p>
 
 <p style="margin-left:6%;">tar(1), libarchive(3),
 archive_write(3), archive_write_set_options(3), cpio(5),
-mtree(5), tar(5)</p>
+libarchive-formats(5), mtree(5), tar(5)</p>
 
 <p style="margin-left:6%; margin-top: 1em">BSD
-February&nbsp;2, 2012 BSD</p>
+February&nbsp;14, 2013 BSD</p>
 <hr>
 </body>
 </html>