summaryrefslogtreecommitdiff
path: root/archivers/libarchive/files/doc/wiki/ManPageArchiveWriteFilter3.wiki
blob: e82588f2e76b6c862be852953f61e3e05d967eb8 (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
ARCHIVE_WRITE_FILTER(3) manual page 
== NAME == 
'''archive_write_add_filter_b64encode''', 
'''archive_write_add_filter_by_name''', 
'''archive_write_add_filter_bzip2''', 
'''archive_write_add_filter_compress''', 
'''archive_write_add_filter_grzip''', 
'''archive_write_add_filter_gzip''', 
'''archive_write_add_filter_lrzip''', 
'''archive_write_add_filter_lz4''', 
'''archive_write_add_filter_lzip''', 
'''archive_write_add_filter_lzma''', 
'''archive_write_add_filter_lzop''', 
'''archive_write_add_filter_none''', 
'''archive_write_add_filter_program''', 
'''archive_write_add_filter_uuencode''', 
'''archive_write_add_filter_xz''', 
'''archive_write_add_filter_zstd''', 
- functions enabling output filters 
== LIBRARY == 
Streaming Archive Library (libarchive, -larchive) 
== SYNOPSIS == 
'''<nowiki>#include <archive.h></nowiki>''' 
<br> 
''int'' 
<br> 
'''archive_write_add_filter_b64encode'''(''struct archive *''); 
<br> 
''int'' 
<br> 
'''archive_write_add_filter_bzip2'''(''struct archive *''); 
<br> 
''int'' 
<br> 
'''archive_write_add_filter_compress'''(''struct archive *''); 
<br> 
''int'' 
<br> 
'''archive_write_add_filter_grzip'''(''struct archive *''); 
<br> 
''int'' 
<br> 
'''archive_write_add_filter_gzip'''(''struct archive *''); 
<br> 
''int'' 
<br> 
'''archive_write_add_filter_lrzip'''(''struct archive *''); 
<br> 
''int'' 
<br> 
'''archive_write_add_filter_lz4'''(''struct archive *''); 
<br> 
''int'' 
<br> 
'''archive_write_add_filter_lzip'''(''struct archive *''); 
<br> 
''int'' 
<br> 
'''archive_write_add_filter_lzma'''(''struct archive *''); 
<br> 
''int'' 
<br> 
'''archive_write_add_filter_lzop'''(''struct archive *''); 
<br> 
''int'' 
<br> 
'''archive_write_add_filter_none'''(''struct archive *''); 
<br> 
''int'' 
<br> 
'''archive_write_add_filter_program'''(''struct archive *'', ''const char * cmd''); 
<br> 
''int'' 
<br> 
'''archive_write_add_filter_uuencode'''(''struct archive *''); 
<br> 
''int'' 
<br> 
'''archive_write_add_filter_xz'''(''struct archive *''); 
<br> 
''int'' 
<br> 
'''archive_write_add_filter_zstd'''(''struct archive *''); 
== DESCRIPTION == 
<dl> 
<dt> 
'''archive_write_add_filter_bzip2'''(), 
'''archive_write_add_filter_compress'''(), 
'''archive_write_add_filter_grzip'''(), 
'''archive_write_add_filter_gzip'''(), 
'''archive_write_add_filter_lrzip'''(), 
'''archive_write_add_filter_lz4'''(), 
'''archive_write_add_filter_lzip'''(), 
'''archive_write_add_filter_lzma'''(), 
'''archive_write_add_filter_lzop'''(), 
'''archive_write_add_filter_xz'''(), 
'''archive_write_add_filter_zstd'''(), 
</dt> <dd> 
The resulting archive will be compressed as specified. 
Note that the compressed output is always properly blocked. 
</dd><dt> 
'''archive_write_add_filter_b64encode'''(), 
'''archive_write_add_filter_uuencode'''(), 
</dt> <dd> 
The output will be encoded as specified. 
The encoded output is always properly blocked. 
</dd><dt>'''archive_write_add_filter_none'''()</dt><dd> 
This is never necessary. 
It is provided only for backwards compatibility. 
</dd><dt>'''archive_write_add_filter_program'''()</dt><dd> 
The archive will be fed into the specified compression program. 
The output of that program is blocked and written to the client 
write callbacks. 
</dd></dl> 
== RETURN VALUES == 
These functions return 
'''ARCHIVE_OK''' 
on success, or 
'''ARCHIVE_FATAL'''. 
== ERRORS == 
Detailed error codes and textual descriptions are available from the 
'''archive_errno'''() 
and 
'''archive_error_string'''() 
functions. 
== SEE ALSO == 
[[ManPageBsdtar1]], 
[[ManPageLibarchive3]], 
[[ManPageArchiveWrite3]], 
[[ManPageArchiveWriteFormat3]], 
[[ManPageArchiveWriteSetOptions3]], 
[[ManPageCpio5]], 
[[ManPageMtree5]], 
[[ManPageTar5]]