ARCHIVE_WRITE_FILTER

Section: C Library Functions (3)
Page Index

BSD mandoc

NAME

archive_write_add_filter_b64encode archive_write_add_filter_by_name archive_write_add_filter_bzip2 archive_write_add_filter_compress archive_write_add_filter_grzip archive_write_add_filter_gzip archive_write_add_filter_lrzip archive_write_add_filter_lz4 archive_write_add_filter_lzip archive_write_add_filter_lzma archive_write_add_filter_lzop archive_write_add_filter_none archive_write_add_filter_program archive_write_add_filter_uuencode archive_write_add_filter_xz archive_write_add_filter_zstd - functions enabling output filters

LIBRARY

Streaming Archive Library (libarchive, -larchive)

SYNOPSIS

In archive.h Ft int Fn archive_write_add_filter_b64encode struct archive * Ft int Fn archive_write_add_filter_bzip2 struct archive * Ft int Fn archive_write_add_filter_compress struct archive * Ft int Fn archive_write_add_filter_grzip struct archive * Ft int Fn archive_write_add_filter_gzip struct archive * Ft int Fn archive_write_add_filter_lrzip struct archive * Ft int Fn archive_write_add_filter_lz4 struct archive * Ft int Fn archive_write_add_filter_lzip struct archive * Ft int Fn archive_write_add_filter_lzma struct archive * Ft int Fn archive_write_add_filter_lzop struct archive * Ft int Fn archive_write_add_filter_none struct archive * Ft int Fn archive_write_add_filter_program struct archive * const char * cmd Ft int Fn archive_write_add_filter_uuencode struct archive * Ft int Fn archive_write_add_filter_xz struct archive * Ft int Fn archive_write_add_filter_zstd struct archive *

DESCRIPTION

Fn archive_write_add_filter_bzip2 , Fn archive_write_add_filter_compress , Fn archive_write_add_filter_grzip , Fn archive_write_add_filter_gzip , Fn archive_write_add_filter_lrzip , Fn archive_write_add_filter_lz4 , Fn archive_write_add_filter_lzip , Fn archive_write_add_filter_lzma , Fn archive_write_add_filter_lzop , Fn archive_write_add_filter_xz , Fn archive_write_add_filter_zstd ,: The resulting archive will be compressed as specified. Note that the compressed output is always properly blocked.
Fn archive_write_add_filter_b64encode , Fn archive_write_add_filter_uuencode ,: The output will be encoded as specified. The encoded output is always properly blocked.
Fn archive_write_add_filter_none: This is never necessary. It is provided only for backwards compatibility.
Fn archive_write_add_filter_program: The archive will be fed into the specified compression program. The output of that program is blocked and written to the client write callbacks.

RETURN VALUES

These functions return ARCHIVE_OK on success, or ARCHIVE_FATAL

ERRORS

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