lib/libarchive/libarchive-formats.5

   1 .\" Copyright (c) 2003-2007 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 April 17, 2009
  28 .Dt libarchive-formats 5
  29 .Os
  30 .Sh NAME
  31 .Nm libarchive-formats
  32 .Nd archive formats supported by the libarchive library
  33 .Sh DESCRIPTION
  34 The
  35 .Xr libarchive 3
  36 library reads and writes a variety of streaming archive formats.
  37 Generally speaking, all of these archive formats consist of a series of
  38 .Dq entries .
  39 Each entry stores a single file system object, such as a file, directory,
  40 or symbolic link.
  41 .Pp
  42 The following provides a brief description of each format supported
  43 by libarchive, with some information about recognized extensions or
  44 limitations of the current library support.
  45 Note that just because a format is supported by libarchive does not
  46 imply that a program that uses libarchive will support that format.
  47 Applications that use libarchive specify which formats they wish
  48 to support.
  49 .Ss Tar Formats
  50 The
  51 .Xr libarchive 3
  52 library can read most tar archives.
  53 However, it only writes POSIX-standard
  54 .Dq ustar
  55 and
  56 .Dq pax interchange
  57 formats.
  58 .Pp
  59 All tar formats store each entry in one or more 512-byte records.
  60 The first record is used for file metadata, including filename,
  61 timestamp, and mode information, and the file data is stored in
  62 subsequent records.
  63 Later variants have extended this by either appropriating undefined
  64 areas of the header record, extending the header to multiple records,
  65 or by storing special entries that modify the interpretation of
  66 subsequent entries.
  67 .Pp
  68 .Bl -tag -width indent
  69 .It Cm gnutar
  70 The
  71 .Xr libarchive 3
  72 library can read GNU-format tar archives.
  73 It currently supports the most popular GNU extensions, including
  74 modern long filename and linkname support, as well as atime and ctime data.
  75 The libarchive library does not support multi-volume
  76 archives, nor the old GNU long filename format.
  77 It can read GNU sparse file entries, including the new POSIX-based
  78 formats, but cannot write GNU sparse file entries.
  79 .It Cm pax
  80 The
  81 .Xr libarchive 3
  82 library can read and write POSIX-compliant pax interchange format
  83 archives.
  84 Pax interchange format archives are an extension of the older ustar
  85 format that adds a separate entry with additional attributes stored
  86 as key/value pairs.
  87 The presence of this additional entry is the only difference between
  88 pax interchange format and the older ustar format.
  89 The extended attributes are of unlimited length and are stored
  90 as UTF-8 Unicode strings.
  91 Keywords defined in the standard are in all lowercase; vendors are allowed
  92 to define custom keys by preceding them with the vendor name in all uppercase.
  93 When writing pax archives, libarchive uses many of the SCHILY keys
  94 defined by Joerg Schilling's
  95 .Dq star
  96 archiver and a few LIBARCHIVE keys.
  97 The libarchive library can read most of the SCHILY keys
  98 and most of the GNU keys introduced by GNU tar.
  99 It silently ignores any keywords that it does not understand.
 100 .It Cm restricted pax
 101 The libarchive library can also write pax archives in which it
 102 attempts to suppress the extended attributes entry whenever
 103 possible.
 104 The result will be identical to a ustar archive unless the
 105 extended attributes entry is required to store a long file
 106 name, long linkname, extended ACL, file flags, or if any of the standard
 107 ustar data (user name, group name, UID, GID, etc) cannot be fully
 108 represented in the ustar header.
 109 In all cases, the result can be dearchived by any program that
 110 can read POSIX-compliant pax interchange format archives.
 111 Programs that correctly read ustar format (see below) will also be
 112 able to read this format; any extended attributes will be extracted as
 113 separate files stored in
 114 .Pa PaxHeader
 115 directories.
 116 .It Cm ustar
 117 The libarchive library can both read and write this format.
 118 This format has the following limitations:
 119 .Bl -bullet -compact
 120 .It
 121 Device major and minor numbers are limited to 21 bits.
 122 Nodes with larger numbers will not be added to the archive.
 123 .It
 124 Path names in the archive are limited to 255 bytes.
 125 (Shorter if there is no / character in exactly the right place.)
 126 .It
 127 Symbolic links and hard links are stored in the archive with
 128 the name of the referenced file.
 129 This name is limited to 100 bytes.
 130 .It
 131 Extended attributes, file flags, and other extended
 132 security information cannot be stored.
 133 .It
 134 Archive entries are limited to 2 gigabytes in size.
 135 .El
 136 Note that the pax interchange format has none of these restrictions.
 137 .El
 138 .Pp
 139 The libarchive library can also read a variety of commonly-used extensions to
 140 the basic tar format.
 141 In particular, it supports base-256 values in certain numeric fields.
 142 This essentially removes the limitations on file size, modification time,
 143 and device numbers.
 144 .Pp
 145 The first tar program appeared in Seventh Edition Unix in 1979.
 146 The first official standard for the tar file format was the
 147 .Dq ustar
 148 (Unix Standard Tar) format defined by POSIX in 1988.
 149 POSIX.1-2001 extended the ustar format to create the
 150 .Dq pax interchange
 151 format.
 152 .Ss Cpio Formats
 153 The libarchive library can read a number of common cpio variants and can write
 154 .Dq odc
 155 and
 156 .Dq newc
 157 format archives.
 158 A cpio archive stores each entry as a fixed-size header followed
 159 by a variable-length filename and variable-length data.
 160 Unlike the tar format, the cpio format does only minimal padding
 161 of the header or file data.
 162 There are a variety of cpio formats, which differ primarily in
 163 how they store the initial header: some store the values as
 164 octal or hexadecimal numbers in ASCII, others as binary values of
 165 varying byte order and length.
 166 .Bl -tag -width indent
 167 .It Cm binary
 168 The libarchive library can read both big-endian and little-endian
 169 variants of the original binary cpio format.
 170 This format used 32-bit binary values for file size and mtime,
 171 and 16-bit binary values for the other fields.
 172 .It Cm odc
 173 The libarchive library can both read and write this
 174 POSIX-standard format, which is officially known as the
 175 .Dq cpio interchange format
 176 or the
 177 .Dq octet-oriented cpio archive format
 178 and sometimes unofficially referred to as the
 179 .Dq old character format .
 180 This format stores the header contents as octal values in ASCII.
 181 It is standard, portable, and immune from byte-order confusion.
 182 File sizes and mtime are limited to 33 bits (8GB file size),
 183 other fields are limited to 18 bits.
 184 .It Cm SVR4
 185 The libarchive library can read both CRC and non-CRC variants of
 186 this format.
 187 The SVR4 format uses eight-digit hexadecimal values for
 188 all header fields.
 189 This limits file size to 4GB, and also limits the mtime and
 190 other fields to 32 bits.
 191 The SVR4 format can optionally include a CRC of the file
 192 contents, although libarchive does not currently verify this CRC.
 193 .El
 194 .Pp
 195 Cpio first appeared in PWB/UNIX 1.0, which was released within
 196 AT&T in 1977.
 197 PWB/UNIX 1.0 formed the basis of System III Unix, released outside
 198 of AT&T in 1981.
 199 This makes cpio older than tar, although cpio was not included
 200 in Version 7 AT&T Unix.
 201 As a result, the tar command became much better known in universities
 202 and research groups that used Version 7.
 203 The combination of the
 204 .Nm find
 205 and
 206 .Nm cpio
 207 utilities provided very precise control over file selection.
 208 Unfortunately, the format has many limitations that make it unsuitable
 209 for widespread use.
 210 Only the POSIX format permits files over 4GB, and its 18-bit
 211 limit for most other fields makes it unsuitable for modern systems.
 212 In addition, cpio formats only store numeric UID/GID values (not
 213 usernames and group names), which can make it very difficult to correctly
 214 transfer archives across systems with dissimilar user numbering.
 215 .Ss Shar Formats
 216 A
 217 .Dq shell archive
 218 is a shell script that, when executed on a POSIX-compliant
 219 system, will recreate a collection of file system objects.
 220 The libarchive library can write two different kinds of shar archives:
 221 .Bl -tag -width indent
 222 .It Cm shar
 223 The traditional shar format uses a limited set of POSIX
 224 commands, including
 225 .Xr echo 1 ,
 226 .Xr mkdir 1 ,
 227 and
 228 .Xr sed 1 .
 229 It is suitable for portably archiving small collections of plain text files.
 230 However, it is not generally well-suited for large archives
 231 (many implementations of
 232 .Xr sh 1
 233 have limits on the size of a script) nor should it be used with non-text files.
 234 .It Cm shardump
 235 This format is similar to shar but encodes files using
 236 .Xr uuencode 1
 237 so that the result will be a plain text file regardless of the file contents.
 238 It also includes additional shell commands that attempt to reproduce as
 239 many file attributes as possible, including owner, mode, and flags.
 240 The additional commands used to restore file attributes make
 241 shardump archives less portable than plain shar archives.
 242 .El
 243 .Ss ISO9660 format
 244 Libarchive can read and extract from files containing ISO9660-compliant
 245 CDROM images.
 246 It also has partial support for Rockridge extensions.
 247 In many cases, this can remove the need to burn a physical CDROM
 248 just in order to read the files contained in an ISO9660 image.
 249 It also avoids security and complexity issues that come with
 250 virtual mounts and loopback devices.
 251 .Ss Zip format
 252 Libarchive can extract from most zip format archives, including
 253 jar archives, archives that use Zip64 extensions and many
 254 self-extracting zip archives.
 255 It currently only supports uncompressed entries and entries
 256 compressed with the
 257 .Dq deflate
 258 algorithm.
 259 Older zip compression algorithms are not supported.
 260 Libarchive reads Zip archives as they are being streamed,
 261 which allows it to read archives of arbitrary size.
 262 It currently does not use the central directory; this
 263 limits libarchive's ability to support some self-extracting
 264 archives and ones that have been modified in certain ways.
 265 .Ss Archive (library) file format
 266 The Unix archive format (commonly created by the
 267 .Xr ar 1
 268 archiver) is a general-purpose format which is
 269 used almost exclusively for object files to be
 270 read by the link editor
 271 .Xr ld 1 .
 272 The ar format has never been standardised.
 273 There are two common variants:
 274 the GNU format derived from SVR4,
 275 and the BSD format, which first appeared in 4.4BSD.
 276 Libarchive provides read and write support for both variants.
 277 .Ss mtree
 278 Libarchive can read and write files in
 279 .Xr mtree 5
 280 format.
 281 This format is not a true archive format, but rather a textual description
 282 of a file hierarchy in which each line specifies the name of a file and
 283 provides specific metadata about that file.
 284 Libarchive can read all of the keywords supported by both
 285 the NetBSD and FreeBSD versions of
 286 .Xr mtree 1 ,
 287 although many of the keywords cannot currently be stored in an
 288 .Tn archive_entry
 289 object.
 290 When reading, libarchive supports an extension that allows it
 291 to obtain the contents of the files described by the
 292 .Xr mtree 5
 293 description from files on disk.
 294 When writing, libarchive supports use of the
 295 .Xr archive_write_set_options 3
 296 interface to specify which keywords should be included in the
 297 output.
 298 This includes the ability to compute hash entries such
 299 as
 300 .Cm sha512
 301 or
 302 .Cm md5
 303 from file data being written to the mtree writer.
 304 .Sh SEE ALSO
 305 .Xr ar 1 ,
 306 .Xr cpio 1 ,
 307 .Xr mkisofs 1 ,
 308 .Xr shar 1 ,
 309 .Xr tar 1 ,
 310 .Xr zip 1 ,
 311 .Xr zlib 3 ,
 312 .Xr cpio 5 ,
 313 .Xr mtree 5 ,
 314 .Xr tar 5