1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
|
<!-- Creator : groff version 1.19.2 -->
<!-- CreationDate: Thu Feb 4 20:36:32 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 8.0
January 8, 2005 FreeBSD 8.0</p>
<hr>
</body>
</html>
|
