1XAR(1) User Commands XAR(1)
2
6 xar - eXtensible ARchiver
7
9 xar -[ctx][v] ...
10
12 The XAR project aims to provide an easily extensible archive format.
13 Important design decisions include an easily extensible XML table of
14 contents (TOC) for random access to archived files, storing the TOC at
15 the beginning of the archive to allow for efficient handling of
16 streamed archives, the ability to handle files of arbitrarily large
17 sizes, the ability to choose independent encodings for individual files
18 in the archive, the ability to store checksums for individual files in
19 both compressed and uncompressed form, and the ability to query the ta‐
20 ble of content's rich meta-data.
21
23 One of the following options must be used:
24 -c Creates an archive
26 -t Lists the contents of an archive
28 -x Extracts an archive
30 NOTE: all of the above require the use of the -f option (filename) as
32 this release of xar doesn't correctly handle pipes or sockets.
33 -f The filename to use for creation, listing or extraction. With
35 extraction, this can be a POSIX regular expression.
36
38 --compression
39 Specifies the compression type to use. Valid values: none,
40 gzip, bzip2. Default value: gzip
41 --dump-toc=<filename>
43 Has xar dump the xml header into the specified file. "-" can be
44 specified to mean stdout.
45 --dump-header
47 Has xar print out the xar binary header information to stdout.
48 --list-subdocs
50 List the subdocuments in the xml header
51 --toc-cksum
53 Specifies the hashing algorithm to use for xml header verifica‐
54 tion. Valid values: none, sha1, and md5. Default value: sha1
55 -l On archival, stay on the local device.
57 -P On extract, set ownership based on uid/gid.
59 -p On extract, set ownership based on symbolic names, if possible.
61 -s <filename>
63 On extract, specifies the file to extract subdocuments to. On
64 archival, specifies an xml file to add as a subdocument.
65 -v Verbose output
67 --exclude
69 Specifies a POSIX regular expression of files to exclude from
70 adding to the archive during creation or from being extracted
71 during extraction. This option can be specified multiple times.
72 --rsize
74 Specifies a size (in bytes) for the internal libxar read buffer
75 while performing I/O.
76 --coalesce-heap
78 When multiple files in the archive are identical, only store one
79 copy of the data in the heap. This creates smaller archives,
80 but the archives created are not streamable.
81 --link-same
83 When the data section of multiple files are identical, hardlink
84 them within the archive.
85 --no-compress
87 Specifies a POSIX regular expression of files to archive, but
88 not compress. The archived files will be copied raw into the
89 archive. This can be used to exclude already gzipped files from
90 being gzipped during the archival process.
91
93 xar -cf sample.xar /home/uid
94 Create a xar archive of all files in /home/uid
95 xar -tf sample.xar
97 List the contents of the xar archive sample.xar
98 xar -xf sample.xar
100 Extract the contents of sample.xar to the current working direc‐
101 tory
102
104 Doesn't currently work with pipes or streams. Might be fixed in a
105 future release.
106 Probably one or two more somewhere in there. If you find one please
108 report it to http://code.google.com/p/xar/
109
111 Rob Braun <bbraun AT synack DOT net>
112 Landon Fuller <landonf AT bikemonkey DOT org>
113 David Leimbach
114 Kevin Van Vechten
115version 1.4 August 22, 2005 XAR(1)