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.\" $FreeBSD$
26.\"
27.Dd June 9, 2020
28.Dt ARCHIVE_READ_FILTER 3
29.Os
30.Sh NAME
31.Nm archive_read_support_filter_all ,
32.Nm archive_read_support_filter_bzip2 ,
33.Nm archive_read_support_filter_compress ,
34.Nm archive_read_support_filter_gzip ,
35.Nm archive_read_support_filter_lz4 ,
36.Nm archive_read_support_filter_lzma ,
37.Nm archive_read_support_filter_none ,
38.Nm archive_read_support_filter_rpm ,
39.Nm archive_read_support_filter_uu ,
40.Nm archive_read_support_filter_xz ,
41.Nm archive_read_support_filter_zstd ,
42.Nm archive_read_support_filter_program ,
43.Nm archive_read_support_filter_program_signature
44.Nd functions for reading streaming archives
45.\"
46.Sh LIBRARY
47Streaming Archive Library (libarchive, -larchive)
48.Sh SYNOPSIS
49.In archive.h
50.Ft int
51.Fn archive_read_support_filter_all "struct archive *"
52.Ft int
53.Fn archive_read_support_filter_by_code "struct archive *" "int"
54.Ft int
55.Fn archive_read_support_filter_bzip2 "struct archive *"
56.Ft int
57.Fn archive_read_support_filter_compress "struct archive *"
58.Ft int
59.Fn archive_read_support_filter_grzip "struct archive *"
60.Ft int
61.Fn archive_read_support_filter_gzip "struct archive *"
62.Ft int
63.Fn archive_read_support_filter_lrzip "struct archive *"
64.Ft int
65.Fn archive_read_support_filter_lz4 "struct archive *"
66.Ft int
67.Fn archive_read_support_filter_lzma "struct archive *"
68.Ft int
69.Fn archive_read_support_filter_lzop "struct archive *"
70.Ft int
71.Fn archive_read_support_filter_none "struct archive *"
72.Ft int
73.Fn archive_read_support_filter_rpm "struct archive *"
74.Ft int
75.Fn archive_read_support_filter_uu "struct archive *"
76.Ft int
77.Fn archive_read_support_filter_xz "struct archive *"
78.Ft int
79.Fn archive_read_support_filter_zstd "struct archive *"
80.Ft int
81.Fo archive_read_support_filter_program
82.Fa "struct archive *"
83.Fa "const char *cmd"
84.Fc
85.Ft int
86.Fo archive_read_support_filter_program_signature
87.Fa "struct archive *"
88.Fa "const char *cmd"
89.Fa "const void *signature"
90.Fa "size_t signature_length"
91.Fc
92.\"
93.Sh DESCRIPTION
94.Bl -tag -compact -width indent
95.It Xo
96.Fn archive_read_support_filter_bzip2 ,
97.Fn archive_read_support_filter_compress ,
98.Fn archive_read_support_filter_grzip ,
99.Fn archive_read_support_filter_gzip ,
100.Fn archive_read_support_filter_lrzip ,
101.Fn archive_read_support_filter_lz4 ,
102.Fn archive_read_support_filter_lzma ,
103.Fn archive_read_support_filter_lzop ,
104.Fn archive_read_support_filter_none ,
105.Fn archive_read_support_filter_rpm ,
106.Fn archive_read_support_filter_uu ,
107.Fn archive_read_support_filter_xz ,
108.Fn archive_read_support_filter_zstd ,
109.Xc
110Enables auto-detection code and decompression support for the
111specified compression.
112These functions may fall back on external programs if an appropriate
113library was not available at build time.
114Decompression using an external program is usually slower than
115decompression through built-in libraries.
116Note that
117.Dq none
118is always enabled by default.
119.It Fn archive_read_support_filter_all
120Enables all available decompression filters.
121.It Fn archive_read_support_filter_by_code
122Enables a single filter specified by the filter code.
123This function does not work with
124.Cm ARCHIVE_FILTER_PROGRAM .
125Note: In statically-linked executables, this will cause
126your program to include support for every filter.
127If executable size is a concern, you may wish to avoid
128using this function.
129.It Fn archive_read_support_filter_program
130Data is fed through the specified external program before being dearchived.
131Note that this disables automatic detection of the compression format,
132so it makes no sense to specify this in conjunction with any other
133decompression option.
134.It Fn archive_read_support_filter_program_signature
135This feeds data through the specified external program
136but only if the initial bytes of the data match the specified
137signature value.
138.El
139.\"
140.\". Sh EXAMPLE
141.\"
142.Sh RETURN VALUES
143These functions return
144.Cm ARCHIVE_OK
145if the compression is fully supported,
146.Cm ARCHIVE_WARN
147if the compression is supported only through an external program.
148.Pp
149.Fn archive_read_support_filter_none
150always succeeds.
151.\"
152.Sh ERRORS
153Detailed error codes and textual descriptions are available from the
154.Fn archive_errno
155and
156.Fn archive_error_string
157functions.
158.\"
159.Sh SEE ALSO
160.Xr archive_read 3 ,
161.Xr archive_read_data 3 ,
162.Xr archive_read_format 3 ,
163.Xr archive_read_format 3 ,
164.Xr libarchive 3
165