source-git / libarchive

Clone
Source Code
GIT

Blame doc/html/archive_util.3.html

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

Powered by Pagure 5.14.1

SSH Hostkey/Fingerprint | Documentation