ARCHIVE_READ_FILTER

Section: C Library Functions (3)
Page Index

BSD mandoc

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_zstd archive_read_support_filter_program archive_read_support_filter_program_signature - functions for reading streaming archives

LIBRARY

Streaming Archive Library (libarchive, -larchive)

SYNOPSIS

In archive.h Ft int Fn archive_read_support_filter_all struct archive * Ft int Fn archive_read_support_filter_by_code struct archive * int Ft int Fn archive_read_support_filter_bzip2 struct archive * Ft int Fn archive_read_support_filter_compress struct archive * Ft int Fn archive_read_support_filter_grzip struct archive * Ft int Fn archive_read_support_filter_gzip struct archive * Ft int Fn archive_read_support_filter_lrzip struct archive * Ft int Fn archive_read_support_filter_lz4 struct archive * Ft int Fn archive_read_support_filter_lzma struct archive * Ft int Fn archive_read_support_filter_lzop struct archive * Ft int Fn archive_read_support_filter_none struct archive * Ft int Fn archive_read_support_filter_rpm struct archive * Ft int Fn archive_read_support_filter_uu struct archive * Ft int Fn archive_read_support_filter_xz struct archive * Ft int Fn archive_read_support_filter_zstd struct archive * Ft int Fo archive_read_support_filter_program Fa struct archive * Fa const char *cmd Fc Ft int Fo archive_read_support_filter_program_signature Fa struct archive * Fa const char *cmd Fa const void *signature Fa size_t signature_length Fc

DESCRIPTION

Fn archive_read_support_filter_bzip2 , Fn archive_read_support_filter_compress , Fn archive_read_support_filter_grzip , Fn archive_read_support_filter_gzip , Fn archive_read_support_filter_lrzip , Fn archive_read_support_filter_lz4 , Fn archive_read_support_filter_lzma , Fn archive_read_support_filter_lzop , Fn archive_read_support_filter_none , Fn archive_read_support_filter_rpm , Fn archive_read_support_filter_uu , Fn archive_read_support_filter_xz , Fn archive_read_support_filter_zstd ,: 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.
Fn archive_read_support_filter_all: Enables all available decompression filters.
Fn archive_read_support_filter_by_code: Enables a single filter specified by the filter code. This function does not work with ARCHIVE_FILTER_PROGRAM Note: In statically-linked executables, this will cause your program to include support for every filter. If executable size is a concern, you may wish to avoid using this function.
Fn archive_read_support_filter_program: 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.
Fn archive_read_support_filter_program_signature: This feeds data through the specified external program but only if the initial bytes of the data match the specified signature value.

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.

Fn archive_read_support_filter_none always succeeds.

ERRORS

Detailed error codes and textual descriptions are available from the Fn archive_errno and Fn archive_error_string functions.