1 .\" Copyright (c) 2003-2011 Tim Kientzle
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .Dt ARCHIVE_WRITE_FORMAT 3
31 .Nm archive_write_set_format_cpio ,
32 .Nm archive_write_set_format_pax ,
33 .Nm archive_write_set_format_pax_restricted ,
34 .Nm archive_write_set_format_shar ,
35 .Nm archive_write_set_format_shar_dump ,
36 .Nm archive_write_set_format_ustar
37 .Nd functions for creating archives
39 Streaming Archive Library (libarchive, -larchive)
43 .Fn archive_write_set_format_cpio "struct archive *"
45 .Fn archive_write_set_format_pax "struct archive *"
47 .Fn archive_write_set_format_pax_restricted "struct archive *"
49 .Fn archive_write_set_format_shar "struct archive *"
51 .Fn archive_write_set_format_shar_dump "struct archive *"
53 .Fn archive_write_set_format_ustar "struct archive *"
55 These functions set the format that will be used for the archive.
58 POSIX octet-oriented cpio format archives,
67 shar archives that store a variety of file attributes and handle binary files,
72 The pax interchange format is a backwards-compatible tar format that
73 adds key/value attributes to each entry and supports arbitrary
74 filenames, linknames, uids, sizes, etc.
75 .Dq Restricted pax interchange format
76 is the library default; this is the same as pax format, but suppresses
77 the pax extended header for most normal files.
78 In most cases, this will result in ordinary ustar archives.
81 These functions return
87 Detailed error codes and textual descriptions are available from the
90 .Fn archive_error_string
97 .Xr archive_write_set_options 3 ,