contrib/libarchive-2/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.7 2007/05/29 01:00:19 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_copy_error ,
  35 .Nm archive_errno ,
  36 .Nm archive_error_string ,
  37 .Nm archive_format ,
  38 .Nm archive_format_name ,
  39 .Nm archive_set_error
  40 .Nd libarchive utility functions
  41 .Sh SYNOPSIS
  42 .In archive.h
  43 .Ft void
  44 .Fn archive_clear_error "struct archive *"
  45 .Ft int
  46 .Fn archive_compression "struct archive *"
  47 .Ft const char *
  48 .Fn archive_compression_name "struct archive *"
  49 .Ft void
  50 .Fn archive_copy_error "struct archive *" "struct archive *"
  51 .Ft int
  52 .Fn archive_errno "struct archive *"
  53 .Ft const char *
  54 .Fn archive_error_string "struct archive *"
  55 .Ft int
  56 .Fn archive_format "struct archive *"
  57 .Ft const char *
  58 .Fn archive_format_name "struct archive *"
  59 .Ft void
  60 .Fn archive_set_error "struct archive *" "int error_code" "const char *fmt" "..."
  61 .Sh DESCRIPTION
  62 These functions provide access to various information about the
  63 .Tn struct archive
  64 object used in the
  65 .Xr libarchive 3
  66 library.
  67 .Bl -tag -compact -width indent
  68 .It Fn archive_clear_error
  69 Clears any error information left over from a previous call.
  70 Not generally used in client code.
  71 .It Fn archive_compression
  72 Returns a numeric code indicating the current compression.
  73 This value is set by
  74 .Fn archive_read_open .
  75 .It Fn archive_compression_name
  76 Returns a text description of the current compression suitable for display.
  77 .It Fn archive_copy_error
  78 Copies error information from one archive to another.
  79 .It Fn archive_errno
  80 Returns a numeric error code (see
  81 .Xr errno 2 )
  82 indicating the reason for the most recent error return.
  83 .It Fn archive_error_string
  84 Returns a textual error message suitable for display.
  85 The error message here is usually more specific than that
  86 obtained from passing the result of
  87 .Fn archive_errno
  88 to
  89 .Xr strerror 3 .
  90 .It Fn archive_format
  91 Returns a numeric code indicating the format of the current
  92 archive entry.
  93 This value is set by a successful call to
  94 .Fn archive_read_next_header .
  95 Note that it is common for this value to change from
  96 entry to entry.
  97 For example, a tar archive might have several entries that
  98 utilize GNU tar extensions and several entries that do not.
  99 These entries will have different format codes.
 100 .It Fn archive_format_name
 101 A textual description of the format of the current entry.
 102 .It Fn archive_set_error
 103 Sets the numeric error code and error description that will be returned
 104 by
 105 .Fn archive_errno
 106 and
 107 .Fn archive_error_string .
 108 This function should be used within I/O callbacks to set system-specific
 109 error codes and error descriptions.
 110 This function accepts a printf-like format string and arguments.
 111 However, you should be careful to use only the following printf
 112 format specifiers:
 113 .Dq %c ,
 114 .Dq %d ,
 115 .Dq %jd ,
 116 .Dq %jo ,
 117 .Dq %ju ,
 118 .Dq %jx ,
 119 .Dq %ld ,
 120 .Dq %lo ,
 121 .Dq %lu ,
 122 .Dq %lx ,
 123 .Dq %o ,
 124 .Dq %u ,
 125 .Dq %s ,
 126 .Dq %x ,
 127 .Dq %% .
 128 Field-width specifiers and other printf features are
 129 not uniformly supported and should not be used.
 130 .El
 131 .Sh SEE ALSO
 132 .Xr archive_read 3 ,
 133 .Xr archive_write 3 ,
 134 .Xr libarchive 3 ,
 135 .Xr printf 3
 136 .Sh HISTORY
 137 The
 138 .Nm libarchive
 139 library first appeared in
 140 .Fx 5.3 .
 141 .Sh AUTHORS
 142 .An -nosplit
 143 The
 144 .Nm libarchive
 145 library was written by
 146 .An Tim Kientzle Aq kientzle@acm.org .