1.\" Copyright (c) 2003-2011 Tim Kientzle
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
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.
12.\"
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
23.\" SUCH DAMAGE.
24.\"
25.Dd August 14, 2014
26.Dt ARCHIVE_WRITE_FILTER 3
27.Os
28.Sh NAME
29.Nm archive_write_add_filter_b64encode ,
30.Nm archive_write_add_filter_by_name ,
31.Nm archive_write_add_filter_bzip2 ,
32.Nm archive_write_add_filter_compress ,
33.Nm archive_write_add_filter_grzip ,
34.Nm archive_write_add_filter_gzip ,
35.Nm archive_write_add_filter_lrzip ,
36.Nm archive_write_add_filter_lz4 ,
37.Nm archive_write_add_filter_lzip ,
38.Nm archive_write_add_filter_lzma ,
39.Nm archive_write_add_filter_lzop ,
40.Nm archive_write_add_filter_none ,
41.Nm archive_write_add_filter_program ,
42.Nm archive_write_add_filter_uuencode ,
43.Nm archive_write_add_filter_xz ,
44.Nm archive_write_add_filter_zstd
45.Nd functions enabling output filters
46.Sh LIBRARY
47Streaming Archive Library (libarchive, -larchive)
48.Sh SYNOPSIS
49.In archive.h
50.Ft int
51.Fn archive_write_add_filter_b64encode "struct archive *"
52.Ft int
53.Fn archive_write_add_filter_bzip2 "struct archive *"
54.Ft int
55.Fn archive_write_add_filter_compress "struct archive *"
56.Ft int
57.Fn archive_write_add_filter_grzip "struct archive *"
58.Ft int
59.Fn archive_write_add_filter_gzip "struct archive *"
60.Ft int
61.Fn archive_write_add_filter_lrzip "struct archive *"
62.Ft int
63.Fn archive_write_add_filter_lz4 "struct archive *"
64.Ft int
65.Fn archive_write_add_filter_lzip "struct archive *"
66.Ft int
67.Fn archive_write_add_filter_lzma "struct archive *"
68.Ft int
69.Fn archive_write_add_filter_lzop "struct archive *"
70.Ft int
71.Fn archive_write_add_filter_none "struct archive *"
72.Ft int
73.Fn archive_write_add_filter_program "struct archive *" "const char * cmd"
74.Ft int
75.Fn archive_write_add_filter_uuencode "struct archive *"
76.Ft int
77.Fn archive_write_add_filter_xz "struct archive *"
78.Ft int
79.Fn archive_write_add_filter_zstd "struct archive *"
80.Sh DESCRIPTION
81.Bl -tag -width indent
82.It Xo
83.Fn archive_write_add_filter_bzip2 ,
84.Fn archive_write_add_filter_compress ,
85.Fn archive_write_add_filter_grzip ,
86.Fn archive_write_add_filter_gzip ,
87.Fn archive_write_add_filter_lrzip ,
88.Fn archive_write_add_filter_lz4 ,
89.Fn archive_write_add_filter_lzip ,
90.Fn archive_write_add_filter_lzma ,
91.Fn archive_write_add_filter_lzop ,
92.Fn archive_write_add_filter_xz ,
93.Fn archive_write_add_filter_zstd ,
94.Xc
95The resulting archive will be compressed as specified.
96Note that the compressed output is always properly blocked.
97.It Xo
98.Fn archive_write_add_filter_b64encode ,
99.Fn archive_write_add_filter_uuencode ,
100.Xc
101The output will be encoded as specified.
102The encoded output is always properly blocked.
103.It Fn archive_write_add_filter_none
104This is never necessary.
105It is provided only for backwards compatibility.
106.It Fn archive_write_add_filter_program
107The archive will be fed into the specified compression program.
108The output of that program is blocked and written to the client
109write callbacks.
110.El
111.Sh RETURN VALUES
112These functions return
113.Cm ARCHIVE_OK
114on success, or
115.Cm ARCHIVE_FATAL .
116.\"
117.Sh ERRORS
118Detailed error codes and textual descriptions are available from the
119.Fn archive_errno
120and
121.Fn archive_error_string
122functions.
123.\"
124.Sh SEE ALSO
125.Xr tar 1 ,
126.Xr archive_write 3 ,
127.Xr archive_write_format 3 ,
128.Xr archive_write_set_options 3 ,
129.Xr libarchive 3 ,
130.Xr cpio 5 ,
131.Xr mtree 5 ,
132.Xr tar 5
133