ARCHIVE_WRITE_OPTIONS(3) Library Functions Manual ARCHIVE_WRITE_OPTIONS(3)
NAME
archive_write_set_filter_option, archive_write_set_format_option, archive_write_set_option, archive_write_set_options — functions controlling options for writing archives
LIBRARY
Streaming Archive Library (libarchive, -larchive)
SYNOPSIS
int
archive_write_set_filter_option(struct archive *, const char *module, const char *option, const char *value);
int
archive_write_set_format_option(struct archive *, const char *module, const char *option, const char *value);
int
archive_write_set_option(struct archive *, const char *module, const char *option, const char *value);
int
archive_write_set_options(struct archive *, const char *options);
DESCRIPTION
These functions provide a way for libarchive clients to configure specific write modules.
archive_write_set_filter_option(), archive_write_set_format_option()
Specifies an option that will be passed to the currently-registered filters (including decompression filters) or format readers.
If option and value are both NULL, these functions will do nothing and ARCHIVE_OK will be returned. If option is NULL but value is not, these functions will do nothing and ARCHIVE_FAILED will be returned.
If module is not NULL, option and value will be provided to the filter or reader named module. The return value will be either ARCHIVE_OK if the option was successfully handled or ARCHIVE_WARN if the option was unrecognized by the module or could otherwise not be handled. If there is no such module, ARCHIVE_FAILED will be returned.
If module is NULL, option and value will be provided to every registered module. If any module returns ARCHIVE_FATAL, this value will be returned immediately. Otherwise, ARCHIVE_OK will be returned if any module accepts the option, and ARCHIVE_FAILED in all other cases.
archive_write_set_option()
Calls archive_write_set_format_option(), then archive_write_set_filter_option(). If either function returns ARCHIVE_FATAL, ARCHIVE_FATAL will be returned immediately. Otherwise, the greater of the two values will be returned.
archive_write_set_options()
options is a comma-separated list of options. If options is NULL or empty, ARCHIVE_OK will be returned immediately.
Individual options have one of the following forms:
option=value
The option/value pair will be provided to every module. Modules that do not accept an option with this name will ignore it.
option
The option will be provided to every module with a value of “1”.
!option
The option will be provided to every module with a NULL value.
module:option=value, module:option, module:!option
As above, but the corresponding option and value will be provided only to modules whose name matches module.
OPTIONS
Filter b64encode
mode
The value is interpreted as octal digits specifying the file mode.
name
The value specifies the file name.
Filter bzip2
compression-level
The value is interpreted as a decimal integer specifying the bzip2 compression level. Supported values are from 1 to 9.
Filter gzip
compression-level
The value is interpreted as a decimal integer specifying the gzip compression level. Supported values are from 0 to 9.
timestamp
Store timestamp. This is enabled by default.
Filter lrzip
compression=type
Use type as compression method. Supported values are “bzip2”, “gzipi”, “lzo” (ultra fast), and “zpaq” (best, extremely slow).
compression-level
The value is interpreted as a decimal integer specifying the lrzip compression level. Supported values are from 1 to 9.
Filter lz4
compression-level
The value is interpreted as a decimal integer specifying the lz4 compression level. Supported values are from 0 to 9.
stream-checksum
Enable stream checksum. This is enabled by default.
block-checksum
Enable block checksum. This is disabled by default.
block-size
The value is interpreted as a decimal integer specifying the lz4 compression block size. Supported values are from 4 to 7 (default).
block-dependence
Use the previous block of the block being compressed for a compression dictionary to improve compression ratio. This is disabled by default.
Filter lzop
compression-level
The value is interpreted as a decimal integer specifying the lzop compression level. Supported values are from 1 to 9.
Filter uuencode
mode
The value is interpreted as octal digits specifying the file mode.
name
The value specifies the file name.
Filter xz
compression-level
The value is interpreted as a decimal integer specifying the compression level. Supported values are from 0 to 9.
threads
The value is interpreted as a decimal integer specifying the number of threads for multi-threaded lzma compression. If supported, the default value is read from lzma_cputhreads().
Filter zstd
compression-level
The value is interpreted as a decimal integer specifying the compression level. Supported values depend on the library version, common values are from 1 to 22.
long
Enables long distance matching. The value is interpreted as a decimal integer specifying log2 window size in bytes. Values from 10 to 30 for 32 bit, or 31 for 64 bit, are supported.
threads
The value is interpreted as a decimal integer specifying the number of threads for multi-threaded zstd compression. If set to 0, zstd will attempt to detect and use the number of active physical CPU cores.
Format 7zip
compression
The value is one of “store”, “copy”, “deflate”, “bzip2”, “lzma1”, “lzma2”, “ppmd”, or “zstd” to indicate how the following entries should be compressed. The values “store” and “copy” are synonyms. Note that this setting is ignored for directories, symbolic links, and other special entries.
compression-level
The value is interpreted as a decimal integer specifying the compression level. Values between 0 and 9 are supported, with the exception of bzip2 which only supports values between 1 and 9, and zstd which may support negative values depending on the library version and commonly used values 1 through 22. The interpretation of the compression level depends on the chosen compression method.
threads
The value is interpreted as a decimal integer specifying the number of threads for multi-threaded compression (for compressors like zstd that support it). If set to 0, an attempt will be made to discover the number of CPU cores.
Format bin
hdrcharset
The value is used as a character set name that will be used when translating file names.
Format gnutar
hdrcharset
The value is used as a character set name that will be used when translating file, group and user names.
Format iso9660 - volume metadata
These options are used to set standard ISO9660 metadata.
abstract-file=filename
The file with the specified name will be identified in the ISO9660 metadata as holding the abstract for this volume. Default: none.
application-id=filename
The file with the specified name will be identified in the ISO9660 metadata as holding the application identifier for this volume. Default: none.
biblio-file=filename
The file with the specified name will be identified in the ISO9660 metadata as holding the bibliography for this volume. Default: none.
copyright-file=filename
The file with the specified name will be identified in the ISO9660 metadata as holding the copyright for this volume. Default: none.
publisher=filename
The file with the specified name will be identified in the ISO9660 metadata as holding the publisher information for this volume. Default: none.
volume-id=string
The specified string will be used as the Volume Identifier in the ISO9660 metadata. It is limited to 32 bytes. Default: none.
Format iso9660 - boot support
These options are used to make an ISO9660 image that can be directly booted on various systems.
boot=filename
The file matching this name will be used as the El Torito boot image file.
boot-catalog=name
The name that will be used for the El Torito boot catalog. Default: boot.catalog
boot-info-table
The boot image file provided by the boot=filename option will be edited with appropriate boot information in bytes 8 through 64. Default: disabled
boot-load-seg=hexadecimal-number
The load segment for a no-emulation boot image.
boot-load-size=decimal-number
The number of "virtual" 512-byte sectors to be loaded from a no-emulation boot image. Some very old BIOSes can only load very small images, setting this value to 4 will often allow such BIOSes to load the first part of the boot image (which will then need to be intelligent enough to load the rest of itself). This should not be needed unless you are trying to support systems with very old BIOSes. This defaults to the full size of the image.
boot-type=value
Specifies the boot semantics used by the El Torito boot image: If the value is fd, then the boot image is assumed to be a bootable floppy image. If the value is hd, then the boot image is assumed to be a bootable hard disk image. If the value is no-emulation, the boot image is used without floppy or hard disk emulation. If the boot image is exactly 1.2MB, 1.44MB, or 2.88MB, then the default is fd, otherwise the default is no-emulation.
Format iso9660 - filename and size extensions
Various extensions to the base ISO9660 format.
allow-ldots
If enabled, allows filenames to begin with a leading period. If disabled, filenames that begin with a leading period will have that period replaced by an underscore character in the standard ISO9660 namespace. This does not impact names stored in the Rockridge or Joliet extension area. Default: disabled.
allow-lowercase
If enabled, allows filenames to contain lowercase characters. If disabled, filenames will be forced to uppercase. This does not impact names stored in the Rockridge or Joliet extension area. Default: disabled.
allow-multidot
If enabled, allows filenames to contain multiple period characters, in violation of the ISO9660 specification. If disabled, additional periods will be converted to underscore characters. This does not impact names stored in the Rockridge or Joliet extension area. Default: disabled.
allow-period
If enabled, allows filenames to contain trailing period characters, in violation of the ISO9660 specification. If disabled, trailing periods will be converted to underscore characters. This does not impact names stored in the Rockridge or Joliet extension area. Default: disabled.
allow-pvd-lowercase
If enabled, the Primary Volume Descriptor may contain lowercase ASCII characters, in violation of the ISO9660 specification. If disabled, characters will be converted to uppercase ASCII. Default: disabled.
allow-sharp-tilde
If enabled, sharp and tilde characters will be permitted in filenames, in violation if the ISO9660 specification. If disabled, such characters will be converted to underscore characters. Default: disabled.
allow-vernum
If enabled, version numbers will be included with files. If disabled, version numbers will be suppressed, in violation of the ISO9660 standard. This does not impact names stored in the Rockridge or Joliet extension area. Default: enabled.
iso-level
This enables support for file size and file name extensions in the core ISO9660 area. The name extensions specified here do not affect the names stored in the Rockridge or Joliet extension areas.
iso-level=1
The most compliant form of ISO9660 image. Filenames are limited to 8.3 uppercase format, directory names are limited to 8 uppercase characters, files are limited to 4 GiB, the complete ISO9660 image cannot exceed 4 GiB.
iso-level=2
Filenames are limited to 30 uppercase characters with a 30-character extension, directory names are limited to 30 characters, files are limited to 4 GiB.
iso-level=3
As with iso-level=2, except that files may exceed 4 GiB.
iso-level=4
As with iso-level=3, except that filenames may be up to 193 characters and may include arbitrary 8-bit characters.
joliet
Microsoft’s Joliet extensions store a completely separate set of directory information about each file. In particular, this information includes Unicode filenames of up to 255 characters. Default: enabled.
limit-depth
If enabled, libarchive will use directory relocation records to ensure that no pathname exceeds the ISO9660 limit of 8 directory levels. If disabled, no relocation will occur. Default: enabled.
limit-dirs
If enabled, libarchive will cause an error if there are more than 65536 directories. If disabled, there is no limit on the number of directories. Default: enabled
pad
If enabled, 300 kiB of zero bytes will be appended to the end of the archive. Default: enabled
relaxed-filenames
If enabled, all 7-bit ASCII characters are permitted in filenames (except lowercase characters unless allow-lowercase is also specified). This violates ISO9660 standards. This does not impact names stored in the Rockridge or Joliet extension area. Default: disabled.
rockridge
The Rockridge extensions store an additional set of POSIX-style file information with each file, including mtime, atime, ctime, permissions, and long filenames with arbitrary 8-bit characters. These extensions also support symbolic links and other POSIX file types. Default: enabled.
Format iso9660 - zisofs support
The zisofs extensions permit each file to be independently compressed using a gzip-compatible compression. This can provide significant size savings, but requires the reading system to have support for these extensions. These extensions are disabled by default.
compression-level=number
The compression level used by the deflate compressor. Ranges from 0 (least effort) to 9 (most effort). Default: 6
zisofs
Synonym for zisofs=direct.
zisofs=direct
Compress each file in the archive. Unlike zisofs=indirect, this is handled entirely within libarchive and does not require a separate utility. For best results, libarchive tests each file and will store the file uncompressed if the compression does not actually save any space. In particular, files under 2k will never be compressed. Note that boot image files are never compressed.
zisofs=indirect
Recognizes files that have already been compressed with the mkzftree utility and sets up the necessary file metadata so that readers will correctly identify these as zisofs-compressed files.
zisofs-exclude=filename
Specifies a filename that should not be compressed when using zisofs=direct. This option can be provided multiple times to suppress compression on many files.
Format mtree
cksum, device, flags, gid,
gname, indent, link, md5,
mode, nlink, rmd160, sha1,
sha256, sha384, sha512, size,
time, uid, uname
Enable a particular keyword in the mtree output. Prefix with an exclamation mark to disable the corresponding keyword. The default is equivalent to “device, flags, gid, gname, link, mode, nlink, size, time, type, uid, uname”.
all
Enables all of the above keywords.
use-set
Enables generation of /set lines that specify default values for the following files and/or directories.
indent
XXX needs explanation XXX
Format newc
hdrcharset
The value is used as a character set name that will be used when translating file names.
Format odc
hdrcharset
The value is used as a character set name that will be used when translating file names.
Format pwb
hdrcharset
The value is used as a character set name that will be used when translating file names.
Format pax
hdrcharset
The value is used as a character set name that will be used when translating file, group and user names. The value is one of “BINARY” or “UTF-8”. With “BINARY” there is no character conversion, with “UTF-8” names are converted to UTF-8.
xattrheader
When storing extended attributes, this option configures which headers should be written. The value is one of “all”, “LIBARCHIVE”, or “SCHILY”. By default, both “LIBARCHIVE.xattr” and “SCHILY.xattr” headers are written.
Format ustar
hdrcharset
The value is used as a character set name that will be used when translating file, group and user names.
Format v7tar
hdrcharset
The value is used as a character set name that will be used when translating file, group and user names.
Format warc
omit-warcinfo
Set to “true” to disable output of the warcinfo record.
Format xar
checksum=type
Use type as file checksum method. Supported values are “none”, “md5”, and “sha1” (default).
compression=type
Use type as compression method. Supported values are “none”, “bzip2”, “gzip” (default), “lzma” and “xz”.
compression_level
The value is a decimal integer from 1 to 9 specifying the compression level.
toc-checksum=type
Use type as table of contents checksum method. Supported values are “none”, “md5” and “sha1” (default).
Format zip
compression
The value is either “store”, “deflate”, “bzip2”, “lzma”, “xz”, or “zstd” to indicate how the following entries should be compressed. Note that this setting is ignored for directories, symbolic links, and other special entries.
compression-level
The value is interpreted as a decimal integer specifying the compression level. Values between 0 and 9 are supported. A compression level of 0 switches the compression method to “store”, other values will enable “deflate”, “bzip2”, “lzma”, or “zstd” compression (in order of priority, depending on what libraries are linked) with the given level.
threads
The value is interpreted as a decimal integer specifying the number of threads to use for compression. It is supported only for “xz” or “zstd” compression and ignored for any other. A threads value of 0 is a special one requesting to detect and use as many threads as the number of active physical CPU cores.
encryption
Enable encryption using traditional zip encryption.
encryption=type
Use type as encryption type. Supported values are “zipcrypt” (traditional zip encryption), “aes128” (WinZip AES-128 encryption) and “aes256” (WinZip AES-256 encryption).
experimental
This boolean option enables or disables experimental Zip features that may not be compatible with other Zip implementations.
fakecrc32
This boolean option disables CRC calculations. All CRC fields are set to zero. It should not be used except for testing purposes.
hdrcharset
The value is used as a character set name that will be used when translating file names.
zip64
Zip64 extensions provide additional file size information for entries larger than 4 GiB. They also provide extended file offset and archive size information when archives exceed 4 GiB. By default, the Zip writer selectively enables these extensions only as needed. In particular, if the file size is unknown, the Zip writer will include Zip64 extensions to guard against the possibility that the file might be larger than 4 GiB.
Setting this boolean option will force the writer to use Zip64 extensions even for small files that would not otherwise require them. This is primarily useful for testing.
Disabling this option with !zip64 will force the Zip writer to avoid Zip64 extensions: It will reject files with size greater than 4 GiB, it will reject any new entries once the total archive size reaches 4 GiB, and it will not use Zip64 extensions for files with unknown size. In particular, this can improve compatibility when generating archives where the entry sizes are not known in advance.
EXAMPLES
The following example creates an archive write handle to create a gzip-compressed ISO9660 format image. The two options here specify that the ISO9660 archive will use kernel.img as the boot image for El Torito booting, and that the gzip compressor should use the maximum compression level.
a =
archive_write_new();
archive_write_add_filter_gzip(a);
archive_write_set_format_iso9660(a);
archive_write_set_options(a,
"boot=kernel.img,compression=9");
archive_write_open_filename(a, filename, blocksize);
ERRORS
More detailed error codes and textual descriptions are available from the archive_errno() and archive_error_string() functions.
SEE ALSO
tar(1), archive_read_set_options(3), archive_write(3), libarchive(3)
HISTORY
The libarchive library first appeared in FreeBSD 5.3.
AUTHORS
The options support for libarchive was originally implemented by Michihiro NAKAJIMA.
BUGS Debian January 31, 2020 ARCHIVE_WRITE_OPTIONS(3)
ARCHIVE_WRITE_OPTIONS(3) BSD Library Functions Manual ARCHIVE_WRITE_OPTIONS(3)
d29 4 a32 5archive_write_set_filter_option, archive_write_set_format_option, archive_write_set_option, archive_write_set_options — functions controlling options for writing archives
d36 1 a36 1Streaming Archive Library d41 1 a41 1
int
d49 1 a49 1int
d57 1 a57 1int
d65 1 a65 1int
d73 1 a73 1These functions provide a way d81 1 a81 1
Specifies an option that will d85 1 a85 1
If d92 1 a92 1
If d101 1 a101 1
If d112 1 a112 1
Calls d122 1 a122 1
options is a d127 1 a127 1
Individual d132 1 a132 1
The option/value pair will be d138 1 a138 1
The option will d144 1 a144 1
The option will be provided to d150 1 a150 1
As above, but the corresponding d158 1 a158 1
The value is d163 1 a163 1
The value d169 1 a169 1
The value is interpreted as a d176 1 a176 1
The value is interpreted as a d182 1 a182 1
Store timestamp. This is d188 1 a188 1
Use type as compression d195 1 a195 1
The value is interpreted as a d202 1 a202 1
The value is interpreted as a d208 1 a208 1
Enable stream checksum. This is d213 1 a213 1
Enable block checksum. This is d218 1 a218 1
The value is interpreted as a d224 1 a224 1
Use the previous block of the d231 1 a231 1
The value is interpreted as a d238 1 a238 1
The value is d243 1 a243 1
The value d249 1 a249 1
The value is interpreted as a d255 1 a255 1
The value is interpreted as a d263 1 a263 1
The value is interpreted as a d270 1 a270 1
Enables long d277 1 a277 1
The value is interpreted as a d286 1 a286 1
The value is one of d298 1 a298 1
The value is interpreted as a d308 1 a308 1
The value is used as a d315 1 a315 1
The value is used as a d321 1 a321 1
These options are used to set d326 1 a326 1
The file with the specified d332 1 a332 1
The file with the specified d339 1 a339 1
The file with the specified d345 1 a345 1
The file with the specified d351 1 a351 1
The file with the specified d358 1 a358 1
The specified string will be d364 1 a364 1
These options are used to make d370 1 a370 1
The file matching this name d375 1 a375 1
The name that will be used for d380 1 a380 1
The boot image file provided by d387 1 a387 1
The load segment for a d392 1 a392 1
The number of d404 1 a404 1
Specifies the boot semantics d417 1 a417 1
Various extensions to the base d422 1 a422 1
If enabled, allows filenames to d431 1 a431 1
If enabled, allows filenames to d439 1 a439 1
If enabled, allows filenames to d448 1 a448 1
If enabled, allows filenames to d457 1 a457 1
If enabled, the Primary Volume d465 1 a465 1
If enabled, sharp and tilde d473 1 a473 1
If enabled, version numbers d481 1 a481 1
This enables support for file d488 1 a488 1
The most compliant form of d496 1 a496 1
Filenames are limited to 30 d503 1 a503 1
As with iso-level=2, d508 1 a508 1
As with iso-level=3, d515 1 a515 1
Microsoft’s d523 1 a523 1
If enabled, libarchive will use d530 1 a530 1
If enabled, libarchive will d537 1 a537 1
If enabled, 300 d543 1 a543 1
If enabled, all 7-bit ASCII d552 1 a552 1
The Rockridge extensions store d561 1 a561 1
The zisofs extensions permit d570 1 a570 1
The compression level used by d576 1 a576 1
Synonym for d581 1 a581 1
Compress each file in the d592 1 a592 1
Recognizes files that have d599 1 a599 1
Specifies a filename that d611 1 a611 1
Enable a particular keyword in d619 1 a619 1
Enables all of d624 1 a624 1
Enables generation of d630 1 a630 1
XXX needs d636 1 a636 1
The value is used as a d643 1 a643 1
The value is used as a d650 1 a650 1
The value is used as a d657 1 a657 1
The value is used as a d666 1 a666 1
When storing extended d676 1 a676 1
The value is used as a d683 1 a683 1
The value is used as a d690 1 a690 1
Set to “true” to d696 1 a696 1
Use type as file d702 1 a702 1
Use type as compression d709 1 a709 1
The value is a decimal integer d714 1 a714 1
Use type as table of d722 1 a722 1
The value is either d730 1 a730 1
The value is interpreted as a d739 1 a739 1
Enable encryption using d744 1 a744 1
Use type as encryption d752 1 a752 1
This boolean option enables or d758 1 a758 1
This boolean option disables d764 1 a764 1
The value is used as a d770 1 a770 1
Zip64 d780 1 a780 1
Setting this d785 1 a785 1
Disabling this d796 1 a796 1
The following example creates an d803 1 a803 1
a = d813 1 a813 1
More detailed error codes and d820 3 a822 3
tar(1), archive_read_set_options(3), archive_write(3), libarchive(3)
d826 1 a826 1The libarchive library d831 1 a831 1
The options support for d835 2 a836 4
BUGS
BSD January 31, 2020 BSD
@ 1.10 log @libarchive: updated to 3.7.4 Libarchive 3.7.4 is a bugfix and security release Security fixes: rar: Fix OOB in rar e8 filter (CVE-2024-26256) zip: Fix out of boundary access Important bugfixes: 7zip: Limit amount of properties bsdtar: Fix error handling around strtol() usages passphrase: Improve newline handling on Windows passphrase: Never allow empty passwords rar: Fix "File CRC Error" when extracting specific rar4 archives xar: Avoid infinite link loop zip: Update AppleDouble support for directories zstd: Implement core detection @ text @d2 1 a2 1 @ 1.9 log @libarchive: updated to 3.7.3 Libarchive 3.7.3 is a feature, security and bugfix release. New features: PCRE2 support add trailing letter b to bsdtar(1) substitute pattern add support for long options "--group" and "--owner" to tar(1) Security fixes: Fix possible vulnerability in tar error reporting introduced in f27c173 Important bugfixes: ISO9660: preserve the natural order of links rar5: fix decoding unicode filenames on Windows rar5: fix infinite loop if during rar5 decompression the last block produced no data xz filter: fix incorrect eof at the end of an lzip member zip: fix end-of-data marker processing when decompressing zip archives multiple bsdunzip(1) fixes filetime truncation fix on Windows @ text @d2 1 a2 1 @ 1.8 log @libarchive: updated to 3.7.2 Libarchive 3.7.2 is a security, bugfix and feature release. Security fixes: Multiple vulnerabilities have been fixed in the PAX writer (1b4e0d0) Important bugfixes: bsdunzip(1) now correctly handles arguments following an -x after the zipfile New features: bsdunzip(1) now supports the "--version" flag 7-zip reader now translates Windows permissions into UNIX permissions uudecode filter in raw mode now supports file name and file mode zstd filter now supports the "long" write option Libarchive 3.7.1 is a security, feature and bugfix release. Security fixes: SEGV and stack buffer overflow in verbose mode of cpio Feature updates: bsdunzip updated to match latest upstream code Important bugfixes: miscellaneous functional bugfixes build fixes on multiple platforms Libarchive 3.7.0 is a feature and bugfix release. New features: bsdunzip: new tool ported from FreeBSD drop-in replacement for Info-ZIP unzip, not yet ported for Windows 7zip reader: support for Zstandard compression 7zip reader: support for ARM64 filter zstd filter: support for multi-frame zstd archives Other notable bugfixes and improvements: pax: fix year 2038 problem on platforms with 64-bit time_t Windows: Universal Windows Platform (UWP) fixes and improvements Windows: bcrypt usage fixes and improvements Windows: time function usage fixes and improvements @ text @d2 1 a2 1 d288 8 a295 6 “store”, “deflate”, “bzip2”, “lzma1”, “lzma2” or “ppmd” to indicate how the following entries should be compressed. Note that this setting is ignored for directories, symbolic links, and other special entries. d301 4 a304 3 between 0 and 9 are supported. The interpretation of the compression level depends on the chosen compression method. @ 1.7 log @libarchive: Update to 3.4.3 Libarchive 3.4.3 is a feature and bugfix release. New features: support for pzstd compressed files (#1357) support for RHT.security.selinux tar extended attribute (#1348) Important bugfixes: various zstd fixes and improvements (#1342 #1352 #1359) child process handling fixes (#1372) Libarchive 3.4.2 is a feature and security release. New features: support for atomic file extraction (bsdtar -x --safe-writes) (#1289) support for mbed TLS (PolarSSL) (#1301) Important bugfixes: security fixes in RAR5 reader (#1280 #1326) compression buffer fix in XAR writer (#1317) fix uname and gname longer than 32 characters in PAX writer (#1319) fix segfault when archiving hard links in ISO9660 and XAR writers (#1325) fix support for extracting 7z archive entries with Delta filter (#987) Libarchive 3.4.1 is a feature and security release. New features: Unicode filename support for reading lha/lzh archives New pax write option "xattrhdr" Important bugfixes: security fixes in wide string processing (#1276 #1298) security fixes in RAR5 reader (#1212 #1217 #1296) security fixes and optimizations to write filter logic (#351) security fix related to use of readlink(2) (1dae5a5) sparse file handling fixes (#1218 #1260) Thanks to all contributors and bug reporters. Special thanks to Christos Zoulas (@@zoulasc) from NetBSD for the atomic file extraction feature. @ text @d1 2 a2 2 d141 1 a141 1 ’’1’’. d190 3 a192 5 method. Supported values are ’’bzip2’’, ’’gzipi’’, ’’lzo’’ (ultra fast), and ’’zpaq’’ (best, extremely slow). d269 15 d288 4 a291 7 ’’store’’, ’’deflate’’, ’’bzip2’’, ’’lzma1’’, ’’lzma2’’ or ’’ppmd’’ to indicate how the following entries should be compressed. Note that this d303 1 a303 1Format cpio
d612 2
a613 2
’’device, flags, gid, gname, link, mode, nlink,
size, time, type, uid, uname’’.
Set to ’’true’’ to disable output of the warcinfo record.
d695 2 a696 4 checksum method. Supported values are ’’none’’, ’’md5’’, and ’’sha1’’ (default). d701 3 a703 6 method. Supported values are ’’none’’, ’’bzip2’’, ’’gzip’’ (default), ’’lzma’’ and ’’xz’’. d714 2 a715 3 ’’none’’, ’’md5’’ and ’’sha1’’ (default). d721 2 a722 3 ’’store’’ or ’’deflate’’ to indicate how the following entries should be compressed. Note that this d731 3 a733 4 switches the compression method to ’’store’’, other values will enable ’’deflate’’ compression with the given level. d743 4 a746 5 type. Supported values are ’’zipcrypt’’ (traditional zip encryption), ’’aes128’’ (WinZip AES-128 encryption) and ’’aes256’’ (WinZip AES-256 encryption). @ 1.6 log @Update for libarchive-3.4.0: - improvements for Android APK and JAR archives - better support for non-recursive list and extract - tar --exclude-vcs support - fixes for file attributes and flags handling - zipx support - rar 5.0 reader @ text @d1 2 a2 2 d83 1 a83 1 be passed to currently-registered filters (including d117 2 a118 2 returned immediately. Otherwise, greater of the two values will be returned. d141 1 a141 1 “1”. d156 76 a231 1 Filter gzipFormat mtree
cksum, device, flags, gid,
gname, indent, link, md5,
mode, nlink, rmd160, sha1,
sha256, sha384, sha512, size,
time, uid, uname
Enable a particular keyword in the mtree output. Prefix with an exclamation mark to disable the corresponding keyword. The default is equivalent to “device, flags, gid, gname, link, mode, nlink, size, time, type, uid, uname”.
d263 2 a264 1all
d266 4 a269 2Enables all of the above keywords.
d271 2 a272 1use-set
d274 10 a283 3Enables generation of /set lines that specify default values for the following files and/or directories.
d285 1 a285 1indent
d287 19 a305 2XXX needs explanation XXX
d401 1 a401 1 no-emulation. d438 1 a438 1 ISO9660 specification. If disabled,trailing periods will be d592 113 d709 3 a711 2 “store” or “deflate” to indicate how the following entries should be compressed. Note that this d715 24 d753 3 a755 2This sets the character set used for filenames.
d809 3 a811 2tar(1), libarchive(3), archive_read_set_options(3), archive_write(3)
d826 1 a826 1BSD February 2, 2012 @ 1.5 log @libarchive: updated to 3.3.3 libarchive 3.3.3: Avoid super-linear slowdown on malformed mtree files Many fixes for building with Visual Studio NO_OVERWRITE doesn't change existing directory attributes New support for Zstandard read and write filters @ text @d1 2 a2 2 d141 1 a141 1 ’’1’’.
d178 2 a179 2 ’’device, flags, gid, gname, link, mode, nlink, size, time, type, uid, uname’’. d486 2 a487 3 ’’store’’ or ’’deflate’’ to indicate how the following entries should be compressed. Note that this @ 1.4 log @Merge for libarchive-3.3.2. @ text @d2 1 a2 1 @ 1.3 log @Merge libarchive-3.3.1. @ text @d2 1 a2 1 d141 1 a141 1 ‘‘1’’. d178 1 a178 1 ‘‘device, flags, gid, gname, link, mode, nlink, d486 2 a487 2 ‘‘store’’ or ‘‘deflate’’ to indicate how the @ 1.2 log @Update for libarchive 3.2.1. @ text @d2 1 a2 1 d141 1 a141 1 ’’1’’. d178 1 a178 1 ’’device, flags, gid, gname, link, mode, nlink, d486 2 a487 2 ’’store’’ or ’’deflate’’ to indicate how the @ 1.1 log @Changes 3.1.2: This is a maintenance update to fix issues with the new RAR seeking feature. This new release also contains fixes for build failures when building libarchive using Visual Studio 2012 and MinGW. @ text @d1 2 a2 2 d33 1 a33 1 controlling options for reading archives d96 5 a100 3 module. The return value will be that of the module. If there is no such module, ARCHIVE_FAILED will be returned. d285 1 a285 1 floppy image. If the value is hd, then the the d482 53 d554 4 a557 3Detailed error codes and textual descriptions are available from the archive_errno() and archive_error_string() functions.
@ 1.1.1.1 log @Import libarchive-3.2.1: - security fixes and other bugfixes - support for multhreading in xz 5.2+ @ text @d1 2 a2 2 d33 1 a33 1 controlling options for writing archives d96 3 a98 5 module. The return value will be either ARCHIVE_OK if the option was successfully handled or ARCHIVE_WARN if the option was unrecognized by the module or could otherwise not be handled. If there is no such module, ARCHIVE_FAILED will be returned. d283 1 a283 1 floppy image. If the value is hd, then the a479 53Format zip
compression
The value is either ’’store’’ or ’’deflate’’ to indicate how the following entries should be compressed. Note that this setting is ignored for directories, symbolic links, and other special entries.
experimental
This boolean option enables or disables experimental Zip features that may not be compatible with other Zip implementations.
fakecrc32
This boolean option disables CRC calculations. All CRC fields are set to zero. It should not be used except for testing purposes.
hdrcharset
This sets the character set used for filenames.
zip64
Zip64 extensions provide additional file size information for entries larger than 4 GiB. They also provide extended file offset and archive size information when archives exceed 4 GiB. By default, the Zip writer selectively enables these extensions only as needed. In particular, if the file size is unknown, the Zip writer will include Zip64 extensions to guard against the possibility that the file might be larger than 4 GiB.
Setting this boolean option will force the writer to use Zip64 extensions even for small files that would not otherwise require them. This is primarily useful for testing.
Disabling this option with !zip64 will force the Zip writer to avoid Zip64 extensions: It will reject files with size greater than 4 GiB, it will reject any new entries once the total archive size reaches 4 GiB, and it will not use Zip64 extensions for files with unknown size. In particular, this can improve compatibility when generating archives where the entry sizes are not known in advance.
d499 3 a501 4More detailed error codes and textual descriptions are available from the archive_errno() and archive_error_string() functions.
@ 1.1.1.2 log @Import libarchive-3.3.1. @ text @d2 1 a2 1 d141 1 a141 1 ‘‘1’’. d178 1 a178 1 ‘‘device, flags, gid, gname, link, mode, nlink, d486 2 a487 2 ‘‘store’’ or ‘‘deflate’’ to indicate how the @ 1.1.1.3 log @Import libarchive-3.3.2 + 9de5f3 + f9dacbf: - Support NFS4 ACLs on Linux - Bugfixes @ text @d2 1 a2 1 d141 1 a141 1 ’’1’’. d178 1 a178 1 ’’device, flags, gid, gname, link, mode, nlink, d486 2 a487 2 ’’store’’ or ’’deflate’’ to indicate how the @ 1.1.1.4 log @Import libarchive-3.3.3 as should have done originally. @ text @d2 1 a2 1 @ 1.1.1.5 log @Import libarchive 3.4.0 @ text @d1 2 a2 2 d141 1 a141 1 “1”. d178 2 a179 2 “device, flags, gid, gname, link, mode, nlink, size, time, type, uid, uname”. d486 3 a488 2 “store” or “deflate” to indicate how the following entries should be compressed. Note that this @ 1.1.1.6 log @Import libarchive 3.7.2 @ text @d2 1 a2 1 d83 1 a83 1 be passed to the currently-registered filters (including d117 2 a118 2 returned immediately. Otherwise, the greater of the two values will be returned. d156 1 a156 45 Filter b64encodeThe value is interpreted as octal digits specifying the file mode.
name
The value specifies the file name.
Filter bzip2
compression-level
The value is interpreted as a decimal integer specifying the bzip2 compression level. Supported values are from 1 to 9.
Filter gzip
compression-level
The value is interpreted as a decimal integer specifying the gzip compression level. Supported values are from 0 to 9.
timestamp
Store timestamp. This is enabled by default.
Filter lrzip
compression=type
Use type as compression method. Supported values are “bzip2”, “gzipi”, “lzo” (ultra fast), and “zpaq” (best, extremely slow).
compression-level
The value is interpreted as a decimal integer specifying the lrzip compression level. Supported values are from 1 to 9.
Filter lz4
d160 1
a160 42
decimal integer specifying the lz4 compression level.
Supported values are from 0 to 9.
stream-checksum
Enable stream checksum. This is enabled by default.
block-checksum
Enable block checksum. This is disabled by default.
block-size
The value is interpreted as a decimal integer specifying the lz4 compression block size. Supported values are from 4 to 7 (default).
block-dependence
Use the previous block of the block being compressed for a compression dictionary to improve compression ratio. This is disabled by default.
Filter lzop
compression-level
The value is interpreted as a decimal integer specifying the lzop compression level. Supported values are from 1 to 9.
Filter uuencode
mode
The value is interpreted as octal digits specifying the file mode.
name
The value specifies the file name.
d166 1 a166 2 decimal integer specifying the compression level. Supported values are from 0 to 9. d168 6 a173 1threads
d175 5 a179 4The value is interpreted as a decimal integer specifying the number of threads for multi-threaded lzma compression. If supported, the default value is read from lzma_cputhreads().
d181 1 a181 2Filter zstd
compression-level
The value is interpreted as a decimal integer specifying the compression level. Supported values depend on the library version, common values are from 1 to 22.
long
Enables long distance matching. The value is interpreted as a decimal integer specifying log2 window size in bytes. Values from 10 to 30 for 32 bit, or 31 for 64 bit, are supported.
d186 1 a186 1threads
d188 3 a190 5The value is interpreted as a decimal integer specifying the number of threads for multi-threaded zstd compression. If set to 0, zstd will attempt to detect and use the number of physical CPU cores.
d192 1 a192 2Format 7zip
compression
The value is one of “store”, “deflate”, “bzip2”, “lzma1”, “lzma2” or “ppmd” to indicate how the following entries should be compressed. Note that this setting is ignored for directories, symbolic links, and other special entries.
compression-level
The value is interpreted as a decimal integer specifying the compression level. Values between 0 and 9 are supported. The interpretation of the compression level depends on the chosen compression method.
Format bin
hdrcharset
The value is used as a character set name that will be used when translating file names.
Format gnutar
hdrcharset
The value is used as a character set name that will be used when translating file, group and user names.
d291 1 a291 1 no-emulation. d328 1 a328 1 ISO9660 specification. If disabled, trailing periods will be a481 115Format mtree
cksum, device, flags, gid,
gname, indent, link, md5,
mode, nlink, rmd160, sha1,
sha256, sha384, sha512, size,
time, uid, uname
Enable a particular keyword in the mtree output. Prefix with an exclamation mark to disable the corresponding keyword. The default is equivalent to “device, flags, gid, gname, link, mode, nlink, size, time, type, uid, uname”.
all
Enables all of the above keywords.
use-set
Enables generation of /set lines that specify default values for the following files and/or directories.
indent
XXX needs explanation XXX
Format newc
hdrcharset
The value is used as a character set name that will be used when translating file names.
Format odc
hdrcharset
The value is used as a character set name that will be used when translating file names.
Format pwb
hdrcharset
The value is used as a character set name that will be used when translating file names.
Format pax
hdrcharset
The value is used as a character set name that will be used when translating file, group and user names. The value is one of “BINARY” or “UTF-8”. With “BINARY” there is no character conversion, with “UTF-8” names are converted to UTF-8.
xattrheader
When storing extended attributes, this option configures which headers should be written. The value is one of “all”, “LIBARCHIVE”, or “SCHILY”. By default, both “LIBARCHIVE.xattr” and “SCHILY.xattr” headers are written.
Format ustar
hdrcharset
The value is used as a character set name that will be used when translating file, group and user names.
Format v7tar
hdrcharset
The value is used as a character set name that will be used when translating file, group and user names.
Format warc
omit-warcinfo
Set to “true” to disable output of the warcinfo record.
Format xar
checksum=type
Use type as file checksum method. Supported values are “none”, “md5”, and “sha1” (default).
compression=type
Use type as compression method. Supported values are “none”, “bzip2”, “gzip” (default), “lzma” and “xz”.
compression_level
The value is a decimal integer from 1 to 9 specifying the compression level.
toc-checksum=type
Use type as table of contents checksum method. Supported values are “none”, “md5” and “sha1” (default).
a490 22compression-level
The value is interpreted as a decimal integer specifying the compression level. Values between 0 and 9 are supported. A compression level of 0 switches the compression method to “store”, other values will enable “deflate” compression with the given level.
encryption
Enable encryption using traditional zip encryption.
encryption=type
Use type as encryption type. Supported values are “zipcrypt” (traditional zip encryption), “aes128” (WinZip AES-128 encryption) and “aes256” (WinZip AES-256 encryption).
d505 2 a506 3The value is used as a character set name that will be used when translating file names.
d560 2 a561 3tar(1), archive_read_set_options(3), archive_write(3), libarchive(3)
d576 1 a576 1BSD January 31, 2020 @ 1.1.1.7 log @libarchive: import version 3.7.3 @ text @d2 1 a2 1 d288 6 a293 8 “store”, “copy”, “deflate”, “bzip2”, “lzma1”, “lzma2” or “ppmd” to indicate how the following entries should be compressed. The values “store” and “copy” are synonyms. Note that this setting is ignored for directories, symbolic links, and other special entries.
d299 3 a301 4 between 0 and 9 are supported, with the exception of bzip2 which only supports values between 1 and 9. The interpretation of the compression level depends on the chosen compression method. @ 1.1.1.8 log @Libarchive 3.7.4 is a bugfix and security release Security fixes: rar: Fix OOB in rar e8 filter (CVE-2024-26256) zip: Fix out of boundary access Important bugfixes: 7zip: Limit amount of properties bsdtar: Fix error handling around strtol() usages passphrase: Improve newline handling on Windows passphrase: Never allow empty passwords rar: Fix "File CRC Error" when extracting specific rar4 archives xar: Avoid infinite link loop zip: Update AppleDouble support for directories zstd: Implement core detection @ text @d2 1 a2 1 @ 1.1.1.9 log @libarchive: imported version 3.7.5 Libarchive 3.7.5 Security fixes: fix multiple vulnerabilities identified by SAST cpio: ignore out-of-range gid/uid/size/ino and harden AFIO parsing lzop: prevent integer overflow rar4: protect copy_from_lzss_window_to_unp() rar4: fix CVE-2024-26256 rar4: fix OOB in delta and audio filter rar4: fix out of boundary access with large files rar4: add boundary checks to rgb filter rar4: fix OOB access with unicode filenames rar5: clear 'data ready' cache on window buffer reallocs rpm: calculate huge header sizes correctly unzip: unify EOF handling util: fix out of boundary access in mktemp functions uu: stop processing if lines are too long Important bugfixes: 7zip: fix issue when skipping first file in 7zip archive that is a multiple of 65536 bytes ar: fix archive entries having no type lha: do not allow negative file sizes lha: fix integer truncation on 32-bit systems shar: check strdup return value rar5: don't try to read rediculously long names xar: fix another infinite loop and expat error handling many Windows fixes, cleanups and improvements @ text @d2 1 a2 1 @ 1.1.1.10 log @libarchove: import version 3.7.7 @ text @d1 2 a2 2 d23 2 a24 2ARCHIVE_WRITE_OPTIONS(3) Library Functions Manual ARCHIVE_WRITE_OPTIONS(3)
d29 5 a33 4archive_write_set_filter_option, archive_write_set_format_option, archive_write_set_option, archive_write_set_options — functions controlling options for writing archives
d37 1 a37 1Streaming Archive Library d42 1 a42 1
int
d50 1 a50 1int
d58 1 a58 1int
d66 1 a66 1int
d74 1 a74 1These functions provide a way d82 1 a82 1
Specifies an option that will d86 1 a86 1
If d93 1 a93 1
If d102 1 a102 1
If d113 1 a113 1
Calls d123 1 a123 1
options is a d128 1 a128 1
Individual d133 1 a133 1
The option/value pair will be d139 1 a139 1
The option will d145 1 a145 1
The option will be provided to d151 1 a151 1
As above, but the corresponding d159 1 a159 1
The value is d164 1 a164 1
The value d170 1 a170 1
The value is interpreted as a d177 1 a177 1
The value is interpreted as a d183 1 a183 1
Store timestamp. This is d189 1 a189 1
Use type as compression d196 1 a196 1
The value is interpreted as a d203 1 a203 1
The value is interpreted as a d209 1 a209 1
Enable stream checksum. This is d214 1 a214 1
Enable block checksum. This is d219 1 a219 1
The value is interpreted as a d225 1 a225 1
Use the previous block of the d232 1 a232 1
The value is interpreted as a d239 1 a239 1
The value is d244 1 a244 1
The value d250 1 a250 1
The value is interpreted as a d256 1 a256 1
The value is interpreted as a d264 1 a264 1
The value is interpreted as a d271 1 a271 1
Enables long d278 1 a278 1
The value is interpreted as a d287 1 a287 1
The value is one of d299 1 a299 1
The value is interpreted as a d309 1 a309 1
The value is used as a d316 1 a316 1
The value is used as a d322 1 a322 1
These options are used to set d327 1 a327 1
The file with the specified d333 1 a333 1
The file with the specified d340 1 a340 1
The file with the specified d346 1 a346 1
The file with the specified d352 1 a352 1
The file with the specified d359 1 a359 1
The specified string will be d365 1 a365 1
These options are used to make d371 1 a371 1
The file matching this name d376 1 a376 1
The name that will be used for d381 1 a381 1
The boot image file provided by d388 1 a388 1
The load segment for a d393 1 a393 1
The number of d405 1 a405 1
Specifies the boot semantics d418 1 a418 1
Various extensions to the base d423 1 a423 1
If enabled, allows filenames to d432 1 a432 1
If enabled, allows filenames to d440 1 a440 1
If enabled, allows filenames to d449 1 a449 1
If enabled, allows filenames to d458 1 a458 1
If enabled, the Primary Volume d466 1 a466 1
If enabled, sharp and tilde d474 1 a474 1
If enabled, version numbers d482 1 a482 1
This enables support for file d489 1 a489 1
The most compliant form of d497 1 a497 1
Filenames are limited to 30 d504 1 a504 1
As with iso-level=2, d509 1 a509 1
As with iso-level=3, d516 1 a516 1
Microsoft’s d524 1 a524 1
If enabled, libarchive will use d531 1 a531 1
If enabled, libarchive will d538 1 a538 1
If enabled, 300 d544 1 a544 1
If enabled, all 7-bit ASCII d553 1 a553 1
The Rockridge extensions store d562 1 a562 1
The zisofs extensions permit d571 1 a571 1
The compression level used by d577 1 a577 1
Synonym for d582 1 a582 1
Compress each file in the d593 1 a593 1
Recognizes files that have d600 1 a600 1
Specifies a filename that d612 1 a612 1
Enable a particular keyword in d620 1 a620 1
Enables all of d625 1 a625 1
Enables generation of d631 1 a631 1
XXX needs d637 1 a637 1
The value is used as a d644 1 a644 1
The value is used as a d651 1 a651 1
The value is used as a d658 1 a658 1
The value is used as a d667 1 a667 1
When storing extended d677 1 a677 1
The value is used as a d684 1 a684 1
The value is used as a d691 1 a691 1
Set to “true” to d697 1 a697 1
Use type as file d703 1 a703 1
Use type as compression d710 1 a710 1
The value is a decimal integer d715 1 a715 1
Use type as table of d723 1 a723 1
The value is either d731 1 a731 1
The value is interpreted as a d740 1 a740 1
Enable encryption using d745 1 a745 1
Use type as encryption d753 1 a753 1
This boolean option enables or d759 1 a759 1
This boolean option disables d765 1 a765 1
The value is used as a d771 1 a771 1
Zip64 d781 1 a781 1
Setting this d786 1 a786 1
Disabling this d797 1 a797 1
The following example creates an d804 1 a804 1
a = d814 1 a814 1
More detailed error codes and d821 3 a823 3
tar(1), archive_read_set_options(3), archive_write(3), libarchive(3)
d827 1 a827 1The libarchive library d832 1 a832 1
The options support for d836 4 a839 2
BUGS Debian January 31, 2020 ARCHIVE_WRITE_OPTIONS(3)
@ 1.1.1.11 log @libarchive: imported version 3.7.9 @ text @d2 1 a2 1 @ 1.1.1.12 log @libarchive: import version 3.8.0 Libarchive 3.8.0 is a feature and bugfix release. New features: bsdtar: support --mtime and --clamp-mtime lib: mbedtls 3.x compatibility 7-zip reader: improve self-extracting archive detection xar: xmllite support for the XAR reader and writer zip writer: added XZ, LZMA, ZSTD and BZIP2 support zip writer: added LZMA + RISCV BCJ filter Notable security fixes: rar: do not skip past EOF while reading rar: fix double free with over 4 billion nodes rar: fix heap-buffer-overflow warc: prevent signed integer overflow tar: fix overflow in build_ustar_entry Notable bugfixes: bsdtar: don't hardlink negative inode files together gz: allow setting the original filename for gzip compressed files lib: improve lseek handling lib: support @@-prefixed Unix epoch timestamps as date strings rar: support large headers on 32 bit systems tar reader: Improve LFS support on 32 bit systems @ text @d2 1 a2 1 d280 1 a280 1 attempt to detect and use the number of active physical CPU d289 6 a294 6 “lzma1”, “lzma2”, “ppmd”, or “zstd” to indicate how the following entries should be compressed. The values “store” and “copy” are synonyms. Note that this setting is ignored for directories, symbolic links, and other special entries. d301 3 a303 13 which only supports values between 1 and 9, and zstd which may support negative values depending on the library version and commonly used values 1 through 22. The interpretation of the compression level depends on the chosen compression method.threads
The value is interpreted as a decimal integer specifying the number of threads for multi-threaded compression (for compressors like zstd that support it). If set to 0, an attempt will be made to discover the number of CPU cores.
d723 4 a726 5 “store”, “deflate”, “bzip2”, “lzma”, “xz”, or “zstd” to indicate how the following entries should be compressed. Note that this setting is ignored for directories, symbolic links, and other special entries. d734 2 a735 15 other values will enable “deflate”, “bzip2”, “lzma”, or “zstd” compression (in order of priority, depending on what libraries are linked) with the given level.threads
The value is interpreted as a decimal integer specifying the number of threads to use for compression. It is supported only for “xz” or “zstd” compression and ignored for any other. A threads value of 0 is a special one requesting to detect and use as many threads as the number of active physical CPU cores.
@ 1.1.1.13 log @libarchive: import version 3.8.1 @ text @d2 1 a2 1 @ 1.1.1.14 log @libarchive: imported version 3.8.2 @ text @d2 1 a2 1 @ 1.1.1.15 log @libarchive: import version 3.8.3 @ text @d2 1 a2 1 @ 1.1.1.16 log @libarchive: import 3.8.4 @ text @d2 1 a2 1 @ 1.1.1.17 log @libarchive: import version 3.8.5 @ text @d2 1 a2 1 @ 1.1.1.18 log @libarchive: imported version 3.8.6 @ text @d2 1 a2 1 @ 1.1.1.19 log @libarchive: imported version 3.8.7 @ text @d2 1 a2 1 @ 1.1.1.20 log @libarchive: import 3.8.8 @ text @d2 1 a2 1 @