|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
"http://www.w3.org/TR/html4/loose.dtd">
|
|
Packit |
08bd4c |
<html>
|
|
Packit |
08bd4c |
<head>
|
|
Packit |
08bd4c |
<meta name="generator" content="groff -Thtml, see www.gnu.org">
|
|
Packit |
08bd4c |
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
|
|
Packit |
08bd4c |
<meta name="Content-Style" content="text/css">
|
|
Packit |
08bd4c |
<style type="text/css">
|
|
Packit |
08bd4c |
p { margin-top: 0; margin-bottom: 0; vertical-align: top }
|
|
Packit |
08bd4c |
pre { margin-top: 0; margin-bottom: 0; vertical-align: top }
|
|
Packit |
08bd4c |
table { margin-top: 0; margin-bottom: 0; vertical-align: top }
|
|
Packit |
08bd4c |
h1 { text-align: center }
|
|
Packit |
08bd4c |
</style>
|
|
Packit |
08bd4c |
<title></title>
|
|
Packit |
08bd4c |
</head>
|
|
Packit |
08bd4c |
<body>
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
ARCHIVE_UTIL(3) BSD Library Functions Manual
|
|
Packit |
08bd4c |
ARCHIVE_UTIL(3)
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
NAME
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
archive_clear_error,
|
|
Packit |
08bd4c |
archive_compression, archive_compression_name,
|
|
Packit |
08bd4c |
archive_copy_error, archive_errno,
|
|
Packit |
08bd4c |
archive_error_string, archive_file_count,
|
|
Packit |
08bd4c |
archive_filter_code, archive_filter_count,
|
|
Packit |
08bd4c |
archive_filter_name, archive_format,
|
|
Packit |
08bd4c |
archive_format_name, archive_position,
|
|
Packit |
08bd4c |
archive_set_error — libarchive utility
|
|
Packit |
08bd4c |
functions
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
LIBRARY
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
Streaming Archive Library
|
|
Packit |
08bd4c |
(libarchive, -larchive)
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
SYNOPSIS
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
#include
|
|
Packit |
08bd4c |
<archive.h>
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
void
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
archive_clear_error(struct archive *);
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
int
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
archive_compression(struct archive *);
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
const char
|
|
Packit |
08bd4c |
*
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
archive_compression_name(struct archive *);
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
void
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
archive_copy_error(struct archive *,
|
|
Packit |
08bd4c |
struct archive *);
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
int
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
archive_errno(struct archive *);
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
const char
|
|
Packit |
08bd4c |
*
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
archive_error_string(struct archive *);
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
int
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
archive_file_count(struct archive *);
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
int
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
archive_filter_code(struct archive *,
|
|
Packit |
08bd4c |
int);
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
int
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
archive_filter_count(struct archive *,
|
|
Packit |
08bd4c |
int);
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
const char
|
|
Packit |
08bd4c |
*
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
archive_filter_name(struct archive *,
|
|
Packit |
08bd4c |
int);
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
int
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
archive_format(struct archive *);
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
const char
|
|
Packit |
08bd4c |
*
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
archive_format_name(struct archive *);
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
int64_t
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
archive_position(struct archive *,
|
|
Packit |
08bd4c |
int);
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
void
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
archive_set_error(struct archive *,
|
|
Packit |
08bd4c |
int error_code,
|
|
Packit |
08bd4c |
const char *fmt, ...);
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
DESCRIPTION
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
These functions provide access
|
|
Packit |
08bd4c |
to various information about the struct archive object used
|
|
Packit |
08bd4c |
in the libarchive(3) library.
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
archive_clear_error()
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
Clears any error information
|
|
Packit |
08bd4c |
left over from a previous call. Not generally used in client
|
|
Packit |
08bd4c |
code.
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
archive_compression()
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
Synonym for
|
|
Packit |
08bd4c |
archive_filter_code(a,(0)).
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
archive_compression_name()
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
Synonym for
|
|
Packit |
08bd4c |
archive_filter_name(a,(0)).
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
archive_copy_error()
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
Copies error information from
|
|
Packit |
08bd4c |
one archive to another.
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
archive_errno()
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
Returns a numeric error code
|
|
Packit |
08bd4c |
(see errno(2)) indicating the reason for the most recent
|
|
Packit |
08bd4c |
error return. Note that this can not be reliably used to
|
|
Packit |
08bd4c |
detect whether an error has occurred. It should be used only
|
|
Packit |
08bd4c |
after another libarchive function has returned an error
|
|
Packit |
08bd4c |
status.
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
archive_error_string()
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
Returns a textual error message
|
|
Packit |
08bd4c |
suitable for display. The error message here is usually more
|
|
Packit |
08bd4c |
specific than that obtained from passing the result of
|
|
Packit |
08bd4c |
archive_errno() to strerror(3).
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
archive_file_count()
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
Returns a count of the number
|
|
Packit |
08bd4c |
of files processed by this archive object. The count is
|
|
Packit |
08bd4c |
incremented by calls to archive_write_header(3) or
|
|
Packit |
08bd4c |
archive_read_next_header(3).
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
archive_filter_code()
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
Returns a numeric code
|
|
Packit |
08bd4c |
identifying the indicated filter. See
|
|
Packit |
08bd4c |
archive_filter_count() for details of the
|
|
Packit |
08bd4c |
numbering.
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
archive_filter_count()
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
Returns the number of filters
|
|
Packit |
08bd4c |
in the current pipeline. For read archive handles, these
|
|
Packit |
08bd4c |
filters are added automatically by the automatic format
|
|
Packit |
08bd4c |
detection. For write archive handles, these filters are
|
|
Packit |
08bd4c |
added by calls to the various
|
|
Packit |
08bd4c |
archive_write_add_filter_XXX() functions. Filters in
|
|
Packit |
08bd4c |
the resulting pipeline are numbered so that filter 0 is the
|
|
Packit |
08bd4c |
filter closest to the format handler. As a convenience,
|
|
Packit |
08bd4c |
functions that expect a filter number will accept -1 as a
|
|
Packit |
08bd4c |
synonym for the highest-numbered filter.
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
For example,
|
|
Packit |
08bd4c |
when reading a uuencoded gzipped tar archive, there are
|
|
Packit |
08bd4c |
three filters: filter 0 is the gunzip filter, filter 1 is
|
|
Packit |
08bd4c |
the uudecode filter, and filter 2 is the pseudo-filter that
|
|
Packit |
08bd4c |
wraps the archive read functions. In this case, requesting
|
|
Packit |
08bd4c |
archive_position(a,(-1)) would be a synonym
|
|
Packit |
08bd4c |
for archive_position(a,(2)) which would return
|
|
Packit |
08bd4c |
the number of bytes currently read from the archive, while
|
|
Packit |
08bd4c |
archive_position(a,(1)) would return the
|
|
Packit |
08bd4c |
number of bytes after uudecoding, and
|
|
Packit |
08bd4c |
archive_position(a,(0)) would return the
|
|
Packit |
08bd4c |
number of bytes after decompression.
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
archive_filter_name()
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
Returns a textual name
|
|
Packit |
08bd4c |
identifying the indicated filter. See
|
|
Packit |
08bd4c |
archive_filter_count() for details of the
|
|
Packit |
08bd4c |
numbering.
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
archive_format()
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
Returns a numeric code
|
|
Packit |
08bd4c |
indicating the format of the current archive entry. This
|
|
Packit |
08bd4c |
value is set by a successful call to
|
|
Packit |
08bd4c |
archive_read_next_header(). Note that it is common
|
|
Packit |
08bd4c |
for this value to change from entry to entry. For example, a
|
|
Packit |
08bd4c |
tar archive might have several entries that utilize GNU tar
|
|
Packit |
08bd4c |
extensions and several entries that do not. These entries
|
|
Packit |
08bd4c |
will have different format codes.
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
archive_format_name()
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
A textual description of the
|
|
Packit |
08bd4c |
format of the current entry.
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
archive_position()
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
Returns the number of bytes
|
|
Packit |
08bd4c |
read from or written to the indicated filter. In particular,
|
|
Packit |
08bd4c |
archive_position(a,(0)) returns the number of
|
|
Packit |
08bd4c |
bytes read or written by the format handler, while
|
|
Packit |
08bd4c |
archive_position(a,(-1)) returns the number of
|
|
Packit |
08bd4c |
bytes read or written to the archive. See
|
|
Packit |
08bd4c |
archive_filter_count() for details of the numbering
|
|
Packit |
08bd4c |
here.
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
archive_set_error()
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
Sets the numeric error code and
|
|
Packit |
08bd4c |
error description that will be returned by
|
|
Packit |
08bd4c |
archive_errno() and archive_error_string().
|
|
Packit |
08bd4c |
This function should be used within I/O callbacks to set
|
|
Packit |
08bd4c |
system-specific error codes and error descriptions. This
|
|
Packit |
08bd4c |
function accepts a printf-like format string and arguments.
|
|
Packit |
08bd4c |
However, you should be careful to use only the following
|
|
Packit |
08bd4c |
printf format specifiers: ’’%c’’,
|
|
Packit |
08bd4c |
’’%d’’,
|
|
Packit |
08bd4c |
’’%jd’’,
|
|
Packit |
08bd4c |
’’%jo’’,
|
|
Packit |
08bd4c |
’’%ju’’,
|
|
Packit |
08bd4c |
’’%jx’’,
|
|
Packit |
08bd4c |
’’%ld’’,
|
|
Packit |
08bd4c |
’’%lo’’,
|
|
Packit |
08bd4c |
’’%lu’’,
|
|
Packit |
08bd4c |
’’%lx’’,
|
|
Packit |
08bd4c |
’’%o’’,
|
|
Packit |
08bd4c |
’’%u’’,
|
|
Packit |
08bd4c |
’’%s’’,
|
|
Packit |
08bd4c |
’’%x’’,
|
|
Packit |
08bd4c |
’’%%’’. Field-width specifiers and
|
|
Packit |
08bd4c |
other printf features are not uniformly supported and should
|
|
Packit |
08bd4c |
not be used.
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
SEE ALSO
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
archive_read(3),
|
|
Packit |
08bd4c |
archive_write(3), libarchive(3), printf(3)
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
HISTORY
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
The libarchive library
|
|
Packit |
08bd4c |
first appeared in FreeBSD 5.3.
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
AUTHORS
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
The libarchive library
|
|
Packit |
08bd4c |
was written by Tim Kientzle <kientzle@acm.org>.
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
BSD
|
|
Packit |
08bd4c |
February 2, 2012 BSD
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
</body>
|
|
Packit |
08bd4c |
</html>
|