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_lzma, archive_read_support_filter_none,
7     archive_read_support_filter_xz, archive_read_support_filter_program,
8     archive_read_support_filter_program_signature — functions for reading
9     streaming archives
10

LIBRARY

12     Streaming Archive Library (libarchive, -larchive)
13

SYNOPSIS

15     #include <archive.h>
16
17     int
18     archive_read_support_filter_all(struct archive *);
19
20     int
21     archive_read_support_filter_bzip2(struct archive *);
22
23     int
24     archive_read_support_filter_compress(struct archive *);
25
26     int
27     archive_read_support_filter_gzip(struct archive *);
28
29     int
30     archive_read_support_filter_lzma(struct archive *);
31
32     int
33     archive_read_support_filter_none(struct archive *);
34
35     int
36     archive_read_support_filter_xz(struct archive *);
37
38     int
39     archive_read_support_filter_program(struct archive *, const char *cmd);
40
41     int
42     archive_read_support_filter_program_signature(struct archive *,
43         const char *cmd, const void *signature, size_t signature_length);
44

DESCRIPTION

46     archive_read_support_filter_bzip2(),
47             archive_read_support_filter_compress(),
48             archive_read_support_filter_gzip(),
49             archive_read_support_filter_lzma(),
50             archive_read_support_filter_none(),
51             archive_read_support_filter_xz()
52             Enables auto-detection code and decompression support for the
53             specified compression.  These functions may fall back on external
54             programs if an appropriate library was not available at build
55             time.  Decompression using an external program is usually slower
56             than decompression through built-in libraries.  Note that “none”
57             is always enabled by default.
58     archive_read_support_filter_all()
59             Enables all available decompression filters.
60     archive_read_support_filter_program()
61             Data is fed through the specified external program before being
62             dearchived.  Note that this disables automatic detection of the
63             compression format, so it makes no sense to specify this in con‐
64             junction with any other decompression option.
65     archive_read_support_filter_program_signature()
66             This feeds data through the specified external program but only
67             if the initial bytes of the data match the specified signature
68             value.
69

RETURN VALUES

71     These functions return ARCHIVE_OK if the compression is fully supported,
72     ARCHIVE_WARN if the compression is supported only through an external
73     program.
74
75     archive_read_support_filter_none() always succeeds.
76

ERRORS

78     Detailed error codes and textual descriptions are available from the
79     archive_errno() and archive_error_string() functions.
80

SEE ALSO

82     libarchive(3), archive_read(3), archive_read_data(3),
83     archive_read_format(3), archive_read_format(3)
84
85BSD                            February 2, 2012                            BSD
Impressum