carta
archive_write_add_filter_compress(3)

archive_write_add_filter_compress3

Functions enabling output filters

Part of archive_write_add_filter_bzip2(3).

Usage

int

int

int

int

int

int

int

int

int

int

int

int

int

int

int

int

Library

Streaming Archive Library (libarchive, -larchive)

Overview

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_xz(), archive_write_add_filter_zstd(), The resulting archive will be compressed as specified. Note that the compressed output is always properly blocked.

archive_write_add_filter_b64encode(), archive_write_add_filter_uuencode(), The output will be encoded as specified. The encoded output is always properly blocked.

archive_write_add_filter_by_name()

Sets the corresponding filter based on the common name.

archive_write_add_filter_none()

This is never necessary. It is provided only for backwards compatibility.

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 (or ARCHIVE_WARN if an external program had to be executed to handle the filter) on success, or ARCHIVE_FATAL.

Errors

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

History

  • FreeBSD 16.0-CURRENT (2026-10-27): the text shown here
  • FreeBSD 15.1-RELEASE to FreeBSD 14.1-RELEASE
  • FreeBSD 14.0-RELEASE
  • FreeBSD 13.5-RELEASE to FreeBSD 13.4-RELEASE
  • FreeBSD 13.3-RELEASE to FreeBSD 12.2-RELEASE
  • FreeBSD 12.1-RELEASE to FreeBSD 12.0-RELEASE
  • FreeBSD 11.4-RELEASE
  • FreeBSD 11.3-RELEASE to FreeBSD 11.2-RELEASE
  • FreeBSD 11.1-RELEASE to FreeBSD 10.4-RELEASE
  • FreeBSD 10.3-RELEASE to FreeBSD 10.0-RELEASE

From base 16.0-CURRENT-20261027-61c70dc16a79 in FreeBSD 16.0-CURRENT (2026-10-27). Parsed by carta from the page's mdoc source.