contrib/libarchive-2.0/libarchive/archive_util.3

   1 .\" Copyright (c) 2003-2007 Tim Kientzle
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD: src/lib/libarchive/archive_util.3,v 1.6 2007/03/03 07:37:36 kientzle Exp $
  26 .\"
  27 .Dd January 8, 2005
  28 .Dt archive_util 3
  29 .Os
  30 .Sh NAME
  31 .Nm archive_clear_error ,
  32 .Nm archive_compression ,
  33 .Nm archive_compression_name ,
  34 .Nm archive_errno ,
  35 .Nm archive_error_string ,
  36 .Nm archive_format ,
  37 .Nm archive_format_name ,
  38 .Nm archive_set_error
  39 .Nd libarchive utility functions
  40 .Sh SYNOPSIS
  41 .In archive.h
  42 .Ft void
  43 .Fn archive_clear_error "struct archive *"
  44 .Ft int
  45 .Fn archive_compression "struct archive *"
  46 .Ft const char *
  47 .Fn archive_compression_name "struct archive *"
  48 .Ft int
  49 .Fn archive_errno "struct archive *"
  50 .Ft const char *
  51 .Fn archive_error_string "struct archive *"
  52 .Ft int
  53 .Fn archive_format "struct archive *"
  54 .Ft const char *
  55 .Fn archive_format_name "struct archive *"
  56 .Ft void
  57 .Fn archive_set_error "struct archive *" "int error_code" "const char *fmt" "..."
  58 .Sh DESCRIPTION
  59 These functions provide access to various information about the
  60 .Tn struct archive
  61 object used in the
  62 .Xr libarchive 3
  63 library.
  64 .Bl -tag -compact -width indent
  65 .It Fn archive_clear_error
  66 Clears any error information left over from a previous call.
  67 Not generally used in client code.
  68 .It Fn archive_compression
  69 Returns a numeric code indicating the current compression.
  70 This value is set by
  71 .Fn archive_read_open .
  72 .It Fn archive_compression_name
  73 Returns a text description of the current compression suitable for display.
  74 .It Fn archive_errno
  75 Returns a numeric error code (see
  76 .Xr errno 2 )
  77 indicating the reason for the most recent error return.
  78 .It Fn archive_error_string
  79 Returns a textual error message suitable for display.
  80 The error message here is usually more specific than that
  81 obtained from passing the result of
  82 .Fn archive_errno
  83 to
  84 .Xr strerror 3 .
  85 .It Fn archive_format
  86 Returns a numeric code indicating the format of the current
  87 archive entry.
  88 This value is set by a successful call to
  89 .Fn archive_read_next_header .
  90 Note that it is common for this value to change from
  91 entry to entry.
  92 For example, a tar archive might have several entries that
  93 utilize GNU tar extensions and several entries that do not.
  94 These entries will have different format codes.
  95 .It Fn archive_format_name
  96 A textual description of the format of the current entry.
  97 .It Fn archive_set_error
  98 Sets the numeric error code and error description that will be returned
  99 by
 100 .Fn archive_errno
 101 and
 102 .Fn archive_error_string .
 103 This function should be used within I/O callbacks to set system-specific
 104 error codes and error descriptions.
 105 This function accepts a printf-like format string and arguments.
 106 However, you should be careful to use only the following printf
 107 format specifiers:
 108 .Dq %c ,
 109 .Dq %d ,
 110 .Dq %jd ,
 111 .Dq %jo ,
 112 .Dq %ju ,
 113 .Dq %jx ,
 114 .Dq %ld ,
 115 .Dq %lo ,
 116 .Dq %lu ,
 117 .Dq %lx ,
 118 .Dq %o ,
 119 .Dq %u ,
 120 .Dq %s ,
 121 .Dq %x ,
 122 .Dq %% .
 123 Field-width specifiers and other printf features are
 124 not uniformly supported and should not be used.
 125 .El
 126 .Sh SEE ALSO
 127 .Xr archive_read 3 ,
 128 .Xr archive_write 3 ,
 129 .Xr libarchive 3 ,
 130 .Xr printf 3
 131 .Sh HISTORY
 132 The
 133 .Nm libarchive
 134 library first appeared in
 135 .Fx 5.3 .
 136 .Sh AUTHORS
 137 .An -nosplit
 138 The
 139 .Nm libarchive
 140 library was written by
 141 .An Tim Kientzle Aq kientzle@acm.org .