Skip site navigation (1)Skip section navigation (2)

FreeBSD Man Pages

Man Page or Keyword Search:
Man Architecture
Apropos Keyword Search (all sections) Output format
home | help
archive_util(3)        FreeBSD Library Functions Manual        archive_util(3)

NAME
     archive_compression, archive_compression_name, archive_errno,
     archive_error_string, archive_format, archive_format_name,
     archive_set_error -- libarchive utility functions

SYNOPSIS
     #include <archive.h>

     int
     archive_compression(struct archive *);

     const char *
     archive_compression_name(struct archive *);

     int
     archive_errno(struct archive *);

     const char *
     archive_error_string(struct archive *);

     int
     archive_format(struct archive *);

     const char *
     archive_format_name(struct archive *);

     void
     archive_set_error(struct archive *, int error_code, const char *fmt,
         ...);

DESCRIPTION
     These functions provide access to various information about the struct
     archive object used in the libarchive(3) library.
     archive_compression()
             Returns a numeric code indicating the current compression.  This
             value is set by archive_read_open().
     archive_compression_name()
             Returns a text description of the current compression suitable
             for display.
     archive_errno()
             Returns a numeric error code (see errno(2)) indicating the reason
             for the most recent error return.
     archive_error_string()
             Returns a textual error message suitable for display.  The error
             message here is usually more specific than that obtained from
             passing the result of archive_errno() to strerror(3).
     archive_format()
             Returns a numeric code indicating the format of the current ar-
             chive entry.  This value is set by a successful call to
             archive_read_next_header().  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.
     archive_format_name()
             A textual description of the format of the current entry.
     archive_set_error()
             Sets the numeric error code and error description that will be
             returned by archive_errno() and archive_error_string().  This
             function should be used within I/O callbacks to set system-spe-
             cific error codes and error descriptions.  This function accepts
             a printf-like format string and arguments.  However, you should
             be careful to use only the following printf format specifiers:
             ``%c'', ``%d'', ``%jd'', ``%jo'', ``%ju'', ``%jx'', ``%ld'',
             ``%lo'', ``%lu'', ``%lx'', ``%o'', ``%u'', ``%s'', ``%x'',
             ``%%''.  Field-width specifiers and other printf features are not
             uniformly supported and should not be used.

SEE ALSO
     archive_read(3), archive_write(3), libarchive(3), printf(3)

HISTORY
     The libarchive library first appeared in FreeBSD 5.3.

AUTHORS
     The libarchive library was written by Tim Kientzle <kientzle@acm.org>.

FreeBSD 6.2                     January 8, 2005                    FreeBSD 6.2

NAME | SYNOPSIS | DESCRIPTION | SEE ALSO | HISTORY | AUTHORS

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=archive_util&sektion=3&manpath=FreeBSD+6.2-RELEASE>

home | help