freebsd-dev/lib/libarchive
Tim Kientzle 04e8ac36ab Document the liblzma support.
Unfortunately, liblzma itself is GPLed, so unlikely to become part of
the FreeBSD base system.
However, the core lzma compression/decompression code is public
domain, so it should be feasible for someone to create a compatible
library without the GPL strings.
2009-04-27 22:39:43 +00:00
..
test Merge r990,r1044 from libarchive.googlecode.com: 2009-04-27 20:09:05 +00:00
archive_check_magic.c Merge from libarchive.googlecode.com: Mostly a bunch of 2009-04-12 05:33:34 +00:00
archive_endian.h Merge r272 from libarchive.googlecode.com: Fix building on MSVC6. 2009-03-03 03:28:09 +00:00
archive_entry_copy_stat.c Merge r552,r559 from libarchive.googlecode.com: Support high-resolution 2009-03-07 00:52:02 +00:00
archive_entry_link_resolver.c The link resolver now unsets the size to mark a hardlink 2008-09-05 06:15:25 +00:00
archive_entry_private.h MfP4: Support for storing birthtime in archive_entry objects. 2008-09-30 03:53:03 +00:00
archive_entry_stat.c Merge r552,r559 from libarchive.googlecode.com: Support high-resolution 2009-03-07 00:52:02 +00:00
archive_entry_strmode.c Mark hardlinks that lack any other interesting filetype information 2008-06-15 05:14:01 +00:00
archive_entry.3 MFp4: libarchive 2.5.4b. (Still 'b' until I get a bit more 2008-05-26 17:00:24 +00:00
archive_entry.c Merge r1053,r1055,r1056,r1057,r1065 from libarchive.googlecode.com: 2009-04-27 18:27:54 +00:00
archive_entry.h Merge from libarchive.googlecode.com: Mostly a bunch of 2009-04-12 05:33:34 +00:00
archive_platform.h Minor fix: some platforms require both inttypes.h and stdint.h. 2009-04-17 00:57:11 +00:00
archive_private.h Minor whitespace adjustment to reduce diffs with libarchive.googlecode.com. 2009-03-07 01:08:16 +00:00
archive_read_data_into_fd.c Check that lseek(2) succeeds and puts us where we expect. [1] 2008-05-23 05:01:29 +00:00
archive_read_disk_entry_from_file.c When pulling metadata from disk, lookup the user and group name at the same time. 2009-04-17 00:59:34 +00:00
archive_read_disk_private.h Merge r399,401,402,405,415,430,440,452,453,458,506,533,536,538,544,590 2009-03-06 04:35:31 +00:00
archive_read_disk_set_standard_lookup.c Dynamically size the buffer we pass to getgrgid_r() and getpwuid_r(). 2009-04-17 01:01:15 +00:00
archive_read_disk.3 Merge from libarchive.googlecode.com r756,r761: 2009-04-12 05:04:02 +00:00
archive_read_disk.c Merge r399,401,402,405,415,430,440,452,453,458,506,533,536,538,544,590 2009-03-06 04:35:31 +00:00
archive_read_extract.c MFp4: libarchive 2.5.4b. (Still 'b' until I get a bit more 2008-05-26 17:00:24 +00:00
archive_read_open_fd.c Merge r1052,r1055 from libarchive.googlecode.com: 2009-04-27 18:33:08 +00:00
archive_read_open_file.c Merge r1052,r1055 from libarchive.googlecode.com: 2009-04-27 18:33:08 +00:00
archive_read_open_filename.c Merge r1052,r1055 from libarchive.googlecode.com: 2009-04-27 18:33:08 +00:00
archive_read_open_memory.c New "version stamp" simplifies determining the exact version 2007-07-06 15:36:38 +00:00
archive_read_private.h Merge r988,r1064 from libarchive.googlecode.com: 2009-04-27 17:42:02 +00:00
archive_read_support_compression_all.c Implement command-line fallbacks for gzip and bzip2 decompression as well. 2009-04-17 00:55:52 +00:00
archive_read_support_compression_bzip2.c Implement command-line fallbacks for gzip and bzip2 decompression as well. 2009-04-17 00:55:52 +00:00
archive_read_support_compression_compress.c LZW bugfix: when we hit end-of-file, return an invalid code. 2009-04-17 00:58:44 +00:00
archive_read_support_compression_gzip.c Implement command-line fallbacks for gzip and bzip2 decompression as well. 2009-04-17 00:55:52 +00:00
archive_read_support_compression_none.c MfP4: Big read filter refactoring. 2008-12-06 06:45:15 +00:00
archive_read_support_compression_program.c Merge from libarchive.googlecode.com r791, r879, r884, r948: Various 2009-04-12 05:47:23 +00:00
archive_read_support_compression_xz.c Merge r1052,r1055 from libarchive.googlecode.com: 2009-04-27 18:33:08 +00:00
archive_read_support_format_all.c Update libarchive to 2.4.10. This includes a number of improvements 2007-12-30 04:58:22 +00:00
archive_read_support_format_ar.c Merge r668 from libarchive.googlecode.com: Style correction to the 2009-03-06 06:14:44 +00:00
archive_read_support_format_cpio.c Merge r1061,r1062,r1063 from libarchive.googlecode.com: 2009-04-27 19:30:09 +00:00
archive_read_support_format_empty.c Remove an unused variable. 2009-04-26 18:24:14 +00:00
archive_read_support_format_iso9660.c Exit with ARCHIVE_FATAL if the ISO image is truncated. 2009-04-26 18:43:49 +00:00
archive_read_support_format_mtree.c Reading an mtree file is supposed to provide 2009-04-26 18:57:50 +00:00
archive_read_support_format_raw.c Merge r990,r1044 from libarchive.googlecode.com: 2009-04-27 20:09:05 +00:00
archive_read_support_format_tar.c Merge r1053,r1055,r1056,r1057,r1065 from libarchive.googlecode.com: 2009-04-27 18:27:54 +00:00
archive_read_support_format_zip.c Merge r541,r542 from libarchive.googlecode.com: Two sign mismatches 2009-03-06 06:13:25 +00:00
archive_read.3 Merge r991 from libarchive.googlecode.com: Various updates 2009-04-27 20:13:13 +00:00
archive_read.c Merge r988,r1064 from libarchive.googlecode.com: 2009-04-27 17:42:02 +00:00
archive_string_sprintf.c Merge r505 from libarchive.googlecode.com: Fix %ju support. Simplify 2009-03-06 05:14:55 +00:00
archive_string.c Merge from libarchive.googlecode.com: Mostly a bunch of 2009-04-12 05:33:34 +00:00
archive_string.h Merge from libarchive.googlecode.com: 2009-04-12 04:59:11 +00:00
archive_util.3 Use .Fo/.Fc and .Xo/.Xc to bring the line widths below 79 columns. 2008-03-10 14:44:41 +00:00
archive_util.c Merge r491,493,500,507,510,530,543 from libarchive.googlecode.com: 2009-03-06 05:58:56 +00:00
archive_virtual.c Merge r390,r391,r392,r397 from libarchive.googlecode.com: Virtualize 2009-03-05 21:18:10 +00:00
archive_write_disk_private.h libarchive 2.0 2007-03-03 07:37:37 +00:00
archive_write_disk_set_standard_lookup.c Use thread-safe getgrnam_r() and getpwnam_r(); dynamically size 2009-04-17 00:44:47 +00:00
archive_write_disk.3 Markup fix. 2008-09-04 05:22:00 +00:00
archive_write_disk.c Fix a minor memory leak. 2009-04-17 00:44:03 +00:00
archive_write_open_fd.c Fix the copyright notice; it was always intended to be 2007-01-09 08:05:56 +00:00
archive_write_open_file.c Fix the copyright notice; it was always intended to be 2007-01-09 08:05:56 +00:00
archive_write_open_filename.c Merge from libarchive.googlecode.com: If we're 2009-04-17 00:39:35 +00:00
archive_write_open_memory.c Fix the copyright notice; it was always intended to be 2007-01-09 08:05:56 +00:00
archive_write_private.h Merge r491,493,500,507,510,530,543 from libarchive.googlecode.com: 2009-03-06 05:58:56 +00:00
archive_write_set_compression_bzip2.c Merge from libarchive.googlecode.com: Numerous fixes to the 2009-04-17 00:42:45 +00:00
archive_write_set_compression_compress.c Support for writing 'compress' format, thanks to Joerg Sonnenberger. 2008-03-14 20:35:38 +00:00
archive_write_set_compression_gzip.c Merge from libarchive.googlecode.com: Numerous fixes to the 2009-04-17 00:42:45 +00:00
archive_write_set_compression_none.c Update libarchive to 2.4.10. This includes a number of improvements 2007-12-30 04:58:22 +00:00
archive_write_set_compression_program.c Merge from libarchive.googlecode.com: Mostly a bunch of 2009-04-12 05:33:34 +00:00
archive_write_set_compression_xz.c Merge new xz/lzma support from libarchive.googlecode.com. 2009-04-17 00:54:35 +00:00
archive_write_set_format_ar.c Merge r491,493,500,507,510,530,543 from libarchive.googlecode.com: 2009-03-06 05:58:56 +00:00
archive_write_set_format_by_name.c Sort the list of format names. 2008-09-01 02:50:53 +00:00
archive_write_set_format_cpio_newc.c Merge r491,493,500,507,510,530,543 from libarchive.googlecode.com: 2009-03-06 05:58:56 +00:00
archive_write_set_format_cpio.c ino_t varies across platforms; casting (int) here avoids 2009-04-27 19:14:43 +00:00
archive_write_set_format_mtree.c Rely on OpenSSL bits only if we're building a system with OpenSSL. 2009-04-18 06:06:47 +00:00
archive_write_set_format_pax.c Merge r1021 from libarchive.googlecode.com: 2009-04-27 18:35:03 +00:00
archive_write_set_format_shar.c Merge r491,493,500,507,510,530,543 from libarchive.googlecode.com: 2009-03-06 05:58:56 +00:00
archive_write_set_format_ustar.c Merge r1021 from libarchive.googlecode.com: 2009-04-27 18:35:03 +00:00
archive_write_set_format.c New mtree writer, thanks to Joerg Sonnenberger. 2008-08-31 07:21:46 +00:00
archive_write.3 Merge from libarchive.googlecode.com: Numerous fixes to the 2009-04-17 00:42:45 +00:00
archive_write.c Merge from libarchive.googlecode.com: Numerous fixes to the 2009-04-17 00:42:45 +00:00
archive.h Merge r990,r1044 from libarchive.googlecode.com: 2009-04-27 20:09:05 +00:00
config_freebsd.h Rely on OpenSSL bits only if we're building a system with OpenSSL. 2009-04-18 06:06:47 +00:00
COPYING Fix the copyright notice; it was always intended to be 2007-01-09 08:05:56 +00:00
cpio.5 MFp4: libarchive 2.5.4b. (Still 'b' until I get a bit more 2008-05-26 17:00:24 +00:00
filter_fork.c Portability: Don't use symbolic constants when the values are more 2008-09-12 05:33:00 +00:00
filter_fork.h libarchive 2.2.3 2007-05-29 01:00:21 +00:00
libarchive_internals.3 Update libarchive to 2.4.10. This includes a number of improvements 2007-12-30 04:58:22 +00:00
libarchive-formats.5 Correct and update the manpage to include 2009-04-18 03:47:29 +00:00
libarchive.3 Fix the copyright notice; it was always intended to be 2007-01-09 08:05:56 +00:00
Makefile Document the liblzma support. 2009-04-27 22:39:43 +00:00
README libarchive 2.0 2007-03-03 07:37:37 +00:00
tar.5 Various improvements to the tar.5 manpage, including 2009-04-26 18:46:40 +00:00

$FreeBSD$

libarchive: a library for reading and writing streaming archives

This is all under a BSD license.  Use, enjoy, but don't blame me if it breaks!

Documentation:
 * libarchive.3 gives an overview of the library as a whole
 * archive_read.3, archive_write.3, and archive_write_disk.3 provide
   detailed calling sequences for the read and write APIs
 * archive_entry.3 details the "struct archive_entry" utility class
 * libarchive-formats.5 documents the file formats supported by the library
 * tar.5 provides some detailed information about a variety of different
   "tar" formats.

You should also read the copious comments in "archive.h" and the source
code for the sample "bsdtar" and "minitar" programs for more details.
Please let me know about any errors or omissions you find.

Currently, the library automatically detects and reads the following:
  * gzip compression
  * bzip2 compression
  * compress/LZW compression
  * GNU tar format (including GNU long filenames, long link names, and
    sparse files)
  * Solaris 9 extended tar format (including ACLs)
  * Old V7 tar archives
  * POSIX ustar
  * POSIX pax interchange format
  * POSIX octet-oriented cpio
  * SVR4 ASCII cpio
  * Binary cpio (big-endian or little-endian)
  * ISO9660 CD-ROM images (with optional Rockridge extensions)
  * ZIP archives (with uncompressed or "deflate" compressed entries)

The library can write:
  * gzip compression
  * bzip2 compression
  * POSIX ustar
  * POSIX pax interchange format
  * "restricted" pax format, which will create ustar archives except for
    entries that require pax extensions (for long filenames, ACLs, etc).
  * POSIX octet-oriented cpio
  * shar archives

Notes:
 * This is a heavily stream-oriented system.  There is no direct
   support for in-place modification or random access and no intention
   of ever adding such support.  Adding such support would require
   sacrificing a lot of other features, so don't bother asking.

 * The library is designed to be extended with new compression and
   archive formats.  The only requirement is that the format be
   readable or writable as a stream and that each archive entry be
   independent.

 * On read, compression and format are always detected automatically.

 * I've attempted to minimize static link pollution.  If you don't
   explicitly invoke a particular feature (such as support for a
   particular compression or format), it won't get pulled in.
   In particular, if you don't explicitly enable a particular
   compression or decompression support, you won't need to link
   against the corresponding compression or decompression libraries.
   This also reduces the size of statically-linked binaries in
   environments where that matters.

 * On read, the library accepts whatever blocks you hand it.
   Your read callback is free to pass the library a byte at a time
   or mmap the entire archive and give it to the library at once.
   On write, the library always produces correctly-blocked
   output.

 * The object-style approach allows you to have multiple archive streams
   open at once.  bsdtar uses this in its "@archive" extension.

 * The archive itself is read/written using callback functions.
   You can read an archive directly from an in-memory buffer or
   write it to a socket, if you wish.  There are some utility
   functions to provide easy-to-use "open file," etc, capabilities.

 * The read/write APIs are designed to allow individual entries
   to be read or written to any data source:  You can create
   a block of data in memory and add it to a tar archive without
   first writing a temporary file.  You can also read an entry from
   an archive and write the data directly to a socket.  If you want
   to read/write entries to disk, the archive_write_disk interface
   treats a directory as if it were an archive so you can copy
   from archive->disk using the same code you use for archive->archive
   transfers.

 * Note: "pax interchange format" is really an extended tar format,
   despite what the name says.