1ARCHIVE_WRITE_FORMAT(3)  BSD Library Functions Manual  ARCHIVE_WRITE_FORMAT(3)
2

NAME

4     archive_write_set_format_cpio, archive_write_set_format_pax,
5     archive_write_set_format_pax_restricted, archive_write_set_format_shar,
6     archive_write_set_format_shar_dump, archive_write_set_format_ustar —
7     functions for creating archives
8

LIBRARY

10     Streaming Archive Library (libarchive, -larchive)
11

SYNOPSIS

13     #include <archive.h>
14
15     int
16     archive_write_set_format_cpio(struct archive *);
17
18     int
19     archive_write_set_format_pax(struct archive *);
20
21     int
22     archive_write_set_format_pax_restricted(struct archive *);
23
24     int
25     archive_write_set_format_shar(struct archive *);
26
27     int
28     archive_write_set_format_shar_dump(struct archive *);
29
30     int
31     archive_write_set_format_ustar(struct archive *);
32

DESCRIPTION

34     These functions set the format that will be used for the archive.
35
36     The library can write POSIX octet-oriented cpio format archives, POSIX-
37     standard “pax interchange” format archives, traditional “shar” archives,
38     enhanced “dump” shar archives that store a variety of file attributes and
39     handle binary files, and POSIX-standard “ustar” archives.  The pax inter‐
40     change format is a backwards-compatible tar format that adds key/value
41     attributes to each entry and supports arbitrary filenames, linknames,
42     uids, sizes, etc.  “Restricted pax interchange format” is the library
43     default; this is the same as pax format, but suppresses the pax extended
44     header for most normal files.  In most cases, this will result in ordi‐
45     nary ustar archives.
46

RETURN VALUES

48     These functions return ARCHIVE_OK on success, or ARCHIVE_FATAL.
49

ERRORS

51     Detailed error codes and textual descriptions are available from the
52     archive_errno() and archive_error_string() functions.
53

SEE ALSO

55     tar(1), libarchive(3), archive_write(3), archive_write_set_options(3),
56     cpio(5), mtree(5), tar(5)
57
58BSD                            February 2, 2012                            BSD
Impressum