summaryrefslogtreecommitdiff
path: root/archivers/libarchive/files/doc/wiki/ManPageArchiveReadFilter3.wiki
diff options
context:
space:
mode:
Diffstat (limited to 'archivers/libarchive/files/doc/wiki/ManPageArchiveReadFilter3.wiki')
-rw-r--r--archivers/libarchive/files/doc/wiki/ManPageArchiveReadFilter3.wiki137
1 files changed, 137 insertions, 0 deletions
diff --git a/archivers/libarchive/files/doc/wiki/ManPageArchiveReadFilter3.wiki b/archivers/libarchive/files/doc/wiki/ManPageArchiveReadFilter3.wiki
new file mode 100644
index 00000000000..f0e87b6bbe9
--- /dev/null
+++ b/archivers/libarchive/files/doc/wiki/ManPageArchiveReadFilter3.wiki
@@ -0,0 +1,137 @@
+ARCHIVE_READ_FILTER(3) manual page
+== NAME ==
+'''archive_read_support_filter_all''',
+'''archive_read_support_filter_bzip2''',
+'''archive_read_support_filter_compress''',
+'''archive_read_support_filter_gzip''',
+'''archive_read_support_filter_lz4''',
+'''archive_read_support_filter_lzma''',
+'''archive_read_support_filter_none''',
+'''archive_read_support_filter_rpm''',
+'''archive_read_support_filter_uu''',
+'''archive_read_support_filter_xz''',
+'''archive_read_support_filter_program''',
+'''archive_read_support_filter_program_signature'''
+- functions for reading streaming archives
+== LIBRARY ==
+Streaming Archive Library (libarchive, -larchive)
+== SYNOPSIS ==
+'''<nowiki>#include <archive.h></nowiki>'''
+<br>
+''int''
+<br>
+'''archive_read_support_filter_all'''(''struct archive *'');
+<br>
+''int''
+<br>
+'''archive_read_support_filter_bzip2'''(''struct archive *'');
+<br>
+''int''
+<br>
+'''archive_read_support_filter_compress'''(''struct archive *'');
+<br>
+''int''
+<br>
+'''archive_read_support_filter_grzip'''(''struct archive *'');
+<br>
+''int''
+<br>
+'''archive_read_support_filter_gzip'''(''struct archive *'');
+<br>
+''int''
+<br>
+'''archive_read_support_filter_lrzip'''(''struct archive *'');
+<br>
+''int''
+<br>
+'''archive_read_support_filter_lz4'''(''struct archive *'');
+<br>
+''int''
+<br>
+'''archive_read_support_filter_lzma'''(''struct archive *'');
+<br>
+''int''
+<br>
+'''archive_read_support_filter_lzop'''(''struct archive *'');
+<br>
+''int''
+<br>
+'''archive_read_support_filter_none'''(''struct archive *'');
+<br>
+''int''
+<br>
+'''archive_read_support_filter_rpm'''(''struct archive *'');
+<br>
+''int''
+<br>
+'''archive_read_support_filter_uu'''(''struct archive *'');
+<br>
+''int''
+<br>
+'''archive_read_support_filter_xz'''(''struct archive *'');
+<br>
+''int''
+<br>
+'''archive_read_support_filter_program'''(''struct archive *'', ''const char *cmd'');
+<br>
+''int''
+<br>
+'''archive_read_support_filter_program_signature'''(''struct archive *'', ''const char *cmd'', ''const void *signature'', ''size_t signature_length'');
+== DESCRIPTION ==
+<dl>
+<dt>
+'''archive_read_support_filter_bzip2'''(),
+'''archive_read_support_filter_compress'''(),
+'''archive_read_support_filter_grzip'''(),
+'''archive_read_support_filter_gzip'''(),
+'''archive_read_support_filter_lrzip'''(),
+'''archive_read_support_filter_lz4'''(),
+'''archive_read_support_filter_lzma'''(),
+'''archive_read_support_filter_lzop'''(),
+'''archive_read_support_filter_none'''(),
+'''archive_read_support_filter_rpm'''(),
+'''archive_read_support_filter_uu'''(),
+'''archive_read_support_filter_xz'''()
+</dt> <dd>
+Enables auto-detection code and decompression support for the
+specified compression.
+These functions may fall back on external programs if an appropriate
+library was not available at build time.
+Decompression using an external program is usually slower than
+decompression through built-in libraries.
+Note that
+"none"
+is always enabled by default.
+</dd><dt>'''archive_read_support_filter_all'''()</dt><dd>
+Enables all available decompression filters.
+</dd><dt>'''archive_read_support_filter_program'''()</dt><dd>
+Data is fed through the specified external program before being dearchived.
+Note that this disables automatic detection of the compression format,
+so it makes no sense to specify this in conjunction with any other
+decompression option.
+</dd><dt>'''archive_read_support_filter_program_signature'''()</dt><dd>
+This feeds data through the specified external program
+but only if the initial bytes of the data match the specified
+signature value.
+</dd></dl>
+== RETURN VALUES ==
+These functions return
+'''ARCHIVE_OK'''
+if the compression is fully supported,
+'''ARCHIVE_WARN'''
+if the compression is supported only through an external program.
+
+'''archive_read_support_filter_none'''()
+always succeeds.
+== ERRORS ==
+Detailed error codes and textual descriptions are available from the
+'''archive_errno'''()
+and
+'''archive_error_string'''()
+functions.
+== SEE ALSO ==
+[[ManPageibarchive3]],
+[[ManPagerchiveead3]],
+[[ManPagerchiveeadata3]],
+[[ManPagerchiveeadormat3]],
+[[ManPagerchiveeadormat3]]