contrib/libarchive/libarchive/archive_write_format.3

   1 .\" Copyright (c) 2003-2011 Tim Kientzle
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   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.
  12 .\"
  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
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd March 23, 2011
  28 .Dt ARCHIVE_WRITE_FORMAT 3
  29 .Os
  30 .Sh NAME
  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
  38 .Sh SYNOPSIS
  39 .In archive.h
  40 .Ft int
  41 .Fn archive_write_set_format_cpio "struct archive *"
  42 .Ft int
  43 .Fn archive_write_set_format_pax "struct archive *"
  44 .Ft int
  45 .Fn archive_write_set_format_pax_restricted "struct archive *"
  46 .Ft int
  47 .Fn archive_write_set_format_shar "struct archive *"
  48 .Ft int
  49 .Fn archive_write_set_format_shar_dump "struct archive *"
  50 .Ft int
  51 .Fn archive_write_set_format_ustar "struct archive *"
  52 .Sh DESCRIPTION
  53 These functions set the format that will be used for the archive.
  54 .Pp
  55 The library can write
  56 POSIX octet-oriented cpio format archives,
  57 POSIX-standard
  58 .Dq pax interchange
  59 format archives,
  60 traditional
  61 .Dq shar
  62 archives,
  63 enhanced
  64 .Dq dump
  65 shar archives that store a variety of file attributes and handle binary files,
  66 and
  67 POSIX-standard
  68 .Dq ustar
  69 archives.
  70 The pax interchange format is a backwards-compatible tar format that
  71 adds key/value attributes to each entry and supports arbitrary
  72 filenames, linknames, uids, sizes, etc.
  73 .Dq Restricted pax interchange format
  74 is the library default; this is the same as pax format, but suppresses
  75 the pax extended header for most normal files.
  76 In most cases, this will result in ordinary ustar archives.
  77 .\"
  78 .Sh RETURN VALUES
  79 These functions return
  80 .Cm ARCHIVE_OK
  81 on success, or
  82 .Cm ARCHIVE_FATAL .
  83 .\"
  84 .Sh ERRORS
  85 Detailed error codes and textual descriptions are available from the
  86 .Fn archive_errno
  87 and
  88 .Fn archive_error_string
  89 functions.
  90 .\"
  91 .Sh SEE ALSO
  92 .Xr tar 1 ,
  93 .Xr libarchive 3 ,
  94 .Xr archive_write 3 ,
  95 .Xr archive_write_set_options 3 ,
  96 .Xr cpio 5 ,
  97 .Xr mtree 5 ,
  98 .Xr tar 5