Import libarchive 2.0.28.
[dragonfly.git] / contrib / libarchive-2.0 / 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 .\"
24 .\"
25 .\" $FreeBSD: src/lib/libarchive/libarchive-formats.5,v 1.14 2007/04/05 05:07:53 kientzle Exp $
26 .\"
27 .Dd April 27, 2004
28 .Dt libarchive-formats 3
29 .Os
30 .Sh NAME
31 .Nm libarchive-formats
32 .Nd archive formats supported by the libarchive library
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 Cm pax
78 The
79 .Xr libarchive 3
80 library can read and write POSIX-compliant pax interchange format
81 archives.
82 Pax interchange format archives are an extension of the older ustar
83 format that adds a separate entry with additional attributes stored
84 as key/value pairs.
85 The presence of this additional entry is the only difference between
86 pax interchange format and the older ustar format.
87 The extended attributes are of unlimited length and are stored
88 as UTF-8 Unicode strings.
89 Keywords defined in the standard are in all lowercase; vendors are allowed
90 to define custom keys by preceding them with the vendor name in all uppercase.
91 When writing pax archives, libarchive uses many of the SCHILY keys
92 defined by Joerg Schilling's
93 .Dq star
94 archiver.
95 The libarchive library can read most of the SCHILY keys.
96 It ignores any keywords that it does not understand.
97 .It Cm restricted pax
98 The libarchive library can also write pax archives in which it
99 attempts to suppress the extended attributes entry whenever
100 possible.
101 The result will be identical to a ustar archive unless the
102 extended attributes entry is required to store a long file
103 name, long linkname, extended ACL, file flags, or if any of the standard
104 ustar data (user name, group name, UID, GID, etc) cannot be fully
105 represented in the ustar header.
106 In all cases, the result can be dearchived by any program that
107 can read POSIX-compliant pax interchange format archives.
108 Programs that correctly read ustar format (see below) will also be
109 able to read this format; any extended attributes will be extracted as
110 separate files stored in
111 .Pa PaxHeader
112 directories.
113 .It Cm ustar
114 The libarchive library can both read and write this format.
115 This format has the following limitations:
116 .Bl -bullet -compact
117 .It
118 Device major and minor numbers are limited to 21 bits.
119 Nodes with larger numbers will not be added to the archive.
120 .It
121 Path names in the archive are limited to 255 bytes.
122 (Shorter if there is no / character in exactly the right place.)
123 .It
124 Symbolic links and hard links are stored in the archive with
125 the name of the referenced file.
126 This name is limited to 100 bytes.
127 .It
128 Extended attributes, file flags, and other extended
129 security information cannot be stored.
130 .It
131 Archive entries are limited to 2 gigabytes in size.
132 .El
133 Note that the pax interchange format has none of these restrictions.
134 .El
135 .Pp
136 The libarchive library can also read a variety of commonly-used extensions to
137 the basic tar format.
138 In particular, it supports base-256 values in certain numeric fields.
139 This essentially removes the limitations on file size, modification time,
140 and device numbers.
141 .Pp
142 The first tar program appeared in Sixth Edition Unix (circa 1976).
143 This makes the tar format one of the oldest and most widely-supported
144 archive formats.
145 The first official standard for the tar file format was the
146 .Dq ustar
147 (Unix Standard Tar) format defined by POSIX in 1988.
148 POSIX.1-2001 extended the ustar format to create the
149 .Dq pax interchange
150 format.
151 There have also been many custom variations.
152 .Ss Cpio Formats
153 The libarchive library can read a number of common cpio variants and can write
154 .Dq odc
155 format archives.
156 A cpio archive stores each entry as a fixed-size header followed
157 by a variable-length filename and variable-length data.
158 Unlike tar, cpio does only minimal padding of the header or file data.
159 There are a variety of cpio formats, which differ primarily in
160 how they store the initial header: some store the values as
161 octal or hexadecimal numbers in ASCII, others as binary values of
162 varying byte order and length.
163 .Bl -tag -width indent
164 .It Cm binary
165 The libarchive library can read both big-endian and little-endian
166 variants of the original binary cpio format.
167 This format used 32-bit binary values for file size and mtime,
168 and 16-bit binary values for the other fields.
169 .It Cm odc
170 The libarchive library can both read and write this
171 POSIX-standard format.
172 This format stores the header contents as octal values in ASCII.
173 It is standard, portable, and immune from byte-order confusion.
174 File sizes and mtime are limited to 33 bits (8GB file size),
175 other fields are limited to 18 bits.
176 .It Cm SVR4
177 The libarchive library can read both CRC and non-CRC variants of
178 this format.
179 The SVR4 format uses eight-digit hexadecimal values for
180 all header fields.
181 This limits file size to 4GB, and also limits the mtime and
182 other fields to 32 bits.
183 The SVR4 format can optionally include a CRC of the file
184 contents, although libarchive does not currently verify this CRC.
185 .El
186 .Pp
187 Cpio is an old format that was widely used because of its simplicity
188 and its support for very long filenames.
189 Unfortunately, it has many limitations that make it unsuitable
190 for widespread use.
191 Only the POSIX format permits files over 4GB, and its 18-bit
192 limit for most other fields makes it unsuitable for modern systems.
193 In addition, cpio formats only store numeric UID/GID values (not
194 usernames and group names), which can make it very difficult to correctly
195 transfer archives across systems.
196 .Ss Shar Formats
197 A
198 .Dq shell archive
199 is a shell script that, when executed on a POSIX-compliant
200 system, will recreate a collection of file system objects.
201 The libarchive library can write two different kinds of shar archives:
202 .Bl -tag -width indent
203 .It Cm shar
204 The traditional shar format uses a limited set of POSIX
205 commands, including
206 .Xr echo 1 ,
207 .Xr mkdir 1 ,
208 and
209 .Xr sed 1 .
210 It is suitable for portably archiving small collections of plain text files.
211 However, it is not generally well-suited for large archives
212 (many implementations of
213 .Xr sh 1
214 have limits on the size of a script) nor should it be used with non-text files.
215 .It Cm shardump
216 This format is similar to shar but encodes files using
217 .Xr uuencode 1
218 so that the result will be a plain text file regardless of the file contents.
219 It also includes additional shell commands that attempt to reproduce as
220 many file attributes as possible, including owner, mode, and flags.
221 The additional commands used to restore file attributes make
222 shardump archives less portable than plain shar archives.
223 .El
224 .Ss ISO9660 format
225 Libarchive can read and extract from files containing ISO9660-compliant
226 CDROM images.
227 It also has partial support for Rockridge extensions.
228 In many cases, this can remove the need to burn a physical CDROM.
229 It also avoids security and complexity issues that come with
230 virtual mounts and loopback devices.
231 .Ss Zip format
232 Libarchive can extract from most zip format archives.
233 It currently only supports uncompressed entries and entries
234 compressed with the
235 .Dq deflate
236 algorithm.
237 Older zip compression algorithms are not supported.
238 .Ss Archive (library) file format
239 The Unix archive format (commonly created by the
240 .Xr ar 1
241 archiver) is a general-purpose format which is
242 used almost exclusively for object files to be
243 read by the link editor
244 .Xr ld 1 .
245 The ar format has never been standardised.
246 There are two common variants:
247 the GNU format derived from SVR4,
248 and the BSD format, which first appeared in 4.4BSD.
249 Libarchive provides read and write support for both variants.
250 .Sh SEE ALSO
251 .Xr ar 1 ,
252 .Xr cpio 1 ,
253 .Xr mkisofs 1 ,
254 .Xr shar 1 ,
255 .Xr tar 1 ,
256 .Xr zip 1 ,
257 .Xr zlib 3 ,
258 .Xr tar 5