summaryrefslogtreecommitdiff
path: root/archivers/libarchive/files/doc/man/archive_util.3
diff options
context:
space:
mode:
authorjoerg <joerg@pkgsrc.org>2010-02-20 03:48:25 +0000
committerjoerg <joerg@pkgsrc.org>2010-02-20 03:48:25 +0000
commit813e1c65cfea70db0fa02bd006013a08731f470f (patch)
treef2e9909a57c8ba8f986b13e36ed04e225fc44b2a /archivers/libarchive/files/doc/man/archive_util.3
parenta3bb8bd3027e67eb07c16f479613f290fb214f4a (diff)
downloadpkgsrc-813e1c65cfea70db0fa02bd006013a08731f470f.tar.gz
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
Diffstat (limited to 'archivers/libarchive/files/doc/man/archive_util.3')
-rw-r--r--archivers/libarchive/files/doc/man/archive_util.3187
1 files changed, 72 insertions, 115 deletions
diff --git a/archivers/libarchive/files/doc/man/archive_util.3 b/archivers/libarchive/files/doc/man/archive_util.3
index 6a9b7f562b2..60375aff195 100644
--- a/archivers/libarchive/files/doc/man/archive_util.3
+++ b/archivers/libarchive/files/doc/man/archive_util.3
@@ -1,171 +1,124 @@
.TH archive_util 3 "January 8, 2005" ""
.SH NAME
-\fBarchive_clear_error\fP,
-\fBarchive_compression\fP,
-\fBarchive_compression_name\fP,
-\fBarchive_copy_error\fP,
-\fBarchive_errno\fP,
-\fBarchive_error_string\fP,
-\fBarchive_format\fP,
-\fBarchive_format_name\fP,
-\fBarchive_set_error\fP
+.ad l
+\fB\%archive_clear_error\fP,
+\fB\%archive_compression\fP,
+\fB\%archive_compression_name\fP,
+\fB\%archive_copy_error\fP,
+\fB\%archive_errno\fP,
+\fB\%archive_error_string\fP,
+\fB\%archive_file_count\fP,
+\fB\%archive_format\fP,
+\fB\%archive_format_name\fP,
+\fB\%archive_set_error\fP
\- libarchive utility functions
.SH SYNOPSIS
+.ad l
\fB#include <archive.h>\fP
.br
\fIvoid\fP
-.RE
-.nh
-\fBarchive_clear_error\fP
-.hy
-("struct archive *");
+.br
+\fB\%archive_clear_error\fP(\fI\%struct\ archive\ *\fP);
+.br
\fIint\fP
-.RE
-.nh
-\fBarchive_compression\fP
-.hy
-("struct archive *");
+.br
+\fB\%archive_compression\fP(\fI\%struct\ archive\ *\fP);
+.br
\fIconst char *\fP
-.RE
-.nh
-\fBarchive_compression_name\fP
-.hy
-("struct archive *");
+.br
+\fB\%archive_compression_name\fP(\fI\%struct\ archive\ *\fP);
+.br
\fIvoid\fP
-.RE
-.nh
-\fBarchive_copy_error\fP
-.hy
-("struct archive *" "struct archive *");
+.br
+\fB\%archive_copy_error\fP(\fI\%struct\ archive\ *\fP, \fI\%struct\ archive\ *\fP);
+.br
\fIint\fP
-.RE
-.nh
-\fBarchive_errno\fP
-.hy
-("struct archive *");
+.br
+\fB\%archive_errno\fP(\fI\%struct\ archive\ *\fP);
+.br
\fIconst char *\fP
-.RE
-.nh
-\fBarchive_error_string\fP
-.hy
-("struct archive *");
+.br
+\fB\%archive_error_string\fP(\fI\%struct\ archive\ *\fP);
+.br
\fIint\fP
-.RE
-.nh
-\fBarchive_format\fP
-.hy
-("struct archive *");
+.br
+\fB\%archive_file_count\fP(\fI\%struct\ archive\ *\fP);
+.br
+\fIint\fP
+.br
+\fB\%archive_format\fP(\fI\%struct\ archive\ *\fP);
+.br
\fIconst char *\fP
-.RE
-.nh
-\fBarchive_format_name\fP
-.hy
-("struct archive *");
+.br
+\fB\%archive_format_name\fP(\fI\%struct\ archive\ *\fP);
+.br
\fIvoid\fP
-.RE
-Fo archive_set_error
-Fa "struct archive *"
-Fa "int error_code"
-Fa "const char *fmt"
-Fa "..."
-Fc
+.br
+\fB\%archive_set_error\fP(\fI\%struct\ archive\ *\fP, \fI\%int\ error_code\fP, \fI\%const\ char\ *fmt\fP, \fI\%...\fP);
.SH DESCRIPTION
+.ad l
These functions provide access to various information about the
Tn struct archive
object used in the
\fBlibarchive\fP(3)
library.
+.RS 5
.TP
-.nh
-\fBarchive_clear_error\fP
-.hy
-();
+\fB\%archive_clear_error\fP()
Clears any error information left over from a previous call.
Not generally used in client code.
.TP
-.nh
-\fBarchive_compression\fP
-.hy
-();
+\fB\%archive_compression\fP()
Returns a numeric code indicating the current compression.
This value is set by
-.nh
-\fBarchive_read_open\fP
-.hy
-(.);
+\fB\%archive_read_open\fP().
.TP
-.nh
-\fBarchive_compression_name\fP
-.hy
-();
+\fB\%archive_compression_name\fP()
Returns a text description of the current compression suitable for display.
.TP
-.nh
-\fBarchive_copy_error\fP
-.hy
-();
+\fB\%archive_copy_error\fP()
Copies error information from one archive to another.
.TP
-.nh
-\fBarchive_errno\fP
-.hy
-();
+\fB\%archive_errno\fP()
Returns a numeric error code (see
\fBerrno\fP(2))
indicating the reason for the most recent error return.
.TP
-.nh
-\fBarchive_error_string\fP
-.hy
-();
+\fB\%archive_error_string\fP()
Returns a textual error message suitable for display.
The error message here is usually more specific than that
obtained from passing the result of
-.nh
-\fBarchive_errno\fP
-.hy
-();
+\fB\%archive_errno\fP()
to
\fBstrerror\fP(3).
.TP
-.nh
-\fBarchive_format\fP
-.hy
-();
+\fB\%archive_file_count\fP()
+Returns a count of the number of files processed by this archive object.
+The count is incremented by calls to
+\fBarchive_write_header\fP()
+or
+\fBarchive_read_next_header\fP(.)
+.TP
+\fB\%archive_format\fP()
Returns a numeric code indicating the format of the current
archive entry.
This value is set by a successful call to
-.nh
-\fBarchive_read_next_header\fP
-.hy
-(.);
+\fB\%archive_read_next_header\fP().
Note that it is common for this value to change from
entry to entry.
For example, a tar archive might have several entries that
utilize GNU tar extensions and several entries that do not.
These entries will have different format codes.
.TP
-.nh
-\fBarchive_format_name\fP
-.hy
-();
+\fB\%archive_format_name\fP()
A textual description of the format of the current entry.
.TP
-.nh
-\fBarchive_set_error\fP
-.hy
-();
+\fB\%archive_set_error\fP()
Sets the numeric error code and error description that will be returned
by
-.nh
-\fBarchive_errno\fP
-.hy
-();
+\fB\%archive_errno\fP()
and
-.nh
-\fBarchive_error_string\fP
-.hy
-(.);
+\fB\%archive_error_string\fP().
This function should be used within I/O callbacks to set system-specific
error codes and error descriptions.
This function accepts a printf-like format string and arguments.
@@ -188,19 +141,23 @@ format specifiers:
``%%''.
Field-width specifiers and other printf features are
not uniformly supported and should not be used.
+.RE
.SH SEE ALSO
+.ad l
\fBarchive_read\fP(3),
\fBarchive_write\fP(3),
\fBlibarchive\fP(3),
\fBprintf\fP(3)
.SH HISTORY
+.ad l
The
-\fBlibarchive\fP
+\fB\%libarchive\fP
library first appeared in
FreeBSD 5.3.
.SH AUTHORS
+.ad l
-nosplit
The
-\fBlibarchive\fP
+\fB\%libarchive\fP
library was written by
-Tim Kientzle <kientzle@acm.org.>
+Tim Kientzle \%<kientzle@acm.org.>