1ARCHIVE_READ_FILTER(3)   BSD Library Functions Manual   ARCHIVE_READ_FILTER(3)
2

NAME

4     archive_read_support_filter_all, archive_read_support_filter_bzip2,
5     archive_read_support_filter_compress, archive_read_support_filter_gzip,
6     archive_read_support_filter_lz4, archive_read_support_filter_lzma,
7     archive_read_support_filter_none, archive_read_support_filter_rpm,
8     archive_read_support_filter_uu, archive_read_support_filter_xz,
9     archive_read_support_filter_zstd, archive_read_support_filter_program,
10     archive_read_support_filter_program_signature — functions for reading
11     streaming archives
12

LIBRARY

14     Streaming Archive Library (libarchive, -larchive)
15

SYNOPSIS

17     #include <archive.h>
18
19     int
20     archive_read_support_filter_all(struct archive *);
21
22     int
23     archive_read_support_filter_by_code(struct archive *, int);
24
25     int
26     archive_read_support_filter_bzip2(struct archive *);
27
28     int
29     archive_read_support_filter_compress(struct archive *);
30
31     int
32     archive_read_support_filter_grzip(struct archive *);
33
34     int
35     archive_read_support_filter_gzip(struct archive *);
36
37     int
38     archive_read_support_filter_lrzip(struct archive *);
39
40     int
41     archive_read_support_filter_lz4(struct archive *);
42
43     int
44     archive_read_support_filter_lzma(struct archive *);
45
46     int
47     archive_read_support_filter_lzop(struct archive *);
48
49     int
50     archive_read_support_filter_none(struct archive *);
51
52     int
53     archive_read_support_filter_rpm(struct archive *);
54
55     int
56     archive_read_support_filter_uu(struct archive *);
57
58     int
59     archive_read_support_filter_xz(struct archive *);
60
61     int
62     archive_read_support_filter_zstd(struct archive *);
63
64     int
65     archive_read_support_filter_program(struct archive *, const char *cmd);
66
67     int
68     archive_read_support_filter_program_signature(struct archive *,
69         const char *cmd, const void *signature, size_t signature_length);
70

DESCRIPTION

72     archive_read_support_filter_bzip2(),
73             archive_read_support_filter_compress(),
74             archive_read_support_filter_grzip(),
75             archive_read_support_filter_gzip(),
76             archive_read_support_filter_lrzip(),
77             archive_read_support_filter_lz4(),
78             archive_read_support_filter_lzma(),
79             archive_read_support_filter_lzop(),
80             archive_read_support_filter_none(),
81             archive_read_support_filter_rpm(),
82             archive_read_support_filter_uu(),
83             archive_read_support_filter_xz(),
84             archive_read_support_filter_zstd(),
85             Enables auto-detection code and decompression support for the
86             specified compression.  These functions may fall back on external
87             programs if an appropriate library was not available at build
88             time.  Decompression using an external program is usually slower
89             than decompression through built-in libraries.  Note that “none”
90             is always enabled by default.
91     archive_read_support_filter_all()
92             Enables all available decompression filters.
93     archive_read_support_filter_by_code()
94             Enables a single filter specified by the filter code.  This func‐
95             tion does not work with ARCHIVE_FILTER_PROGRAM.  Note: In stati‐
96             cally-linked executables, this will cause your program to include
97             support for every filter.  If executable size is a concern, you
98             may wish to avoid using this function.
99     archive_read_support_filter_program()
100             Data is fed through the specified external program before being
101             dearchived.  Note that this disables automatic detection of the
102             compression format, so it makes no sense to specify this in con‐
103             junction with any other decompression option.
104     archive_read_support_filter_program_signature()
105             This feeds data through the specified external program but only
106             if the initial bytes of the data match the specified signature
107             value.
108

RETURN VALUES

110     These functions return ARCHIVE_OK if the compression is fully supported,
111     ARCHIVE_WARN if the compression is supported only through an external
112     program.
113
114     archive_read_support_filter_none() always succeeds.
115

ERRORS

117     Detailed error codes and textual descriptions are available from the
118     archive_errno() and archive_error_string() functions.
119

SEE ALSO

121     archive_read(3), archive_read_data(3), archive_read_format(3),
122     archive_read_format(3), libarchive(3)
123
124BSD                              June 9, 2020                              BSD
Impressum