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
211
212
213
214
215
216
217
218
219
220
221
|
<!-- Creator : groff version 1.23.0 -->
<!-- CreationDate: Mon Jan 5 10:42:44 2026 -->
<!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; vertical-align: top }
pre { margin-top: 0; margin-bottom: 0; vertical-align: top }
table { margin-top: 0; margin-bottom: 0; vertical-align: top }
h1 { text-align: center }
</style>
<title></title>
</head>
<body>
<hr>
<p><i>ARCHIVE_READ_FILTER</i>(3) Library Functions Manual
<i>ARCHIVE_READ_FILTER</i>(3)</p>
<p style="margin-top: 1em"><b>NAME</b></p>
<p style="margin-left:9%;">archive_read_support_filter_all,
archive_read_support_filter_bzip2,
archive_read_support_filter_compress,
archive_read_support_filter_gzip,
archive_read_support_filter_lz4,
archive_read_support_filter_lzma,
archive_read_support_filter_none,
archive_read_support_filter_rpm,
archive_read_support_filter_uu,
archive_read_support_filter_xz,
archive_read_support_filter_zstd,
archive_read_support_filter_program,
archive_read_support_filter_program_signature —
functions for reading streaming archives</p>
<p style="margin-top: 1em"><b>LIBRARY</b></p>
<p style="margin-left:9%;">Streaming Archive Library
(libarchive, -larchive)</p>
<p style="margin-top: 1em"><b>SYNOPSIS</b></p>
<p style="margin-left:9%;"><b>#include
<archive.h></b></p>
<p style="margin-left:9%; margin-top: 1em"><i>int</i></p>
<p style="margin-left:14%;"><b>archive_read_support_filter_all</b>(<i>struct archive *</i>);</p>
<p style="margin-left:9%; margin-top: 1em"><i>int</i></p>
<p style="margin-left:14%;"><b>archive_read_support_filter_by_code</b>(<i>struct archive *</i>,
<i>int</i>);</p>
<p style="margin-left:9%; margin-top: 1em"><i>int</i></p>
<p style="margin-left:14%;"><b>archive_read_support_filter_bzip2</b>(<i>struct archive *</i>);</p>
<p style="margin-left:9%; margin-top: 1em"><i>int</i></p>
<p style="margin-left:14%;"><b>archive_read_support_filter_compress</b>(<i>struct archive *</i>);</p>
<p style="margin-left:9%; margin-top: 1em"><i>int</i></p>
<p style="margin-left:14%;"><b>archive_read_support_filter_grzip</b>(<i>struct archive *</i>);</p>
<p style="margin-left:9%; margin-top: 1em"><i>int</i></p>
<p style="margin-left:14%;"><b>archive_read_support_filter_gzip</b>(<i>struct archive *</i>);</p>
<p style="margin-left:9%; margin-top: 1em"><i>int</i></p>
<p style="margin-left:14%;"><b>archive_read_support_filter_lrzip</b>(<i>struct archive *</i>);</p>
<p style="margin-left:9%; margin-top: 1em"><i>int</i></p>
<p style="margin-left:14%;"><b>archive_read_support_filter_lz4</b>(<i>struct archive *</i>);</p>
<p style="margin-left:9%; margin-top: 1em"><i>int</i></p>
<p style="margin-left:14%;"><b>archive_read_support_filter_lzma</b>(<i>struct archive *</i>);</p>
<p style="margin-left:9%; margin-top: 1em"><i>int</i></p>
<p style="margin-left:14%;"><b>archive_read_support_filter_lzop</b>(<i>struct archive *</i>);</p>
<p style="margin-left:9%; margin-top: 1em"><i>int</i></p>
<p style="margin-left:14%;"><b>archive_read_support_filter_none</b>(<i>struct archive *</i>);</p>
<p style="margin-left:9%; margin-top: 1em"><i>int</i></p>
<p style="margin-left:14%;"><b>archive_read_support_filter_rpm</b>(<i>struct archive *</i>);</p>
<p style="margin-left:9%; margin-top: 1em"><i>int</i></p>
<p style="margin-left:14%;"><b>archive_read_support_filter_uu</b>(<i>struct archive *</i>);</p>
<p style="margin-left:9%; margin-top: 1em"><i>int</i></p>
<p style="margin-left:14%;"><b>archive_read_support_filter_xz</b>(<i>struct archive *</i>);</p>
<p style="margin-left:9%; margin-top: 1em"><i>int</i></p>
<p style="margin-left:14%;"><b>archive_read_support_filter_zstd</b>(<i>struct archive *</i>);</p>
<p style="margin-left:9%; margin-top: 1em"><i>int</i></p>
<p><b>archive_read_support_filter_program</b>(<i>struct archive *</i>,
<i>const char *cmd</i>);</p>
<p style="margin-left:9%; margin-top: 1em"><i>int</i></p>
<p><b>archive_read_support_filter_program_signature</b>(<i>struct archive *</i>,
<i>const char *cmd</i>,
<i>const void *signature</i>,
<i>size_t signature_length</i>);</p>
<p style="margin-top: 1em"><b>DESCRIPTION <br>
archive_read_support_filter_bzip2</b>(),
<b>archive_read_support_filter_compress</b>(),
<b>archive_read_support_filter_grzip</b>(),
<b>archive_read_support_filter_gzip</b>(),
<b>archive_read_support_filter_lrzip</b>(),
<b>archive_read_support_filter_lz4</b>(),
<b>archive_read_support_filter_lzma</b>(),
<b>archive_read_support_filter_lzop</b>(),
<b>archive_read_support_filter_none</b>(),
<b>archive_read_support_filter_rpm</b>(),
<b>archive_read_support_filter_uu</b>(),
<b>archive_read_support_filter_xz</b>(),
<b>archive_read_support_filter_zstd</b>(),</p>
<p style="margin-left:19%;">Enables auto-detection code and
decompression support for the specified compression. These
functions may fall back on external programs if an
appropriate library was not available at build time.
Decompression using an external program is usually slower
than decompression through built-in libraries. Note that
“none” is always enabled by default.</p>
<p><b>archive_read_support_filter_all</b>()</p>
<p style="margin-left:19%;">Enables all available
decompression filters.</p>
<p><b>archive_read_support_filter_by_code</b>()</p>
<p style="margin-left:19%;">Enables a single filter
specified by the filter code. This function does not work
with <b>ARCHIVE_FILTER_PROGRAM</b>. Note: In
statically-linked executables, this will cause your program
to include support for every filter. If executable size is a
concern, you may wish to avoid using this function.</p>
<p><b>archive_read_support_filter_program</b>()</p>
<p style="margin-left:19%;">Data is fed through the
specified external program before being dearchived. Note
that this disables automatic detection of the compression
format, so it makes no sense to specify this in conjunction
with any other decompression option.</p>
<p><b>archive_read_support_filter_program_signature</b>()</p>
<p style="margin-left:19%;">This feeds data through the
specified external program but only if the initial bytes of
the data match the specified signature value.</p>
<p style="margin-top: 1em"><b>RETURN VALUES</b></p>
<p style="margin-left:9%;">These functions return
<b>ARCHIVE_OK</b> if the compression is fully supported,
<b>ARCHIVE_WARN</b> if the compression is supported only
through an external program.</p>
<p style="margin-left:9%; margin-top: 1em"><b>archive_read_support_filter_none</b>()
always succeeds.</p>
<p style="margin-top: 1em"><b>ERRORS</b></p>
<p style="margin-left:9%;">Detailed error codes and textual
descriptions are available from the <b>archive_errno</b>()
and <b>archive_error_string</b>() functions.</p>
<p style="margin-top: 1em"><b>SEE ALSO</b></p>
<p style="margin-left:9%;"><i>archive_read</i>(3),
<i>archive_read_data</i>(3), <i>archive_read_format</i>(3),
<i>archive_read_format</i>(3), <i>libarchive</i>(3) Debian
June 9, 2020 <i>ARCHIVE_READ_FILTER</i>(3)</p>
<hr>
</body>
</html>
|
