| 5 |
|
libarchive development, including documentation, and |
| 6 |
|
links to the libarchive mailing lists. |
| 7 |
|
* To report an issue, use the issue tracker at |
| 8 |
< |
http://code.google.com/p/libarchive/issues/list |
| 8 |
> |
https://github.com/libarchive/libarchive/issues |
| 9 |
|
* To submit an enhancement to libarchive, please submit |
| 10 |
|
a pull request via GitHub. |
| 11 |
|
https://github.com/libarchive/libarchive/pulls |
| 13 |
|
This distribution bundle includes the following components: |
| 14 |
|
* libarchive: a library for reading and writing streaming archives |
| 15 |
|
* tar: the 'bsdtar' program is a full-featured 'tar' |
| 16 |
< |
replacement built on libarchive |
| 16 |
> |
implementation built on libarchive |
| 17 |
|
* cpio: the 'bsdcpio' program is a different interface to |
| 18 |
|
essentially the same functionality |
| 19 |
+ |
* cat: the 'bsdcat' program is a simple replacement tool for |
| 20 |
+ |
zcat, bzcat, xzcat, and such |
| 21 |
|
* examples: Some small example programs that you may find useful. |
| 22 |
|
* examples/minitar: a compact sample demonstrating use of libarchive. |
| 23 |
|
* contrib: Various items sent to me by third parties; |
| 41 |
|
Guide to Documentation installed by this system: |
| 42 |
|
* bsdtar.1 explains the use of the bsdtar program |
| 43 |
|
* bsdcpio.1 explains the use of the bsdcpio program |
| 44 |
+ |
* bsdcat.1 explains the use of the bsdcat program |
| 45 |
|
* libarchive.3 gives an overview of the library as a whole |
| 46 |
|
* archive_read.3, archive_write.3, archive_write_disk.3, and |
| 47 |
|
archive_read_disk.3 provide detailed calling sequences for the read |
| 87 |
|
* bzip2 compression |
| 88 |
|
* compress/LZW compression |
| 89 |
|
* lzma, lzip, and xz compression |
| 90 |
+ |
* lz4 compression |
| 91 |
+ |
* lzop compression |
| 92 |
|
|
| 93 |
|
The library can create archives in any of the following formats: |
| 94 |
|
* POSIX ustar |
| 96 |
|
* "restricted" pax format, which will create ustar archives except for |
| 97 |
|
entries that require pax extensions (for long filenames, ACLs, etc). |
| 98 |
|
* Old GNU tar format |
| 99 |
+ |
* Old V7 tar format |
| 100 |
|
* POSIX octet-oriented cpio |
| 101 |
|
* SVR4 "newc" cpio |
| 102 |
|
* shar archives |
| 113 |
|
* bzip2 compression |
| 114 |
|
* compress/LZW compression |
| 115 |
|
* lzma, lzip, and xz compression |
| 116 |
+ |
* lz4 compression |
| 117 |
+ |
* lzop compression |
| 118 |
|
|
| 119 |
|
Notes about the library architecture: |
| 120 |
|
|
| 131 |
|
|
| 132 |
|
* I've attempted to minimize static link pollution. If you don't |
| 133 |
|
explicitly invoke a particular feature (such as support for a |
| 134 |
< |
particular compression or format), it won't get pulled in. |
| 135 |
< |
In particular, if you don't explicitly enable a particular |
| 136 |
< |
compression or decompression support, you won't need to link |
| 137 |
< |
against the corresponding compression or decompression libraries. |
| 138 |
< |
This also reduces the size of statically-linked binaries in |
| 139 |
< |
environments where that matters. |
| 134 |
> |
particular compression or format), it won't get pulled in to |
| 135 |
> |
statically-linked programs. In particular, if you don't explicitly |
| 136 |
> |
enable a particular compression or decompression support, you won't |
| 137 |
> |
need to link against the corresponding compression or decompression |
| 138 |
> |
libraries. This also reduces the size of statically-linked |
| 139 |
> |
binaries in environments where that matters. |
| 140 |
|
|
| 141 |
|
* On read, the library accepts whatever blocks you hand it. |
| 142 |
|
Your read callback is free to pass the library a byte at a time |
