diff options
Diffstat (limited to 'archivers/libarchive/files/doc/html/archive_util.3.html')
| -rw-r--r-- | archivers/libarchive/files/doc/html/archive_util.3.html | 705 |
1 files changed, 210 insertions, 495 deletions
diff --git a/archivers/libarchive/files/doc/html/archive_util.3.html b/archivers/libarchive/files/doc/html/archive_util.3.html index f544ca25ab8..e7c2f1f917e 100644 --- a/archivers/libarchive/files/doc/html/archive_util.3.html +++ b/archivers/libarchive/files/doc/html/archive_util.3.html @@ -1,495 +1,210 @@ -%!PS-Adobe-3.0 -%%Creator: groff version 1.19.2 -%%CreationDate: Sun Mar 14 02:49:16 2010 -%%DocumentNeededResources: font Times-Roman -%%DocumentSuppliedResources: procset grops 1.19 2 -%%Pages: 27 -%%PageOrder: Ascend -%%DocumentMedia: Default 612 792 0 () () -%%Orientation: Portrait -%%EndComments -%%BeginDefaults -%%PageMedia: Default -%%EndDefaults -%%BeginProlog -%%BeginResource: procset grops 1.19 2 -%!PS-Adobe-3.0 Resource-ProcSet -/setpacking where{ -pop -currentpacking -true setpacking -}if -/grops 120 dict dup begin -/SC 32 def -/A/show load def -/B{0 SC 3 -1 roll widthshow}bind def -/C{0 exch ashow}bind def -/D{0 exch 0 SC 5 2 roll awidthshow}bind def -/E{0 rmoveto show}bind def -/F{0 rmoveto 0 SC 3 -1 roll widthshow}bind def -/G{0 rmoveto 0 exch ashow}bind def -/H{0 rmoveto 0 exch 0 SC 5 2 roll awidthshow}bind def -/I{0 exch rmoveto show}bind def -/J{0 exch rmoveto 0 SC 3 -1 roll widthshow}bind def -/K{0 exch rmoveto 0 exch ashow}bind def -/L{0 exch rmoveto 0 exch 0 SC 5 2 roll awidthshow}bind def -/M{rmoveto show}bind def -/N{rmoveto 0 SC 3 -1 roll widthshow}bind def -/O{rmoveto 0 exch ashow}bind def -/P{rmoveto 0 exch 0 SC 5 2 roll awidthshow}bind def -/Q{moveto show}bind def -/R{moveto 0 SC 3 -1 roll widthshow}bind def -/S{moveto 0 exch ashow}bind def -/T{moveto 0 exch 0 SC 5 2 roll awidthshow}bind def -/SF{ -findfont exch -[exch dup 0 exch 0 exch neg 0 0]makefont -dup setfont -[exch/setfont cvx]cvx bind def -}bind def -/MF{ -findfont -[5 2 roll -0 3 1 roll -neg 0 0]makefont -dup setfont -[exch/setfont cvx]cvx bind def -}bind def -/level0 0 def -/RES 0 def -/PL 0 def -/LS 0 def -/MANUAL{ -statusdict begin/manualfeed true store end -}bind def -/PLG{ -gsave newpath clippath pathbbox grestore -exch pop add exch pop -}bind def -/BP{ -/level0 save def -1 setlinecap -1 setlinejoin -72 RES div dup scale -LS{ -90 rotate -}{ -0 PL translate -}ifelse -1 -1 scale -}bind def -/EP{ -level0 restore -showpage -}def -/DA{ -newpath arcn stroke -}bind def -/SN{ -transform -.25 sub exch .25 sub exch -round .25 add exch round .25 add exch -itransform -}bind def -/DL{ -SN -moveto -SN -lineto stroke -}bind def -/DC{ -newpath 0 360 arc closepath -}bind def -/TM matrix def -/DE{ -TM currentmatrix pop -translate scale newpath 0 0 .5 0 360 arc closepath -TM setmatrix -}bind def -/RC/rcurveto load def -/RL/rlineto load def -/ST/stroke load def -/MT/moveto load def -/CL/closepath load def -/Fr{ -setrgbcolor fill -}bind def -/setcmykcolor where{ -pop -/Fk{ -setcmykcolor fill -}bind def -}if -/Fg{ -setgray fill -}bind def -/FL/fill load def -/LW/setlinewidth load def -/Cr/setrgbcolor load def -/setcmykcolor where{ -pop -/Ck/setcmykcolor load def -}if -/Cg/setgray load def -/RE{ -findfont -dup maxlength 1 index/FontName known not{1 add}if dict begin -{ -1 index/FID ne{def}{pop pop}ifelse -}forall -/Encoding exch def -dup/FontName exch def -currentdict end definefont pop -}bind def -/DEFS 0 def -/EBEGIN{ -moveto -DEFS begin -}bind def -/EEND/end load def -/CNT 0 def -/level1 0 def -/PBEGIN{ -/level1 save def -translate -div 3 1 roll div exch scale -neg exch neg exch translate -0 setgray -0 setlinecap -1 setlinewidth -0 setlinejoin -10 setmiterlimit -[]0 setdash -/setstrokeadjust where{ -pop -false setstrokeadjust -}if -/setoverprint where{ -pop -false setoverprint -}if -newpath -/CNT countdictstack def -userdict begin -/showpage{}def -/setpagedevice{}def -}bind def -/PEND{ -countdictstack CNT sub{end}repeat -level1 restore -}bind def -end def -/setpacking where{ -pop -setpacking -}if -%%EndResource -%%EndProlog -%%BeginSetup -%%BeginFeature: *PageSize Default -<< /PageSize [ 612 792 ] /ImagingBBox null >> setpagedevice -%%EndFeature -%%IncludeResource: font Times-Roman -grops begin/DEFS 1 dict def DEFS begin/u{.001 mul}bind def end/RES 72 -def/PL 792 def/LS false def/ENC0[/asciicircum/asciitilde/Scaron/Zcaron -/scaron/zcaron/Ydieresis/trademark/quotesingle/Euro/.notdef/.notdef -/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef -/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef -/.notdef/.notdef/space/exclam/quotedbl/numbersign/dollar/percent -/ampersand/quoteright/parenleft/parenright/asterisk/plus/comma/hyphen -/period/slash/zero/one/two/three/four/five/six/seven/eight/nine/colon -/semicolon/less/equal/greater/question/at/A/B/C/D/E/F/G/H/I/J/K/L/M/N/O -/P/Q/R/S/T/U/V/W/X/Y/Z/bracketleft/backslash/bracketright/circumflex -/underscore/quoteleft/a/b/c/d/e/f/g/h/i/j/k/l/m/n/o/p/q/r/s/t/u/v/w/x/y -/z/braceleft/bar/braceright/tilde/.notdef/quotesinglbase/guillemotleft -/guillemotright/bullet/florin/fraction/perthousand/dagger/daggerdbl -/endash/emdash/ff/fi/fl/ffi/ffl/dotlessi/dotlessj/grave/hungarumlaut -/dotaccent/breve/caron/ring/ogonek/quotedblleft/quotedblright/oe/lslash -/quotedblbase/OE/Lslash/.notdef/exclamdown/cent/sterling/currency/yen -/brokenbar/section/dieresis/copyright/ordfeminine/guilsinglleft -/logicalnot/minus/registered/macron/degree/plusminus/twosuperior -/threesuperior/acute/mu/paragraph/periodcentered/cedilla/onesuperior -/ordmasculine/guilsinglright/onequarter/onehalf/threequarters -/questiondown/Agrave/Aacute/Acircumflex/Atilde/Adieresis/Aring/AE -/Ccedilla/Egrave/Eacute/Ecircumflex/Edieresis/Igrave/Iacute/Icircumflex -/Idieresis/Eth/Ntilde/Ograve/Oacute/Ocircumflex/Otilde/Odieresis -/multiply/Oslash/Ugrave/Uacute/Ucircumflex/Udieresis/Yacute/Thorn -/germandbls/agrave/aacute/acircumflex/atilde/adieresis/aring/ae/ccedilla -/egrave/eacute/ecircumflex/edieresis/igrave/iacute/icircumflex/idieresis -/eth/ntilde/ograve/oacute/ocircumflex/otilde/odieresis/divide/oslash -/ugrave/uacute/ucircumflex/udieresis/yacute/thorn/ydieresis]def -/Times-Roman@0 ENC0/Times-Roman RE -%%EndSetup -%%Page: 1 1 -%%BeginPageSetup -BP -%%EndPageSetup -/F0 10/Times-Roman@0 SF(<html>)0 12 Q(<head>)0 24 Q(<title>)36 36 Q -(January 8, 2005 archi)74.5 48 Q -.15(ve)-.25 G(_util 3).15 E(</title>) -36 72 Q 0 Cg EP -%%Page: 2 2 -%%BeginPageSetup -BP -%%EndPageSetup -/F0 10/Times-Roman@0 SF(<style type="te)36 12 Q(xt/css">)-.15 E(<!--)36 -24 Q(body { mar)72 36 Q(gin-left:4%; })-.18 E(H1, H2, H3, H4, H5 {)72 48 -Q(color: maroon; padding: 4pt; mar)108 60 Q(gin-left: -4%;)-.18 E -(border: solid; border)108 72 Q(-width: thin; width: 100%;)-.2 E 0 Cg EP -%%Page: 3 3 -%%BeginPageSetup -BP -%%EndPageSetup -/F0 10/Times-Roman@0 SF(background: r)108 12 Q(gb\(204,204,255\))-.18 E -(})72 24 Q(-->)36 36 Q(</style>)36 48 Q(</head>)0 60 Q -(<body bgcolor="#FFFFFF" te)0 72 Q(xt="#000000">)-.15 E 0 Cg EP -%%Page: 4 4 -%%BeginPageSetup -BP -%%EndPageSetup -/F0 10/Times-Roman@0 SF(<h3 id="N)36 12 Q(AME">)-.35 E -.35(NA)36 24 S -(ME).35 E(</h3>)36 36 Q(<b>archi)0 48 Q -.15(ve)-.25 G -(_clear_error</b>,).15 E(<b>archi)0 60 Q -.15(ve)-.25 G -(_compression</b>,).15 E(<b>archi)0 72 Q -.15(ve)-.25 G -(_compression_name</b>,).15 E 0 Cg EP -%%Page: 5 5 -%%BeginPageSetup -BP -%%EndPageSetup -/F0 10/Times-Roman@0 SF(<b>archi)0 12 Q -.15(ve)-.25 G(_cop).15 E -(y_error</b>,)-.1 E(<b>archi)0 24 Q -.15(ve)-.25 G(_errno</b>,).15 E -(<b>archi)0 36 Q -.15(ve)-.25 G(_error_string</b>,).15 E(<b>archi)0 48 Q --.15(ve)-.25 G(_\214le_count</b>,).15 E(<b>archi)0 60 Q -.15(ve)-.25 G -(_format</b>,).15 E(<b>archi)0 72 Q -.15(ve)-.25 G(_format_name</b>,).15 -E 0 Cg EP -%%Page: 6 6 -%%BeginPageSetup -BP -%%EndPageSetup -/F0 10/Times-Roman@0 SF(<b>archi)0 12 Q -.15(ve)-.25 G(_set_error</b>) -.15 E 2.5(-l)0 24 S(ibarchi)-2.5 E .3 -.15(ve u)-.25 H(tility functions) -.15 E(<h3 id="SYNOPSIS">)36 36 Q(SYNOPSIS)36 48 Q(</h3>)36 60 Q -(<br><br><code></code><code>v)0 72 Q(oid</code>)-.2 E 0 Cg EP -%%Page: 7 7 -%%BeginPageSetup -BP -%%EndPageSetup -/F0 10/Times-Roman@0 SF(<b>archi)0 12 Q -.15(ve)-.25 G -(_clear_error</b>\(<code></code><code>struct archi).15 E .3 -.15(ve *) --.25 H(</code>\)).15 E(<br><br><code></code><code>int</code>)0 24 Q -(<b>archi)0 36 Q -.15(ve)-.25 G -(_compression</b>\(<code></code><code>struct archi).15 E .3 -.15(ve *) --.25 H(</code>\)).15 E(<br><br><code></code><code>const</code><code> ch\ -ar</code><code> *</code>)0 48 Q(<b>archi)0 60 Q -.15(ve)-.25 G -(_compression_name</b>\(<code></code><code>struct archi).15 E .3 -.15 -(ve *)-.25 H(</code>\)).15 E(<br><br><code></code><code>v)0 72 Q -(oid</code>)-.2 E 0 Cg EP -%%Page: 8 8 -%%BeginPageSetup -BP -%%EndPageSetup -/F0 10/Times-Roman@0 SF(<b>archi)0 12 Q -.15(ve)-.25 G(_cop).15 E -(y_error</b>\(<code></code><code>struct archi)-.1 E .3 -.15(ve *)-.25 H -(</code><code>, struct archi).15 E .3 -.15(ve *)-.25 H(</code>\)).15 E -(<br><br><code></code><code>int</code>)0 24 Q(<b>archi)0 36 Q -.15(ve) --.25 G(_errno</b>\(<code></code><code>struct archi).15 E .3 -.15(ve *) --.25 H(</code>\)).15 E(<br><br><code></code><code>const</code><code> ch\ -ar</code><code> *</code>)0 48 Q(<b>archi)0 60 Q -.15(ve)-.25 G -(_error_string</b>\(<code></code><code>struct archi).15 E .3 -.15(ve *) --.25 H(</code>\)).15 E(<br><br><code></code><code>int</code>)0 72 Q 0 Cg -EP -%%Page: 9 9 -%%BeginPageSetup -BP -%%EndPageSetup -/F0 10/Times-Roman@0 SF(<b>archi)0 12 Q -.15(ve)-.25 G -(_\214le_count</b>\(<code></code><code>struct archi).15 E .3 -.15(ve *) --.25 H(</code>\)).15 E(<br><br><code></code><code>int</code>)0 24 Q -(<b>archi)0 36 Q -.15(ve)-.25 G -(_format</b>\(<code></code><code>struct archi).15 E .3 -.15(ve *)-.25 H -(</code>\)).15 E(<br><br><code></code><code>const</code><code> char</co\ -de><code> *</code>)0 48 Q(<b>archi)0 60 Q -.15(ve)-.25 G -(_format_name</b>\(<code></code><code>struct archi).15 E .3 -.15(ve *) --.25 H(</code>\)).15 E(<br><br><code></code><code>v)0 72 Q(oid</code>) --.2 E 0 Cg EP -%%Page: 10 10 -%%BeginPageSetup -BP -%%EndPageSetup -/F0 10/Times-Roman@0 SF(<b>archi)0 12 Q -.15(ve)-.25 G -(_set_error</b>\(<code></code>).15 E(<code></code><code>struct archi)0 -24 Q .3 -.15(ve *)-.25 H(</code>).15 E -(<code></code><code>int error_code</code>)0 36 Q -(<code></code><code>const char *fmt</code>)0 48 Q -(<code></code><code>...</code>)0 60 Q(\))0 72 Q 0 Cg EP -%%Page: 11 11 -%%BeginPageSetup -BP -%%EndPageSetup -/F0 10/Times-Roman@0 SF(<h3 id="DESCRIPTION">)36 12 Q(DESCRIPTION)36 24 -Q(</h3>)36 36 Q(These functions pro)0 48 Q(vide access to v)-.15 E -(arious information about the)-.25 E(<font size="-1"></font><font size=\ -"-1">struct</font><font size="-1"> archi)0 60 Q -.15(ve)-.25 G(</font>) -.15 E(object used in the)0 72 Q 0 Cg EP -%%Page: 12 12 -%%BeginPageSetup -BP -%%EndPageSetup -/F0 10/Times-Roman@0 SF(<a href="../html3/libarchi)0 12 Q -.15(ve)-.25 G -(.html">libarchi).15 E -.15(ve)-.25 G(\(3\)</a>).15 E(library)0 24 Q(.) --.65 E(<dl compact>)0 36 Q(<dt><b>archi)0 48 Q -.15(ve)-.25 G -(_clear_error</b>\(<code></code>\)<dd>).15 E(Clears an)0 60 Q 2.5(ye) --.15 G(rror information left o)-2.5 E -.15(ve)-.15 G 2.5(rf).15 G -(rom a pre)-2.5 E(vious call.)-.25 E(Not generally used in client code.) -0 72 Q 0 Cg EP -%%Page: 13 13 -%%BeginPageSetup -BP -%%EndPageSetup -/F0 10/Times-Roman@0 SF(<dt><b>archi)0 12 Q -.15(ve)-.25 G -(_compression</b>\(<code></code>\)<dd>).15 E -(Returns a numeric code indicating the current compression.)0 24 Q -(This v)0 36 Q(alue is set by)-.25 E(<b>archi)0 48 Q -.15(ve)-.25 G -(_read_open</b>\(<code></code>\).).15 E(<dt><b>archi)0 60 Q -.15(ve)-.25 -G(_compression_name</b>\(<code></code>\)<dd>).15 E(Returns a te)0 72 Q -(xt description of the current compression suitable for display)-.15 E -(.)-.65 E 0 Cg EP -%%Page: 14 14 -%%BeginPageSetup -BP -%%EndPageSetup -/F0 10/Times-Roman@0 SF(<dt><b>archi)0 12 Q -.15(ve)-.25 G(_cop).15 E -(y_error</b>\(<code></code>\)<dd>)-.1 E -(Copies error information from one archi)0 24 Q .3 -.15(ve t)-.25 H 2.5 -(oa).15 G(nother)-2.5 E(.)-.55 E(<dt><b>archi)0 36 Q -.15(ve)-.25 G -(_errno</b>\(<code></code>\)<dd>).15 E -(Returns a numeric error code \(see)0 48 Q -(<a href="../html2/errno.html">errno\(2\)</a>\))0 60 Q -(indicating the reason for the most recent error return.)0 72 Q 0 Cg EP -%%Page: 15 15 -%%BeginPageSetup -BP -%%EndPageSetup -/F0 10/Times-Roman@0 SF(<dt><b>archi)0 12 Q -.15(ve)-.25 G -(_error_string</b>\(<code></code>\)<dd>).15 E(Returns a te)0 24 Q -(xtual error message suitable for display)-.15 E(.)-.65 E -(The error message here is usually more speci\214c than that)0 36 Q -(obtained from passing the result of)0 48 Q(<b>archi)0 60 Q -.15(ve)-.25 -G(_errno</b>\(<code></code>\)).15 E(to)0 72 Q 0 Cg EP -%%Page: 16 16 -%%BeginPageSetup -BP -%%EndPageSetup -/F0 10/Times-Roman@0 SF(<a href="../html3/strerror)0 12 Q -(.html">strerror\(3\)</a>.)-.55 E(<dt><b>archi)0 24 Q -.15(ve)-.25 G -(_\214le_count</b>\(<code></code>\)<dd>).15 E -(Returns a count of the number of \214les processed by this archi)0 36 Q -.3 -.15(ve o)-.25 H(bject.).15 E(The count is incremented by calls to)0 -48 Q(<code>archi)0 60 Q -.15(ve)-.25 G(_write_header</code>).15 E(or)0 -72 Q 0 Cg EP -%%Page: 17 17 -%%BeginPageSetup -BP -%%EndPageSetup -/F0 10/Times-Roman@0 SF(<code>archi)0 12 Q -.15(ve)-.25 G(_read_ne).15 E -(xt_header</code>)-.15 E(<dt><b>archi)0 24 Q -.15(ve)-.25 G -(_format</b>\(<code></code>\)<dd>).15 E -(Returns a numeric code indicating the format of the current)0 36 Q -(archi)0 48 Q .3 -.15(ve e)-.25 H(ntry).15 E(.)-.65 E(This v)0 60 Q -(alue is set by a successful call to)-.25 E(<b>archi)0 72 Q -.15(ve)-.25 -G(_read_ne).15 E(xt_header</b>\(<code></code>\).)-.15 E 0 Cg EP -%%Page: 18 18 -%%BeginPageSetup -BP -%%EndPageSetup -/F0 10/Times-Roman@0 SF(Note that it is common for this v)0 12 Q -(alue to change from)-.25 E(entry to entry)0 24 Q(.)-.65 E -.15(Fo)0 36 -S 2.5(re).15 G(xample, a tar archi)-2.65 E .3 -.15(ve m)-.25 H(ight ha) -.15 E .3 -.15(ve s)-.2 H -2.15 -.25(ev e).15 H(ral entries that).25 E -(utilize GNU tar e)0 48 Q(xtensions and se)-.15 E -.15(ve)-.25 G -(ral entries that do not.).15 E(These entries will ha)0 60 Q .3 -.15 -(ve d)-.2 H(if).15 E(ferent format codes.)-.25 E(<dt><b>archi)0 72 Q --.15(ve)-.25 G(_format_name</b>\(<code></code>\)<dd>).15 E 0 Cg EP -%%Page: 19 19 -%%BeginPageSetup -BP -%%EndPageSetup -/F0 10/Times-Roman@0 SF 2.5(At)0 12 S -.15(ex)-2.5 G -(tual description of the format of the current entry).15 E(.)-.65 E -(<dt><b>archi)0 24 Q -.15(ve)-.25 G(_set_error</b>\(<code></code>\)<dd>) -.15 E(Sets the numeric error code and error description that will be re\ -turned)0 36 Q(by)0 48 Q(<b>archi)0 60 Q -.15(ve)-.25 G -(_errno</b>\(<code></code>\)).15 E(and)0 72 Q 0 Cg EP -%%Page: 20 20 -%%BeginPageSetup -BP -%%EndPageSetup -/F0 10/Times-Roman@0 SF(<b>archi)0 12 Q -.15(ve)-.25 G -(_error_string</b>\(<code></code>\).).15 E(This function should be used\ - within I/O callbacks to set system-speci\214c)0 24 Q -(error codes and error descriptions.)0 36 Q -(This function accepts a printf-lik)0 48 Q 2.5(ef)-.1 G -(ormat string and ar)-2.5 E(guments.)-.18 E(Ho)0 60 Q(we)-.25 E -.15(ve) --.25 G .8 -.4(r, y).15 H(ou should be careful to use only the follo).4 E -(wing printf)-.25 E(format speci\214ers:)0 72 Q 0 Cg EP -%%Page: 21 21 -%%BeginPageSetup -BP -%%EndPageSetup -/F0 10/Times-Roman@0 SF -.74(``)0 12 S(%c').74 E(',)-.74 E -.74(``)0 24 -S(%d').74 E(',)-.74 E -.74(``)0 36 S(%jd').74 E(',)-.74 E -.74(``)0 48 S -(%jo').74 E(',)-.74 E -.74(``)0 60 S(%ju').74 E(',)-.74 E -.74(``)0 72 S -(%jx').74 E(',)-.74 E 0 Cg EP -%%Page: 22 22 -%%BeginPageSetup -BP -%%EndPageSetup -/F0 10/Times-Roman@0 SF -.74(``)0 12 S(%ld').74 E(',)-.74 E -.74(``)0 24 -S(%lo').74 E(',)-.74 E -.74(``)0 36 S(%lu').74 E(',)-.74 E -.74(``)0 48 -S(%lx').74 E(',)-.74 E -.74(``)0 60 S(%o').74 E(',)-.74 E -.74(``)0 72 S -(%u').74 E(',)-.74 E 0 Cg EP -%%Page: 23 23 -%%BeginPageSetup -BP -%%EndPageSetup -/F0 10/Times-Roman@0 SF -.74(``)0 12 S(%s').74 E(',)-.74 E -.74(``)0 24 -S(%x').74 E(',)-.74 E -.74(``)0 36 S(%%').74 E('.)-.74 E -(Field-width speci\214ers and other printf features are)0 48 Q -(not uniformly supported and should not be used.)0 60 Q(</dl>)0 72 Q 0 -Cg EP -%%Page: 24 24 -%%BeginPageSetup -BP -%%EndPageSetup -/F0 10/Times-Roman@0 SF(<h3 id="SEE ALSO">)36 12 Q(SEE ALSO)36 24 Q -(</h3>)36 36 Q(<a href="../html3/archi)0 48 Q -.15(ve)-.25 G -(_read.html">archi).15 E -.15(ve)-.25 G(_read\(3\)</a>,).15 E -(<a href="../html3/archi)0 60 Q -.15(ve)-.25 G(_write.html">archi).15 E --.15(ve)-.25 G(_write\(3\)</a>,).15 E(<a href="../html3/libarchi)0 72 Q --.15(ve)-.25 G(.html">libarchi).15 E -.15(ve)-.25 G(\(3\)</a>,).15 E 0 -Cg EP -%%Page: 25 25 -%%BeginPageSetup -BP -%%EndPageSetup -/F0 10/Times-Roman@0 SF(<a href="../html3/printf.html">printf\(3\)</a>)0 -12 Q(<h3 id="HIST)36 24 Q(OR)-.18 E(Y">)-.65 E(HIST)36 36 Q(OR)-.18 E(Y) --.65 E(</h3>)36 48 Q(The)0 60 Q(<b>libarchi)0 72 Q -.15(ve)-.25 G(</b>) -.15 E 0 Cg EP -%%Page: 26 26 -%%BeginPageSetup -BP -%%EndPageSetup -/F0 10/Times-Roman@0 SF(library \214rst appeared in)0 12 Q(FreeBSD5.3.)0 -24 Q(<h3 id="A)36 36 Q(UTHORS">)-.55 E -.55(AU)36 48 S(THORS).55 E -(</h3>)36 60 Q(<p>)36 72 Q 0 Cg EP -%%Page: 27 27 -%%BeginPageSetup -BP -%%EndPageSetup -/F0 10/Times-Roman@0 SF(The)0 12 Q(<b>libarchi)0 24 Q -.15(ve)-.25 G -(</b>).15 E(library w)0 36 Q(as written by)-.1 E -.35(Ti)0 48 S 2.5(mK) -.35 G(ientzle <kientzle@acm.or)-2.5 E(g>.)-.18 E(</body>)0 60 Q -(</html>)0 72 Q 0 Cg EP -%%Trailer -end -%%EOF +<!-- Creator : groff version 1.19.2 --> +<!-- CreationDate: Sun Mar 14 19:50:20 2010 --> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" +"http://www.w3.org/TR/html4/loose.dtd"> +<html> +<head> +<meta name="generator" content="groff -Thtml, see www.gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<meta name="Content-Style" content="text/css"> +<style type="text/css"> + p { margin-top: 0; margin-bottom: 0; } + pre { margin-top: 0; margin-bottom: 0; } + table { margin-top: 0; margin-bottom: 0; } +</style> +<title></title> +</head> +<body> + +<hr> + + +<p valign="top">archive_util(3) FreeBSD Library Functions +Manual archive_util(3)</p> + +<p style="margin-top: 1em" valign="top"><b>NAME</b></p> + +<p style="margin-left:8%;"><b>archive_clear_error</b>, +<b>archive_compression</b>, <b>archive_compression_name</b>, +<b>archive_copy_error</b>, <b>archive_errno</b>, +<b>archive_error_string</b>, <b>archive_file_count</b>, +<b>archive_format</b>, <b>archive_format_name</b>, +<b>archive_set_error</b> — libarchive utility +functions</p> + + +<p style="margin-top: 1em" valign="top"><b>SYNOPSIS</b></p> + +<p style="margin-left:8%;"><b>#include +<archive.h></b></p> + +<p style="margin-left:8%; margin-top: 1em"><i>void</i></p> + + +<p style="margin-left:14%;"><b>archive_clear_error</b>(<i>struct archive *</i>);</p> + +<p style="margin-left:8%; margin-top: 1em"><i>int</i></p> + + +<p style="margin-left:14%;"><b>archive_compression</b>(<i>struct archive *</i>);</p> + +<p style="margin-left:8%; margin-top: 1em"><i>const char +*</i></p> + + +<p style="margin-left:14%;"><b>archive_compression_name</b>(<i>struct archive *</i>);</p> + +<p style="margin-left:8%; margin-top: 1em"><i>void</i></p> + + +<p style="margin-left:14%;"><b>archive_copy_error</b>(<i>struct archive *</i>, +<i>struct archive *</i>);</p> + +<p style="margin-left:8%; margin-top: 1em"><i>int</i></p> + + +<p style="margin-left:14%;"><b>archive_errno</b>(<i>struct archive *</i>);</p> + +<p style="margin-left:8%; margin-top: 1em"><i>const char +*</i></p> + + +<p style="margin-left:14%;"><b>archive_error_string</b>(<i>struct archive *</i>);</p> + +<p style="margin-left:8%; margin-top: 1em"><i>int</i></p> + + +<p style="margin-left:14%;"><b>archive_file_count</b>(<i>struct archive *</i>);</p> + +<p style="margin-left:8%; margin-top: 1em"><i>int</i></p> + + +<p style="margin-left:14%;"><b>archive_format</b>(<i>struct archive *</i>);</p> + +<p style="margin-left:8%; margin-top: 1em"><i>const char +*</i></p> + + +<p style="margin-left:14%;"><b>archive_format_name</b>(<i>struct archive *</i>);</p> + +<p style="margin-left:8%; margin-top: 1em"><i>void</i></p> + + +<p valign="top"><b>archive_set_error</b>(<i>struct archive *</i>, +<i>int error_code</i>, +<i>const char *fmt</i>, <i>...</i>);</p> + + +<p style="margin-top: 1em" valign="top"><b>DESCRIPTION</b></p> + +<p style="margin-left:8%;">These functions provide access +to various information about the struct archive object used +in the libarchive(3) library.</p> + +<p valign="top"><b>archive_clear_error</b>()</p> + +<p style="margin-left:20%;">Clears any error information +left over from a previous call. Not generally used in client +code.</p> + +<p valign="top"><b>archive_compression</b>()</p> + +<p style="margin-left:20%;">Returns a numeric code +indicating the current compression. This value is set by +<b>archive_read_open</b>().</p> + +<p valign="top"><b>archive_compression_name</b>()</p> + +<p style="margin-left:20%;">Returns a text description of +the current compression suitable for display.</p> + +<p valign="top"><b>archive_copy_error</b>()</p> + +<p style="margin-left:20%;">Copies error information from +one archive to another.</p> + +<p valign="top"><b>archive_errno</b>()</p> + +<p style="margin-left:20%;">Returns a numeric error code +(see errno(2)) indicating the reason for the most recent +error return.</p> + +<p valign="top"><b>archive_error_string</b>()</p> + +<p style="margin-left:20%;">Returns a textual error message +suitable for display. The error message here is usually more +specific than that obtained from passing the result of +<b>archive_errno</b>() to strerror(3).</p> + +<p valign="top"><b>archive_file_count</b>()</p> + +<p style="margin-left:20%;">Returns a count of the number +of files processed by this archive object. The count is +incremented by calls to archive_write_header or +archive_read_next_header.</p> + +<p valign="top"><b>archive_format</b>()</p> + +<p style="margin-left:20%;">Returns a numeric code +indicating the format of the current archive entry. This +value is set by a successful call to +<b>archive_read_next_header</b>(). 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.</p> + +<p valign="top"><b>archive_format_name</b>()</p> + +<p style="margin-left:20%;">A textual description of the +format of the current entry.</p> + +<p valign="top"><b>archive_set_error</b>()</p> + +<p style="margin-left:20%;">Sets the numeric error code and +error description that will be returned by +<b>archive_errno</b>() and <b>archive_error_string</b>(). +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. +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.</p> + +<p style="margin-top: 1em" valign="top"><b>SEE ALSO</b></p> + +<p style="margin-left:8%;">archive_read(3), +archive_write(3), libarchive(3), printf(3)</p> + +<p style="margin-top: 1em" valign="top"><b>HISTORY</b></p> + +<p style="margin-left:8%;">The <b>libarchive</b> library +first appeared in FreeBSD 5.3.</p> + +<p style="margin-top: 1em" valign="top"><b>AUTHORS</b></p> + +<p style="margin-left:8%;">The <b>libarchive</b> library +was written by Tim Kientzle +⟨kientzle@acm.org⟩.</p> + + +<p style="margin-left:8%; margin-top: 1em">FreeBSD 9.0 +January 8, 2005 FreeBSD 9.0</p> +<hr> +</body> +</html> |