freebsd-dev/lib/libarchive
David E. O'Brien 731239920f Build as a shared lib again.
Discussed with:	kientzle
2004-10-11 22:04:05 +00:00
..
archive_check_magic.c More work on ACLs: fix error in archive_entry's ACL parsing code, 2004-04-12 01:16:16 +00:00
archive_entry.3 Add archive_entry_set_mtime() 2004-08-08 07:39:19 +00:00
archive_entry.c Add archive_entry_set_mtime() 2004-08-08 07:39:19 +00:00
archive_entry.h Add archive_entry_set_mtime() 2004-08-08 07:39:19 +00:00
archive_platform.h libarchive now has two complete build systems. The usual "Makefile" 2004-08-07 03:09:28 +00:00
archive_private.h Eliminate reliance on non-portable <err.h> by implementing a very 2004-08-14 03:45:45 +00:00
archive_read_data_into_buffer.c Read gtar-style sparse archives. 2004-06-27 01:15:31 +00:00
archive_read_data_into_fd.c Read gtar-style sparse archives. 2004-06-27 01:15:31 +00:00
archive_read_extract.c Cache uid-from-uname and gid-from-gname lookups during extraction. 2004-08-27 03:40:48 +00:00
archive_read_open_fd.c Refuse to extract an entry from an archive on top of the archive being read. 2004-06-27 23:36:39 +00:00
archive_read_open_file.c Refuse to extract an entry from an archive on top of the archive being read. 2004-06-27 23:36:39 +00:00
archive_read_open_filename.c Refuse to extract an entry from an archive on top of the archive being read. 2004-06-27 23:36:39 +00:00
archive_read_support_compression_all.c Conditionalize the bzip2/gzip compression/decompression 2004-07-30 04:14:47 +00:00
archive_read_support_compression_bzip2.c Eliminate reliance on non-portable <err.h> by implementing a very 2004-08-14 03:45:45 +00:00
archive_read_support_compression_compress.c Eliminate reliance on non-portable <err.h> by implementing a very 2004-08-14 03:45:45 +00:00
archive_read_support_compression_gzip.c Eliminate reliance on non-portable <err.h> by implementing a very 2004-08-14 03:45:45 +00:00
archive_read_support_compression_none.c Add statistics: track offset in compressed and uncompressed archive, 2004-04-28 04:41:27 +00:00
archive_read_support_format_all.c 'gnutar' is now handled by the 'tar' reader, so 2004-05-27 21:27:42 +00:00
archive_read_support_format_cpio.c Eliminate reliance on non-portable <err.h> by implementing a very 2004-08-14 03:45:45 +00:00
archive_read_support_format_tar.c Some old tar archives rely on "regular-file-plus-trailing-slash" to 2004-09-04 21:49:42 +00:00
archive_read.3 Split archive_{read,write}_finish into separate "close" (finish the archive 2004-08-07 19:22:50 +00:00
archive_read.c Eliminate reliance on non-portable <err.h> by implementing a very 2004-08-14 03:45:45 +00:00
archive_string_sprintf.c It is not legal to re-use a va_list variable. This caused 2004-08-26 03:33:53 +00:00
archive_string.c Eliminate reliance on non-portable <err.h> by implementing a very 2004-08-14 03:45:45 +00:00
archive_string.h Consistify: #define gets 1 tab character afterwards 2004-05-03 01:40:34 +00:00
archive_util.3 Fixed cross-references in SEE ALSO. 2004-07-04 21:15:37 +00:00
archive_util.c Eliminate reliance on non-portable <err.h> by implementing a very 2004-08-14 03:45:45 +00:00
archive_write_open_fd.c Clean up some consistent confusion between "dev" and "rdev." 2004-06-27 18:38:13 +00:00
archive_write_open_file.c Clean up some consistent confusion between "dev" and "rdev." 2004-06-27 18:38:13 +00:00
archive_write_open_filename.c Clean up some consistent confusion between "dev" and "rdev." 2004-06-27 18:38:13 +00:00
archive_write_set_compression_bzip2.c Conditionalize the bzip2/gzip compression/decompression 2004-07-30 04:14:47 +00:00
archive_write_set_compression_gzip.c Don't forget to count the end-of-file padding as part of the finished 2004-08-07 19:21:18 +00:00
archive_write_set_compression_none.c Don't forget to count the end-of-file padding as part of the finished 2004-08-07 19:21:18 +00:00
archive_write_set_format_by_name.c Allow "posix" as a synonym for "pax". (The gtar folks chose "posix", 2004-07-25 23:10:38 +00:00
archive_write_set_format_cpio.c * Plug a buffer overrun in ACL parsing. (archive_entry.c) 2004-04-13 23:45:37 +00:00
archive_write_set_format_pax.c Fix two ugly errors: 2004-09-17 04:39:07 +00:00
archive_write_set_format_shar.c Clean up some consistent confusion between "dev" and "rdev." 2004-06-27 18:38:13 +00:00
archive_write_set_format_ustar.c Beef up the "cannot archive this" error message with the 2004-08-07 02:24:20 +00:00
archive_write_set_format.c Many fixes. 2004-03-09 19:50:41 +00:00
archive_write.3 Split archive_{read,write}_finish into separate "close" (finish the archive 2004-08-07 19:22:50 +00:00
archive_write.c We don't need <paths.h>, so don't bother including it. 2004-08-14 03:43:35 +00:00
archive.h.in Split archive_{read,write}_finish into separate "close" (finish the archive 2004-08-07 19:22:50 +00:00
configure.ac.in We don't need <paths.h>, so don't bother including it. 2004-08-14 03:43:35 +00:00
COPYING libarchive now has two complete build systems. The usual "Makefile" 2004-08-07 03:09:28 +00:00
INSTALL libarchive now has two complete build systems. The usual "Makefile" 2004-08-07 03:09:28 +00:00
libarchive-formats.5 Fixed cross-references in SEE ALSO. 2004-07-04 21:15:37 +00:00
libarchive.3 Fixed cross-references in SEE ALSO. 2004-07-04 21:15:37 +00:00
Makefile Build as a shared lib again. 2004-10-11 22:04:05 +00:00
Makefile.am The configure-built Makefile wasn't installing archive.h 2004-08-08 00:48:39 +00:00
README Correct the names and descriptions of the man pages. 2004-08-04 06:19:31 +00:00
tar.5 Having implemented read support for it, I now know how to document the 2004-08-07 17:24:50 +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 and archive_write.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" program for more details.  Please let me know
about any errors or omissions you find.  (In particular, I no doubt missed
a few things when researching the tar.5 page.)

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)

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, there are convenience functions to
   make this especially easy.

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