Blame doc/text/archive_read_filter.3.txt

Packit 08bd4c
ARCHIVE_READ_FILTER(3)	 BSD Library Functions Manual	ARCHIVE_READ_FILTER(3)
Packit 08bd4c
Packit 08bd4c
NAME
Packit 08bd4c
     archive_read_support_filter_all, archive_read_support_filter_bzip2,
Packit 08bd4c
     archive_read_support_filter_compress, archive_read_support_filter_gzip,
Packit 08bd4c
     archive_read_support_filter_lz4, archive_read_support_filter_lzma,
Packit 08bd4c
     archive_read_support_filter_none, archive_read_support_filter_rpm,
Packit 08bd4c
     archive_read_support_filter_uu, archive_read_support_filter_xz,
Packit 08bd4c
     archive_read_support_filter_program,
Packit 08bd4c
     archive_read_support_filter_program_signature — functions for reading
Packit 08bd4c
     streaming archives
Packit 08bd4c
Packit 08bd4c
LIBRARY
Packit 08bd4c
     Streaming Archive Library (libarchive, -larchive)
Packit 08bd4c
Packit 08bd4c
SYNOPSIS
Packit 08bd4c
     #include <archive.h>
Packit 08bd4c
Packit 08bd4c
     int
Packit 08bd4c
     archive_read_support_filter_all(struct archive *);
Packit 08bd4c
Packit 08bd4c
     int
Packit 08bd4c
     archive_read_support_filter_bzip2(struct archive *);
Packit 08bd4c
Packit 08bd4c
     int
Packit 08bd4c
     archive_read_support_filter_compress(struct archive *);
Packit 08bd4c
Packit 08bd4c
     int
Packit 08bd4c
     archive_read_support_filter_grzip(struct archive *);
Packit 08bd4c
Packit 08bd4c
     int
Packit 08bd4c
     archive_read_support_filter_gzip(struct archive *);
Packit 08bd4c
Packit 08bd4c
     int
Packit 08bd4c
     archive_read_support_filter_lrzip(struct archive *);
Packit 08bd4c
Packit 08bd4c
     int
Packit 08bd4c
     archive_read_support_filter_lz4(struct archive *);
Packit 08bd4c
Packit 08bd4c
     int
Packit 08bd4c
     archive_read_support_filter_lzma(struct archive *);
Packit 08bd4c
Packit 08bd4c
     int
Packit 08bd4c
     archive_read_support_filter_lzop(struct archive *);
Packit 08bd4c
Packit 08bd4c
     int
Packit 08bd4c
     archive_read_support_filter_none(struct archive *);
Packit 08bd4c
Packit 08bd4c
     int
Packit 08bd4c
     archive_read_support_filter_rpm(struct archive *);
Packit 08bd4c
Packit 08bd4c
     int
Packit 08bd4c
     archive_read_support_filter_uu(struct archive *);
Packit 08bd4c
Packit 08bd4c
     int
Packit 08bd4c
     archive_read_support_filter_xz(struct archive *);
Packit 08bd4c
Packit 08bd4c
     int
Packit 08bd4c
     archive_read_support_filter_program(struct archive *, const char *cmd);
Packit 08bd4c
Packit 08bd4c
     int
Packit 08bd4c
     archive_read_support_filter_program_signature(struct archive *,
Packit 08bd4c
	 const char *cmd, const void *signature, size_t signature_length);
Packit 08bd4c
Packit 08bd4c
DESCRIPTION
Packit 08bd4c
     archive_read_support_filter_bzip2(),
Packit 08bd4c
	     archive_read_support_filter_compress(),
Packit 08bd4c
	     archive_read_support_filter_grzip(),
Packit 08bd4c
	     archive_read_support_filter_gzip(),
Packit 08bd4c
	     archive_read_support_filter_lrzip(),
Packit 08bd4c
	     archive_read_support_filter_lz4(),
Packit 08bd4c
	     archive_read_support_filter_lzma(),
Packit 08bd4c
	     archive_read_support_filter_lzop(),
Packit 08bd4c
	     archive_read_support_filter_none(),
Packit 08bd4c
	     archive_read_support_filter_rpm(),
Packit 08bd4c
	     archive_read_support_filter_uu(),
Packit 08bd4c
	     archive_read_support_filter_xz()
Packit 08bd4c
	     Enables auto-detection code and decompression support for the
Packit 08bd4c
	     specified compression.  These functions may fall back on external
Packit 08bd4c
	     programs if an appropriate library was not available at build
Packit 08bd4c
	     time.  Decompression using an external program is usually slower
Packit 08bd4c
	     than decompression through built-in libraries.  Note that “none”
Packit 08bd4c
	     is always enabled by default.
Packit 08bd4c
     archive_read_support_filter_all()
Packit 08bd4c
	     Enables all available decompression filters.
Packit 08bd4c
     archive_read_support_filter_program()
Packit 08bd4c
	     Data is fed through the specified external program before being
Packit 08bd4c
	     dearchived.  Note that this disables automatic detection of the
Packit 08bd4c
	     compression format, so it makes no sense to specify this in con‐
Packit 08bd4c
	     junction with any other decompression option.
Packit 08bd4c
     archive_read_support_filter_program_signature()
Packit 08bd4c
	     This feeds data through the specified external program but only
Packit 08bd4c
	     if the initial bytes of the data match the specified signature
Packit 08bd4c
	     value.
Packit 08bd4c
Packit 08bd4c
RETURN VALUES
Packit 08bd4c
     These functions return ARCHIVE_OK if the compression is fully supported,
Packit 08bd4c
     ARCHIVE_WARN if the compression is supported only through an external
Packit 08bd4c
     program.
Packit 08bd4c
Packit 08bd4c
     archive_read_support_filter_none() always succeeds.
Packit 08bd4c
Packit 08bd4c
ERRORS
Packit 08bd4c
     Detailed error codes and textual descriptions are available from the
Packit 08bd4c
     archive_errno() and archive_error_string() functions.
Packit 08bd4c
Packit 08bd4c
SEE ALSO
Packit 08bd4c
     libarchive(3), archive_read(3), archive_read_data(3),
Packit 08bd4c
     archive_read_format(3), archive_read_format(3)
Packit 08bd4c
Packit 08bd4c
BSD				August 14, 2014 			   BSD