carta
archive_write_set_format_pax(3)

archive_write_set_format_pax3

Functions for creating archives

Part of archive_write_format(3).

Usage

int

int

int

int

int

int

int

int

int

int

int

int

int

int

int

int

int

int

int

int

int

int

int

int

int

int

Library

Streaming Archive Library (libarchive, -larchive)

Overview

These functions set the format that will be used for the archive.

The library can write a variety of common archive formats.

archive_write_set_format()

Sets the format based on the format code (see archive.h for the full list of format codes). In particular, this can be used in conjunction with archive_format() to create a new archive with the same format as an existing archive.

archive_write_set_format_by_name()

Sets the corresponding format based on the common name.

archive_write_set_format_filter_by_ext() archive_write_set_format_filter_by_ext_def() Sets both filters and format based on the output filename, optionally referring to a default extension if the supplied filename does not have a known one. Supported extensions: .7z, .zip, .jar, .cpio, .iso, .a, .ar, .tar, .tgz, .tar.gz, .tar.bz2, .tar.xz

archive_write_set_format_7zip() archive_write_set_format_ar_bsd() archive_write_set_format_ar_svr4() archive_write_set_format_cpio() archive_write_set_format_cpio_bin() archive_write_set_format_cpio_newc() archive_write_set_format_cpio_odc() archive_write_set_format_cpio_pwb() archive_write_set_format_gnutar() archive_write_set_format_iso9660() archive_write_set_format_mtree() archive_write_set_format_mtree_classic() archive_write_set_format_pax() archive_write_set_format_pax_restricted() archive_write_set_format_raw() archive_write_set_format_shar() archive_write_set_format_shar_dump() archive_write_set_format_ustar() archive_write_set_format_v7tar() archive_write_set_format_warc() archive_write_set_format_xar() archive_write_set_format_zip() Set the format as specified. More details on the formats supported by libarchive can be found in the libarchive-formats(5) manual page.

Return values

These functions return ARCHIVE_OK 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 13.1-RELEASE
  • FreeBSD 13.0-RELEASE
  • FreeBSD 12.4-RELEASE to FreeBSD 12.3-RELEASE
  • FreeBSD 12.2-RELEASE
  • FreeBSD 12.1-RELEASE to FreeBSD 12.0-RELEASE
  • FreeBSD 11.4-RELEASE
  • FreeBSD 11.3-RELEASE to FreeBSD 11.1-RELEASE
  • FreeBSD 11.0-RELEASE
  • FreeBSD 10.4-RELEASE
  • FreeBSD 10.3-RELEASE to FreeBSD 10.0-RELEASE
  • FreeBSD 9.3-RELEASE
  • FreeBSD 9.2-RELEASE
  • FreeBSD 9.1-RELEASE
  • FreeBSD 9.0-RELEASE
  • FreeBSD 8.4-RELEASE
  • FreeBSD 8.3-RELEASE
  • FreeBSD 8.2-RELEASE
  • FreeBSD 8.1-RELEASE
  • FreeBSD 8.0-RELEASE
  • FreeBSD 7.4-RELEASE
  • FreeBSD 7.3-RELEASE
  • FreeBSD 7.2-RELEASE
  • FreeBSD 7.1-RELEASE
  • FreeBSD 7.0-RELEASE
  • FreeBSD 6.4-RELEASE
  • FreeBSD 6.3-RELEASE
  • FreeBSD 6.2-RELEASE
  • FreeBSD 6.1-RELEASE to FreeBSD 6.0-RELEASE
  • FreeBSD 5.5-RELEASE
  • FreeBSD 5.4-RELEASE
  • FreeBSD 5.3-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.