ARCHIVE_READ(3) Library Functions Manual ARCHIVE_READ(3)
NAME
archive_read — functions for reading streaming archives
LIBRARY
Streaming Archive Library (libarchive, -larchive)
SYNOPSIS
#include <archive.h>
DESCRIPTION
These functions provide a complete API for reading streaming archives. The general process is to first create the struct archive object, set options, initialize the reader, iterate over the archive headers and associated data, then close the archive and release all resources.
Create archive object
See archive_read_new(3).
To read an archive, you must first obtain an initialized struct archive object from archive_read_new().
Enable filters and formats
See archive_read_filter(3) and archive_read_format(3).
You can then modify this object for the desired operations with the various archive_read_set_XXX() and archive_read_support_XXX() functions. In particular, you will need to invoke appropriate archive_read_support_XXX() functions to enable the corresponding compression and format support. Note that these latter functions perform two distinct operations: they cause the corresponding support code to be linked into your program, and they enable the corresponding auto-detect code. Unless you have specific constraints, you will generally want to invoke archive_read_support_filter_all() and archive_read_support_format_all() to enable auto-detect for all formats and compression types currently supported by the library.
Set options
See archive_read_set_options(3).
Open archive
See archive_read_open(3).
Once you have prepared the struct archive object, you call archive_read_open() to actually open the archive and prepare it for reading. There are several variants of this function; the most basic expects you to provide pointers to several functions that can provide blocks of bytes from the archive. There are convenience forms that allow you to specify a filename, file descriptor, FILE * object, or a block of memory from which to read the archive data. Note that the core library makes no assumptions about the size of the blocks read; callback functions are free to read whatever block size is most appropriate for the medium.
Consume archive
See archive_read_header(3), archive_read_data(3) and archive_read_extract(3).
Each archive entry consists of a header followed by a certain amount of data. You can obtain the next header with archive_read_next_header(), which returns a pointer to an struct archive_entry structure with information about the current archive element. If the entry is a regular file, then the header will be followed by the file data. You can use archive_read_data() (which works much like the read(2) system call) to read this data from the archive, or archive_read_data_block() which provides a slightly more efficient interface. You may prefer to use the higher-level archive_read_data_skip(), which reads and discards the data for this entry, archive_read_data_into_fd(), which copies the data to the provided file descriptor, or archive_read_extract(), which recreates the specified entry on disk and copies data from the archive. In particular, note that archive_read_extract() uses the struct archive_entry structure that you provide it, which may differ from the entry just read from the archive. In particular, many applications will want to override the pathname, file permissions, or ownership.
Release resources
See archive_read_free(3).
Once you have finished reading data from the archive, you should call archive_read_close() to close the archive, then call archive_read_free() to release all resources, including all memory allocated by the library.
EXAMPLES
The following illustrates basic usage of the library. In this example, the callback functions are simply wrappers around the standard open(2), read(2), and close(2) system calls.
void
list_archive(const char *name)
{
struct mydata *mydata;
struct archive *a;
struct archive_entry *entry;
mydata =
malloc(sizeof(struct mydata));
a = archive_read_new();
mydata->name = name;
archive_read_support_filter_all(a);
archive_read_support_format_all(a);
archive_read_open(a, mydata, myopen, myread, myclose);
while (archive_read_next_header(a, &entry) ==
ARCHIVE_OK) {
printf("%s\n",archive_entry_pathname(entry));
archive_read_data_skip(a);
}
archive_read_free(a);
free(mydata);
}
la_ssize_t
myread(struct archive *a, void *client_data, const void
**buff)
{
struct mydata *mydata = client_data;
*buff =
mydata->buff;
return (read(mydata->fd, mydata->buff, 10240));
}
int
myopen(struct archive *a, void *client_data)
{
struct mydata *mydata = client_data;
mydata->fd =
open(mydata->name, O_RDONLY);
return (mydata->fd >= 0 ? ARCHIVE_OK : ARCHIVE_FATAL);
}
int
myclose(struct archive *a, void *client_data)
{
struct mydata *mydata = client_data;
if
(mydata->fd > 0)
close(mydata->fd);
return (ARCHIVE_OK);
}
SEE ALSO
tar(1), archive_read_data(3), archive_read_extract(3), archive_read_filter(3), archive_read_format(3), archive_read_header(3), archive_read_new(3), archive_read_open(3), archive_read_set_options(3), archive_util(3), libarchive(3), tar(5)
HISTORY
The libarchive library first appeared in FreeBSD 5.3.
AUTHORS
The libarchive library was written by Tim Kientzle <kientzle@@acm.org>.
BUGS
Many traditional archiver programs treat empty files as valid empty archives. For example, many implementations of tar(1) allow you to append entries to an empty file. Of course, it is impossible to determine the format of an empty file by inspecting the contents, so this library treats empty files as having a special “empty” format. Debian February 2, 2012 ARCHIVE_READ(3)
ARCHIVE_READ(3) BSD Library Functions Manual ARCHIVE_READ(3)
d28 2 a29 2archive_read — functions for reading streaming archives
d33 1 a33 1Streaming Archive Library d38 1 a38 1
#include d43 1 a43 1
These functions provide a d50 2 a51 3
Create
archive object
See archive_read_new(3).
To read an d60 6 a65 3
Enable
filters and formats
See archive_read_filter(3) and archive_read_format(3).
You can then d83 8 a90 7
Set
options
See archive_read_set_options(3).
Open
archive
See archive_read_open(3).
Once you have d108 6 a113 4
Consume
archive
See archive_read_header(3), archive_read_data(3) and
archive_read_extract(3).
Each archive d123 5 a127 5 read(2) system call) to read this data from the archive, or archive_read_data_block() which provides a slightly more efficient interface. You may prefer to use the higher-level archive_read_data_skip(), which reads and discards the data for this entry, d138 2 a139 3
Release
resources
See archive_read_free(3).
Once you have d152 1 a152 1
The following illustrates basic d154 3 a156 2 functions are simply wrappers around the standard open(2), read(2), and close(2) system calls.
d158 1 a158 1void
d165 1
a165 1
mydata = d181 1 a181 1
la_ssize_t
d187 1
a187 1
*buff = d192 1 a192 1
int
d197 1
a197 1
mydata->fd = d203 1 a203 1
int
d208 1
a208 1
if d216 8 a223 6
tar(1), archive_read_data(3), archive_read_extract(3), archive_read_filter(3), archive_read_format(3), archive_read_header(3), archive_read_new(3), archive_read_open(3), archive_read_set_options(3), archive_util(3), libarchive(3), tar(5)
d227 1 a227 1The libarchive library d232 1 a232 1
The libarchive library d237 1 a237 1
Many traditional archiver d239 3 a241 3 example, many implementations of tar(1) allow you to append entries to an empty file. Of course, it is impossible to determine the format of an empty file by inspecting the d243 2 a244 4 special “empty” format.
BSD February 2, 2012 BSD
@ 1.11 log @libarchive: updated to 3.7.4 Libarchive 3.7.4 is a bugfix and security release Security fixes: rar: Fix OOB in rar e8 filter (CVE-2024-26256) zip: Fix out of boundary access Important bugfixes: 7zip: Limit amount of properties bsdtar: Fix error handling around strtol() usages passphrase: Improve newline handling on Windows passphrase: Never allow empty passwords rar: Fix "File CRC Error" when extracting specific rar4 archives xar: Avoid infinite link loop zip: Update AppleDouble support for directories zstd: Implement core detection @ text @d2 1 a2 1 @ 1.10 log @libarchive: updated to 3.7.3 Libarchive 3.7.3 is a feature, security and bugfix release. New features: PCRE2 support add trailing letter b to bsdtar(1) substitute pattern add support for long options "--group" and "--owner" to tar(1) Security fixes: Fix possible vulnerability in tar error reporting introduced in f27c173 Important bugfixes: ISO9660: preserve the natural order of links rar5: fix decoding unicode filenames on Windows rar5: fix infinite loop if during rar5 decompression the last block produced no data xz filter: fix incorrect eof at the end of an lzip member zip: fix end-of-data marker processing when decompressing zip archives multiple bsdunzip(1) fixes filetime truncation fix on Windows @ text @d2 1 a2 1 @ 1.9 log @libarchive: updated to 3.7.2 Libarchive 3.7.2 is a security, bugfix and feature release. Security fixes: Multiple vulnerabilities have been fixed in the PAX writer (1b4e0d0) Important bugfixes: bsdunzip(1) now correctly handles arguments following an -x after the zipfile New features: bsdunzip(1) now supports the "--version" flag 7-zip reader now translates Windows permissions into UNIX permissions uudecode filter in raw mode now supports file name and file mode zstd filter now supports the "long" write option Libarchive 3.7.1 is a security, feature and bugfix release. Security fixes: SEGV and stack buffer overflow in verbose mode of cpio Feature updates: bsdunzip updated to match latest upstream code Important bugfixes: miscellaneous functional bugfixes build fixes on multiple platforms Libarchive 3.7.0 is a feature and bugfix release. New features: bsdunzip: new tool ported from FreeBSD drop-in replacement for Info-ZIP unzip, not yet ported for Windows 7zip reader: support for Zstandard compression 7zip reader: support for ARM64 filter zstd filter: support for multi-frame zstd archives Other notable bugfixes and improvements: pax: fix year 2038 problem on platforms with 64-bit time_t Windows: Universal Windows Platform (UWP) fixes and improvements Windows: bcrypt usage fixes and improvements Windows: time function usage fixes and improvements @ text @d2 1 a2 1 @ 1.8 log @libarchive: Update to 3.4.3 Libarchive 3.4.3 is a feature and bugfix release. New features: support for pzstd compressed files (#1357) support for RHT.security.selinux tar extended attribute (#1348) Important bugfixes: various zstd fixes and improvements (#1342 #1352 #1359) child process handling fixes (#1372) Libarchive 3.4.2 is a feature and security release. New features: support for atomic file extraction (bsdtar -x --safe-writes) (#1289) support for mbed TLS (PolarSSL) (#1301) Important bugfixes: security fixes in RAR5 reader (#1280 #1326) compression buffer fix in XAR writer (#1317) fix uname and gname longer than 32 characters in PAX writer (#1319) fix segfault when archiving hard links in ISO9660 and XAR writers (#1325) fix support for extracting 7z archive entries with Delta filter (#987) Libarchive 3.4.1 is a feature and security release. New features: Unicode filename support for reading lha/lzh archives New pax write option "xattrhdr" Important bugfixes: security fixes in wide string processing (#1276 #1298) security fixes in RAR5 reader (#1212 #1217 #1296) security fixes and optimizations to write filter logic (#351) security fix related to use of readlink(2) (1dae5a5) sparse file handling fixes (#1218 #1260) Thanks to all contributors and bug reporters. Special thanks to Christos Zoulas (@@zoulasc) from NetBSD for the atomic file extraction feature. @ text @d1 2 a2 2 d227 1 a227 1 special ’’empty’’ format. @ 1.7 log @Update for libarchive-3.4.0: - improvements for Android APK and JAR archives - better support for non-recursive list and extract - tar --exclude-vcs support - fixes for file attributes and flags handling - zipx support - rar 5.0 reader @ text @d1 2 a2 2 d137 1 a137 1EXAMPLE
d202 1 a202 2tar(1), libarchive(3), archive_read_new(3), archive_read_data(3), d205 3 a207 2 archive_read_open(3), archive_read_set_options(3), archive_util(3), tar(5)
d227 1 a227 1 special “empty” format. @ 1.6 log @libarchive: updated to 3.3.3 libarchive 3.3.3: Avoid super-linear slowdown on malformed mtree files Many fixes for building with Visual Studio NO_OVERWRITE doesn't change existing directory attributes New support for Zstandard read and write filters @ text @d1 2 a2 2 d227 1 a227 1 special ’’empty’’ format. @ 1.5 log @Merge for libarchive-3.3.2. @ text @d2 1 a2 1 @ 1.4 log @Merge libarchive-3.3.1. @ text @d2 1 a2 1 d227 1 a227 1 special ‘‘empty’’ format. @ 1.3 log @Update for libarchive 3.2.1. @ text @d2 1 a2 1 d227 1 a227 1 special ’’empty’’ format. @ 1.2 log @Changes 3.1.2: This is a maintenance update to fix issues with the new RAR seeking feature. This new release also contains fixes for build failures when building libarchive using Visual Studio 2012 and MinGW. @ text @d1 2 a2 2 d117 1 a117 1 archive_read_data_to_file(), which copies the data to d167 1 a167 1ssize_t
d217 1
a217 2
was written by Tim Kientzle ⟨ kientzle@@acm.org⟩
.
archive_read(3) FreeBSD Library Functions Manual archive_read(3)
d26 1 a26 1NAME
d28 2 a29 36archive_read_new, archive_read_set_filter_options, archive_read_set_format_options, archive_read_set_options, archive_read_support_compression_all, archive_read_support_compression_bzip2, archive_read_support_compression_compress, archive_read_support_compression_gzip, archive_read_support_compression_lzma, archive_read_support_compression_none, archive_read_support_compression_xz, archive_read_support_compression_program, archive_read_support_compression_program_signature, archive_read_support_format_all, archive_read_support_format_ar, archive_read_support_format_cpio, archive_read_support_format_empty, archive_read_support_format_iso9660, archive_read_support_format_mtree, archive_read_support_format_raw, archive_read_support_format_tar, archive_read_support_format_zip, archive_read_open, archive_read_open2, archive_read_open_fd, archive_read_open_FILE, archive_read_open_filename, archive_read_open_memory, archive_read_next_header, archive_read_next_header2, archive_read_data, archive_read_data_block, archive_read_data_skip, archive_read_data_into_buffer, archive_read_data_into_fd, archive_read_extract, archive_read_extract2, archive_read_extract_set_progress_callback, archive_read_close, archive_read_finish — functions for reading streaming archives
d31 1 d33 2 a34 1SYNOPSIS
d36 3 a38 1#include d41 1 a41 113
struct archive *
archive_read_new(void);
int
archive_read_support_compression_all(struct archive *);
int
archive_read_support_compression_bzip2(struct archive *);
int
archive_read_support_compression_compress(struct archive *);
int
archive_read_support_compression_gzip(struct archive *);
int
archive_read_support_compression_lzma(struct archive *);
int
archive_read_support_compression_none(struct archive *);
int
archive_read_support_compression_xz(struct archive *);
int
archive_read_support_compression_program(struct archive *, const char *cmd);
int
archive_read_support_compression_program_signature(struct archive *, const char *cmd, const void *signature, size_t signature_length);
int
archive_read_support_format_all(struct archive *);
int
archive_read_support_format_ar(struct archive *);
int
archive_read_support_format_cpio(struct archive *);
int
archive_read_support_format_empty(struct archive *);
int
archive_read_support_format_iso9660(struct archive *);
int
archive_read_support_format_mtree(struct archive *);
int
archive_read_support_format_raw(struct archive *);
int
archive_read_support_format_tar(struct archive *);
int
archive_read_support_format_zip(struct archive *);
int
archive_read_set_filter_options(struct archive *, const char *);
int
archive_read_set_format_options(struct archive *, const char *);
int
d43 1 a43 126archive_read_set_options(struct archive *, const char *);
int
archive_read_open(struct archive *, void *client_data, archive_open_callback *, archive_read_callback *, archive_close_callback *);
int
archive_read_open2(struct archive *, void *client_data, archive_open_callback *, archive_read_callback *, archive_skip_callback *, archive_close_callback *);
int
archive_read_open_FILE(struct archive *, FILE *file);
int
archive_read_open_fd(struct archive *, int fd, size_t block_size);
int
archive_read_open_filename(struct archive *, const char *filename, size_t block_size);
int
archive_read_open_memory(struct archive *, void *buff, size_t size);
int
archive_read_next_header(struct archive *, struct archive_entry **);
int
archive_read_next_header2(struct archive *, struct archive_entry *);
ssize_t
archive_read_data(struct archive *, void *buff, size_t len);
int
archive_read_data_block(struct archive *, const void **buff, size_t *len, off_t *offset);
int
archive_read_data_skip(struct archive *);
int
archive_read_data_into_buffer(struct archive *, void *, ssize_t len);
int
archive_read_data_into_fd(struct archive *, int fd);
int
archive_read_extract(struct archive *, struct archive_entry *, int flags);
int
archive_read_extract2(struct archive *src, struct archive_entry *, struct archive *dest);
void
archive_read_extract_set_progress_callback(struct archive *, void (*func)(void *), void *user_data);
int
archive_read_close(struct archive *);
int
archive_read_finish(struct archive *);
DESCRIPTION
These functions provide a d48 1 a48 4 release all resources. The following summary describes the functions in approximately the order they would be used:
archive_read_new()
d50 86 a135 365Allocates and initializes a struct archive object suitable for reading from an archive.
archive_read_support_compression_bzip2(), archive_read_support_compression_compress(), archive_read_support_compression_gzip(), archive_read_support_compression_lzma(), archive_read_support_compression_none(), archive_read_support_compression_xz()
Enables auto-detection code and decompression support for the specified compression. Returns ARCHIVE_OK if the compression is fully supported, or ARCHIVE_WARN if the compression is supported only through an external program. Note that decompression using an external program is usually slower than decompression through built-in libraries. Note that ‘‘none’’ is always enabled by default.
archive_read_support_compression_all()
Enables all available decompression filters.
archive_read_support_compression_program()
Data is fed through the specified external program before being dearchived. Note that this disables automatic detection of the compression format, so it makes no sense to specify this in conjunction with any other decompression option.
archive_read_support_compression_program_signature()
This feeds data through the specified external program but only if the initial bytes of the data match the specified signature value.
archive_read_support_format_all(), archive_read_support_format_ar(), archive_read_support_format_cpio(), archive_read_support_format_empty(), archive_read_support_format_iso9660(), archive_read_support_format_mtree(), archive_read_support_format_tar(), archive_read_support_format_zip()
Enables support---including auto-detection code---for the specified archive format. For example, archive_read_support_format_tar() enables support for a variety of standard tar formats, old-style tar, ustar, pax interchange format, and many common variants. For convenience, archive_read_support_format_all() enables support for all available formats. Only empty archives are supported by default.
archive_read_support_format_raw()
The ‘‘raw’’ format handler allows libarchive to be used to read arbitrary data. It treats any data stream as an archive with a single entry. The pathname of this entry is ‘‘data’’; all other entry fields are unset. This is not enabled by archive_read_support_format_all() in order to avoid erroneous handling of damaged archives.
archive_read_set_filter_options(), archive_read_set_format_options(), archive_read_set_options()
Specifies options that will be passed to currently-registered filters (including decompression filters) and/or format readers. The argument is a comma-separated list of individual options. Individual options have one of the following forms:
option=value
The option/value pair will be provided to every module. Modules that do not accept an option with this name will ignore it.
option
The option will be provided to every module with a value of ‘‘1’’.
!option
The option will be provided to every module with a NULL value.
module:option=value, module:option, module:!option
As above, but the corresponding option and value will be provided only to modules whose name matches module.
The return value will be ARCHIVE_OK if any module accepts the option, or ARCHIVE_WARN if no module accepted the option, or ARCHIVE_FATAL if there was a fatal error while attempting to process the option.
The currently supported options are:
Format iso9660
joliet
Support Joliet extensions. Defaults to enabled, use !joliet to disable.
archive_read_open()
The same as archive_read_open2(), except that the skip callback is assumed to be NULL.
archive_read_open2()
Freeze the settings, open the archive, and prepare for reading entries. This is the most generic version of this call, which accepts four callback functions. Most clients will want to use archive_read_open_filename(), archive_read_open_FILE(), archive_read_open_fd(), or archive_read_open_memory() instead. The library invokes the client-provided functions to obtain raw bytes from the archive.
archive_read_open_FILE()
Like archive_read_open(), except that it accepts a FILE * pointer. This function should not be used with tape drives or other devices that require strict I/O blocking.
archive_read_open_fd()
Like archive_read_open(), except that it accepts a file descriptor and block size rather than a set of function pointers. Note that the file descriptor will not be automatically closed at end-of-archive. This function is safe for use with tape drives or other blocked devices.
archive_read_open_file()
This is a deprecated synonym for archive_read_open_filename().
archive_read_open_filename()
Like archive_read_open(), except that it accepts a simple filename and a block size. A NULL filename represents standard input. This function is safe for use with tape drives or other blocked devices.
archive_read_open_memory()
Like archive_read_open(), except that it accepts a pointer and size of a block of memory containing the archive data.
archive_read_next_header()
Read the header for the next entry and return a pointer to a struct archive_entry. This is a convenience wrapper around archive_read_next_header2() that reuses an internal struct archive_entry object for each request.
archive_read_next_header2()
Read the header for the next entry and populate the provided struct archive_entry.
archive_read_data()
Read data associated with the header just read. Internally, this is a convenience function that calls archive_read_data_block() and fills any gaps with nulls so that callers see a single continuous stream of data.
archive_read_data_block()
Return the next available block of data for this entry. Unlike archive_read_data(), the archive_read_data_block() function avoids copying data and allows you to correctly handle sparse files, as supported by some archive formats. The library guarantees that offsets will increase and that blocks will not overlap. Note that the blocks returned from this function can be much larger than the block size read from disk, due to compression and internal buffer optimizations.
archive_read_data_skip()
A convenience function that repeatedly calls archive_read_data_block() to skip all of the data for this archive entry.
archive_read_data_into_buffer()
This function is deprecated and will be removed. Use archive_read_data() instead.
archive_read_data_into_fd()
A convenience function that repeatedly calls archive_read_data_block() to copy the entire entry to the provided file descriptor.
archive_read_extract(), archive_read_extract_set_skip_file()
A convenience function that wraps the corresponding archive_write_disk(3) interfaces. The first call to archive_read_extract() creates a restore object using archive_write_disk_new(3) and archive_write_disk_set_standard_lookup(3), then transparently invokes archive_write_disk_set_options(3), archive_write_header(3), archive_write_data(3), and archive_write_finish_entry(3) to create the entry on disk and copy data into it. The flags argument is passed unmodified to archive_write_disk_set_options(3).
archive_read_extract2()
This is another version of archive_read_extract() that allows you to provide your own restore object. In particular, this allows you to override the standard lookup functions using archive_write_disk_set_group_lookup(3), and archive_write_disk_set_user_lookup(3). Note that archive_read_extract2() does not accept a flags argument; you should use archive_write_disk_set_options() to set the restore options yourself.
archive_read_extract_set_progress_callback()
Sets a pointer to a user-defined callback that can be used for updating progress displays during extraction. The progress function will be invoked during the extraction of large regular files. The progress function will be invoked with the pointer provided to this call. Generally, the data pointed to should include a reference to the archive object and the archive_entry object so that various statistics can be retrieved for the progress display.
archive_read_close()
Complete the archive and invoke the close callback.
archive_read_finish()
Invokes archive_read_close() if it was not invoked manually, then release all resources. Note: In libarchive 1.x, this function was declared to return void, which made it impossible to detect certain errors when archive_read_close() was invoked implicitly from this function. The declaration is corrected beginning with libarchive 2.0.
Note that the library determines most of the relevant information about the archive by inspection. In particular, it automatically detects gzip(1) or bzip2(1) compression and transparently performs the appropriate decompression. It also automatically detects the archive format.
A complete description of the struct archive and struct archive_entry objects can be found in the overview manual page for libarchive(3).
CLIENT CALLBACKS
The callback functions must match the following prototypes:
typedef ssize_t
archive_read_callback(struct archive *, void *client_data, const void **buffer)
typedef int
archive_skip_callback(struct archive *, void *client_data, size_t request)
typedef int archive_open_callback(struct archive *, void *client_data)
typedef int archive_close_callback(struct archive *, void *client_data)
The open callback is invoked by archive_open(). It should return ARCHIVE_OK if the underlying file or data source is successfully opened. If the open fails, it should call archive_set_error() to register an error code and message and return ARCHIVE_FATAL.
The read callback is invoked whenever the library requires raw bytes from the archive. The read callback should read data into a buffer, set the const void **buffer argument to point to the available data, and return a count of the number of bytes available. The library will invoke the read callback again only after it has consumed this data. The library imposes no constraints on the size of the data blocks returned. On end-of-file, the read callback should return zero. On error, the read callback should invoke archive_set_error() to register an error code and message and return -1.
The skip callback is invoked when the library wants to ignore a block of data. The return value is the number of bytes actually skipped, which may differ from the request. If the callback cannot skip data, it should return zero. If the skip callback is not provided (the function pointer is NULL ), the library will invoke the read function instead and simply discard the result. A skip callback can provide significant performance gains when reading uncompressed archives from slow disk drives or other media that can skip quickly.
The close callback is invoked by archive_close when the archive processing is complete. The callback should return ARCHIVE_OK on success. On failure, the callback should invoke archive_set_error() to register an error code and message and return ARCHIVE_FATAL.
d137 1 a137 1EXAMPLE
d139 1 a139 1The following illustrates basic d144 1 a144 1
void
d151 1
a151 1
mydata =
d155 1
a155 1
archive_read_support_compression_all(a);
d163 1
a163 1
archive_read_finish(a);
d167 1
a167 1
ssize_t
d173 1
a173 1
*buff = d178 1 a178 1
int
d183 1
a183 1
mydata->fd = d189 1 a189 1
int
d194 1
a194 1
if d200 1 a200 2
RETURN VALUES
d202 5 a206 41Most functions return zero on success, non-zero on error. The possible return codes include: ARCHIVE_OK (the operation succeeded), ARCHIVE_WARN (the operation succeeded but a non-critical error was encountered), ARCHIVE_EOF (end-of-archive was encountered), ARCHIVE_RETRY (the operation failed but can be retried), and ARCHIVE_FATAL (there was a fatal error; the archive should be closed immediately). Detailed error codes and textual descriptions are available from the archive_errno() and archive_error_string() functions.
archive_read_new() returns a pointer to a freshly allocated struct archive object. It returns NULL on error.
archive_read_data() returns a count of bytes actually read or zero at the end of the entry. On error, a value of ARCHIVE_FATAL, ARCHIVE_WARN, or ARCHIVE_RETRY is returned and an error code and textual description can be retrieved from the archive_errno() and archive_error_string() functions.
The library expects the client callbacks to behave similarly. If there is an error, you can use archive_set_error() to set an appropriate error code and description, then return one of the non-zero values above. (Note that the value eventually returned to the client may not be the same; many errors that are not critical at the level of basic I/O can prevent the archive from being properly read, thus most I/O errors eventually cause ARCHIVE_FATAL to be returned.)
SEE ALSO
tar(1), archive(3), d209 1 a209 1
HISTORY
d211 1 a211 1The libarchive library d214 1 a214 1
AUTHORS
d216 3 a218 3The libarchive library was written by Tim Kientzle ⟨kientzle@@acm.org⟩.
d220 1 a220 1BUGS
d222 1 a222 1Many traditional archiver d228 1 a228 2 special ‘‘empty’’ format.
d230 2 a231 2FreeBSD 8.0 April 13, 2009 FreeBSD 8.0
@ 1.1.1.1 log @Import libarchive 2.8.0: - Infrastructure: - Allow command line tools as fallback for missing compression libraries. If compiled without gzip for example, gunzip will be used automatically. - Improved support for a number of platforms like high-resolution timestamps and Extended Attributes on various Unix systems - New convience interface for creating archives based on disk content, complement of the archive_write_disk interface. - Frontends: - bsdcpio ready for public consumption - hand-written date parser replaces the yacc code - Filter system: - Simplified read filter chains - Option support for filters - LZMA, XZ, uudecode handled - Format support: - Write support for mtree files based on file system or archive content - Basic read support for Joliet - Write support for zip files - Write support for shar archives, both text-only and binary-safe @ text @@ 1.1.1.2 log @libarchive-2.8.2: - Fix NULL deference for short self-extracting zip archives - Don't dereference symlinks on Linux when reading ACLs - Better detection of SHA2 support for old OpenSSL versions - Fix parsing of input files for bsdtar -T - Do not leak setup_xattr into the global namespace - Fix build when an older libarchive is already installed - Use O_BINARY opening files in bsdtar - Include missing archive_crc32.h - Correctly include iconv.h required by libxml2 @ text @d1 820 a820 1509 %!PS-Adobe-3.0 %%Creator: groff version 1.19.2 %%CreationDate: Sun Mar 14 02:49:15 2010 %%DocumentNeededResources: font Times-Roman %%DocumentSuppliedResources: procset grops 1.19 2 %%Pages: 118 %%PageOrder: Ascend %%DocumentMedia: Default 612 792 0 () () %%Orientation: Portrait %%EndComments %%BeginDefaults %%PageMedia: Default %%EndDefaults %%BeginProlog %%BeginResource: procset grops 1.19 2 %!PS-Adobe-3.0 Resource-ProcSet /setpacking where{ pop currentpacking true setpacking }if /grops 120 dict dup begin /SC 32 def /A/show load def /B{0 SC 3 -1 roll widthshow}bind def /C{0 exch ashow}bind def /D{0 exch 0 SC 5 2 roll awidthshow}bind def /E{0 rmoveto show}bind def /F{0 rmoveto 0 SC 3 -1 roll widthshow}bind def /G{0 rmoveto 0 exch ashow}bind def /H{0 rmoveto 0 exch 0 SC 5 2 roll awidthshow}bind def /I{0 exch rmoveto show}bind def /J{0 exch rmoveto 0 SC 3 -1 roll widthshow}bind def /K{0 exch rmoveto 0 exch ashow}bind def /L{0 exch rmoveto 0 exch 0 SC 5 2 roll awidthshow}bind def /M{rmoveto show}bind def /N{rmoveto 0 SC 3 -1 roll widthshow}bind def /O{rmoveto 0 exch ashow}bind def /P{rmoveto 0 exch 0 SC 5 2 roll awidthshow}bind def /Q{moveto show}bind def /R{moveto 0 SC 3 -1 roll widthshow}bind def /S{moveto 0 exch ashow}bind def /T{moveto 0 exch 0 SC 5 2 roll awidthshow}bind def /SF{ findfont exch [exch dup 0 exch 0 exch neg 0 0]makefont dup setfont [exch/setfont cvx]cvx bind def }bind def /MF{ findfont [5 2 roll 0 3 1 roll neg 0 0]makefont dup setfont [exch/setfont cvx]cvx bind def }bind def /level0 0 def /RES 0 def /PL 0 def /LS 0 def /MANUAL{ statusdict begin/manualfeed true store end }bind def /PLG{ gsave newpath clippath pathbbox grestore exch pop add exch pop }bind def /BP{ /level0 save def 1 setlinecap 1 setlinejoin 72 RES div dup scale LS{ 90 rotate }{ 0 PL translate }ifelse 1 -1 scale }bind def /EP{ level0 restore showpage }def /DA{ newpath arcn stroke }bind def /SN{ transform .25 sub exch .25 sub exch round .25 add exch round .25 add exch itransform }bind def /DL{ SN moveto SN lineto stroke }bind def /DC{ newpath 0 360 arc closepath }bind def /TM matrix def /DE{ TM currentmatrix pop translate scale newpath 0 0 .5 0 360 arc closepath TM setmatrix }bind def /RC/rcurveto load def /RL/rlineto load def /ST/stroke load def /MT/moveto load def /CL/closepath load def /Fr{ setrgbcolor fill }bind def /setcmykcolor where{ pop /Fk{ setcmykcolor fill }bind def }if /Fg{ setgray fill }bind def /FL/fill load def /LW/setlinewidth load def /Cr/setrgbcolor load def /setcmykcolor where{ pop /Ck/setcmykcolor load def }if /Cg/setgray load def /RE{ findfont dup maxlength 1 index/FontName known not{1 add}if dict begin { 1 index/FID ne{def}{pop pop}ifelse }forall /Encoding exch def dup/FontName exch def currentdict end definefont pop }bind def /DEFS 0 def /EBEGIN{ moveto DEFS begin }bind def /EEND/end load def /CNT 0 def /level1 0 def /PBEGIN{ /level1 save def translate div 3 1 roll div exch scale neg exch neg exch translate 0 setgray 0 setlinecap 1 setlinewidth 0 setlinejoin 10 setmiterlimit []0 setdash /setstrokeadjust where{ pop false setstrokeadjust }if /setoverprint where{ pop false setoverprint }if newpath /CNT countdictstack def userdict begin /showpage{}def /setpagedevice{}def }bind def /PEND{ countdictstack CNT sub{end}repeat level1 restore }bind def end def /setpacking where{ pop setpacking }if %%EndResource %%EndProlog %%BeginSetup %%BeginFeature: *PageSize Default << /PageSize [ 612 792 ] /ImagingBBox null >> setpagedevice %%EndFeature %%IncludeResource: font Times-Roman grops begin/DEFS 1 dict def DEFS begin/u{.001 mul}bind def end/RES 72 def/PL 792 def/LS false def/ENC0[/asciicircum/asciitilde/Scaron/Zcaron /scaron/zcaron/Ydieresis/trademark/quotesingle/Euro/.notdef/.notdef /.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef /.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef /.notdef/.notdef/space/exclam/quotedbl/numbersign/dollar/percent /ampersand/quoteright/parenleft/parenright/asterisk/plus/comma/hyphen /period/slash/zero/one/two/three/four/five/six/seven/eight/nine/colon /semicolon/less/equal/greater/question/at/A/B/C/D/E/F/G/H/I/J/K/L/M/N/O /P/Q/R/S/T/U/V/W/X/Y/Z/bracketleft/backslash/bracketright/circumflex /underscore/quoteleft/a/b/c/d/e/f/g/h/i/j/k/l/m/n/o/p/q/r/s/t/u/v/w/x/y /z/braceleft/bar/braceright/tilde/.notdef/quotesinglbase/guillemotleft /guillemotright/bullet/florin/fraction/perthousand/dagger/daggerdbl /endash/emdash/ff/fi/fl/ffi/ffl/dotlessi/dotlessj/grave/hungarumlaut /dotaccent/breve/caron/ring/ogonek/quotedblleft/quotedblright/oe/lslash /quotedblbase/OE/Lslash/.notdef/exclamdown/cent/sterling/currency/yen /brokenbar/section/dieresis/copyright/ordfeminine/guilsinglleft /logicalnot/minus/registered/macron/degree/plusminus/twosuperior /threesuperior/acute/mu/paragraph/periodcentered/cedilla/onesuperior /ordmasculine/guilsinglright/onequarter/onehalf/threequarters /questiondown/Agrave/Aacute/Acircumflex/Atilde/Adieresis/Aring/AE /Ccedilla/Egrave/Eacute/Ecircumflex/Edieresis/Igrave/Iacute/Icircumflex /Idieresis/Eth/Ntilde/Ograve/Oacute/Ocircumflex/Otilde/Odieresis /multiply/Oslash/Ugrave/Uacute/Ucircumflex/Udieresis/Yacute/Thorn /germandbls/agrave/aacute/acircumflex/atilde/adieresis/aring/ae/ccedilla /egrave/eacute/ecircumflex/edieresis/igrave/iacute/icircumflex/idieresis /eth/ntilde/ograve/oacute/ocircumflex/otilde/odieresis/divide/oslash /ugrave/uacute/ucircumflex/udieresis/yacute/thorn/ydieresis]def /Times-Roman@@0 ENC0/Times-Roman RE %%EndSetup %%Page: 1 1 %%BeginPageSetup BP %%EndPageSetup /F0 10/Times-Roman@@0 SF()0 12 Q()0 24 Q(struct archi)0 72 Q -.15(ve)
-.25 G( *).15 E 0 Cg EP
%%Page: 12 12
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(archi)0 12 Q -.15(ve)-.25 G(_read_ne).15 E
(w\(v)-.25 E(oid\))-.2 E
(int)0 24 Q(archi)0 36 Q -.15(ve)
-.25 G
(_read_support_compression_all\(struct archi).15
E .3 -.15(ve *)-.25 H(\)).15 E
(int)0 48 Q(archi)0 60 Q -.15(ve)
-.25 G
(_read_support_compression_bzip2\(struct archi)
.15 E .3 -.15(ve *)-.25 H(\)).15 E
(int)0 72 Q 0 Cg EP
%%Page: 13 13
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(archi)0 12 Q -.15(ve)-.25 G(_read_support_co\
mpression_compress\(struct archi).15 E .3 -.15
(ve *)-.25 H(\)).15 E(int)0 24
Q(archi)0 36 Q -.15(ve)-.25 G
(_read_support_compression_gzip\(struct archi).15
E .3 -.15(ve *)-.25 H(\)).15 E
(int)0 48 Q(archi)0 60 Q -.15(ve)
-.25 G
(_read_support_compression_lzma\(struct archi).15
E .3 -.15(ve *)-.25 H(\)).15 E
(int)0 72 Q 0 Cg EP
%%Page: 14 14
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(archi)0 12 Q -.15(ve)-.25 G
(_read_support_compression_none\(struct archi).15
E .3 -.15(ve *)-.25 H(\)).15 E
(int)0 24 Q(archi)0 36 Q -.15(ve)
-.25 G
(_read_support_compression_xz\(struct archi).15 E
.3 -.15(ve *)-.25 H(\)).15 E
(int)0 48 Q(archi)0 60 Q -.15(ve)
-.25 G(_read_support_compression_program\(struct archi)0 72 Q .3 -.15(ve *)-.25 H().15
E 0 Cg EP
%%Page: 15 15
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(const char *cmd)0 12 Q
(\))0 24 Q(int)0 36 Q(archi)0 48 Q
-.15(ve)-.25 G
(_read_support_compression_program_signature\(struct archi)0 60 Q .3 -.15(ve *)-.25 H().15
E(const char *cmd)0 72 Q 0 Cg EP
%%Page: 16 16
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(const v)0 12 Q
(oid *signature)-.2 E
(size_t signature_length)0 24 Q(\))0 36 Q
(int)0 48 Q(archi)0 60 Q -.15(ve)
-.25 G(_read_support_format_all\(struct archi).15
E .3 -.15(ve *)-.25 H(\)).15 E
(int)0 72 Q 0 Cg EP
%%Page: 17 17
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(archi)0 12 Q -.15(ve)-.25 G
(_read_support_format_ar\(struct archi).15 E .3
-.15(ve *)-.25 H(\)).15 E(int)0
24 Q(archi)0 36 Q -.15(ve)-.25 G
(_read_support_format_cpio\(struct archi).15 E .3
-.15(ve *)-.25 H(\)).15 E(int)0
48 Q(archi)0 60 Q -.15(ve)-.25 G
(_read_support_format_empty\(struct archi).15 E
.3 -.15(ve *)-.25 H(\)).15 E
(int)0 72 Q 0 Cg EP
%%Page: 18 18
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(archi)0 12 Q -.15(ve)-.25 G
(_read_support_format_iso9660\(struct archi).15 E
.3 -.15(ve *)-.25 H(\)).15 E
(int)0 24 Q(archi)0 36 Q -.15(ve)
-.25 G(_read_support_format_mtree\(struct archi)
.15 E .3 -.15(ve *)-.25 H(\)).15 E
(int)0 48 Q(archi)0 60 Q -.15(ve)
-.25 G(_read_support_format_ra).15 E
(w\(struct archi)-.15 E .3 -.15(ve *)-.25 H
(\)).15 E(int)0 72 Q 0 Cg EP
%%Page: 19 19
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(archi)0 12 Q -.15(ve)-.25 G
(_read_support_format_tar\(struct archi).15 E .3
-.15(ve *)-.25 H(\)).15 E(int)0
24 Q(archi)0 36 Q -.15(ve)-.25 G
(_read_support_format_zip\(struct archi).15 E .3
-.15(ve *)-.25 H(\)).15 E(int)0
48 Q(archi)0 60 Q -.15(ve)-.25 G
(_read_set_\214lter_options\(struct archi).15 E
.3 -.15(ve *)-.25 H(, const char *\)).15 E
(int)0 72 Q 0 Cg EP
%%Page: 20 20
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(archi)0 12 Q -.15(ve)-.25 G
(_read_set_format_options\(struct archi).15 E .3
-.15(ve *)-.25 H(, const char *\)).15 E
(int)0 24 Q(archi)0 36 Q -.15(ve)
-.25 G(_read_set_options\(struct archi).15 E .3
-.15(ve *)-.25 H(, const char *\)).15 E
(int)0 48 Q(archi)0 60 Q -.15(ve)
-.25 G(_read_open\(struct archi)0 72 Q .3 -.15(ve *)-.25 H().15
E 0 Cg EP
%%Page: 21 21
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(v)0 12 Q
(oid *client_data)-.2 E(archi)0 24 Q -.15(ve)
-.25 G(_open_callback *).15 E(archi)0 36 Q
-.15(ve)-.25 G(_read_callback *).15 E(archi)0
48 Q -.15(ve)-.25 G(_close_callback *).15 E(\))0 60 Q
(int)0 72 Q 0 Cg EP
%%Page: 22 22
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(archi)0 12 Q -.15(ve)-.25 G
(_read_open2\(struct archi)0
24 Q .3 -.15(ve *)-.25 H().15 E(v)0 36 Q
(oid *client_data)-.2 E(archi)0 48 Q -.15(ve)
-.25 G(_open_callback *).15 E(archi)0 60 Q
-.15(ve)-.25 G(_read_callback *).15 E(archi)0
72 Q -.15(ve)-.25 G(_skip_callback *).15 E 0 Cg EP
%%Page: 23 23
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(archi)0 12 Q -.15(ve)-.25 G
(_close_callback *).15 E(\))0 24 Q
(int)0 36 Q(archi)0 48 Q -.15(ve)
-.25 G(_read_open_FILE\(struct archi).15 E .3
-.15(ve *)-.25 H(, FILE *\214le\)).15 E
(int)0 60 Q(archi)0 72 Q -.15(ve)
-.25 G(_read_open_fd\(struct archi).15 E .3 -.15
(ve *)-.25 H
(, int fd, size_t block_size\)).15 E 0
Cg EP
%%Page: 24 24
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(int)0 12 Q
(archi)0 24 Q -.15(ve)-.25 G
(_read_open_\214lename\(struct archi)0 36 Q .3 -.15(ve *)-.25 H().15
E(const char *\214lename)0 48 Q
(size_t block_size)0 60 Q(\))0 72 Q 0 Cg EP
%%Page: 25 25
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(int)0 12 Q
(archi)0 24 Q -.15(ve)-.25 G
(_read_open_memory\(struct archi).15 E .3 -.15
(ve *)-.25 H(, v).15 E(oid *b)-.2 E(uf)-.2 E
(f, size_t size\))-.25 E
(int)0 36 Q(archi)0 48 Q -.15(ve)
-.25 G(_read_ne).15 E(xt_header\(struct archi)
-.15 E .3 -.15(ve *)-.25 H(, struct archi).15 E -.15(ve)
-.25 G(_entry **\)).15 E(int)0
60 Q(archi)0 72 Q -.15(ve)-.25 G(_read_ne).15 E
(xt_header2\(struct archi)-.15 E .3 -.15(ve *)
-.25 H(, struct archi).15 E -.15(ve)-.25 G
(_entry *\)).15 E 0 Cg EP
%%Page: 26 26
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(ssize_t)0 12 Q
(archi)0 24 Q -.15(ve)-.25 G
(_read_data\(struct archi).15 E .3 -.15(ve *)-.25
H(, v).15 E(oid *b)-.2 E(uf)-.2 E
(f, size_t len\))-.25 E
(int)0 36 Q(archi)0 48 Q -.15(ve)
-.25 G(_read_data_block\(struct archi)0 60 Q .3 -.15(ve *)-.25 H().15
E(const v)0 72 Q(oid **b)-.2 E(uf)-.2 E(f)-.25
E 0 Cg EP
%%Page: 27 27
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(size_t *len)0 12 Q
(of)0 24 Q(f_t *of)-.25 E(fset)-.25 E(\))0 36
Q(int)0 48 Q(archi)0 60 Q -.15(ve)
-.25 G(_read_data_skip\(struct archi).15 E .3
-.15(ve *)-.25 H(\)).15 E(int)0
72 Q 0 Cg EP
%%Page: 28 28
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(archi)0 12 Q -.15(ve)-.25 G
(_read_data_into_b).15 E(uf)-.2 E
(fer\(struct archi)-.25 E .3 -.15(ve *)-.25 H
(, v).15 E(oid *, ssize_t len\))-.2 E
(int)0 24 Q(archi)0 36 Q -.15(ve)
-.25 G(_read_data_into_fd\(struct archi).15 E .3
-.15(ve *)-.25 H(, int fd\)).15 E
(int)0 48 Q(archi)0 60 Q -.15(ve)
-.25 G(_read_e).15 E(xtract\(struct archi)0 72 Q .3 -.15(ve *)-.25 H().15
E 0 Cg EP
%%Page: 29 29
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(struct archi)0 12 Q -.15(ve)
-.25 G(_entry *).15 E(int \215ags)0 24
Q(\))0 36 Q(int)0 48 Q(archi)0 60 Q
-.15(ve)-.25 G(_read_e).15 E(xtract2\(struct archi)0 72 Q .3 -.15(ve *)-.25 H(src)
.15 E 0 Cg EP
%%Page: 30 30
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(struct archi)0 12 Q -.15(ve)
-.25 G(_entry *).15 E(struct archi)0 24 Q .3
-.15(ve *)-.25 H(dest).15 E(\))0 36 Q
(v)0 48 Q(oid)-.2 E(archi)0 60 Q
-.15(ve)-.25 G(_read_e).15 E
(xtract_set_progress_callback\(struct archi)0 72 Q .3 -.15(ve *)-.25 H().15
E 0 Cg EP
%%Page: 31 31
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(v)0 12 Q(oid \(*func\)\(v)-.2
E(oid *\))-.2 E(v)0 24 Q
(oid *user_data)-.2 E(\))0 36 Q
(int)0 48 Q(archi)0 60 Q -.15(ve)
-.25 G(_read_close\(struct archi).15 E .3 -.15
(ve *)-.25 H(\)).15 E(int)0 72
Q 0 Cg EP
%%Page: 32 32
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(archi)0 12 Q -.15(ve)-.25 G
(_read_\214nish\(struct archi).15 E .3 -.15(ve *)
-.25 H(\)).15 E()36 60 Q (The currently supported options are:)0 72 Q 0 Cg EP %%Page: 50 50 %%BeginPageSetup BP %%EndPageSetup /F0 10/Times-Roman@@0 SF(
NULL.)0 36 Q(FILE *)0
36 Q(pointer)0 48 Q(.)-.55 E
(This function should not be used with tape dri)0 60 Q -.15(ve)-.25 G
2.5(so).15 G 2.5(ro)-2.5 G(ther de)-2.5 E(vices)-.25 E
(that require strict I/O blocking.)0 72 Q 0 Cg EP
%%Page: 56 56
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(v)0 72 Q(oid,)-.2 E 0 Cg EP
%%Page: 76 76
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF
(which made it impossible to detect certain errors when)0 12 Q(archi)
0 24 Q -.15(ve)-.25 G(_read_close\()36 72 Q 0 Cg EP %%Page: 77 77 %%BeginPageSetup BP %%EndPageSetup /F0 10/Times-Roman@@0 SF (Note that the library determines most of the rele)0 12 Q -.25(va)-.25 G (nt information about).25 E(the archi)0 24 Q .3 -.15(ve b)-.25 H 2.5(yi) .15 G(nspection.)-2.5 E(In particular)0 36 Q 2.5(,i)-.4 G 2.5(ta)-2.5 G (utomatically detects)-2.5 E(gzip\(1\)) 0 48 Q(or)0 60 Q(bzip2\(1\))0 72 Q 0 Cg EP %%Page: 78 78 %%BeginPageSetup BP %%EndPageSetup /F0 10/Times-Roman@@0 SF (compression and transparently performs the appropriate decompression.)0 12 Q(It also automatically detects the archi)0 24 Q .3 -.15(ve f)-.25 H (ormat.).15 E(
)36 36 Q 2.5(Ac)0 48 S(omplete description of the)-2.5
E(struct \
archi)0 60 Q -.15(ve)-.25 G().15 E(and)0 72 Q 0 Cg EP
%%Page: 79 79
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(struct archi)0 12 Q -.15(ve)-.25 G(_entry).15 E
(objects can be found in the o)0 24 Q -.15(ve)-.15 G(rvie).15 E 2.5(wm)
-.25 G(anual page for)-2.5 E(libarchi).15 E -.15(ve)-.25 G(\(3\).).15 E
( )36 72 Q 0 Cg EP
%%Page: 84 84
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(The open callback is in)0 12 Q -.2(vo)-.4 G -.1
(ke).2 G 2.5(db).1 G(y)-2.5 E(archi)0 24 Q -.15(ve)-.25 G
(_open\( )36
60 Q(The read callback is in)0 72 Q -.2(vo)-.4 G -.1(ke).2 G 2.5(dw).1 G
(hene)-2.5 E -.15(ve)-.25 G 2.5(rt).15 G(he library)-2.5 E 0 Cg EP
%%Page: 86 86
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(requires ra)0 12 Q 2.5(wb)-.15 G
(ytes from the archi)-2.5 E -.15(ve)-.25 G(.).15 E
(The read callback should read data into a b)0 24 Q(uf)-.2 E(fer)-.25 E
(,)-.4 E(set the)0 36 Q( )36 60
Q(The skip callback is in)0 72 Q -.2(vo)-.4 G -.1(ke).2 G 2.5(dw).1 G
(hen the)-2.5 E 0 Cg EP
%%Page: 89 89
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(library w)0 12 Q
(ants to ignore a block of data.)-.1 E(The return v)0 24 Q
(alue is the number of bytes actually)-.25 E(skipped, which may dif)0 36
Q(fer from the request.)-.25 E
(If the callback cannot skip data, it should return)0 48 Q(zero.)0 60 Q
(If the skip callback is not pro)0 72 Q(vided \(the)-.15 E 0 Cg EP
%%Page: 90 90
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(function pointer is)0 12 Q
( )36 36 Q(The close callback is in)0 48 Q -.2(vo)-.4 G -.1(ke).2 G
2.5(db).1 G 2.5(ya)-2.5 G(rchi)-2.5 E -.15(ve)-.25 G(_close when).15 E
(the archi)0 60 Q .3 -.15(ve p)-.25 H(rocessing is complete.).15 E
(The callback should return)0 72 Q 0 Cg EP
%%Page: 92 92
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(ARCHIVE_OK)0 12 Q(on success.)0 24
Q(On f)0 36 Q(ailure, the callback should in)-.1 E -.2(vo)-.4 G -.1(ke)
.2 G(archi)0 48 Q -.15(ve)-.25 G(_set_error\( )36 48 Q
(mydata = malloc\(sizeof\(struct mydata\)\);)5 60 Q 2.5(a=a)5 72 S(rchi)
-2.5 E -.15(ve)-.25 G(_read_ne).15 E(w\(\);)-.25 E 0 Cg EP
%%Page: 97 97
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(mydata->name = name;)5 12 Q(archi)5 24 Q -.15
(ve)-.25 G(_read_support_compression_all\(a\);).15 E(archi)5 36 Q -.15
(ve)-.25 G(_read_support_format_all\(a\);).15 E(archi)5 48 Q -.15(ve)
-.25 G(_read_open\(a, mydata, myopen, myread, myclose\);).15 E
(while \(archi)5 60 Q -.15(ve)-.25 G(_read_ne).15 E
(xt_header\(a, &entry\) == ARCHIVE_OK\) {)-.15 E(printf\("%s\\n",archi)
10 72 Q -.15(ve)-.25 G(_entry_pathname\(entry\)\);).15 E 0 Cg EP
%%Page: 98 98
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(archi)10 12 Q -.15(ve)-.25 G
(_read_data_skip\(a\);).15 E(})5 24 Q(archi)5 36 Q -.15(ve)-.25 G
(_read_\214nish\(a\);).15 E(free\(mydata\);)5 48 Q(})0 60 Q( )36 72 Q
0 Cg EP
%%Page: 99 99
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(ssize_t)0 12 Q(myread\(struct archi)0 24 Q .3
-.15(ve *)-.25 H(a, v).15 E(oid *client_data, const v)-.2 E(oid **b)-.2
E(uf)-.2 E(f\))-.25 E({)0 36 Q(struct mydata *mydata = client_data;)5 48
Q( )36 60 Q(*b)5 72 Q(uf)-.2 E 2.5(f=m)-.25 G(ydata->b)-2.5 E(uf)-.2 E
(f;)-.25 E 0 Cg EP
%%Page: 100 100
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(return \(read\(mydata->fd, mydata->b)5 12 Q(uf)
-.2 E(f, 10240\)\);)-.25 E(})0 24 Q( )36 36 Q(int)0 48 Q
(myopen\(struct archi)0 60 Q .3 -.15(ve *)-.25 H(a, v).15 E
(oid *client_data\))-.2 E({)0 72 Q 0 Cg EP
%%Page: 101 101
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(struct mydata *mydata = client_data;)5 12 Q( )
36 24 Q(mydata->fd = open\(mydata->name, O_RDONL)5 36 Q(Y\);)-1 E
(return \(mydata->fd >= 0 ? ARCHIVE_OK : ARCHIVE_F)5 48 Q -1.21 -1.11
(AT A)-.74 H(L\);)1.11 E(})0 60 Q( )36 72 Q 0 Cg EP
%%Page: 102 102
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(int)0 12 Q(myclose\(struct archi)0 24 Q .3 -.15
(ve *)-.25 H(a, v).15 E(oid *client_data\))-.2 E({)0 36 Q
(struct mydata *mydata = client_data;)5 48 Q( )36 60 Q
(if \(mydata->fd > 0\))5 72 Q 0 Cg EP
%%Page: 103 103
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(close\(mydata->fd\);)10 12 Q
(return \(ARCHIVE_OK\);)5 24 Q(})0 36 Q( )36 48 Q
(archi)0 60 Q -.15(ve)-.25 G(_read_ne).15 E(w\( )36 72 Q 0 Cg EP
%%Page: 109 109
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(archi)0 12 Q -.15(ve)-.25 G
(_read_data\( )36 12 Q(The library e)0 24 Q
(xpects the client callbacks to beha)-.15 E .3 -.15(ve s)-.2 H(imilarly)
.15 E(.)-.65 E(If there is an error)0 36 Q 2.5(,y)-.4 G(ou can use)-2.5
E(archi)0 48 Q -.15(ve)-.25 G(_set_error\( )36 72 Q 0 Cg EP
%%Page: 116 116
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(The)0 12 Q(libarchi)0 24 Q -.15(ve)-.25 G
().15 E(library w)0 36 Q(as written by)-.1 E -.35(Ti)0 48 S 2.5(mK)
.35 G(ientzle <kientzle@@acm.or)-2.5 E(g>.)-.18 E( archive_read(3) FreeBSD Library Functions
Manual archive_read(3) NAME archive_read_new,
archive_read_set_filter_options,
archive_read_set_format_options,
archive_read_set_options,
archive_read_support_compression_all,
archive_read_support_compression_bzip2,
archive_read_support_compression_compress,
archive_read_support_compression_gzip,
archive_read_support_compression_lzma,
archive_read_support_compression_none,
archive_read_support_compression_xz,
archive_read_support_compression_program,
archive_read_support_compression_program_signature,
archive_read_support_format_all,
archive_read_support_format_ar,
archive_read_support_format_cpio,
archive_read_support_format_empty,
archive_read_support_format_iso9660,
archive_read_support_format_mtree,
archive_read_support_format_raw,
archive_read_support_format_tar,
archive_read_support_format_zip,
archive_read_open, archive_read_open2,
archive_read_open_fd, archive_read_open_FILE,
archive_read_open_filename,
archive_read_open_memory,
archive_read_next_header,
archive_read_next_header2, archive_read_data,
archive_read_data_block,
archive_read_data_skip,
archive_read_data_into_buffer,
archive_read_data_into_fd,
archive_read_extract, archive_read_extract2,
archive_read_extract_set_progress_callback,
archive_read_close, archive_read_finish
— functions for reading streaming archives SYNOPSIS #include
<archive.h> struct
archive * archive_read_new(void); int archive_read_support_compression_all(struct archive *); int archive_read_support_compression_bzip2(struct archive *); int archive_read_support_compression_compress(struct archive *); int archive_read_support_compression_gzip(struct archive *); int archive_read_support_compression_lzma(struct archive *); int archive_read_support_compression_none(struct archive *); int archive_read_support_compression_xz(struct archive *); int archive_read_support_compression_program(struct archive *,
const char *cmd); int archive_read_support_compression_program_signature(struct archive *,
const char *cmd,
const void *signature,
size_t signature_length); int archive_read_support_format_all(struct archive *); int archive_read_support_format_ar(struct archive *); int archive_read_support_format_cpio(struct archive *); int archive_read_support_format_empty(struct archive *); int archive_read_support_format_iso9660(struct archive *); int archive_read_support_format_mtree(struct archive *); int archive_read_support_format_raw(struct archive *); int archive_read_support_format_tar(struct archive *); int archive_read_support_format_zip(struct archive *); int archive_read_set_filter_options(struct archive *,
const char *); int archive_read_set_format_options(struct archive *,
const char *); int archive_read_set_options(struct archive *,
const char *); int archive_read_open(struct archive *,
void *client_data,
archive_open_callback *,
archive_read_callback *,
archive_close_callback *); int archive_read_open2(struct archive *,
void *client_data,
archive_open_callback *,
archive_read_callback *,
archive_skip_callback *,
archive_close_callback *); int archive_read_open_FILE(struct archive *,
FILE *file); int archive_read_open_fd(struct archive *,
int fd, size_t block_size); int archive_read_open_filename(struct archive *,
const char *filename,
size_t block_size); int archive_read_open_memory(struct archive *,
void *buff, size_t size); int archive_read_next_header(struct archive *,
struct archive_entry **); int archive_read_next_header2(struct archive *,
struct archive_entry *); ssize_t archive_read_data(struct archive *,
void *buff, size_t len); int archive_read_data_block(struct archive *,
const void **buff, size_t *len,
off_t *offset); int archive_read_data_skip(struct archive *); int archive_read_data_into_buffer(struct archive *,
void *, ssize_t len); int archive_read_data_into_fd(struct archive *,
int fd); int archive_read_extract(struct archive *,
struct archive_entry *,
int flags); int archive_read_extract2(struct archive *src,
struct archive_entry *,
struct archive *dest); void archive_read_extract_set_progress_callback(struct archive *,
void (*func)(void *),
void *user_data); int archive_read_close(struct archive *); int archive_read_finish(struct archive *); DESCRIPTION These functions provide a
complete API for reading streaming archives. The general
process is to first create the struct archive object, set
options, initialize the reader, iterate over the archive
headers and associated data, then close the archive and
release all resources. The following summary describes the
functions in approximately the order they would be used: archive_read_new() Allocates and initializes a
struct archive object suitable for reading from an
archive. archive_read_support_compression_bzip2(),
archive_read_support_compression_compress(),
archive_read_support_compression_gzip(),
archive_read_support_compression_lzma(),
archive_read_support_compression_none(),
archive_read_support_compression_xz() Enables auto-detection code and
decompression support for the specified compression. Returns
ARCHIVE_OK if the compression is fully supported, or
ARCHIVE_WARN if the compression is supported only
through an external program. Note that decompression using
an external program is usually slower than decompression
through built-in libraries. Note that
‘‘none’’ is always enabled by
default. archive_read_support_compression_all() Enables all available
decompression filters. archive_read_support_compression_program() Data is fed through the
specified external program before being dearchived. Note
that this disables automatic detection of the compression
format, so it makes no sense to specify this in conjunction
with any other decompression option. archive_read_support_compression_program_signature() This feeds data through the
specified external program but only if the initial bytes of
the data match the specified signature value. archive_read_support_format_all(),
archive_read_support_format_ar(),
archive_read_support_format_cpio(),
archive_read_support_format_empty(),
archive_read_support_format_iso9660(),
archive_read_support_format_mtree(),
archive_read_support_format_tar(),
archive_read_support_format_zip() Enables support---including
auto-detection code---for the specified archive format. For
example, archive_read_support_format_tar() enables
support for a variety of standard tar formats, old-style
tar, ustar, pax interchange format, and many common
variants. For convenience,
archive_read_support_format_all() enables support for
all available formats. Only empty archives are supported by
default. archive_read_support_format_raw() The
‘‘raw’’ format handler allows
libarchive to be used to read arbitrary data. It treats any
data stream as an archive with a single entry. The pathname
of this entry is ‘‘data’’; all other
entry fields are unset. This is not enabled by
archive_read_support_format_all() in order to avoid
erroneous handling of damaged archives. archive_read_set_filter_options(),
archive_read_set_format_options(),
archive_read_set_options() Specifies options that will be
passed to currently-registered filters (including
decompression filters) and/or format readers. The argument
is a comma-separated list of individual options. Individual
options have one of the following forms: option=value The option/value pair will be
provided to every module. Modules that do not accept an
option with this name will ignore it. option The option will
be provided to every module with a value of
‘‘1’’. !option The option will be provided to
every module with a NULL value. module:option=value,
module:option, module:!option As above, but the corresponding
option and value will be provided only to modules whose name
matches module. The return value will be
ARCHIVE_OK if any module accepts the option, or
ARCHIVE_WARN if no module accepted the option, or
ARCHIVE_FATAL if there was a fatal error while
attempting to process the option. The currently
supported options are: Format iso9660 Support Joliet
extensions. Defaults to enabled, use !joliet to
disable. archive_read_open() The same as
archive_read_open2(), except that the skip callback
is assumed to be NULL. archive_read_open2() Freeze the settings, open the
archive, and prepare for reading entries. This is the most
generic version of this call, which accepts four callback
functions. Most clients will want to use
archive_read_open_filename(),
archive_read_open_FILE(),
archive_read_open_fd(), or
archive_read_open_memory() instead. The library
invokes the client-provided functions to obtain raw bytes
from the archive. archive_read_open_FILE() Like
archive_read_open(), except that it accepts a FILE
* pointer. This function should not be used with tape
drives or other devices that require strict I/O
blocking. archive_read_open_fd() Like
archive_read_open(), except that it accepts a file
descriptor and block size rather than a set of function
pointers. Note that the file descriptor will not be
automatically closed at end-of-archive. This function is
safe for use with tape drives or other blocked devices. archive_read_open_file() This is a deprecated synonym
for archive_read_open_filename(). archive_read_open_filename() Like
archive_read_open(), except that it accepts a simple
filename and a block size. A NULL filename represents
standard input. This function is safe for use with tape
drives or other blocked devices. archive_read_open_memory() Like
archive_read_open(), except that it accepts a pointer
and size of a block of memory containing the archive
data. archive_read_next_header() Read the header for the next
entry and return a pointer to a struct archive_entry. This
is a convenience wrapper around
archive_read_next_header2() that reuses an internal
struct archive_entry object for each request. archive_read_next_header2() Read the header for the next
entry and populate the provided struct archive_entry. archive_read_data() Read data associated with the
header just read. Internally, this is a convenience function
that calls archive_read_data_block() and fills any
gaps with nulls so that callers see a single continuous
stream of data. archive_read_data_block() Return the next available block
of data for this entry. Unlike archive_read_data(),
the archive_read_data_block() function avoids copying
data and allows you to correctly handle sparse files, as
supported by some archive formats. The library guarantees
that offsets will increase and that blocks will not overlap.
Note that the blocks returned from this function can be much
larger than the block size read from disk, due to
compression and internal buffer optimizations. archive_read_data_skip() A convenience function that
repeatedly calls archive_read_data_block() to skip
all of the data for this archive entry. archive_read_data_into_buffer() This function is deprecated and
will be removed. Use archive_read_data() instead. archive_read_data_into_fd() A convenience function that
repeatedly calls archive_read_data_block() to copy
the entire entry to the provided file descriptor. archive_read_extract(),
archive_read_extract_set_skip_file() A convenience function that
wraps the corresponding archive_write_disk(3) interfaces.
The first call to archive_read_extract() creates a
restore object using archive_write_disk_new(3) and
archive_write_disk_set_standard_lookup(3), then
transparently invokes archive_write_disk_set_options(3),
archive_write_header(3), archive_write_data(3), and
archive_write_finish_entry(3) to create the entry on disk
and copy data into it. The flags argument is passed
unmodified to archive_write_disk_set_options(3). archive_read_extract2() This is another version of
archive_read_extract() that allows you to provide
your own restore object. In particular, this allows you to
override the standard lookup functions using
archive_write_disk_set_group_lookup(3), and
archive_write_disk_set_user_lookup(3). Note that
archive_read_extract2() does not accept a
flags argument; you should use
archive_write_disk_set_options() to set the restore
options yourself. archive_read_extract_set_progress_callback() Sets a pointer to a
user-defined callback that can be used for updating progress
displays during extraction. The progress function will be
invoked during the extraction of large regular files. The
progress function will be invoked with the pointer provided
to this call. Generally, the data pointed to should include
a reference to the archive object and the archive_entry
object so that various statistics can be retrieved for the
progress display. archive_read_close() Complete the archive and invoke
the close callback. archive_read_finish() Invokes
archive_read_close() if it was not invoked manually,
then release all resources. Note: In libarchive 1.x, this
function was declared to return void, which made it
impossible to detect certain errors when
archive_read_close() was invoked implicitly from this
function. The declaration is corrected beginning with
libarchive 2.0. Note that the
library determines most of the relevant information about
the archive by inspection. In particular, it automatically
detects gzip(1) or bzip2(1) compression and transparently
performs the appropriate decompression. It also
automatically detects the archive format. A complete
description of the struct archive and struct archive_entry
objects can be found in the overview manual page for
libarchive(3). CLIENT
CALLBACKS The callback functions must
match the following prototypes: typedef
ssize_t archive_read_callback(struct archive *,
void *client_data,
const void **buffer) typedef
int archive_skip_callback(struct archive *,
void *client_data,
size_t request) typedef
int archive_open_callback(struct archive
*, void *client_data) typedef
int archive_close_callback(struct archive
*, void *client_data) The open
callback is invoked by archive_open(). It should
return ARCHIVE_OK if the underlying file or data
source is successfully opened. If the open fails, it should
call archive_set_error() to register an error code
and message and return ARCHIVE_FATAL. The read
callback is invoked whenever the library requires raw bytes
from the archive. The read callback should read data into a
buffer, set the const void **buffer argument to point to the
available data, and return a count of the number of bytes
available. The library will invoke the read callback again
only after it has consumed this data. The library imposes no
constraints on the size of the data blocks returned. On
end-of-file, the read callback should return zero. On error,
the read callback should invoke archive_set_error()
to register an error code and message and return -1. The skip
callback is invoked when the library wants to ignore a block
of data. The return value is the number of bytes actually
skipped, which may differ from the request. If the callback
cannot skip data, it should return zero. If the skip
callback is not provided (the function pointer is NULL ),
the library will invoke the read function instead and simply
discard the result. A skip callback can provide significant
performance gains when reading uncompressed archives from
slow disk drives or other media that can skip quickly. The close
callback is invoked by archive_close when the archive
processing is complete. The callback should return
ARCHIVE_OK on success. On failure, the callback
should invoke archive_set_error() to register an
error code and message and return ARCHIVE_FATAL. EXAMPLE The following illustrates basic
usage of the library. In this example, the callback
functions are simply wrappers around the standard open(2),
read(2), and close(2) system calls. void mydata =
malloc(sizeof(struct mydata)); ssize_t *buff =
mydata->buff; int mydata->fd =
open(mydata->name, O_RDONLY); int if
(mydata->fd > 0) RETURN
VALUES Most functions return zero on
success, non-zero on error. The possible return codes
include: ARCHIVE_OK (the operation succeeded),
ARCHIVE_WARN (the operation succeeded but a
non-critical error was encountered), ARCHIVE_EOF
(end-of-archive was encountered), ARCHIVE_RETRY (the
operation failed but can be retried), and
ARCHIVE_FATAL (there was a fatal error; the archive
should be closed immediately). Detailed error codes and
textual descriptions are available from the
archive_errno() and archive_error_string()
functions. archive_read_new()
returns a pointer to a freshly allocated struct archive
object. It returns NULL on error. archive_read_data()
returns a count of bytes actually read or zero at the end of
the entry. On error, a value of ARCHIVE_FATAL,
ARCHIVE_WARN, or ARCHIVE_RETRY is returned and
an error code and textual description can be retrieved from
the archive_errno() and archive_error_string()
functions. The library
expects the client callbacks to behave similarly. If there
is an error, you can use archive_set_error() to set
an appropriate error code and description, then return one
of the non-zero values above. (Note that the value
eventually returned to the client may not be the same; many
errors that are not critical at the level of basic I/O can
prevent the archive from being properly read, thus most I/O
errors eventually cause ARCHIVE_FATAL to be
returned.) SEE ALSO tar(1), archive(3),
archive_util(3), tar(5) HISTORY The libarchive library
first appeared in FreeBSD 5.3. AUTHORS The libarchive library
was written by Tim Kientzle
⟨kientzle@@acm.org⟩. BUGS Many traditional archiver
programs treat empty files as valid empty archives. For
example, many implementations of tar(1) allow you to append
entries to an empty file. Of course, it is impossible to
determine the format of an empty file by inspecting the
contents, so this library treats empty files as having a
special ‘‘empty’’ format. FreeBSD 9.0
April 13, 2009 FreeBSD 9.0 )36 60 Q
(The currently supported options are:)0 72 Q 0 Cg EP
%%Page: 50 50
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF( )36 72 Q 0 Cg EP
%%Page: 77 77
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF
(Note that the library determines most of the rele)0 12 Q -.25(va)-.25 G
(nt information about).25 E(the archi)0 24 Q .3 -.15(ve b)-.25 H 2.5(yi)
.15 G(nspection.)-2.5 E(In particular)0 36 Q 2.5(,i)-.4 G 2.5(ta)-2.5 G
(utomatically detects)-2.5 E(gzip\(1\))
0 48 Q(or)0 60 Q(bzip2\(1\))0 72 Q 0
Cg EP
%%Page: 78 78
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF
(compression and transparently performs the appropriate decompression.)0
12 Q(It also automatically detects the archi)0 24 Q .3 -.15(ve f)-.25 H
(ormat.).15 E( )36 36 Q 2.5(Ac)0 48 S(omplete description of the)-2.5
E(struct \
archi)0 60 Q -.15(ve)-.25 G().15 E(and)0 72 Q 0 Cg EP
%%Page: 79 79
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(struct archi)0 12 Q -.15(ve)-.25 G(_entry).15 E
(objects can be found in the o)0 24 Q -.15(ve)-.15 G(rvie).15 E 2.5(wm)
-.25 G(anual page for)-2.5 E(libarchi).15 E -.15(ve)-.25 G(\(3\).).15 E
( )36 72 Q 0 Cg EP
%%Page: 84 84
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(The open callback is in)0 12 Q -.2(vo)-.4 G -.1
(ke).2 G 2.5(db).1 G(y)-2.5 E(archi)0 24 Q -.15(ve)-.25 G
(_open\( )36
60 Q(The read callback is in)0 72 Q -.2(vo)-.4 G -.1(ke).2 G 2.5(dw).1 G
(hene)-2.5 E -.15(ve)-.25 G 2.5(rt).15 G(he library)-2.5 E 0 Cg EP
%%Page: 86 86
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(requires ra)0 12 Q 2.5(wb)-.15 G
(ytes from the archi)-2.5 E -.15(ve)-.25 G(.).15 E
(The read callback should read data into a b)0 24 Q(uf)-.2 E(fer)-.25 E
(,)-.4 E(set the)0 36 Q( )36 60
Q(The skip callback is in)0 72 Q -.2(vo)-.4 G -.1(ke).2 G 2.5(dw).1 G
(hen the)-2.5 E 0 Cg EP
%%Page: 89 89
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(library w)0 12 Q
(ants to ignore a block of data.)-.1 E(The return v)0 24 Q
(alue is the number of bytes actually)-.25 E(skipped, which may dif)0 36
Q(fer from the request.)-.25 E
(If the callback cannot skip data, it should return)0 48 Q(zero.)0 60 Q
(If the skip callback is not pro)0 72 Q(vided \(the)-.15 E 0 Cg EP
%%Page: 90 90
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(function pointer is)0 12 Q
( )36 36 Q(The close callback is in)0 48 Q -.2(vo)-.4 G -.1(ke).2 G
2.5(db).1 G 2.5(ya)-2.5 G(rchi)-2.5 E -.15(ve)-.25 G(_close when).15 E
(the archi)0 60 Q .3 -.15(ve p)-.25 H(rocessing is complete.).15 E
(The callback should return)0 72 Q 0 Cg EP
%%Page: 92 92
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(ARCHIVE_OK)0 12 Q(on success.)0 24
Q(On f)0 36 Q(ailure, the callback should in)-.1 E -.2(vo)-.4 G -.1(ke)
.2 G(archi)0 48 Q -.15(ve)-.25 G(_set_error\( )36 48 Q
(mydata = malloc\(sizeof\(struct mydata\)\);)5 60 Q 2.5(a=a)5 72 S(rchi)
-2.5 E -.15(ve)-.25 G(_read_ne).15 E(w\(\);)-.25 E 0 Cg EP
%%Page: 97 97
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(mydata->name = name;)5 12 Q(archi)5 24 Q -.15
(ve)-.25 G(_read_support_compression_all\(a\);).15 E(archi)5 36 Q -.15
(ve)-.25 G(_read_support_format_all\(a\);).15 E(archi)5 48 Q -.15(ve)
-.25 G(_read_open\(a, mydata, myopen, myread, myclose\);).15 E
(while \(archi)5 60 Q -.15(ve)-.25 G(_read_ne).15 E
(xt_header\(a, &entry\) == ARCHIVE_OK\) {)-.15 E(printf\("%s\\n",archi)
10 72 Q -.15(ve)-.25 G(_entry_pathname\(entry\)\);).15 E 0 Cg EP
%%Page: 98 98
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(archi)10 12 Q -.15(ve)-.25 G
(_read_data_skip\(a\);).15 E(})5 24 Q(archi)5 36 Q -.15(ve)-.25 G
(_read_\214nish\(a\);).15 E(free\(mydata\);)5 48 Q(})0 60 Q( )36 72 Q
0 Cg EP
%%Page: 99 99
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(ssize_t)0 12 Q(myread\(struct archi)0 24 Q .3
-.15(ve *)-.25 H(a, v).15 E(oid *client_data, const v)-.2 E(oid **b)-.2
E(uf)-.2 E(f\))-.25 E({)0 36 Q(struct mydata *mydata = client_data;)5 48
Q( )36 60 Q(*b)5 72 Q(uf)-.2 E 2.5(f=m)-.25 G(ydata->b)-2.5 E(uf)-.2 E
(f;)-.25 E 0 Cg EP
%%Page: 100 100
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(return \(read\(mydata->fd, mydata->b)5 12 Q(uf)
-.2 E(f, 10240\)\);)-.25 E(})0 24 Q( )36 36 Q(int)0 48 Q
(myopen\(struct archi)0 60 Q .3 -.15(ve *)-.25 H(a, v).15 E
(oid *client_data\))-.2 E({)0 72 Q 0 Cg EP
%%Page: 101 101
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(struct mydata *mydata = client_data;)5 12 Q( )
36 24 Q(mydata->fd = open\(mydata->name, O_RDONL)5 36 Q(Y\);)-1 E
(return \(mydata->fd >= 0 ? ARCHIVE_OK : ARCHIVE_F)5 48 Q -1.21 -1.11
(AT A)-.74 H(L\);)1.11 E(})0 60 Q( )36 72 Q 0 Cg EP
%%Page: 102 102
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(int)0 12 Q(myclose\(struct archi)0 24 Q .3 -.15
(ve *)-.25 H(a, v).15 E(oid *client_data\))-.2 E({)0 36 Q
(struct mydata *mydata = client_data;)5 48 Q( )36 60 Q
(if \(mydata->fd > 0\))5 72 Q 0 Cg EP
%%Page: 103 103
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(close\(mydata->fd\);)10 12 Q
(return \(ARCHIVE_OK\);)5 24 Q(})0 36 Q( )36 48 Q
(archi)0 60 Q -.15(ve)-.25 G(_read_ne).15 E(w\( )36 72 Q 0 Cg EP
%%Page: 109 109
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(archi)0 12 Q -.15(ve)-.25 G
(_read_data\( )36 12 Q(The library e)0 24 Q
(xpects the client callbacks to beha)-.15 E .3 -.15(ve s)-.2 H(imilarly)
.15 E(.)-.65 E(If there is an error)0 36 Q 2.5(,y)-.4 G(ou can use)-2.5
E(archi)0 48 Q -.15(ve)-.25 G(_set_error\( )36 72 Q 0 Cg EP
%%Page: 116 116
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(The)0 12 Q(libarchi)0 24 Q -.15(ve)-.25 G
().15 E(library w)0 36 Q(as written by)-.1 E -.35(Ti)0 48 S 2.5(mK)
.35 G(ientzle <kientzle@@acm.or)-2.5 E(g>.)-.18 E( ARCHIVE_READ(3) BSD Library Functions Manual
ARCHIVE_READ(3) NAME archive_read —
functions for reading streaming archives LIBRARY Streaming Archive Library
(libarchive, -larchive) SYNOPSIS #include
<archive.h> DESCRIPTION These functions provide a
complete API for reading streaming archives. The general
process is to first create the struct archive object, set
options, initialize the reader, iterate over the archive
headers and associated data, then close the archive and
release all resources. Create
archive object To read an
archive, you must first obtain an initialized struct archive
object from archive_read_new(). Enable
filters and formats You can then
modify this object for the desired operations with the
various archive_read_set_XXX() and
archive_read_support_XXX() functions. In particular,
you will need to invoke appropriate
archive_read_support_XXX() functions to enable the
corresponding compression and format support. Note that
these latter functions perform two distinct operations: they
cause the corresponding support code to be linked into your
program, and they enable the corresponding auto-detect code.
Unless you have specific constraints, you will generally
want to invoke archive_read_support_filter_all() and
archive_read_support_format_all() to enable
auto-detect for all formats and compression types currently
supported by the library. Set
options Open
archive Once you have
prepared the struct archive object, you call
archive_read_open() to actually open the archive and
prepare it for reading. There are several variants of this
function; the most basic expects you to provide pointers to
several functions that can provide blocks of bytes from the
archive. There are convenience forms that allow you to
specify a filename, file descriptor, FILE * object,
or a block of memory from which to read the archive data.
Note that the core library makes no assumptions about the
size of the blocks read; callback functions are free to read
whatever block size is most appropriate for the medium. Consume
archive Each archive
entry consists of a header followed by a certain amount of
data. You can obtain the next header with
archive_read_next_header(), which returns a pointer
to an struct archive_entry structure with information about
the current archive element. If the entry is a regular file,
then the header will be followed by the file data. You can
use archive_read_data() (which works much like the
read(2) system call) to read this data from the archive, or
archive_read_data_block() which provides a slightly
more efficient interface. You may prefer to use the
higher-level archive_read_data_skip(), which reads
and discards the data for this entry,
archive_read_data_into_fd(), which copies the data to
the provided file descriptor, or
archive_read_extract(), which recreates the specified
entry on disk and copies data from the archive. In
particular, note that archive_read_extract() uses the
struct archive_entry structure that you provide it, which
may differ from the entry just read from the archive. In
particular, many applications will want to override the
pathname, file permissions, or ownership. Release
resources Once you have
finished reading data from the archive, you should call
archive_read_close() to close the archive, then call
archive_read_free() to release all resources,
including all memory allocated by the library. EXAMPLE The following illustrates basic
usage of the library. In this example, the callback
functions are simply wrappers around the standard open(2),
read(2), and close(2) system calls. void mydata =
malloc(sizeof(struct mydata)); la_ssize_t *buff =
mydata->buff; int mydata->fd =
open(mydata->name, O_RDONLY); int if
(mydata->fd > 0) SEE ALSO tar(1), libarchive(3),
archive_read_new(3), archive_read_data(3),
archive_read_extract(3), archive_read_filter(3),
archive_read_format(3), archive_read_header(3),
archive_read_open(3), archive_read_set_options(3),
archive_util(3), tar(5) HISTORY The libarchive library
first appeared in FreeBSD 5.3. AUTHORS The libarchive library
was written by Tim Kientzle <kientzle@@acm.org>. BUGS Many traditional archiver
programs treat empty files as valid empty archives. For
example, many implementations of tar(1) allow you to append
entries to an empty file. Of course, it is impossible to
determine the format of an empty file by inspecting the
contents, so this library treats empty files as having a
special ’’empty’’ format. BSD
February 2, 2012 BSD EXAMPLES tar(1), archive_read_data(3),
d206 2
a207 3
archive_read_new(3), archive_read_open(3),
archive_read_set_options(3), archive_util(3), libarchive(3),
tar(5) ARCHIVE_READ(3) Library Functions Manual
ARCHIVE_READ(3) archive_read — functions
for reading streaming archives Streaming Archive Library
d38 1
a38 1
#include
d43 1
a43 1
These functions provide a
d50 3
a52 2
Create
archive object See
archive_read_new(3). To read an
d58 3
a60 6
Enable
filters and formats See
archive_read_filter(3) and
archive_read_format(3). You can then
d78 7
a84 8
Set
options See
archive_read_set_options(3). Open
archive See
archive_read_open(3). Once you have
d99 4
a102 6
Consume
archive See
archive_read_header(3), archive_read_data(3)
and archive_read_extract(3). Each archive
d112 5
a116 5
read(2) system call) to read this data from the
archive, or archive_read_data_block() which provides
a slightly more efficient interface. You may prefer to use
the higher-level archive_read_data_skip(), which
reads and discards the data for this entry,
d127 3
a129 2
Release
resources See
archive_read_free(3). Once you have
d139 1
a139 1
The following illustrates basic
d141 2
a142 3
functions are simply wrappers around the standard
open(2), read(2), and close(2) system
calls. void mydata =
d167 1
a167 1
la_ssize_t *buff =
d178 1
a178 1
int mydata->fd =
d189 1
a189 1
int if
d202 6
a207 8
tar(1),
archive_read_data(3), archive_read_extract(3),
archive_read_filter(3),
archive_read_format(3),
archive_read_header(3), archive_read_new(3),
archive_read_open(3),
archive_read_set_options(3), archive_util(3),
libarchive(3), tar(5) The libarchive library
d216 1
a216 1
The libarchive library
d221 1
a221 1
Many traditional archiver
d223 3
a225 3
example, many implementations of tar(1) allow you to
append entries to an empty file. Of course, it is impossible
to determine the format of an empty file by inspecting the
d227 4
a230 2
special “empty” format. Debian February 2, 2012
ARCHIVE_READ(3)).4 E(CLIENT CALLB)36 60
Q -.4(AC)-.35 G(KS).4 E(
)36 72 Q 0 Cg EP
%%Page: 80 80
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(The callback functions must match the follo)0 12
Q(wing prototypes:)-.25 E()0 24 Q(
)0 60 Q(typedef ssize_t)0 48 Q
(archi)0 60 Q -.15(ve)-.25 G(_read_callback\().15 E
(struct archi)0 72 Q .3 -.15(ve *)-.25 H().15
E 0 Cg EP
%%Page: 81 81
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(v)0 12 Q
(oid *client_data)-.2 E(const v)0 24 Q
(oid **b)-.2 E(uf)-.2 E(fer)-.25 E(\))0 36 Q(typedef int)0 60 Q
(archi)0 72 Q -.15(ve)-.25 G(_skip_callback\().15 E
0 Cg EP
%%Page: 82 82
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(struct archi)0 12 Q .3 -.15
(ve *)-.25 H().15 E(v)0 24 Q
(oid *client_data)-.2 E(size_t request)
0 36 Q(\))0 48 Q(typedef int)0 72 Q 0 Cg
EP
%%Page: 83 83
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(archi)0 12 Q -.15(ve)-.25 G
(_open_callback\(struct archi).15 E .3 -.15(ve *)
-.25 H(, v).15 E(oid *client_data\))-.2 E(typedef int)0 36 Q
(archi)0 48 Q -.15(ve)-.25 G
(_close_callback\(struct archi).15 E .3 -.15
(ve *)-.25 H(, v).15 E(oid *client_data\))-.2 E
(\).).15 E(It should return)0 36 Q
(ARCHIVE_OK)0 48 Q
(if the underlying \214le or data source is successfully)0 60 Q(opened.)
0 72 Q 0 Cg EP
%%Page: 85 85
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(If the open f)0 12 Q(ails, it should call)-.1 E
(archi)0 24 Q -.15(ve)-.25 G(_set_error\(\)).15 E
(to re)0 36 Q(gister an error code and message and return)-.15 E
(ARCHIVE_F)0 48 Q -1.21 -1.11(AT A)-.74 H(L.)1.11 E(const v)0 48 Q
(oid **b)-.2 E(uf)-.2 E(fer)-.25 E(ar)0 60 Q
(gument to point to the a)-.18 E -.25(va)-.2 G(ilable data, and).25 E
(return a count of the number of bytes a)0 72 Q -.25(va)-.2 G(ilable.)
.25 E 0 Cg EP
%%Page: 87 87
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(The library will in)0 12 Q -.2(vo)-.4 G .2 -.1
(ke t).2 H(he read callback ag).1 E(ain)-.05 E
(only after it has consumed this data.)0 24 Q
(The library imposes no constraints on the size)0 36 Q
(of the data blocks returned.)0 48 Q
(On end-of-\214le, the read callback should)0 60 Q(return zero.)0 72 Q 0
Cg EP
%%Page: 88 88
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(On error)0 12 Q 2.5(,t)-.4 G
(he read callback should in)-2.5 E -.2(vo)-.4 G -.1(ke).2 G(archi)0
24 Q -.15(ve)-.25 G(_set_error\(\)).15 E(to re)0 36 Q
(gister an error code and message and)-.15 E(return -1.)0 48 Q(NULL \),)0 24 Q
(the library will in)0 36 Q -.2(vo)-.4 G .2 -.1(ke t).2 H
(he read function).1 E(instead and simply discard the result.)0 48 Q 2.5
(As)0 60 S(kip callback can pro)-2.5 E(vide signi\214cant)-.15 E
(performance g)0 72 Q(ains when reading uncompressed)-.05 E 0 Cg EP
%%Page: 91 91
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(archi)0 12 Q -.15(ve)-.25 G 2.5(sf).15 G
(rom slo)-2.5 E 2.5(wd)-.25 G(isk dri)-2.5 E -.15(ve)-.25 G 2.5(so).15 G
2.5(ro)-2.5 G(ther media)-2.5 E(that can skip quickly)0 24 Q(.)-.65 E
(\)).15
E(to re)0 60 Q(gister an error code and message and)-.15 E(return)0 72 Q
0 Cg EP
%%Page: 93 93
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(ARCHIVE_F)0 12 Q -1.21 -1.11(AT A)-.74
H(L.)1.11 E()36 24 Q(EXAMPLE)36 36 Q(
)36 48 Q
(The follo)0 60 Q(wing illustrates basic usage of the library)-.25 E(.)
-.65 E(In this e)0 72 Q(xample,)-.15 E 0 Cg EP
%%Page: 94 94
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF
(the callback functions are simply wrappers around the standard)0 12 Q
(open\(2\),)0 24 Q
(read\(2\),)0 36 Q(and)0 48 Q
(close\(2\))0 60 Q(system calls.)0 72
Q 0 Cg EP
%%Page: 95 95
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(
)0 72 Q 0 Cg EP
%%Page: 104 104
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF()0 24 Q()0 60 Q
()
0 36 Q -.2(vo)0 48 S(id).2 E(list_archi)0 60 Q -.15(ve)-.25 G
(\(const char *name\)).15 E({)0 72 Q 0 Cg EP
%%Page: 96 96
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(struct mydata *mydata;)5 12 Q(struct archi)5 24
Q .3 -.15(ve *)-.25 H(a;).15 E(struct archi)5 36 Q -.15(ve)-.25 G
(_entry *entry;).15 E()0 48 Q()-1.35 E
(RETURN V)36 24 Q(ALUES)-1.35 E(
)36 36 Q
(Most functions return zero on success, non-zero on error)0 48 Q(.)-.55
E(The possible return codes include:)0 60 Q(ARCHIVE_OK)0
72 Q 0 Cg EP
%%Page: 105 105
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(\(the operation succeeded\),)0 12 Q
(ARCHIVE_W)0 24 Q(ARN)-1.2 E(\(the operation succeeded b)0
36 Q(ut a non-critical error w)-.2 E(as encountered\),)-.1 E
(ARCHIVE_EOF)0 48 Q(\(end-of-archi)0 60 Q .3 -.15(ve w)
-.25 H(as encountered\),).05 E(ARCHIVE_RETR)0 72 Q(Y)-.65
E 0 Cg EP
%%Page: 106 106
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(\(the operation f)0 12 Q(ailed b)-.1 E
(ut can be retried\),)-.2 E(and)0 24 Q(ARCHIVE_F)0 36 Q -1.21
-1.11(AT A)-.74 H(L)1.11 E(\(there w)0 48 Q(as a f)-.1 E
(atal error; the archi)-.1 E .3 -.15(ve s)-.25 H
(hould be closed immediately\).).15 E(Detailed error codes and te)0 60 Q
(xtual descriptions are a)-.15 E -.25(va)-.2 G(ilable from the).25 E
(archi)0 72 Q -.15(ve)-.25 G(_errno\(\)).15 E 0 Cg
EP
%%Page: 107 107
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(and)0 12 Q(archi)0 24 Q -.15(ve)-.25 G
(_error_string\(\)).15 E(functions.)0 36 Q(\))
-.25 E(returns a pointer to a freshly allocated)0 72 Q 0 Cg EP
%%Page: 108 108
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(struct archi)0 12 Q -.15(ve)-.25 G().15 E(object.)
0 24 Q(It returns)0 36 Q(NULL)0 48 Q(on error)
0 60 Q(.)-.55 E(\)).15 E
(returns a count of bytes actually read or zero at the end of the entry)
0 24 Q(.)-.65 E(On error)0 36 Q 2.5(,av)-.4 G(alue of)-2.75 E
(ARCHIVE_F)0 48 Q -1.21 -1.11(AT A)-.74 H(L,)1.11 E
(ARCHIVE_W)0 60 Q(ARN,)-1.2 E(or)0 72 Q 0 Cg EP
%%Page: 110 110
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(ARCHIVE_RETR)0 12 Q(Y)-.65 E
(is returned and an error code and te)0 24 Q
(xtual description can be retrie)-.15 E -.15(ve)-.25 G 2.5(df).15 G
(rom the)-2.5 E(archi)0 36 Q -.15(ve)-.25 G
(_errno\(\)).15 E(and)0 48 Q(archi)0 60 Q -.15(ve)
-.25 G(_error_string\(\)).15 E(functions.)0 72 Q 0 Cg
EP
%%Page: 111 111
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(\)).15 E
(to set an appropriate error code and description,)0 60 Q
(then return one of the non-zero v)0 72 Q(alues abo)-.25 E -.15(ve)-.15
G(.).15 E 0 Cg EP
%%Page: 112 112
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(\(Note that the v)0 12 Q(alue e)-.25 E -.15(ve)
-.25 G(ntually returned to the client may).15 E(not be the same; man)0
24 Q 2.5(ye)-.15 G(rrors that are not critical at the le)-2.5 E -.15(ve)
-.25 G(l).15 E(of basic I/O can pre)0 36 Q -.15(ve)-.25 G(nt the archi)
.15 E .3 -.15(ve f)-.25 H(rom being properly read,).15 E
(thus most I/O errors e)0 48 Q -.15(ve)-.25 G(ntually cause).15 E
(ARCHIVE_F)0 60 Q -1.21 -1.11(AT A)-.74 H(L)1.11 E
(to be returned.\))0 72 Q 0 Cg EP
%%Page: 113 113
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF()36 12 Q(SEE ALSO)36 24 Q
(
)36 36 Q(tar\(1\),)-.55 E
(archi).15 E -.15
(ve)-.25 G(\(3\),).15 E(archi).15 E -.15(ve)-.25 G(_util\(3\),).15 E 0 Cg EP
%%Page: 114 114
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(tar\(5\))-.55 E()-.65 E
(HIST)36 36 Q(OR)-.18 E(Y)-.65 E(
)36 48 Q(The)0 60 Q(libarchi)0
72 Q -.15(ve)-.25 G().15 E 0 Cg EP
%%Page: 115 115
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(library \214rst appeared in)0 12 Q(FreeBSD5.3.)0
24 Q()-.55 E -.55(AU)36 48 S(THORS).55 E
(
)36 60 Q()-.1 E -.1(BU)36 72 S(GS).1 E 0 Cg EP
%%Page: 117 117
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(
)36 12 Q(Man)0 24 Q 2.5(yt)-.15 G
(raditional archi)-2.5 E -.15(ve)-.25 G 2.5(rp).15 G(rograms treat)-2.5
E(empty \214les as v)0 36 Q(alid empty archi)-.25 E -.15(ve)-.25 G(s.)
.15 E -.15(Fo)0 48 S 2.5(re).15 G(xample, man)-2.65 E 2.5(yi)-.15 G
(mplementations of)-2.5 E(tar\(1\))-.55 E(allo)0 72 Q 2.5(wy)-.25 G
(ou to append entries to an empty \214le.)-2.5 E 0 Cg EP
%%Page: 118 118
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF
(Of course, it is impossible to determine the format of an empty \214le)
0 12 Q
(by inspecting the contents, so this library treats empty \214les as)0
24 Q(ha)0 36 Q(ving a special)-.2 E -.74(``)0 48 S(empty').74 E(')-.74 E
(format.)0 60 Q()0 72 Q 0 Cg EP
%%Trailer
end
%%EOF
@
1.1.1.3
log
@libarchive-2.8.3: Build fix for Linux
@
text
@d1 1509
a1509 820
joliet
list_archive(const char *name)
{
struct mydata *mydata;
struct archive *a;
struct archive_entry *entry;
a = archive_read_new();
mydata->name = name;
archive_read_support_compression_all(a);
archive_read_support_format_all(a);
archive_read_open(a, mydata, myopen, myread, myclose);
while (archive_read_next_header(a, &entry) ==
ARCHIVE_OK) {
printf("%s\n",archive_entry_pathname(entry));
archive_read_data_skip(a);
}
archive_read_finish(a);
free(mydata);
}
myread(struct archive *a, void *client_data, const void
**buff)
{
struct mydata *mydata = client_data;
return (read(mydata->fd, mydata->buff, 10240));
}
myopen(struct archive *a, void *client_data)
{
struct mydata *mydata = client_data;
return (mydata->fd >= 0 ? ARCHIVE_OK : ARCHIVE_FATAL);
}
myclose(struct archive *a, void *client_data)
{
struct mydata *mydata = client_data;
close(mydata->fd);
return (ARCHIVE_OK);
}
@
1.1.1.4
log
@Import libarchive-2.8.4:
- Improved reliability of hash function detection
- Fix issues on ancient FreeBSD, QNX, ancient NetBSD and Minix
@
text
@d1 820
a820 1509
%!PS-Adobe-3.0
%%Creator: groff version 1.19.2
%%CreationDate: Wed Jun 30 11:55:52 2010
%%DocumentNeededResources: font Times-Roman
%%DocumentSuppliedResources: procset grops 1.19 2
%%Pages: 118
%%PageOrder: Ascend
%%DocumentMedia: Default 612 792 0 () ()
%%Orientation: Portrait
%%EndComments
%%BeginDefaults
%%PageMedia: Default
%%EndDefaults
%%BeginProlog
%%BeginResource: procset grops 1.19 2
%!PS-Adobe-3.0 Resource-ProcSet
/setpacking where{
pop
currentpacking
true setpacking
}if
/grops 120 dict dup begin
/SC 32 def
/A/show load def
/B{0 SC 3 -1 roll widthshow}bind def
/C{0 exch ashow}bind def
/D{0 exch 0 SC 5 2 roll awidthshow}bind def
/E{0 rmoveto show}bind def
/F{0 rmoveto 0 SC 3 -1 roll widthshow}bind def
/G{0 rmoveto 0 exch ashow}bind def
/H{0 rmoveto 0 exch 0 SC 5 2 roll awidthshow}bind def
/I{0 exch rmoveto show}bind def
/J{0 exch rmoveto 0 SC 3 -1 roll widthshow}bind def
/K{0 exch rmoveto 0 exch ashow}bind def
/L{0 exch rmoveto 0 exch 0 SC 5 2 roll awidthshow}bind def
/M{rmoveto show}bind def
/N{rmoveto 0 SC 3 -1 roll widthshow}bind def
/O{rmoveto 0 exch ashow}bind def
/P{rmoveto 0 exch 0 SC 5 2 roll awidthshow}bind def
/Q{moveto show}bind def
/R{moveto 0 SC 3 -1 roll widthshow}bind def
/S{moveto 0 exch ashow}bind def
/T{moveto 0 exch 0 SC 5 2 roll awidthshow}bind def
/SF{
findfont exch
[exch dup 0 exch 0 exch neg 0 0]makefont
dup setfont
[exch/setfont cvx]cvx bind def
}bind def
/MF{
findfont
[5 2 roll
0 3 1 roll
neg 0 0]makefont
dup setfont
[exch/setfont cvx]cvx bind def
}bind def
/level0 0 def
/RES 0 def
/PL 0 def
/LS 0 def
/MANUAL{
statusdict begin/manualfeed true store end
}bind def
/PLG{
gsave newpath clippath pathbbox grestore
exch pop add exch pop
}bind def
/BP{
/level0 save def
1 setlinecap
1 setlinejoin
72 RES div dup scale
LS{
90 rotate
}{
0 PL translate
}ifelse
1 -1 scale
}bind def
/EP{
level0 restore
showpage
}def
/DA{
newpath arcn stroke
}bind def
/SN{
transform
.25 sub exch .25 sub exch
round .25 add exch round .25 add exch
itransform
}bind def
/DL{
SN
moveto
SN
lineto stroke
}bind def
/DC{
newpath 0 360 arc closepath
}bind def
/TM matrix def
/DE{
TM currentmatrix pop
translate scale newpath 0 0 .5 0 360 arc closepath
TM setmatrix
}bind def
/RC/rcurveto load def
/RL/rlineto load def
/ST/stroke load def
/MT/moveto load def
/CL/closepath load def
/Fr{
setrgbcolor fill
}bind def
/setcmykcolor where{
pop
/Fk{
setcmykcolor fill
}bind def
}if
/Fg{
setgray fill
}bind def
/FL/fill load def
/LW/setlinewidth load def
/Cr/setrgbcolor load def
/setcmykcolor where{
pop
/Ck/setcmykcolor load def
}if
/Cg/setgray load def
/RE{
findfont
dup maxlength 1 index/FontName known not{1 add}if dict begin
{
1 index/FID ne{def}{pop pop}ifelse
}forall
/Encoding exch def
dup/FontName exch def
currentdict end definefont pop
}bind def
/DEFS 0 def
/EBEGIN{
moveto
DEFS begin
}bind def
/EEND/end load def
/CNT 0 def
/level1 0 def
/PBEGIN{
/level1 save def
translate
div 3 1 roll div exch scale
neg exch neg exch translate
0 setgray
0 setlinecap
1 setlinewidth
0 setlinejoin
10 setmiterlimit
[]0 setdash
/setstrokeadjust where{
pop
false setstrokeadjust
}if
/setoverprint where{
pop
false setoverprint
}if
newpath
/CNT countdictstack def
userdict begin
/showpage{}def
/setpagedevice{}def
}bind def
/PEND{
countdictstack CNT sub{end}repeat
level1 restore
}bind def
end def
/setpacking where{
pop
setpacking
}if
%%EndResource
%%EndProlog
%%BeginSetup
%%BeginFeature: *PageSize Default
<< /PageSize [ 612 792 ] /ImagingBBox null >> setpagedevice
%%EndFeature
%%IncludeResource: font Times-Roman
grops begin/DEFS 1 dict def DEFS begin/u{.001 mul}bind def end/RES 72
def/PL 792 def/LS false def/ENC0[/asciicircum/asciitilde/Scaron/Zcaron
/scaron/zcaron/Ydieresis/trademark/quotesingle/Euro/.notdef/.notdef
/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef
/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef
/.notdef/.notdef/space/exclam/quotedbl/numbersign/dollar/percent
/ampersand/quoteright/parenleft/parenright/asterisk/plus/comma/hyphen
/period/slash/zero/one/two/three/four/five/six/seven/eight/nine/colon
/semicolon/less/equal/greater/question/at/A/B/C/D/E/F/G/H/I/J/K/L/M/N/O
/P/Q/R/S/T/U/V/W/X/Y/Z/bracketleft/backslash/bracketright/circumflex
/underscore/quoteleft/a/b/c/d/e/f/g/h/i/j/k/l/m/n/o/p/q/r/s/t/u/v/w/x/y
/z/braceleft/bar/braceright/tilde/.notdef/quotesinglbase/guillemotleft
/guillemotright/bullet/florin/fraction/perthousand/dagger/daggerdbl
/endash/emdash/ff/fi/fl/ffi/ffl/dotlessi/dotlessj/grave/hungarumlaut
/dotaccent/breve/caron/ring/ogonek/quotedblleft/quotedblright/oe/lslash
/quotedblbase/OE/Lslash/.notdef/exclamdown/cent/sterling/currency/yen
/brokenbar/section/dieresis/copyright/ordfeminine/guilsinglleft
/logicalnot/minus/registered/macron/degree/plusminus/twosuperior
/threesuperior/acute/mu/paragraph/periodcentered/cedilla/onesuperior
/ordmasculine/guilsinglright/onequarter/onehalf/threequarters
/questiondown/Agrave/Aacute/Acircumflex/Atilde/Adieresis/Aring/AE
/Ccedilla/Egrave/Eacute/Ecircumflex/Edieresis/Igrave/Iacute/Icircumflex
/Idieresis/Eth/Ntilde/Ograve/Oacute/Ocircumflex/Otilde/Odieresis
/multiply/Oslash/Ugrave/Uacute/Ucircumflex/Udieresis/Yacute/Thorn
/germandbls/agrave/aacute/acircumflex/atilde/adieresis/aring/ae/ccedilla
/egrave/eacute/ecircumflex/edieresis/igrave/iacute/icircumflex/idieresis
/eth/ntilde/ograve/oacute/ocircumflex/otilde/odieresis/divide/oslash
/ugrave/uacute/ucircumflex/udieresis/yacute/thorn/ydieresis]def
/Times-Roman@@0 ENC0/Times-Roman RE
%%EndSetup
%%Page: 1 1
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF()0 12 Q()0 24 Q()-.35 E -.35(NA)36 24 S
(ME).35 E(
)36 36 Q(archi)0 48 Q -.15(ve)-.25 G(_read_ne).15 E
(w,)-.25 E(archi)0 60 Q -.15(ve)-.25 G
(_read_set_\214lter_options,).15 E(archi)0 72 Q -.15(ve)-.25 G
(_read_set_format_options,).15 E 0 Cg EP
%%Page: 5 5
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(archi)0 12 Q -.15(ve)-.25 G
(_read_set_options,).15 E(archi)0 24 Q -.15(ve)-.25 G
(_read_support_compression_all,).15 E(archi)0 36 Q -.15(ve)-.25 G
(_read_support_compression_bzip2,).15 E(archi)0 48 Q -.15(ve)-.25
G(_read_support_compression_compress,).15 E(archi)0 60 Q -.15(ve)
-.25 G(_read_support_compression_gzip,).15 E(archi)0 72 Q -.15
(ve)-.25 G(_read_support_compression_lzma,).15 E 0 Cg EP
%%Page: 6 6
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(archi)0 12 Q -.15(ve)-.25 G
(_read_support_compression_none,).15 E(archi)0 24 Q -.15(ve)-.25
G(_read_support_compression_xz,).15 E(archi)0 36 Q -.15(ve)-.25 G
(_read_support_compression_program,).15 E(archi)0 48 Q -.15(ve)
-.25 G(_read_support_compression_program_signature,).15 E(archi)0
60 Q -.15(ve)-.25 G(_read_support_format_all,).15 E(archi)0 72 Q
-.15(ve)-.25 G(_read_support_format_ar,).15 E 0 Cg EP
%%Page: 7 7
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(archi)0 12 Q -.15(ve)-.25 G
(_read_support_format_cpio,).15 E(archi)0 24 Q -.15(ve)-.25 G
(_read_support_format_empty,).15 E(archi)0 36 Q -.15(ve)-.25 G
(_read_support_format_iso9660,).15 E(archi)0 48 Q -.15(ve)-.25 G
(_read_support_format_mtree,).15 E(archi)0 60 Q -.15(ve)-.25 G
(_read_support_format_ra).15 E -.65(w,)-.15 G().65 E(archi)0 72 Q
-.15(ve)-.25 G(_read_support_format_tar,).15 E 0 Cg EP
%%Page: 8 8
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(archi)0 12 Q -.15(ve)-.25 G
(_read_support_format_zip,).15 E(archi)0 24 Q -.15(ve)-.25 G
(_read_open,).15 E(archi)0 36 Q -.15(ve)-.25 G(_read_open2,)
.15 E(archi)0 48 Q -.15(ve)-.25 G(_read_open_fd,).15 E(archi)0
60 Q -.15(ve)-.25 G(_read_open_FILE,).15 E(archi)0 72 Q -.15(ve)
-.25 G(_read_open_\214lename,).15 E 0 Cg EP
%%Page: 9 9
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(archi)0 12 Q -.15(ve)-.25 G
(_read_open_memory,).15 E(archi)0 24 Q -.15(ve)-.25 G(_read_ne)
.15 E(xt_header,)-.15 E(archi)0 36 Q -.15(ve)-.25 G(_read_ne).15
E(xt_header2,)-.15 E(archi)0 48 Q -.15(ve)-.25 G(_read_data,)
.15 E(archi)0 60 Q -.15(ve)-.25 G(_read_data_block,).15 E
(archi)0 72 Q -.15(ve)-.25 G(_read_data_skip,).15 E 0 Cg EP
%%Page: 10 10
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(archi)0 12 Q -.15(ve)-.25 G
(_read_data_into_b).15 E(uf)-.2 E(fer,)-.25 E(archi)0 24 Q -.15
(ve)-.25 G(_read_data_into_fd,).15 E(archi)0 36 Q -.15(ve)-.25 G
(_read_e).15 E(xtract,)-.15 E(archi)0 48 Q -.15(ve)-.25 G
(_read_e).15 E(xtract2,)-.15 E(archi)0 60 Q -.15(ve)-.25 G
(_read_e).15 E(xtract_set_progress_callback,)-.15 E(archi)0 72 Q
-.15(ve)-.25 G(_read_close,).15 E 0 Cg EP
%%Page: 11 11
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(archi)0 12 Q -.15(ve)-.25 G
(_read_\214nish).15 E 2.5(-f)0 24 S
(unctions for reading streaming archi)-2.5 E -.15(ve)-.25 G(s).15 E
()36 36 Q(SYNOPSIS)36 48 Q(
)36 60 Q
(struct archi)0 72 Q -.15(ve)
-.25 G( *).15 E 0 Cg EP
%%Page: 12 12
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(archi)0 12 Q -.15(ve)-.25 G(_read_ne).15 E
(w\(v)-.25 E(oid\))-.2 E
(int)0 24 Q(archi)0 36 Q -.15(ve)
-.25 G
(_read_support_compression_all\(struct archi).15
E .3 -.15(ve *)-.25 H(\)).15 E
(int)0 48 Q(archi)0 60 Q -.15(ve)
-.25 G
(_read_support_compression_bzip2\(struct archi)
.15 E .3 -.15(ve *)-.25 H(\)).15 E
(int)0 72 Q 0 Cg EP
%%Page: 13 13
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(archi)0 12 Q -.15(ve)-.25 G(_read_support_co\
mpression_compress\(struct archi).15 E .3 -.15
(ve *)-.25 H(\)).15 E(int)0 24
Q(archi)0 36 Q -.15(ve)-.25 G
(_read_support_compression_gzip\(struct archi).15
E .3 -.15(ve *)-.25 H(\)).15 E
(int)0 48 Q(archi)0 60 Q -.15(ve)
-.25 G
(_read_support_compression_lzma\(struct archi).15
E .3 -.15(ve *)-.25 H(\)).15 E
(int)0 72 Q 0 Cg EP
%%Page: 14 14
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(archi)0 12 Q -.15(ve)-.25 G
(_read_support_compression_none\(struct archi).15
E .3 -.15(ve *)-.25 H(\)).15 E
(int)0 24 Q(archi)0 36 Q -.15(ve)
-.25 G
(_read_support_compression_xz\(struct archi).15 E
.3 -.15(ve *)-.25 H(\)).15 E
(int)0 48 Q(archi)0 60 Q -.15(ve)
-.25 G(_read_support_compression_program\().15 E
(struct archi)0 72 Q .3 -.15(ve *)-.25 H().15
E 0 Cg EP
%%Page: 15 15
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(const char *cmd)0 12 Q
(\))0 24 Q(int)0 36 Q(archi)0 48 Q
-.15(ve)-.25 G
(_read_support_compression_program_signature\().15 E
(struct archi)0 60 Q .3 -.15(ve *)-.25 H().15
E(const char *cmd)0 72 Q 0 Cg EP
%%Page: 16 16
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(const v)0 12 Q
(oid *signature)-.2 E
(size_t signature_length)0 24 Q(\))0 36 Q
(int)0 48 Q(archi)0 60 Q -.15(ve)
-.25 G(_read_support_format_all\(struct archi).15
E .3 -.15(ve *)-.25 H(\)).15 E
(int)0 72 Q 0 Cg EP
%%Page: 17 17
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(archi)0 12 Q -.15(ve)-.25 G
(_read_support_format_ar\(struct archi).15 E .3
-.15(ve *)-.25 H(\)).15 E(int)0
24 Q(archi)0 36 Q -.15(ve)-.25 G
(_read_support_format_cpio\(struct archi).15 E .3
-.15(ve *)-.25 H(\)).15 E(int)0
48 Q(archi)0 60 Q -.15(ve)-.25 G
(_read_support_format_empty\(struct archi).15 E
.3 -.15(ve *)-.25 H(\)).15 E
(int)0 72 Q 0 Cg EP
%%Page: 18 18
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(archi)0 12 Q -.15(ve)-.25 G
(_read_support_format_iso9660\(struct archi).15 E
.3 -.15(ve *)-.25 H(\)).15 E
(int)0 24 Q(archi)0 36 Q -.15(ve)
-.25 G(_read_support_format_mtree\(struct archi)
.15 E .3 -.15(ve *)-.25 H(\)).15 E
(int)0 48 Q(archi)0 60 Q -.15(ve)
-.25 G(_read_support_format_ra).15 E
(w\(struct archi)-.15 E .3 -.15(ve *)-.25 H
(\)).15 E(int)0 72 Q 0 Cg EP
%%Page: 19 19
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(archi)0 12 Q -.15(ve)-.25 G
(_read_support_format_tar\(struct archi).15 E .3
-.15(ve *)-.25 H(\)).15 E(int)0
24 Q(archi)0 36 Q -.15(ve)-.25 G
(_read_support_format_zip\(struct archi).15 E .3
-.15(ve *)-.25 H(\)).15 E(int)0
48 Q(archi)0 60 Q -.15(ve)-.25 G
(_read_set_\214lter_options\(struct archi).15 E
.3 -.15(ve *)-.25 H(, const char *\)).15 E
(int)0 72 Q 0 Cg EP
%%Page: 20 20
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(archi)0 12 Q -.15(ve)-.25 G
(_read_set_format_options\(struct archi).15 E .3
-.15(ve *)-.25 H(, const char *\)).15 E
(int)0 24 Q(archi)0 36 Q -.15(ve)
-.25 G(_read_set_options\(struct archi).15 E .3
-.15(ve *)-.25 H(, const char *\)).15 E
(int)0 48 Q(archi)0 60 Q -.15(ve)
-.25 G(_read_open\().15 E
(struct archi)0 72 Q .3 -.15(ve *)-.25 H().15
E 0 Cg EP
%%Page: 21 21
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(v)0 12 Q
(oid *client_data)-.2 E(archi)0 24 Q -.15(ve)
-.25 G(_open_callback *).15 E(archi)0 36 Q
-.15(ve)-.25 G(_read_callback *).15 E(archi)0
48 Q -.15(ve)-.25 G(_close_callback *).15 E(\))0 60 Q
(int)0 72 Q 0 Cg EP
%%Page: 22 22
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(archi)0 12 Q -.15(ve)-.25 G
(_read_open2\().15 E(struct archi)0
24 Q .3 -.15(ve *)-.25 H().15 E(v)0 36 Q
(oid *client_data)-.2 E(archi)0 48 Q -.15(ve)
-.25 G(_open_callback *).15 E(archi)0 60 Q
-.15(ve)-.25 G(_read_callback *).15 E(archi)0
72 Q -.15(ve)-.25 G(_skip_callback *).15 E 0 Cg EP
%%Page: 23 23
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(archi)0 12 Q -.15(ve)-.25 G
(_close_callback *).15 E(\))0 24 Q
(int)0 36 Q(archi)0 48 Q -.15(ve)
-.25 G(_read_open_FILE\(struct archi).15 E .3
-.15(ve *)-.25 H(, FILE *\214le\)).15 E
(int)0 60 Q(archi)0 72 Q -.15(ve)
-.25 G(_read_open_fd\(struct archi).15 E .3 -.15
(ve *)-.25 H
(, int fd, size_t block_size\)).15 E 0
Cg EP
%%Page: 24 24
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(int)0 12 Q
(archi)0 24 Q -.15(ve)-.25 G
(_read_open_\214lename\().15 E
(struct archi)0 36 Q .3 -.15(ve *)-.25 H().15
E(const char *\214lename)0 48 Q
(size_t block_size)0 60 Q(\))0 72 Q 0 Cg EP
%%Page: 25 25
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(int)0 12 Q
(archi)0 24 Q -.15(ve)-.25 G
(_read_open_memory\(struct archi).15 E .3 -.15
(ve *)-.25 H(, v).15 E(oid *b)-.2 E(uf)-.2 E
(f, size_t size\))-.25 E
(int)0 36 Q(archi)0 48 Q -.15(ve)
-.25 G(_read_ne).15 E(xt_header\(struct archi)
-.15 E .3 -.15(ve *)-.25 H(, struct archi).15 E -.15(ve)
-.25 G(_entry **\)).15 E(int)0
60 Q(archi)0 72 Q -.15(ve)-.25 G(_read_ne).15 E
(xt_header2\(struct archi)-.15 E .3 -.15(ve *)
-.25 H(, struct archi).15 E -.15(ve)-.25 G
(_entry *\)).15 E 0 Cg EP
%%Page: 26 26
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(ssize_t)0 12 Q
(archi)0 24 Q -.15(ve)-.25 G
(_read_data\(struct archi).15 E .3 -.15(ve *)-.25
H(, v).15 E(oid *b)-.2 E(uf)-.2 E
(f, size_t len\))-.25 E
(int)0 36 Q(archi)0 48 Q -.15(ve)
-.25 G(_read_data_block\().15 E
(struct archi)0 60 Q .3 -.15(ve *)-.25 H().15
E(const v)0 72 Q(oid **b)-.2 E(uf)-.2 E(f)-.25
E 0 Cg EP
%%Page: 27 27
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(size_t *len)0 12 Q
(of)0 24 Q(f_t *of)-.25 E(fset)-.25 E(\))0 36
Q(int)0 48 Q(archi)0 60 Q -.15(ve)
-.25 G(_read_data_skip\(struct archi).15 E .3
-.15(ve *)-.25 H(\)).15 E(int)0
72 Q 0 Cg EP
%%Page: 28 28
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(archi)0 12 Q -.15(ve)-.25 G
(_read_data_into_b).15 E(uf)-.2 E
(fer\(struct archi)-.25 E .3 -.15(ve *)-.25 H
(, v).15 E(oid *, ssize_t len\))-.2 E
(int)0 24 Q(archi)0 36 Q -.15(ve)
-.25 G(_read_data_into_fd\(struct archi).15 E .3
-.15(ve *)-.25 H(, int fd\)).15 E
(int)0 48 Q(archi)0 60 Q -.15(ve)
-.25 G(_read_e).15 E(xtract\()-.15 E
(struct archi)0 72 Q .3 -.15(ve *)-.25 H().15
E 0 Cg EP
%%Page: 29 29
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(struct archi)0 12 Q -.15(ve)
-.25 G(_entry *).15 E(int \215ags)0 24
Q(\))0 36 Q(int)0 48 Q(archi)0 60 Q
-.15(ve)-.25 G(_read_e).15 E(xtract2\()-.15 E
(struct archi)0 72 Q .3 -.15(ve *)-.25 H(src)
.15 E 0 Cg EP
%%Page: 30 30
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(struct archi)0 12 Q -.15(ve)
-.25 G(_entry *).15 E(struct archi)0 24 Q .3
-.15(ve *)-.25 H(dest).15 E(\))0 36 Q
(v)0 48 Q(oid)-.2 E(archi)0 60 Q
-.15(ve)-.25 G(_read_e).15 E
(xtract_set_progress_callback\()-.15 E
(struct archi)0 72 Q .3 -.15(ve *)-.25 H().15
E 0 Cg EP
%%Page: 31 31
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(v)0 12 Q(oid \(*func\)\(v)-.2
E(oid *\))-.2 E(v)0 24 Q
(oid *user_data)-.2 E(\))0 36 Q
(int)0 48 Q(archi)0 60 Q -.15(ve)
-.25 G(_read_close\(struct archi).15 E .3 -.15
(ve *)-.25 H(\)).15 E(int)0 72
Q 0 Cg EP
%%Page: 32 32
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(archi)0 12 Q -.15(ve)-.25 G
(_read_\214nish\(struct archi).15 E .3 -.15(ve *)
-.25 H(\)).15 E()36 24 Q(DESCRIPTION)36 36 Q
(
)36 48 Q(These functions pro)0 60 Q
(vide a complete API for reading streaming archi)-.15 E -.15(ve)-.25 G
(s.).15 E(The general process is to \214rst create the)0 72 Q 0 Cg EP
%%Page: 33 33
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(struct archi)0 12 Q -.15(ve)-.25 G().15 E
(object, set options, initialize the reader)0 24 Q 2.5(,i)-.4 G
(terate o)-2.5 E -.15(ve)-.15 G 2.5(rt).15 G(he archi)-2.5 E -.15(ve)
-.25 G(headers and associated data, then close the archi)0 36 Q .3 -.15
(ve a)-.25 H(nd release all).15 E(resources.)0 48 Q(The follo)0 60 Q
(wing summary describes the functions in approximately the)-.25 E
(order the)0 72 Q 2.5(yw)-.15 G(ould be used:)-2.6 E 0 Cg EP
%%Page: 34 34
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF()0 12 Q(
)0
60 Q(\)\),).15 E(archi)0
24 Q -.15(ve)-.25 G
(_read_support_compression_compress\(\),).15 E
(archi)0 36 Q -.15(ve)-.25 G
(_read_support_compression_gzip\(\),).15 E(archi)0
48 Q -.15(ve)-.25 G
(_read_support_compression_lzma\(\),).15 E(archi)0
60 Q -.15(ve)-.25 G
(_read_support_compression_none\(\),).15 E(archi)0
72 Q -.15(ve)-.25 G(_read_support_compression_xz\(\))
.15 E 0 Cg EP
%%Page: 36 36
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF
(Enables auto-detection code and decompression support for the)0 12 Q
(speci\214ed compression.)0 24 Q(Returns)0 36 Q
(ARCHIVE_OK)0 48 Q
(if the compression is fully supported, or)0 60 Q(ARCHIVE_W)0
72 Q(ARN)-1.2 E 0 Cg EP
%%Page: 37 37
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF
(if the compression is supported only through an e)0 12 Q
(xternal program.)-.15 E(Note that decompression using an e)0 24 Q
(xternal program is usually slo)-.15 E(wer than)-.25 E
(decompression through b)0 36 Q(uilt-in libraries.)-.2 E(Note that)0 48
Q -.74(``)0 60 S(none').74 E(')-.74 E(is al)0 72 Q -.1(wa)-.1 G
(ys enabled by def).1 E(ault.)-.1 E 0 Cg EP
%%Page: 38 38
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(\)\)\)\),).15 E(archi)0 24 Q
-.15(ve)-.25 G(_read_support_format_ar\(\),).15 E
(archi)0 36 Q -.15(ve)-.25 G
(_read_support_format_cpio\(\),).15 E(archi)0 48 Q
-.15(ve)-.25 G(_read_support_format_empty\(\),).15 E
(archi)0 60 Q -.15(ve)-.25 G
(_read_support_format_iso9660\(\),).15 E(archi)0 72
Q -.15(ve)-.25 G(_read_support_format_mtree\(\),).15 E
0 Cg EP
%%Page: 41 41
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(archi)0 12 Q -.15(ve)-.25 G
(_read_support_format_tar\(\),).15 E(archi)0 24 Q
-.15(ve)-.25 G(_read_support_format_zip\(\)).15 E
(Enables support---including auto-detection code---for the)0 36 Q
(speci\214ed archi)0 48 Q .3 -.15(ve f)-.25 H(ormat.).15 E -.15(Fo)0 60
S 2.5(re).15 G(xample,)-2.65 E(archi)0 72 Q -.15(ve)-.25 G
(_read_support_format_tar\(\)).15 E 0 Cg EP
%%Page: 42 42
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(enables support for a v)0 12 Q
(ariety of standard tar formats, old-style tar)-.25 E(,)-.4 E(ustar)0 24
Q 2.5(,p)-.4 G(ax interchange format, and man)-2.5 E 2.5(yc)-.15 G
(ommon v)-2.5 E(ariants.)-.25 E -.15(Fo)0 36 S 2.5(rc).15 G(on)-2.5 E
-.15(ve)-.4 G(nience,).15 E(archi)0 48 Q -.15(ve)-.25 G
(_read_support_format_all\(\)).15 E
(enables support for all a)0 60 Q -.25(va)-.2 G(ilable formats.).25 E
(Only empty archi)0 72 Q -.15(ve)-.25 G 2.5(sa).15 G
(re supported by def)-2.5 E(ault.)-.1 E 0 Cg EP
%%Page: 43 43
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(\)\)).15 E(in order to a)0 60
Q -.2(vo)-.2 G(id erroneous handling of damaged archi).2 E -.15(ve)-.25
G(s.).15 E(\),).15 E(archi)0 24 Q
-.15(ve)-.25 G(_read_set_format_options\(\),).15 E
(archi)0 36 Q -.15(ve)-.25 G(_read_set_options\(\))
.15 E(Speci\214es options that will be passed to currently-re)0 48 Q
(gistered)-.15 E
(\214lters \(including decompression \214lters\) and/or format readers.)
0 60 Q(The ar)0 72 Q(gument is a comma-separated list of indi)-.18 E
(vidual options.)-.25 E 0 Cg EP
%%Page: 46 46
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(Indi)0 12 Q(vidual options ha)-.25 E .3 -.15
(ve o)-.2 H(ne of the follo).15 E(wing forms:)-.25 E()0 24 Q
(
)0 36 Q(The return v)0 48 Q
(alue will be)-.25 E(ARCHIVE_OK)0 60 Q(if an)0 72 Q 2.5
(ym)-.15 G(odule accepts the option, or)-2.5 E 0 Cg EP
%%Page: 49 49
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(ARCHIVE_W)0 12 Q(ARN)-1.2 E
(if no module accepted the option, or)0 24 Q(ARCHIVE_F)0 36 Q
-1.21 -1.11(AT A)-.74 H(L)1.11 E(if there w)0 48 Q(as a f)-.1 E
(atal error while attempting to process the option.)-.1 E()0 12 Q(
)0 48 Q()0 36 Q
(
)0 36 Q(\)\),).15 E -.15(ex)0 24 S
(cept that the skip callback is assumed to be).15 E
(NULL.)0 36 Q(\)\),).15 E(archi)0 48 Q
-.15(ve)-.25 G(_read_open_FILE\(\),).15 E(archi)0 60
Q -.15(ve)-.25 G(_read_open_fd\(\),).15 E(or)0 72 Q 0
Cg EP
%%Page: 54 54
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(archi)0 12 Q -.15(ve)-.25 G
(_read_open_memory\(\)).15 E(instead.)0 24 Q
(The library in)0 36 Q -.2(vo)-.4 G -.1(ke).2 G 2.5(st).1 G
(he client-pro)-2.5 E(vided functions to obtain)-.15 E(ra)0 48 Q 2.5(wb)
-.15 G(ytes from the archi)-2.5 E -.15(ve)-.25 G(.).15 E(\)\),).15 E -.15(ex)0 24 S
(cept that it accepts a).15 E(FILE *)0
36 Q(pointer)0 48 Q(.)-.55 E
(This function should not be used with tape dri)0 60 Q -.15(ve)-.25 G
2.5(so).15 G 2.5(ro)-2.5 G(ther de)-2.5 E(vices)-.25 E
(that require strict I/O blocking.)0 72 Q 0 Cg EP
%%Page: 56 56
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(\)\),).15 E
-.15(ex)0 48 S
(cept that it accepts a \214le descriptor and block size rather than).15
E 2.5(as)0 60 S(et of function pointers.)-2.5 E
(Note that the \214le descriptor will not be automatically closed at)0
72 Q 0 Cg EP
%%Page: 57 57
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(end-of-archi)0 12 Q -.15(ve)-.25 G(.).15 E
(This function is safe for use with tape dri)0 24 Q -.15(ve)-.25 G 2.5
(so).15 G 2.5(ro)-2.5 G(ther block)-2.5 E(ed de)-.1 E(vices.)-.25 E
(\)\).).15 E
(\)\),).15 E -.15(ex)0 36 S
(cept that it accepts a simple \214lename and a block size.).15 E 2.5
(AN)0 48 S(ULL \214lename represents standard input.)-2.5 E
(This function is safe for use with tape dri)0 60 Q -.15(ve)-.25 G 2.5
(so).15 G 2.5(ro)-2.5 G(ther block)-2.5 E(ed de)-.1 E(vices.)-.25 E
(\)\),).15 E -.15(ex)0 36 S
(cept that it accepts a pointer and size of a block of).15 E
(memory containing the archi)0 48 Q .3 -.15(ve d)-.25 H(ata.).15 E
(\)\))-.15 E(that reuses an internal)0 60 Q
(struct a\
rchi)0 72 Q -.15(ve)-.25 G(_entry).15 E 0 Cg EP
%%Page: 61 61
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(object for each request.)0 12 Q(\)\)\)).15 E
(and \214lls an)0 36 Q 2.5(yg)-.15 G
(aps with nulls so that callers see a single)-2.55 E
(continuous stream of data.)0 48 Q(\)\),).15 E(the)0 36 Q(archi)0 48 Q
-.15(ve)-.25 G(_read_data_block\(\)).15 E(function a)0
60 Q -.2(vo)-.2 G(ids cop).2 E(ying data and allo)-.1 E
(ws you to correctly handle)-.25 E
(sparse \214les, as supported by some archi)0 72 Q .3 -.15(ve f)-.25 H
(ormats.).15 E 0 Cg EP
%%Page: 64 64
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(The library guarantees that of)0 12 Q
(fsets will increase and that blocks)-.25 E(will not o)0 24 Q -.15(ve)
-.15 G(rlap.).15 E
(Note that the blocks returned from this function can be much lar)0 36 Q
(ger)-.18 E(than the block size read from disk, due to compression)0 48
Q(and internal b)0 60 Q(uf)-.2 E(fer optimizations.)-.25 E(\)\)).15 E
(to skip all of the data for this archi)0 36 Q .3 -.15(ve e)-.25 H(ntry)
.15 E(.)-.65 E(\)\)).15 E(instead.)0 24 Q(\)\)).15 E(to cop)0 72 Q 2.5(yt)
-.1 G(he entire entry to the pro)-2.5 E(vided \214le descriptor)-.15 E
(.)-.55 E 0 Cg EP
%%Page: 67 67
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(archi)-.15 E -.15(ve)-.25 G(_read_e).15 E
(xtract_set_skip_\214le\(\)\)\))-.15 E 0 Cg EP
%%Page: 68 68
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(creates a restore object using)0 12 Q
(archi).65 E -.15(ve)-.25 G(_write_disk_ne).15 E
(w\(3\))-.25 E(and)0 36 Q(archi).15 E -.15(ve)-.25 G
(_write_disk_set_standard_lookup\(3\),).15 E(then transparently in)0
60 Q -.2(vo)-.4 G -.1(ke).2 G(s).1 E(archi).15 E -.15(ve)-.25 G
(_write_disk_set_options\(3\),).15 E 0 Cg EP
%%Page: 69 69
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(archi)-.55 E -.15(ve)-.25 G
(_write_header\(3\),).15 E(archi).15 E -.15(ve)-.25 G
(_write_data\(3\),).15 E(and)0 36 Q(archi)-.65 E -.15(ve)
-.25 G(_write_\214nish_entry\(3\)).15 E
(to create the entry on disk and cop)0 60 Q 2.5(yd)-.1 G(ata into it.)
-2.5 E(The)0 72 Q 0 Cg EP
%%Page: 70 70
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(\215ags)0 12 Q(ar)0 24 Q
(gument is passed unmodi\214ed to)-.18 E(archi).15 E -.15(ve)-.25 G
(_write_disk_set_options\(3\).).15 E(\)\))-.15 E 0 Cg EP
%%Page: 71 71
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(that allo)0 12 Q(ws you to pro)-.25 E
(vide your o)-.15 E(wn restore object.)-.25 E(In particular)0 24 Q 2.5
(,t)-.4 G(his allo)-2.5 E(ws you to o)-.25 E -.15(ve)-.15 G
(rride the standard lookup functions).15 E(using)0 36 Q
(archi).15 E -.15(ve)-.25 G
(_write_disk_set_group_lookup\(3\),).15 E(and)0 60 Q
(archi).15 E -.15(ve)-.25 G
(_write_disk_set_user_lookup\(3\).).15 E 0 Cg EP
%%Page: 72 72
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(Note that)0 12 Q(archi)0 24 Q -.15(ve)-.25 G
(_read_e).15 E(xtract2\(\))-.15 E(does not accept a)0
36 Q(\215ags)0 48 Q(ar)0 60 Q(gument; you should use)-.18
E(archi)0 72 Q -.15(ve)-.25 G
(_write_disk_set_options\(\)).15 E 0 Cg EP
%%Page: 73 73
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(to set the restore options yourself.)0 12 Q
(\)\)\)\)).15 E(if it w)0 48 Q(as not in)-.1 E
-.2(vo)-.4 G -.1(ke).2 G 2.5(dm).1 G(anually)-2.5 E 2.5(,t)-.65 G
(hen release all resources.)-2.5 E(Note: In libarchi)0 60 Q .3 -.15
(ve 1)-.25 H(.x, this function w).15 E(as declared to return)-.1 E
(v)0 72 Q(oid,)-.2 E 0 Cg EP
%%Page: 76 76
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF
(which made it impossible to detect certain errors when)0 12 Q(archi)
0 24 Q -.15(ve)-.25 G(_read_close\(\)).15 E -.1(wa)0 36
S 2.5(si).1 G -1.9 -.4(nv o)-2.5 H -.1(ke).4 G 2.5(di).1 G
(mplicitly from this function.)-2.5 E(The declaration is corrected be)0
48 Q(ginning with libarchi)-.15 E .3 -.15(ve 2)-.25 H(.0.).15 E().4 E(CLIENT CALLB)36 60
Q -.4(AC)-.35 G(KS).4 E(
)36 72 Q 0 Cg EP
%%Page: 80 80
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(The callback functions must match the follo)0 12
Q(wing prototypes:)-.25 E()0 24 Q(
)0 60 Q(typedef ssize_t)0 48 Q
(archi)0 60 Q -.15(ve)-.25 G(_read_callback\().15 E
(struct archi)0 72 Q .3 -.15(ve *)-.25 H().15
E 0 Cg EP
%%Page: 81 81
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(v)0 12 Q
(oid *client_data)-.2 E(const v)0 24 Q
(oid **b)-.2 E(uf)-.2 E(fer)-.25 E(\))0 36 Q(typedef int)0 60 Q
(archi)0 72 Q -.15(ve)-.25 G(_skip_callback\().15 E
0 Cg EP
%%Page: 82 82
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(struct archi)0 12 Q .3 -.15
(ve *)-.25 H().15 E(v)0 24 Q
(oid *client_data)-.2 E(size_t request)
0 36 Q(\))0 48 Q(typedef int)0 72 Q 0 Cg
EP
%%Page: 83 83
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(archi)0 12 Q -.15(ve)-.25 G
(_open_callback\(struct archi).15 E .3 -.15(ve *)
-.25 H(, v).15 E(oid *client_data\))-.2 E(typedef int)0 36 Q
(archi)0 48 Q -.15(ve)-.25 G
(_close_callback\(struct archi).15 E .3 -.15
(ve *)-.25 H(, v).15 E(oid *client_data\))-.2 E
(\).).15 E(It should return)0 36 Q
(ARCHIVE_OK)0 48 Q
(if the underlying \214le or data source is successfully)0 60 Q(opened.)
0 72 Q 0 Cg EP
%%Page: 85 85
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(If the open f)0 12 Q(ails, it should call)-.1 E
(archi)0 24 Q -.15(ve)-.25 G(_set_error\(\)).15 E
(to re)0 36 Q(gister an error code and message and return)-.15 E
(ARCHIVE_F)0 48 Q -1.21 -1.11(AT A)-.74 H(L.)1.11 E(const v)0 48 Q
(oid **b)-.2 E(uf)-.2 E(fer)-.25 E(ar)0 60 Q
(gument to point to the a)-.18 E -.25(va)-.2 G(ilable data, and).25 E
(return a count of the number of bytes a)0 72 Q -.25(va)-.2 G(ilable.)
.25 E 0 Cg EP
%%Page: 87 87
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(The library will in)0 12 Q -.2(vo)-.4 G .2 -.1
(ke t).2 H(he read callback ag).1 E(ain)-.05 E
(only after it has consumed this data.)0 24 Q
(The library imposes no constraints on the size)0 36 Q
(of the data blocks returned.)0 48 Q
(On end-of-\214le, the read callback should)0 60 Q(return zero.)0 72 Q 0
Cg EP
%%Page: 88 88
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(On error)0 12 Q 2.5(,t)-.4 G
(he read callback should in)-2.5 E -.2(vo)-.4 G -.1(ke).2 G(archi)0
24 Q -.15(ve)-.25 G(_set_error\(\)).15 E(to re)0 36 Q
(gister an error code and message and)-.15 E(return -1.)0 48 Q(NULL \),)0 24 Q
(the library will in)0 36 Q -.2(vo)-.4 G .2 -.1(ke t).2 H
(he read function).1 E(instead and simply discard the result.)0 48 Q 2.5
(As)0 60 S(kip callback can pro)-2.5 E(vide signi\214cant)-.15 E
(performance g)0 72 Q(ains when reading uncompressed)-.05 E 0 Cg EP
%%Page: 91 91
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(archi)0 12 Q -.15(ve)-.25 G 2.5(sf).15 G
(rom slo)-2.5 E 2.5(wd)-.25 G(isk dri)-2.5 E -.15(ve)-.25 G 2.5(so).15 G
2.5(ro)-2.5 G(ther media)-2.5 E(that can skip quickly)0 24 Q(.)-.65 E
(\)).15
E(to re)0 60 Q(gister an error code and message and)-.15 E(return)0 72 Q
0 Cg EP
%%Page: 93 93
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(ARCHIVE_F)0 12 Q -1.21 -1.11(AT A)-.74
H(L.)1.11 E()36 24 Q(EXAMPLE)36 36 Q(
)36 48 Q
(The follo)0 60 Q(wing illustrates basic usage of the library)-.25 E(.)
-.65 E(In this e)0 72 Q(xample,)-.15 E 0 Cg EP
%%Page: 94 94
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF
(the callback functions are simply wrappers around the standard)0 12 Q
(open\(2\),)0 24 Q
(read\(2\),)0 36 Q(and)0 48 Q
(close\(2\))0 60 Q(system calls.)0 72
Q 0 Cg EP
%%Page: 95 95
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(
)0 72 Q 0 Cg EP
%%Page: 104 104
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF()0 24 Q()0 60 Q
()
0 36 Q -.2(vo)0 48 S(id).2 E(list_archi)0 60 Q -.15(ve)-.25 G
(\(const char *name\)).15 E({)0 72 Q 0 Cg EP
%%Page: 96 96
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(struct mydata *mydata;)5 12 Q(struct archi)5 24
Q .3 -.15(ve *)-.25 H(a;).15 E(struct archi)5 36 Q -.15(ve)-.25 G
(_entry *entry;).15 E()0 48 Q()-1.35 E
(RETURN V)36 24 Q(ALUES)-1.35 E(
)36 36 Q
(Most functions return zero on success, non-zero on error)0 48 Q(.)-.55
E(The possible return codes include:)0 60 Q(ARCHIVE_OK)0
72 Q 0 Cg EP
%%Page: 105 105
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(\(the operation succeeded\),)0 12 Q
(ARCHIVE_W)0 24 Q(ARN)-1.2 E(\(the operation succeeded b)0
36 Q(ut a non-critical error w)-.2 E(as encountered\),)-.1 E
(ARCHIVE_EOF)0 48 Q(\(end-of-archi)0 60 Q .3 -.15(ve w)
-.25 H(as encountered\),).05 E(ARCHIVE_RETR)0 72 Q(Y)-.65
E 0 Cg EP
%%Page: 106 106
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(\(the operation f)0 12 Q(ailed b)-.1 E
(ut can be retried\),)-.2 E(and)0 24 Q(ARCHIVE_F)0 36 Q -1.21
-1.11(AT A)-.74 H(L)1.11 E(\(there w)0 48 Q(as a f)-.1 E
(atal error; the archi)-.1 E .3 -.15(ve s)-.25 H
(hould be closed immediately\).).15 E(Detailed error codes and te)0 60 Q
(xtual descriptions are a)-.15 E -.25(va)-.2 G(ilable from the).25 E
(archi)0 72 Q -.15(ve)-.25 G(_errno\(\)).15 E 0 Cg
EP
%%Page: 107 107
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(and)0 12 Q(archi)0 24 Q -.15(ve)-.25 G
(_error_string\(\)).15 E(functions.)0 36 Q(\))
-.25 E(returns a pointer to a freshly allocated)0 72 Q 0 Cg EP
%%Page: 108 108
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(struct archi)0 12 Q -.15(ve)-.25 G().15 E(object.)
0 24 Q(It returns)0 36 Q(NULL)0 48 Q(on error)
0 60 Q(.)-.55 E(\)).15 E
(returns a count of bytes actually read or zero at the end of the entry)
0 24 Q(.)-.65 E(On error)0 36 Q 2.5(,av)-.4 G(alue of)-2.75 E
(ARCHIVE_F)0 48 Q -1.21 -1.11(AT A)-.74 H(L,)1.11 E
(ARCHIVE_W)0 60 Q(ARN,)-1.2 E(or)0 72 Q 0 Cg EP
%%Page: 110 110
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(ARCHIVE_RETR)0 12 Q(Y)-.65 E
(is returned and an error code and te)0 24 Q
(xtual description can be retrie)-.15 E -.15(ve)-.25 G 2.5(df).15 G
(rom the)-2.5 E(archi)0 36 Q -.15(ve)-.25 G
(_errno\(\)).15 E(and)0 48 Q(archi)0 60 Q -.15(ve)
-.25 G(_error_string\(\)).15 E(functions.)0 72 Q 0 Cg
EP
%%Page: 111 111
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(\)).15 E
(to set an appropriate error code and description,)0 60 Q
(then return one of the non-zero v)0 72 Q(alues abo)-.25 E -.15(ve)-.15
G(.).15 E 0 Cg EP
%%Page: 112 112
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(\(Note that the v)0 12 Q(alue e)-.25 E -.15(ve)
-.25 G(ntually returned to the client may).15 E(not be the same; man)0
24 Q 2.5(ye)-.15 G(rrors that are not critical at the le)-2.5 E -.15(ve)
-.25 G(l).15 E(of basic I/O can pre)0 36 Q -.15(ve)-.25 G(nt the archi)
.15 E .3 -.15(ve f)-.25 H(rom being properly read,).15 E
(thus most I/O errors e)0 48 Q -.15(ve)-.25 G(ntually cause).15 E
(ARCHIVE_F)0 60 Q -1.21 -1.11(AT A)-.74 H(L)1.11 E
(to be returned.\))0 72 Q 0 Cg EP
%%Page: 113 113
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF()36 12 Q(SEE ALSO)36 24 Q
(
)36 36 Q(tar\(1\),)-.55 E
(archi).15 E -.15
(ve)-.25 G(\(3\),).15 E(archi).15 E -.15(ve)-.25 G(_util\(3\),).15 E 0 Cg EP
%%Page: 114 114
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(tar\(5\))-.55 E()-.65 E
(HIST)36 36 Q(OR)-.18 E(Y)-.65 E(
)36 48 Q(The)0 60 Q(libarchi)0
72 Q -.15(ve)-.25 G().15 E 0 Cg EP
%%Page: 115 115
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(library \214rst appeared in)0 12 Q(FreeBSD5.3.)0
24 Q()-.55 E -.55(AU)36 48 S(THORS).55 E
(
)36 60 Q()-.1 E -.1(BU)36 72 S(GS).1 E 0 Cg EP
%%Page: 117 117
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF(
)36 12 Q(Man)0 24 Q 2.5(yt)-.15 G
(raditional archi)-2.5 E -.15(ve)-.25 G 2.5(rp).15 G(rograms treat)-2.5
E(empty \214les as v)0 36 Q(alid empty archi)-.25 E -.15(ve)-.25 G(s.)
.15 E -.15(Fo)0 48 S 2.5(re).15 G(xample, man)-2.65 E 2.5(yi)-.15 G
(mplementations of)-2.5 E(tar\(1\))-.55 E(allo)0 72 Q 2.5(wy)-.25 G
(ou to append entries to an empty \214le.)-2.5 E 0 Cg EP
%%Page: 118 118
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@@0 SF
(Of course, it is impossible to determine the format of an empty \214le)
0 12 Q
(by inspecting the contents, so this library treats empty \214les as)0
24 Q(ha)0 36 Q(ving a special)-.2 E -.74(``)0 48 S(empty').74 E(')-.74 E
(format.)0 60 Q()0 72 Q 0 Cg EP
%%Trailer
end
%%EOF
@
1.1.1.5
log
@Import libarchive-3.2.1:
- security fixes and other bugfixes
- support for multhreading in xz 5.2+
@
text
@d1 1509
a1509 233
See archive_read_new(3).
See archive_read_filter(3) and archive_read_format(3).
See archive_read_set_options(3).
See archive_read_open(3).
See archive_read_header(3), archive_read_data(3) and
archive_read_extract(3).
See archive_read_free(3).
list_archive(const char *name)
{
struct mydata *mydata;
struct archive *a;
struct archive_entry *entry;
a = archive_read_new();
mydata->name = name;
archive_read_support_filter_all(a);
archive_read_support_format_all(a);
archive_read_open(a, mydata, myopen, myread, myclose);
while (archive_read_next_header(a, &entry) ==
ARCHIVE_OK) {
printf("%s\n",archive_entry_pathname(entry));
archive_read_data_skip(a);
}
archive_read_free(a);
free(mydata);
}
myread(struct archive *a, void *client_data, const void
**buff)
{
struct mydata *mydata = client_data;
return (read(mydata->fd, mydata->buff, 10240));
}
myopen(struct archive *a, void *client_data)
{
struct mydata *mydata = client_data;
return (mydata->fd >= 0 ? ARCHIVE_OK : ARCHIVE_FATAL);
}
myclose(struct archive *a, void *client_data)
{
struct mydata *mydata = client_data;
close(mydata->fd);
return (ARCHIVE_OK);
}
@
1.1.1.6
log
@Import libarchive-3.3.1.
@
text
@d2 1
a2 1
d227 1
a227 1
special ‘‘empty’’ format.
d151 1
a151 1
d173 1
a173 1
d183 1
a183 1
d194 1
a194 1