README.md (1839de1a4b91ea96b2dc5a5503af0a76b62da80f) README.md (a7bc28227ee728b642fb81fe04699e021ee1f031)
1# Welcome to libarchive!
2
3The libarchive project develops a portable, efficient C library that
4can read and write streaming archives in a variety of formats. It
5also includes implementations of the common `tar`, `cpio`, and `zcat`
6command-line tools that use the libarchive library.
7
8## Questions? Issues?

--- 85 unchanged lines hidden (view full) ---

94 * uuencoded files
95 * files with RPM wrapper
96 * gzip compression
97 * bzip2 compression
98 * compress/LZW compression
99 * lzma, lzip, and xz compression
100 * lz4 compression
101 * lzop compression
1# Welcome to libarchive!
2
3The libarchive project develops a portable, efficient C library that
4can read and write streaming archives in a variety of formats. It
5also includes implementations of the common `tar`, `cpio`, and `zcat`
6command-line tools that use the libarchive library.
7
8## Questions? Issues?

--- 85 unchanged lines hidden (view full) ---

94 * uuencoded files
95 * files with RPM wrapper
96 * gzip compression
97 * bzip2 compression
98 * compress/LZW compression
99 * lzma, lzip, and xz compression
100 * lz4 compression
101 * lzop compression
102 * zstandard compression
102
103The library can create archives in any of the following formats:
104 * POSIX ustar
105 * POSIX pax interchange format
106 * "restricted" pax format, which will create ustar archives except for
107 entries that require pax extensions (for long filenames, ACLs, etc).
108 * Old GNU tar format
109 * Old V7 tar format

--- 10 unchanged lines hidden (view full) ---

120When creating archives, the result can be filtered with any of the following:
121 * uuencode
122 * gzip compression
123 * bzip2 compression
124 * compress/LZW compression
125 * lzma, lzip, and xz compression
126 * lz4 compression
127 * lzop compression
103
104The library can create archives in any of the following formats:
105 * POSIX ustar
106 * POSIX pax interchange format
107 * "restricted" pax format, which will create ustar archives except for
108 entries that require pax extensions (for long filenames, ACLs, etc).
109 * Old GNU tar format
110 * Old V7 tar format

--- 10 unchanged lines hidden (view full) ---

121When creating archives, the result can be filtered with any of the following:
122 * uuencode
123 * gzip compression
124 * bzip2 compression
125 * compress/LZW compression
126 * lzma, lzip, and xz compression
127 * lz4 compression
128 * lzop compression
129 * zstandard compression
128
129## Notes about the Library Design
130
131The following notes address many of the most common
132questions we are asked about libarchive:
133
134* This is a heavily stream-oriented system. That means that
135 it is optimized to read or write the archive in a single

--- 18 unchanged lines hidden (view full) ---

154* The library is designed to be extended with new compression and
155 archive formats. The only requirement is that the format be
156 readable or writable as a stream and that each archive entry be
157 independent. There are articles on the libarchive Wiki explaining
158 how to extend libarchive.
159
160* On read, compression and format are always detected automatically.
161
130
131## Notes about the Library Design
132
133The following notes address many of the most common
134questions we are asked about libarchive:
135
136* This is a heavily stream-oriented system. That means that
137 it is optimized to read or write the archive in a single

--- 18 unchanged lines hidden (view full) ---

156* The library is designed to be extended with new compression and
157 archive formats. The only requirement is that the format be
158 readable or writable as a stream and that each archive entry be
159 independent. There are articles on the libarchive Wiki explaining
160 how to extend libarchive.
161
162* On read, compression and format are always detected automatically.
163
162* The same API is used for all formats; in particular, it's very
164* The same API is used for all formats; it should be very
163 easy for software using libarchive to transparently handle
164 any of libarchive's archiving formats.
165
166* Libarchive's automatic support for decompression can be used
167 without archiving by explicitly selecting the "raw" and "empty"
168 formats.
169
170* I've attempted to minimize static link pollution. If you don't

--- 52 unchanged lines hidden ---
165 easy for software using libarchive to transparently handle
166 any of libarchive's archiving formats.
167
168* Libarchive's automatic support for decompression can be used
169 without archiving by explicitly selecting the "raw" and "empty"
170 formats.
171
172* I've attempted to minimize static link pollution. If you don't

--- 52 unchanged lines hidden ---