summaryrefslogtreecommitdiff
path: root/archivers/libarchive/files/doc/wiki/ManPageArchiveReadFilter3.wiki
blob: 9005be9991c4fa8a27bc6879eae2a3580b1ba832 (plain)
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
ARCHIVE_READ_FILTER(3) manual page 
== NAME == 
'''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 
== LIBRARY == 
Streaming Archive Library (libarchive, -larchive) 
== SYNOPSIS == 
'''<nowiki>#include <archive.h></nowiki>''' 
<br> 
''int'' 
<br> 
'''archive_read_support_filter_all'''(''struct archive *''); 
<br> 
''int'' 
<br> 
'''archive_read_support_filter_bzip2'''(''struct archive *''); 
<br> 
''int'' 
<br> 
'''archive_read_support_filter_compress'''(''struct archive *''); 
<br> 
''int'' 
<br> 
'''archive_read_support_filter_grzip'''(''struct archive *''); 
<br> 
''int'' 
<br> 
'''archive_read_support_filter_gzip'''(''struct archive *''); 
<br> 
''int'' 
<br> 
'''archive_read_support_filter_lrzip'''(''struct archive *''); 
<br> 
''int'' 
<br> 
'''archive_read_support_filter_lz4'''(''struct archive *''); 
<br> 
''int'' 
<br> 
'''archive_read_support_filter_lzma'''(''struct archive *''); 
<br> 
''int'' 
<br> 
'''archive_read_support_filter_lzop'''(''struct archive *''); 
<br> 
''int'' 
<br> 
'''archive_read_support_filter_none'''(''struct archive *''); 
<br> 
''int'' 
<br> 
'''archive_read_support_filter_rpm'''(''struct archive *''); 
<br> 
''int'' 
<br> 
'''archive_read_support_filter_uu'''(''struct archive *''); 
<br> 
''int'' 
<br> 
'''archive_read_support_filter_xz'''(''struct archive *''); 
<br> 
''int'' 
<br> 
'''archive_read_support_filter_zstd'''(''struct archive *''); 
<br> 
''int'' 
<br> 
'''archive_read_support_filter_program'''(''struct archive *'', ''const char *cmd''); 
<br> 
''int'' 
<br> 
'''archive_read_support_filter_program_signature'''(''struct archive *'', ''const char *cmd'', ''const void *signature'', ''size_t signature_length''); 
== DESCRIPTION == 
<dl> 
<dt> 
'''archive_read_support_filter_bzip2'''(), 
'''archive_read_support_filter_compress'''(), 
'''archive_read_support_filter_grzip'''(), 
'''archive_read_support_filter_gzip'''(), 
'''archive_read_support_filter_lrzip'''(), 
'''archive_read_support_filter_lz4'''(), 
'''archive_read_support_filter_lzma'''(), 
'''archive_read_support_filter_lzop'''(), 
'''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'''(), 
</dt> <dd> 
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. 
</dd><dt>'''archive_read_support_filter_all'''()</dt><dd> 
Enables all available decompression filters. 
</dd><dt>'''archive_read_support_filter_program'''()</dt><dd> 
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. 
</dd><dt>'''archive_read_support_filter_program_signature'''()</dt><dd> 
This feeds data through the specified external program 
but only if the initial bytes of the data match the specified 
signature value. 
</dd></dl> 
== RETURN VALUES == 
These functions return 
'''ARCHIVE_OK''' 
if the compression is fully supported, 
'''ARCHIVE_WARN''' 
if the compression is supported only through an external program. 

'''archive_read_support_filter_none'''() 
always succeeds. 
== ERRORS == 
Detailed error codes and textual descriptions are available from the 
'''archive_errno'''() 
and 
'''archive_error_string'''() 
functions. 
== SEE ALSO == 
[[ManPageLibarchive3]], 
[[ManPageArchiveRead3]], 
[[ManPageArchiveReadData3]], 
[[ManPageArchiveReadFormat3]], 
[[ManPageArchiveReadFormat3]]