freebsd-dev/lib/libarchive
Tim Kientzle 92ab0af8a3 Correct the documented declaration of the archive_write_callback to
match the code.

PR:		docs/128089
Submitted by:	Mel
MFC after:	3 days
2008-11-01 19:11:21 +00:00
..
test If we don't know the file size, leave the file size unset. 2008-10-21 05:08:35 +00:00
archive_check_magic.c Style: bare "unsigned" is deprecated, use "unsigned int" instead. 2007-04-02 00:15:45 +00:00
archive_endian.h MFp4: libarchive 2.5.4b. (Still 'b' until I get a bit more 2008-05-26 17:00:24 +00:00
archive_entry_copy_stat.c MfP4: Support for storing birthtime in archive_entry objects. 2008-09-30 03:53:03 +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 MfP4: Support for storing birthtime in archive_entry objects. 2008-09-30 03:53:03 +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 MfP4: Support for storing birthtime in archive_entry objects. 2008-09-30 03:53:03 +00:00
archive_entry.h MfP4: Support for storing birthtime in archive_entry objects. 2008-09-30 03:53:03 +00:00
archive_platform.h Portability: Support platforms that lack (struct stat).st_blksize or SSIZE_MAX 2008-09-12 04:03:34 +00:00
archive_private.h Mark functions as __dead2 in order to help the LLVM static checker 2008-08-04 01:25:48 +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_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 Fix 'bsdtar -t' on tape drives. Libarchive uses the 2007-06-26 03:06:48 +00:00
archive_read_open_file.c Fix 'bsdtar -t' on tape drives. Libarchive uses the 2007-06-26 03:06:48 +00:00
archive_read_open_filename.c Include O_BINARY in open() calls on platforms that support it. 2008-02-19 06:10:48 +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 Update a comment: the format bid only runs once per archive; it no 2008-03-15 11:09:16 +00:00
archive_read_support_compression_all.c Fix the copyright notice; it was always intended to be 2007-01-09 08:05:56 +00:00
archive_read_support_compression_bzip2.c MFp4: libarchive 2.5.4b. (Still 'b' until I get a bit more 2008-05-26 17:00:24 +00:00
archive_read_support_compression_compress.c libarchive 2.2.3 2007-05-29 01:00:21 +00:00
archive_read_support_compression_gzip.c Correct a compile error when libbz2/zlib are unavailable. 2008-02-19 05:44:59 +00:00
archive_read_support_compression_none.c Update libarchive to 2.4.10. This includes a number of improvements 2007-12-30 04:58:22 +00:00
archive_read_support_compression_program.c Windows compatibility: The stub replacement for compression_program 2008-09-12 03:53:54 +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 MFp4: libarchive 2.5.4b. (Still 'b' until I get a bit more 2008-05-26 17:00:24 +00:00
archive_read_support_format_cpio.c Support uppercase hex digits in cpio archives. 2008-01-15 04:56:48 +00:00
archive_read_support_format_empty.c libarchive 2.2.3 2007-05-29 01:00:21 +00:00
archive_read_support_format_iso9660.c MFp4: libarchive 2.5.4b. (Still 'b' until I get a bit more 2008-05-26 17:00:24 +00:00
archive_read_support_format_mtree.c Trying to distinguish different "versions" of mtree files was a silly idea. 2008-09-18 04:13:36 +00:00
archive_read_support_format_tar.c MfP4: Store/read birthtime data in pax format. 2008-09-30 03:57:07 +00:00
archive_read_support_format_zip.c If we don't know the file size, leave the file size unset. 2008-10-21 05:08:35 +00:00
archive_read.3 MFp4: libarchive 2.5.4b. (Still 'b' until I get a bit more 2008-05-26 17:00:24 +00:00
archive_read.c Remove some unused fields from the private archive_read structure 2008-03-12 04:58:32 +00:00
archive_string_sprintf.c Add a useful sprintf()-style wrapper around 2008-03-14 22:00:09 +00:00
archive_string.c Rework the my_mbtowc_utf8() support function to fully match the mbtowc() 2008-06-15 11:28:56 +00:00
archive_string.h Portability: wchar_t is defined in stdlib.h on some systems. 2008-06-15 05:11:08 +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 Move va_end() up 2008-10-21 12:10:30 +00:00
archive_virtual.c libarchive 2.0 2007-03-03 07:37:37 +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 libarchive 2.2.3 2007-05-29 01:00:21 +00:00
archive_write_disk.3 Markup fix. 2008-09-04 05:22:00 +00:00
archive_write_disk.c Add test to verify ACL restores on FreeBSD, verify kern/128203 (mtime 2008-10-19 00:18:44 +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 Portability: Include O_BINARY if the local platform defines it. 2008-02-19 05:46:58 +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 Remove the duplicate "archive_format" and "archive_format_name" fields 2008-03-15 11:04:45 +00:00
archive_write_set_compression_bzip2.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_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 Sanity-check the block size. 2008-02-21 03:21:50 +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 A number of minor corrections to the support for external compression 2008-06-15 10:45:57 +00:00
archive_write_set_format_ar.c MfP4: Joerg Sonnenberger's fixes to make 'ar' and 'pax' writers 2008-08-10 02:06:28 +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 Remove the duplicate "archive_format" and "archive_format_name" fields 2008-03-15 11:04:45 +00:00
archive_write_set_format_cpio.c Remove the duplicate "archive_format" and "archive_format_name" fields 2008-03-15 11:04:45 +00:00
archive_write_set_format_mtree.c New mtree writer, thanks to Joerg Sonnenberger. 2008-08-31 07:21:46 +00:00
archive_write_set_format_pax.c MfP4: Store/read birthtime data in pax format. 2008-09-30 03:57:07 +00:00
archive_write_set_format_shar.c Joerg Sonnenberger's improvements to the shar writer. 2008-08-31 07:10:40 +00:00
archive_write_set_format_ustar.c MFp4: libarchive 2.5.4b. (Still 'b' until I get a bit more 2008-05-26 17:00:24 +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 Correct the documented declaration of the archive_write_callback to 2008-11-01 19:11:21 +00:00
archive_write.c Don't advertise the default block size as a constant; don't 2008-03-14 23:09:02 +00:00
archive.h MfP4: Generalize int64_t in the public headers to support compilers 2008-09-18 04:19:06 +00:00
config_freebsd.h MfP4: Support for storing birthtime in archive_entry objects. 2008-09-30 03:53:03 +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 MFp4: libarchive 2.5.4b. (Still 'b' until I get a bit more 2008-05-26 17:00:24 +00:00
libarchive.3 Fix the copyright notice; it was always intended to be 2007-01-09 08:05:56 +00:00
Makefile New mtree writer, thanks to Joerg Sonnenberger. 2008-08-31 07:21:46 +00:00
README libarchive 2.0 2007-03-03 07:37:37 +00:00
tar.5 MFp4: libarchive 2.5.4b. (Still 'b' until I get a bit more 2008-05-26 17:00:24 +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.