1 .\" Copyright (c) 2003-2011 Tim Kientzle
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .Dt ARCHIVE_WRITE_FILTER 3
31 .Nm archive_write_add_filter_b64encode ,
32 .Nm archive_write_add_filter_by_name ,
33 .Nm archive_write_add_filter_bzip2 ,
34 .Nm archive_write_add_filter_compress ,
35 .Nm archive_write_add_filter_grzip ,
36 .Nm archive_write_add_filter_gzip ,
37 .Nm archive_write_add_filter_lrzip ,
38 .Nm archive_write_add_filter_lz4 ,
39 .Nm archive_write_add_filter_lzip ,
40 .Nm archive_write_add_filter_lzma ,
41 .Nm archive_write_add_filter_lzop ,
42 .Nm archive_write_add_filter_none ,
43 .Nm archive_write_add_filter_program ,
44 .Nm archive_write_add_filter_uuencode ,
45 .Nm archive_write_add_filter_xz ,
46 .Nm archive_write_add_filter_zstd
47 .Nd functions enabling output filters
49 Streaming Archive Library (libarchive, -larchive)
53 .Fn archive_write_add_filter_b64encode "struct archive *"
55 .Fn archive_write_add_filter_bzip2 "struct archive *"
57 .Fn archive_write_add_filter_compress "struct archive *"
59 .Fn archive_write_add_filter_grzip "struct archive *"
61 .Fn archive_write_add_filter_gzip "struct archive *"
63 .Fn archive_write_add_filter_lrzip "struct archive *"
65 .Fn archive_write_add_filter_lz4 "struct archive *"
67 .Fn archive_write_add_filter_lzip "struct archive *"
69 .Fn archive_write_add_filter_lzma "struct archive *"
71 .Fn archive_write_add_filter_lzop "struct archive *"
73 .Fn archive_write_add_filter_none "struct archive *"
75 .Fn archive_write_add_filter_program "struct archive *" "const char * cmd"
77 .Fn archive_write_add_filter_uuencode "struct archive *"
79 .Fn archive_write_add_filter_xz "struct archive *"
81 .Fn archive_write_add_filter_zstd "struct archive *"
83 .Bl -tag -width indent
85 .Fn archive_write_add_filter_bzip2 ,
86 .Fn archive_write_add_filter_compress ,
87 .Fn archive_write_add_filter_grzip ,
88 .Fn archive_write_add_filter_gzip ,
89 .Fn archive_write_add_filter_lrzip ,
90 .Fn archive_write_add_filter_lz4 ,
91 .Fn archive_write_add_filter_lzip ,
92 .Fn archive_write_add_filter_lzma ,
93 .Fn archive_write_add_filter_lzop ,
94 .Fn archive_write_add_filter_xz ,
95 .Fn archive_write_add_filter_zstd ,
97 The resulting archive will be compressed as specified.
98 Note that the compressed output is always properly blocked.
100 .Fn archive_write_add_filter_b64encode ,
101 .Fn archive_write_add_filter_uuencode ,
103 The output will be encoded as specified.
104 The encoded output is always properly blocked.
105 .It Fn archive_write_add_filter_none
106 This is never necessary.
107 It is provided only for backwards compatibility.
108 .It Fn archive_write_add_filter_program
109 The archive will be fed into the specified compression program.
110 The output of that program is blocked and written to the client
114 These functions return
120 Detailed error codes and textual descriptions are available from the
123 .Fn archive_error_string
128 .Xr archive_write 3 ,
129 .Xr archive_write_format 3 ,
130 .Xr archive_write_set_options 3 ,