head 1.11; access; symbols libarchive-3-8-9:1.1.1.9 libarchive-3-8-8:1.1.1.8 pkgsrc-2026Q2:1.10.0.10 pkgsrc-2026Q2-base:1.10 libarchive-3-8-7:1.1.1.8 libarchive-3-8-6:1.1.1.8 pkgsrc-2026Q1:1.10.0.8 pkgsrc-2026Q1-base:1.10 libarchive-3-8-5:1.1.1.8 libarchive-3-8-4:1.1.1.8 pkgsrc-2025Q4:1.10.0.6 pkgsrc-2025Q4-base:1.10 libarchive-3-8-3:1.1.1.8 libarchive-3-8-2:1.1.1.8 pkgsrc-2025Q3:1.10.0.4 pkgsrc-2025Q3-base:1.10 libarchive-3-8-1:1.1.1.8 pkgsrc-2025Q2:1.10.0.2 pkgsrc-2025Q2-base:1.10 libarchive-3-8-0:1.1.1.8 libarchive-3-7-9:1.1.1.7 pkgsrc-2025Q1:1.9.0.4 pkgsrc-2025Q1-base:1.9 pkgsrc-2024Q4:1.9.0.2 pkgsrc-2024Q4-base:1.9 libarchive-3-7-7:1.1.1.7 pkgsrc-2024Q3:1.8.0.4 pkgsrc-2024Q3-base:1.8 libarchive-3-7-5:1.1.1.6 pkgsrc-2024Q2:1.8.0.2 pkgsrc-2024Q2-base:1.8 libarchive-3-7-4:1.1.1.6 libarchive-3-7-3:1.1.1.6 pkgsrc-2024Q1:1.7.0.2 pkgsrc-2024Q1-base:1.7 libarchive-3-7-2:1.1.1.5 pkgsrc-2023Q4:1.6.0.30 pkgsrc-2023Q4-base:1.6 pkgsrc-2023Q3:1.6.0.28 pkgsrc-2023Q3-base:1.6 pkgsrc-2023Q2:1.6.0.26 pkgsrc-2023Q2-base:1.6 pkgsrc-2023Q1:1.6.0.24 pkgsrc-2023Q1-base:1.6 pkgsrc-2022Q4:1.6.0.22 pkgsrc-2022Q4-base:1.6 pkgsrc-2022Q3:1.6.0.20 pkgsrc-2022Q3-base:1.6 pkgsrc-2022Q2:1.6.0.18 pkgsrc-2022Q2-base:1.6 pkgsrc-2022Q1:1.6.0.16 pkgsrc-2022Q1-base:1.6 pkgsrc-2021Q4:1.6.0.14 pkgsrc-2021Q4-base:1.6 pkgsrc-2021Q3:1.6.0.12 pkgsrc-2021Q3-base:1.6 pkgsrc-2021Q2:1.6.0.10 pkgsrc-2021Q2-base:1.6 pkgsrc-2021Q1:1.6.0.8 pkgsrc-2021Q1-base:1.6 pkgsrc-2020Q4:1.6.0.6 pkgsrc-2020Q4-base:1.6 pkgsrc-2020Q3:1.6.0.4 pkgsrc-2020Q3-base:1.6 pkgsrc-2020Q2:1.6.0.2 pkgsrc-2020Q2-base:1.6 pkgsrc-2020Q1:1.5.0.4 pkgsrc-2020Q1-base:1.5 pkgsrc-2019Q4:1.5.0.6 pkgsrc-2019Q4-base:1.5 pkgsrc-2019Q3:1.5.0.2 pkgsrc-2019Q3-base:1.5 libarchive-3-4-0:1.1.1.4 libarchive-3-3-3:1.1.1.3 pkgsrc-2019Q2:1.4.0.18 pkgsrc-2019Q2-base:1.4 pkgsrc-2019Q1:1.4.0.16 pkgsrc-2019Q1-base:1.4 pkgsrc-2018Q4:1.4.0.14 pkgsrc-2018Q4-base:1.4 pkgsrc-2018Q3:1.4.0.12 pkgsrc-2018Q3-base:1.4 pkgsrc-2018Q2:1.4.0.10 pkgsrc-2018Q2-base:1.4 pkgsrc-2018Q1:1.4.0.8 pkgsrc-2018Q1-base:1.4 pkgsrc-2017Q4:1.4.0.6 pkgsrc-2017Q4-base:1.4 pkgsrc-2017Q3:1.4.0.4 pkgsrc-2017Q3-base:1.4 libarchive-3-3-2:1.1.1.3 pkgsrc-2017Q2:1.3.0.4 pkgsrc-2017Q2-base:1.3 pkgsrc-2017Q1:1.3.0.2 pkgsrc-2017Q1-base:1.3 libarchive-3-3-1:1.1.1.2 pkgsrc-2016Q4:1.2.0.6 pkgsrc-2016Q4-base:1.2 pkgsrc-2016Q3:1.2.0.4 pkgsrc-2016Q3-base:1.2 pkgsrc-2016Q2:1.2.0.2 pkgsrc-2016Q2-base:1.2 libarchive-3-2-1:1.1.1.1 KIENTZLE:1.1.1 pkgsrc-2016Q1:1.1.0.10 pkgsrc-2016Q1-base:1.1 pkgsrc-2015Q4:1.1.0.8 pkgsrc-2015Q4-base:1.1 pkgsrc-2015Q3:1.1.0.6 pkgsrc-2015Q3-base:1.1 pkgsrc-2015Q2:1.1.0.4 pkgsrc-2015Q2-base:1.1 pkgsrc-2015Q1:1.1.0.2 pkgsrc-2015Q1-base:1.1; locks; strict; comment @# @; 1.11 date 2026.08.01.15.33.02; author adam; state Exp; branches; next 1.10; commitid OeG7s22aQguJSWPG; 1.10 date 2025.05.21.15.25.50; author adam; state Exp; branches; next 1.9; commitid 6aTN21WjRYk8TMVF; 1.9 date 2024.10.19.05.39.58; author adam; state Exp; branches; next 1.8; commitid fYRSlpIWMYluweuF; 1.8 date 2024.04.12.15.39.50; author adam; state Exp; branches; next 1.7; commitid 52ilmjFHKDf0XR5F; 1.7 date 2024.01.18.18.00.16; author adam; state Exp; branches; next 1.6; commitid hNXpsHx3SuHqsXUE; 1.6 date 2020.05.26.09.16.41; author nia; state Exp; branches; next 1.5; commitid nNhsdZACz3PjmJ9C; 1.5 date 2019.09.22.09.55.08; author joerg; state Exp; branches; next 1.4; commitid FdPvRjF4OzwBwZDB; 1.4 date 2017.08.01.22.26.23; author joerg; state Exp; branches; next 1.3; commitid 32clTfkmVE8bPy1A; 1.3 date 2017.02.25.21.11.19; author joerg; state Exp; branches; next 1.2; commitid rW8QfCWrsCO1snHz; 1.2 date 2016.06.20.17.24.57; author joerg; state Exp; branches; next 1.1; commitid ArUvympBjfBseebz; 1.1 date 2015.01.17.12.44.49; author adam; state Exp; branches 1.1.1.1; next ; commitid yy7e1hLrfmA2pn6y; 1.1.1.1 date 2016.06.20.17.12.02; author joerg; state Exp; branches; next 1.1.1.2; commitid rRgm3BqbmbI8aebz; 1.1.1.2 date 2017.02.25.20.54.12; author joerg; state Exp; branches; next 1.1.1.3; commitid ReqPI0ibLYjdmnHz; 1.1.1.3 date 2017.08.01.22.21.12; author joerg; state Exp; branches; next 1.1.1.4; commitid XQwPAFJku336Ny1A; 1.1.1.4 date 2019.09.22.09.51.33; author joerg; state Exp; branches; next 1.1.1.5; commitid 5kDbfPbiV3INvZDB; 1.1.1.5 date 2024.01.18.17.37.46; author adam; state Exp; branches; next 1.1.1.6; commitid zDULEPUODGjTkXUE; 1.1.1.6 date 2024.04.12.15.27.44; author adam; state Exp; branches; next 1.1.1.7; commitid tQWTddCoxBumSR5F; 1.1.1.7 date 2024.10.19.05.27.34; author adam; state Exp; branches; next 1.1.1.8; commitid v1iXM4j1Na52seuF; 1.1.1.8 date 2025.05.21.15.11.28; author adam; state Exp; branches; next 1.1.1.9; commitid Nzqt2UgtvkVXNMVF; 1.1.1.9 date 2026.08.01.15.14.08; author adam; state Exp; branches; next ; commitid G6lcb6OWxRjcMWPG; desc @@ 1.11 log @libarchive: updated to 3.8.9 Libarchive 3.8.9 is a security, bugfix and minor feature release. @ text @4mARCHIVE_WRITE_OPTIONS24m(3) Library Functions Manual 4mARCHIVE_WRITE_OPTIONS24m(3) 1mNAME0m archive_write_set_filter_option, archive_write_set_format_option, archive_write_set_option, archive_write_set_options — functions con‐ trolling options for writing archives 1mLIBRARY0m Streaming Archive Library (libarchive, -larchive) 1mSYNOPSIS0m 4mint0m 1marchive_write_set_filter_option22m(4mstruct24m 4marchive24m 4m*24m, 4mconst24m 4mchar24m 4m*module24m, 4mconst24m 4mchar24m 4m*option24m, 4mconst24m 4mchar24m 4m*value24m); 4mint0m 1marchive_write_set_format_option22m(4mstruct24m 4marchive24m 4m*24m, 4mconst24m 4mchar24m 4m*module24m, 4mconst24m 4mchar24m 4m*option24m, 4mconst24m 4mchar24m 4m*value24m); 4mint0m 1marchive_write_set_option22m(4mstruct24m 4marchive24m 4m*24m, 4mconst24m 4mchar24m 4m*module24m, 4mconst24m 4mchar24m 4m*option24m, 4mconst24m 4mchar24m 4m*value24m); 4mint0m 1marchive_write_set_options22m(4mstruct24m 4marchive24m 4m*24m, 4mconst24m 4mchar24m 4m*options24m); 1mDESCRIPTION0m These functions provide a way for libarchive clients to configure spe‐ cific write modules. 1marchive_write_set_filter_option22m(), 1marchive_write_set_format_option22m() Specifies an option that will be passed to the currently-regis‐ tered filters (including decompression filters) or format read‐ ers. If 4moption24m and 4mvalue24m are both NULL, these functions will do nothing and 1mARCHIVE_OK 22mwill be returned. If 4moption24m is NULL but 4mvalue24m is not, these functions will do nothing and 1mARCHIVE_FAILED 22mwill be returned. If 4mmodule24m is not NULL, 4moption24m and 4mvalue24m will be provided to the filter or reader named 4mmodule24m. The return value will be either 1mARCHIVE_OK 22mif the option was successfully handled or 1mARCHIVE_WARN 22mif the option was unrecognized by the module or could otherwise not be handled. If there is no such module, 1mARCHIVE_FAILED 22mwill be returned. If 4mmodule24m is NULL, 4moption24m and 4mvalue24m will be provided to every registered module. If any module returns 1mARCHIVE_FATAL22m, this value will be returned immediately. Otherwise, 1mARCHIVE_OK 22mwill be returned if any module accepts the option, and 1mARCHIVE_FAILED 22min all other cases. 1marchive_write_set_option22m() Calls 1marchive_write_set_format_option22m(), then 1marchive_write_set_filter_option22m(). If either function returns 1mARCHIVE_FATAL22m, 1mARCHIVE_FATAL 22mwill be returned immediately. Otherwise, the greater of the two values will be returned. 1marchive_write_set_options22m() 4moptions24m is a comma-separated list of options. If 4moptions24m is NULL or empty, 1mARCHIVE_OK 22mwill be returned immediately. Individual options have one of the following forms: 4moption=value0m The option/value pair will be provided to every module. Modules that do not accept an option with this name will ignore it. 4moption24m The option will be provided to every module with a value of “1”. 4m!option0m The option will be provided to every module with a NULL value. 4mmodule:option=value24m, 4mmodule:option24m, 4mmodule:!option0m As above, but the corresponding option and value will be provided only to modules whose name matches 4mmodule24m. 1mOPTIONS0m Filter b64encode 1mmode 22mThe value is interpreted as octal digits specifying the file mode. 1mname 22mThe value specifies the file name. Filter bzip2 1mcompression-level0m The value is interpreted as a decimal integer specify‐ ing the bzip2 compression level. Supported values are from 1 to 9. Filter gzip 1mcompression-level0m The value is interpreted as a decimal integer specify‐ ing the gzip compression level. Supported values are from 0 to 9. 1mtimestamp0m Store timestamp. This is enabled by default. Filter lrzip 1mcompression22m=4mtype0m Use 4mtype24m as compression method. Supported values are “bzip2”, “gzipi”, “lzo” (ultra fast), and “zpaq” (best, extremely slow). 1mcompression-level0m The value is interpreted as a decimal integer specify‐ ing the lrzip compression level. Supported values are from 1 to 9. Filter lz4 1mcompression-level0m The value is interpreted as a decimal integer specify‐ ing the lz4 compression level. Supported values are from 0 to 9. 1mstream-checksum0m Enable stream checksum. This is enabled by default. 1mblock-checksum0m Enable block checksum. This is disabled by default. 1mblock-size0m The value is interpreted as a decimal integer specify‐ ing the lz4 compression block size. Supported values are from 4 to 7 (default). 1mblock-dependence0m Use the previous block of the block being compressed for a compression dictionary to improve compression ra‐ tio. This is disabled by default. Filter lzop 1mcompression-level0m The value is interpreted as a decimal integer specify‐ ing the lzop compression level. Supported values are from 1 to 9. Filter uuencode 1mmode 22mThe value is interpreted as octal digits specifying the file mode. 1mname 22mThe value specifies the file name. Filter xz 1mcompression-level0m The value is interpreted as a decimal integer specify‐ ing the compression level. Supported values are from 0 to 9. 1mthreads0m The value is interpreted as a decimal integer specify‐ ing the number of threads for multi-threaded lzma com‐ pression. If supported, the default value is read from 1mlzma_cputhreads22m(). Filter zstd 1mcompression-level0m The value is interpreted as a decimal integer specify‐ ing the compression level. Supported values depend on the library version, common values are from 1 to 22. 1mlong 22mEnables long distance matching. The value is inter‐ preted 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. 1mthreads0m The value is interpreted as a decimal integer specify‐ ing the number of threads for multi-threaded zstd com‐ pression. If set to 0, zstd will attempt to detect and use the number of active physical CPU cores. Format 7zip 1mcompression0m The value is one of “store”, “copy”, “deflate”, “bzip2”, “lzma1”, “lzma2”, “ppmd”, or “zstd” to indi‐ cate 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. 1mcompression-level0m The value is interpreted as a decimal integer specify‐ ing the compression level. Values between 0 and 9 are supported, with the exception of bzip2 which only sup‐ ports values between 1 and 9, and zstd which may sup‐ port negative values depending on the library version and commonly used values 1 through 22. The interpreta‐ tion of the compression level depends on the chosen compression method. 1mthreads0m The value is interpreted as a decimal integer specify‐ ing the number of threads for multi-threaded compres‐ sion (for compressors like zstd that support it). If set to 0, an attempt will be made to discover the num‐ ber of CPU cores. Format bin 1mhdrcharset0m The value is used as a character set name that will be used when translating file names. Format gnutar 1mhdrcharset0m 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. 1mabstract-file22m=4mfilename0m The file with the specified name will be identified in the ISO9660 metadata as holding the abstract for this volume. Default: none. 1mapplication-id22m=4mfilename0m The file with the specified name will be identified in the ISO9660 metadata as holding the application identi‐ fier for this volume. Default: none. 1mbiblio-file22m=4mfilename0m The file with the specified name will be identified in the ISO9660 metadata as holding the bibliography for this volume. Default: none. 1mcopyright-file22m=4mfilename0m The file with the specified name will be identified in the ISO9660 metadata as holding the copyright for this volume. Default: none. 1mpublisher22m=4mfilename0m The file with the specified name will be identified in the ISO9660 metadata as holding the publisher informa‐ tion for this volume. Default: none. 1mvolume-id22m=4mstring0m The specified string will be used as the Volume Identi‐ fier 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 di‐ rectly booted on various systems. 1mboot22m=4mfilename0m The file matching this name will be used as the El Torito boot image file. 1mboot-catalog22m=4mname0m The name that will be used for the El Torito boot cata‐ log. Default: 4mboot.catalog0m 1mboot-info-table0m The boot image file provided by the 1mboot22m=4mfilename24m op‐ tion will be edited with appropriate boot information in bytes 8 through 64. Default: disabled 1mboot-load-seg22m=4mhexadecimal-number0m The load segment for a no-emulation boot image. 1mboot-load-size22m=4mdecimal-number0m 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 intelli‐ gent 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. 1mboot-type22m=4mvalue0m Specifies the boot semantics used by the El Torito boot image: If the 4mvalue24m is 1mfd22m, then the boot image is as‐ sumed to be a bootable floppy image. If the 4mvalue24m is 1mhd22m, then the boot image is assumed to be a bootable hard disk image. If the 4mvalue24m is 1mno-emulation22m, the boot image is used without floppy or hard disk emula‐ tion. If the boot image is exactly 1.2MB, 1.44MB, or 2.88MB, then the default is 1mfd22m, otherwise the default is 1mno-emulation22m. Format iso9660 - filename and size extensions Various extensions to the base ISO9660 format. 1mallow-ldots0m If enabled, allows filenames to begin with a leading period. If disabled, filenames that begin with a lead‐ ing period will have that period replaced by an under‐ score character in the standard ISO9660 namespace. This does not impact names stored in the Rockridge or Joliet extension area. Default: disabled. 1mallow-lowercase0m If enabled, allows filenames to contain lowercase char‐ acters. If disabled, filenames will be forced to up‐ percase. This does not impact names stored in the Rockridge or Joliet extension area. Default: disabled. 1mallow-multidot0m 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. De‐ fault: disabled. 1mallow-period0m If enabled, allows filenames to contain trailing period characters, in violation of the ISO9660 specification. If disabled, trailing periods will be converted to un‐ derscore characters. This does not impact names stored in the Rockridge or Joliet extension area. Default: disabled. 1mallow-pvd-lowercase0m If enabled, the Primary Volume Descriptor may contain lowercase ASCII characters, in violation of the ISO9660 specification. If disabled, characters will be con‐ verted to uppercase ASCII. Default: disabled. 1mallow-sharp-tilde0m If enabled, sharp and tilde characters will be permit‐ ted in filenames, in violation if the ISO9660 specifi‐ cation. If disabled, such characters will be converted to underscore characters. Default: disabled. 1mallow-vernum0m If enabled, version numbers will be included with files. If disabled, version numbers will be sup‐ pressed, in violation of the ISO9660 standard. This does not impact names stored in the Rockridge or Joliet extension area. Default: enabled. 1miso-level0m This enables support for file size and file name exten‐ sions in the core ISO9660 area. The name extensions specified here do not affect the names stored in the Rockridge or Joliet extension areas. 1miso-level=10m 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. 1miso-level=20m Filenames are limited to 30 uppercase charac‐ ters with a 30-character extension, directory names are limited to 30 characters, files are limited to 4 GiB. 1miso-level=30m As with 1miso-level=222m, except that files may ex‐ ceed 4 GiB. 1miso-level=40m As with 1miso-level=322m, except that filenames may be up to 193 characters and may include arbi‐ trary 8-bit characters. 1mjoliet 22mMicrosoft's Joliet extensions store a completely sepa‐ rate set of directory information about each file. In particular, this information includes Unicode filenames of up to 255 characters. Default: enabled. 1mlimit-depth0m If enabled, libarchive will use directory relocation records to ensure that no pathname exceeds the ISO9660 limit of 8 directory levels. If disabled, no reloca‐ tion will occur. Default: enabled. 1mlimit-dirs0m 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 1mpad 22mIf enabled, 300 kiB of zero bytes will be appended to the end of the archive. Default: enabled 1mrelaxed-filenames0m If enabled, all 7-bit ASCII characters are permitted in filenames (except lowercase characters unless 1mallow-lowercase 22mis also specified). This violates ISO9660 standards. This does not impact names stored in the Rockridge or Joliet extension area. Default: disabled. 1mrockridge0m 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. De‐ fault: enabled. Format iso9660 - zisofs support The zisofs extensions permit each file to be independently com‐ pressed 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 dis‐ abled by default. 1mcompression-level22m=number The compression level used by the deflate compressor. Ranges from 0 (least effort) to 9 (most effort). De‐ fault: 6 1mzisofs 22mSynonym for 1mzisofs=direct22m. 1mzisofs=direct0m Compress each file in the archive. Unlike 1mzisofs=indirect22m, 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. 1mzisofs=indirect0m Recognizes files that have already been compressed with the 1mmkzftree 22mutility and sets up the necessary file metadata so that readers will correctly identify these as zisofs-compressed files. 1mzisofs-exclude22m=4mfilename0m Specifies a filename that should not be compressed when using 1mzisofs=direct22m. This option can be provided mul‐ tiple times to suppress compression on many files. Format mtree 1mcksum22m, 1mdevice22m, 1mflags22m, 1mgid22m, 1mgname22m, 1mindent22m, 1mlink22m, 1mmd522m, 1mmode22m, 1mnlink22m, 1mrmd16022m, 1msha122m, 1msha25622m, 1msha38422m, 1msha51222m, 1msize22m, 1mtime22m, 1muid22m, 1muname0m Enable a particular keyword in the mtree output. Pre‐ fix with an exclamation mark to disable the correspond‐ ing keyword. The default is equivalent to “device, flags, gid, gname, link, mode, nlink, size, time, type, uid, uname”. 1mall 22mEnables all of the above keywords. 1muse-set0m Enables generation of 1m/set 22mlines that specify default values for the following files and/or directories. 1mindent 22mXXX needs explanation XXX Format newc 1mhdrcharset0m The value is used as a character set name that will be used when translating file names. Format odc 1mhdrcharset0m The value is used as a character set name that will be used when translating file names. Format pwb 1mhdrcharset0m The value is used as a character set name that will be used when translating file names. Format pax 1malign 22mPad the extended header of each regular file so that the file data that follows begins on a multiple of the given number of bytes within the uncompressed archive stream. The value must be a power of two and a multi‐ ple of 512. Because the alignment is applied to the uncompressed stream, it is independent of any compres‐ sion filter: the decompressed archive is aligned re‐ gardless of whether the archive is compressed. This allows tools to share file contents out of an uncom‐ pressed archive (or an uncompressed copy of one) using reflinks or 4mcopy_file_range24m(2), at the cost of some ex‐ tra padding. Files shorter than the alignment are not padded. 1mhdrcharset0m 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. 1mxattrheader0m When storing extended attributes, this option config‐ ures which headers should be written. The value is one of “all”, “LIBARCHIVE”, or “SCHILY”. By default, both “LIBARCHIVE.xattr” and “SCHILY.xattr” headers are writ‐ ten. Format ustar 1mhdrcharset0m The value is used as a character set name that will be used when translating file, group and user names. Format v7tar 1mhdrcharset0m The value is used as a character set name that will be used when translating file, group and user names. Format warc 1momit-warcinfo0m Set to “true” to disable output of the warcinfo record. Format xar 1mchecksum22m=4mtype0m Use 4mtype24m as file checksum method. Supported values are “none”, “md5”, “sha1” (default), “sha256”, and “sha512”. 1mcompression22m=4mtype0m Use 4mtype24m as compression method. Supported values are “none”, “bzip2”, “gzip” (default), “lzma” and “xz”. 1mcompression_level0m The value is a decimal integer from 1 to 9 specifying the compression level. 1mtoc-checksum22m=4mtype0m Use 4mtype24m as table of contents checksum method. Sup‐ ported values are “none”, “md5”, “sha1” (default), “sha256”, and “sha512”. Format zip 1mcompression0m 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. 1mcompression-level0m The value is interpreted as a decimal integer specify‐ ing the compression level. Values between 0 and 9 are supported. A compression level of 0 switches the com‐ pression 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. 1mthreads0m The value is interpreted as a decimal integer specify‐ ing 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 spe‐ cial one requesting to detect and use as many threads as the number of active physical CPU cores. 1mencryption0m Enable encryption using traditional zip encryption. 1mencryption22m=4mtype0m Use 4mtype24m as encryption type. Supported values are “zipcrypt” (traditional zip encryption), “aes128” (WinZip AES-128 encryption) and “aes256” (WinZip AES-256 encryption). 1mexperimental0m This boolean option enables or disables experimental Zip features that may not be compatible with other Zip implementations. 1mfakecrc320m This boolean option disables CRC calculations. All CRC fields are set to zero. It should not be used except for testing purposes. 1mhdrcharset0m The value is used as a character set name that will be used when translating file names. 1mzip64 22mZip64 extensions provide additional file size informa‐ tion 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 se‐ lectively 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 pos‐ sibility 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 1m!zip64 22mwill 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. 1mEXAMPLES0m 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 4mkernel.img24m as the boot image for El Torito booting, and that the gzip compressor should use the maximum compres‐ sion 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); 1mERRORS0m More detailed error codes and textual descriptions are available from the 1marchive_errno22m() and 1marchive_error_string22m() functions. 1mSEE ALSO0m 4mtar24m(1), 4marchive_read_set_options24m(3), 4marchive_write24m(3), 4mlibarchive24m(3) 1mHISTORY0m The 1mlibarchive 22mlibrary first appeared in FreeBSD 5.3. 1mAUTHORS0m The options support for libarchive was originally implemented by Michihiro NAKAJIMA. 1mBUGS0m Debian January 31, 2020 4mARCHIVE_WRITE_OPTIONS24m(3) @ 1.10 log @libarchive bsdtar: updated to 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 @d398 13 d412 4 a415 4 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 d418 3 a420 3 When storing extended attributes, this option config‐ ures which headers should be written. The value is one of “all”, “LIBARCHIVE”, or “SCHILY”. By default, both d425 1 a425 1 The value is used as a character set name that will be d429 1 a429 1 The value is used as a character set name that will be d437 2 a438 1 “none”, “md5”, and “sha1” (default). d447 2 a448 1 ported values are “none”, “md5” and “sha1” (default). d451 4 a454 4 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 d457 6 a462 6 The value is interpreted as a decimal integer specify‐ ing the compression level. Values between 0 and 9 are supported. A compression level of 0 switches the com‐ pression method to “store”, other values will enable “deflate”, “bzip2”, “lzma”, or “zstd” compression (in order of priority, depending on what libraries are d465 5 a469 5 The value is interpreted as a decimal integer specify‐ ing 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 spe‐ cial one requesting to detect and use as many threads d474 3 a476 3 Use 4mtype24m as encryption type. Supported values are “zipcrypt” (traditional zip encryption), “aes128” (WinZip AES-128 encryption) and “aes256” (WinZip d479 2 a480 2 This boolean option enables or disables experimental Zip features that may not be compatible with other Zip d484 1 a484 1 fields are set to zero. It should not be used except d487 1 a487 1 The value is used as a character set name that will be d489 5 a493 5 1mzip64 22mZip64 extensions provide additional file size informa‐ tion 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 se‐ lectively enables these extensions only as needed. In d498 3 a500 3 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 d503 4 a506 4 Disabling this option with 1m!zip64 22mwill 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 d508 2 a509 2 size. In particular, this can improve compatibility when generating archives where the entry sizes are not d515 2 a516 2 ISO9660 archive will use 4mkernel.img24m as the boot image for El Torito booting, and that the gzip compressor should use the maximum compres‐ d526 1 a526 1 More detailed error codes and textual descriptions are available from d536 1 a536 1 The options support for libarchive was originally implemented by @ 1.9 log @libarchive: updated to 3.7.7 Libarchive 3.7.7 is a bugfix and security release Security fixes: gzip: prevent a hang when processing a malformed gzip inside a gzip tar: don't crash on truncated tar archives tar: fix two leaks in tar header parsing Important bugfixes: 7-zip: read/write symlink paths as UTF-8 cpio: exit with an error code if an entry could not be extracted rar5: report encrypted entries tar: fix truncation of entry pathnames in specific archives windows: fix ARCHIVE_EXTRACT_SECURE_NOABSOLUTEPATHS Libarchive 3.7.6 is a bugfix and security release. This release fixes a tar regression introduced in libarchive 3.7.5 Important bugfixes. tar: clean up linkpath between entries tar: fix memory leaks when processing symlinks or parsing pax headers iso: be more cautious about parsing ISO-9660 timestamps @ text @d153 1 a153 1 use the number of physical CPU cores. d157 5 a161 5 “bzip2”, “lzma1”, “lzma2” or “ppmd” to indicate how the following entries should be compressed. The values “store” and “copy” are synonyms. Note that this set‐ ting is ignored for directories, symbolic links, and other special entries. d163 14 a176 6 The value is interpreted as a decimal integer specify‐ ing the compression level. Values between 0 and 9 are supported, with the exception of bzip2 which only sup‐ ports values between 1 and 9. The interpretation of the compression level depends on the chosen compression method. d179 1 a179 1 The value is used as a character set name that will be d183 1 a183 1 The value is used as a character set name that will be d188 2 a189 2 The file with the specified name will be identified in the ISO9660 metadata as holding the abstract for this d192 1 a192 1 The file with the specified name will be identified in d196 2 a197 2 The file with the specified name will be identified in the ISO9660 metadata as holding the bibliography for d200 2 a201 2 The file with the specified name will be identified in the ISO9660 metadata as holding the copyright for this d204 2 a205 2 The file with the specified name will be identified in the ISO9660 metadata as holding the publisher informa‐ d209 1 a209 1 fier in the ISO9660 metadata. It is limited to 32 d215 1 a215 1 The file matching this name will be used as the El d221 2 a222 2 The boot image file provided by the 1mboot22m=4mfilename24m op‐ tion will be edited with appropriate boot information d227 8 a234 8 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 intelli‐ gent 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 d238 7 a244 7 image: If the 4mvalue24m is 1mfd22m, then the boot image is as‐ sumed to be a bootable floppy image. If the 4mvalue24m is 1mhd22m, then the boot image is assumed to be a bootable hard disk image. If the 4mvalue24m is 1mno-emulation22m, the boot image is used without floppy or hard disk emula‐ tion. If the boot image is exactly 1.2MB, 1.44MB, or 2.88MB, then the default is 1mfd22m, otherwise the default d249 1 a249 1 If enabled, allows filenames to begin with a leading d251 3 a253 3 ing period will have that period replaced by an under‐ score character in the standard ISO9660 namespace. This does not impact names stored in the Rockridge or d257 2 a258 2 acters. If disabled, filenames will be forced to up‐ percase. This does not impact names stored in the d262 4 a265 4 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. De‐ d269 2 a270 2 characters, in violation of the ISO9660 specification. If disabled, trailing periods will be converted to un‐ d272 1 a272 1 in the Rockridge or Joliet extension area. Default: d275 1 a275 1 If enabled, the Primary Volume Descriptor may contain d277 1 a277 1 specification. If disabled, characters will be con‐ d280 2 a281 2 If enabled, sharp and tilde characters will be permit‐ ted in filenames, in violation if the ISO9660 specifi‐ d285 3 a287 3 If enabled, version numbers will be included with files. If disabled, version numbers will be sup‐ pressed, in violation of the ISO9660 standard. This d292 2 a293 2 sions in the core ISO9660 area. The name extensions specified here do not affect the names stored in the d297 3 a299 3 Filenames are limited to 8.3 uppercase format, directory names are limited to 8 uppercase characters, files are limited to 4 GiB, the d302 3 a304 3 Filenames are limited to 30 uppercase charac‐ ters with a 30-character extension, directory names are limited to 30 characters, files are d307 1 a307 1 As with 1miso-level=222m, except that files may ex‐ d310 2 a311 2 As with 1miso-level=322m, except that filenames may be up to 193 characters and may include arbi‐ d313 2 a314 2 1mjoliet 22mMicrosoft's Joliet extensions store a completely sepa‐ rate set of directory information about each file. In d318 3 a320 3 If enabled, libarchive will use directory relocation records to ensure that no pathname exceeds the ISO9660 limit of 8 directory levels. If disabled, no reloca‐ d324 1 a324 1 more than 65536 directories. If disabled, there is no d326 1 a326 1 1mpad 22mIf enabled, 300 kiB of zero bytes will be appended to d330 1 a330 1 filenames (except lowercase characters unless d332 2 a333 2 ISO9660 standards. This does not impact names stored in the Rockridge or Joliet extension area. Default: d336 3 a338 3 The Rockridge extensions store an additional set of POSIX-style file information with each file, including mtime, atime, ctime, permissions, and long filenames d344 3 a346 3 pressed 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 dis‐ d349 2 a350 2 The compression level used by the deflate compressor. Ranges from 0 (least effort) to 9 (most effort). De‐ d354 4 a357 4 Compress each file in the archive. Unlike 1mzisofs=indirect22m, this is handled entirely within libarchive and does not require a separate utility. For best results, libarchive tests each file and will d360 1 a360 1 will never be compressed. Note that boot image files d364 2 a365 2 the 1mmkzftree 22mutility and sets up the necessary file metadata so that readers will correctly identify these d369 1 a369 1 using 1mzisofs=direct22m. This option can be provided mul‐ d372 2 a373 2 1mcksum22m, 1mdevice22m, 1mflags22m, 1mgid22m, 1mgname22m, 1mindent22m, 1mlink22m, 1mmd522m, 1mmode22m, 1mnlink22m, 1mrmd16022m, 1msha122m, 1msha25622m, 1msha38422m, 1msha51222m, 1msize22m, d375 1 a375 1 Enable a particular keyword in the mtree output. Pre‐ d377 1 a377 1 ing keyword. The default is equivalent to “device, d382 1 a382 1 Enables generation of 1m/set 22mlines that specify default d387 1 a387 1 The value is used as a character set name that will be d391 1 a391 1 The value is used as a character set name that will be d395 1 a395 1 The value is used as a character set name that will be d399 4 a402 4 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 d405 3 a407 3 When storing extended attributes, this option config‐ ures which headers should be written. The value is one of “all”, “LIBARCHIVE”, or “SCHILY”. By default, both d412 1 a412 1 The value is used as a character set name that will be d416 1 a416 1 The value is used as a character set name that will be d426 1 a426 1 Use 4mtype24m as compression method. Supported values are d429 1 a429 1 The value is a decimal integer from 1 to 9 specifying d432 1 a432 1 Use 4mtype24m as table of contents checksum method. Sup‐ d436 5 a440 4 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. d446 10 a455 1 “deflate” compression with the given level. d459 3 a461 3 Use 4mtype24m as encryption type. Supported values are “zipcrypt” (traditional zip encryption), “aes128” (WinZip AES-128 encryption) and “aes256” (WinZip d464 2 a465 2 This boolean option enables or disables experimental Zip features that may not be compatible with other Zip d469 1 a469 1 fields are set to zero. It should not be used except d472 1 a472 1 The value is used as a character set name that will be d474 5 a478 5 1mzip64 22mZip64 extensions provide additional file size informa‐ tion 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 se‐ lectively enables these extensions only as needed. In d483 3 a485 3 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 d488 4 a491 4 Disabling this option with 1m!zip64 22mwill 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 d493 2 a494 2 size. In particular, this can improve compatibility when generating archives where the entry sizes are not d500 2 a501 2 ISO9660 archive will use 4mkernel.img24m as the boot image for El Torito booting, and that the gzip compressor should use the maximum compres‐ d511 1 a511 1 More detailed error codes and textual descriptions are available from d521 1 a521 1 The options support for libarchive was originally implemented by @ 1.8 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 @d1 1 a1 1 ARCHIVE_WRITE_OPTIONS(3) BSD Library Functions Manual ARCHIVE_WRITE_OPTIONS(3) d3 502 a504 498 NAME archive_write_set_filter_option, archive_write_set_format_option, archive_write_set_option, archive_write_set_options — functions control‐ ling 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 spe‐ cific write modules. archive_write_set_filter_option(), archive_write_set_format_option() Specifies an option that will be passed to the currently-regis‐ tered filters (including decompression filters) or format read‐ ers. If option and value are both NULL, these functions will do noth‐ ing 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. Oth‐ erwise, 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 compres‐ sion. 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 li‐ brary 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 compres‐ sion. If set to 0, zstd will attempt to detect and use the number of physical CPU cores. Format 7zip compression The value is one of “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 en‐ tries. compression-level The value is interpreted as a decimal integer specifying the compression level. Values between 0 and 9 are sup‐ ported, with the exception of bzip2 which only supports values between 1 and 9. The interpretation of the com‐ pression 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. 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 identi‐ fier 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 Identi‐ fier 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 di‐ rectly 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 cata‐ log. 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 im‐ age. 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 de‐ fault 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 pe‐ riod. 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 exten‐ sion area. Default: disabled. allow-lowercase If enabled, allows filenames to contain lowercase charac‐ ters. If disabled, filenames will be forced to upper‐ case. 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 un‐ derscore characters. This does not impact names stored in the Rockridge or Joliet extension area. Default: dis‐ abled. 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 under‐ score characters. This does not impact names stored in the Rockridge or Joliet extension area. Default: dis‐ abled. 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 under‐ score characters. Default: disabled. allow-vernum If enabled, version numbers will be included with files. If disabled, version numbers will be suppressed, in vio‐ lation 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 exten‐ sions 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. File‐ names are limited to 8.3 uppercase format, direc‐ tory 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 partic‐ ular, 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: dis‐ abled. 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 sup‐ port symbolic links and other POSIX file types. Default: enabled. Format iso9660 - zisofs support The zisofs extensions permit each file to be independently com‐ pressed 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). De‐ fault: 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 actu‐ ally 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 meta‐ data 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 multi‐ ple 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 con‐ verted 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 writ‐ ten. 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” 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. compression-level The value is interpreted as a decimal integer specifying the compression level. Values between 0 and 9 are sup‐ ported. A compression level of 0 switches the compres‐ sion 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). experimental This boolean option enables or disables experimental Zip features that may not be compatible with other Zip imple‐ mentations. 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 ex‐ tended file offset and archive size information when ar‐ chives exceed 4 GiB. By default, the Zip writer selec‐ tively enables these extensions only as needed. In par‐ ticular, 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 oth‐ erwise require them. This is primarily useful for test‐ ing. 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 en‐ tries 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 boot‐ ing, 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. d506 2 a507 2 BUGS BSD January 31, 2020 BSD @ 1.7 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 @d155 4 a158 3 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 d164 3 a166 2 ported. The interpretation of the compression level de‐ pends on the chosen compression method. @ 1.6 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 @d5 1 a5 1 archive_write_set_option, archive_write_set_options -- functions control- d28 1 a28 1 These functions provide a way for libarchive clients to configure spe- d32 2 a33 2 Specifies an option that will be passed to the currently-regis- tered filters (including decompression filters) or format read- d36 1 a36 1 If option and value are both NULL, these functions will do noth- d49 1 a49 1 registered module. If any module returns ARCHIVE_FATAL, this d56 2 a57 2 archive_write_set_filter_option(). If either function returns ARCHIVE_FATAL, ARCHIVE_FATAL will be returned immediately. Oth- d70 1 a70 1 of ``1''. d98 2 a99 2 ``bzip2'', ``gzipi'', ``lzo'' (ultra fast), and ``zpaq'' (best, extremely slow). d136 1 a136 1 the number of threads for multi-threaded lzma compres- d142 11 a152 2 the compression level. Supported values depend on the library version, common values are from 1 to 22. d155 5 a159 5 The value is one of ``store'', ``deflate'', ``bzip2'', ``lzma1'', ``lzma2'' or ``ppmd'' to indicate how the fol- lowing entries should be compressed. Note that this set- ting is ignored for directories, symbolic links, and other special entries. d162 4 a165 4 the compression level. Values between 0 and 9 are sup- ported. The interpretation of the compression level depends on the chosen compression method. Format cpio d181 1 a181 1 the ISO9660 metadata as holding the application identi- d196 1 a196 1 The specified string will be used as the Volume Identi- d200 2 a201 2 These options are used to make an ISO9660 image that can be directly booted on various systems. d206 1 a206 1 The name that will be used for the El Torito boot cata- d227 2 a228 2 the boot image is assumed to be a bootable hard disk image. If the value is no-emulation, the boot image is d230 2 a231 2 image is exactly 1.2MB, 1.44MB, or 2.88MB, then the default is fd, otherwise the default is no-emulation. d235 2 a236 2 If enabled, allows filenames to begin with a leading period. If disabled, filenames that begin with a leading d239 2 a240 2 not impact names stored in the Rockridge or Joliet exten- sion area. Default: disabled. d242 2 a243 2 If enabled, allows filenames to contain lowercase charac- ters. If disabled, filenames will be forced to upper- d249 3 a251 3 If disabled, additional periods will be converted to underscore characters. This does not impact names stored in the Rockridge or Joliet extension area. Default: dis- d256 1 a256 1 If disabled, trailing periods will be converted to under- d258 1 a258 1 the Rockridge or Joliet extension area. Default: dis- d268 1 a268 1 If disabled, such characters will be converted to under- d272 1 a272 1 If disabled, version numbers will be suppressed, in vio- d277 1 a277 1 This enables support for file size and file name exten- d282 2 a283 2 The most compliant form of ISO9660 image. File- names are limited to 8.3 uppercase format, direc- d300 1 a300 1 set of directory information about each file. In partic- d302 1 a302 1 to 255 characters. Default: enabled. d318 2 a319 2 ISO9660 standards. This does not impact names stored in the Rockridge or Joliet extension area. Default: dis- d325 1 a325 1 arbitrary 8-bit characters. These extensions also sup- d329 1 a329 1 The zisofs extensions permit each file to be independently com- d336 2 a337 2 Ranges from 0 (least effort) to 9 (most effort). Default: 6 d340 1 a340 1 Compress each file in the archive. Unlike d344 1 a344 1 the file uncompressed if the compression does not actu- d350 1 a350 1 the mkzftree utility and sets up the necessary file meta- d355 1 a355 1 using zisofs=direct. This option can be provided multi- d363 1 a363 1 keyword. The default is equivalent to ``device, flags, d365 1 a365 1 uname''. d375 8 d387 3 a389 3 value is one of ``BINARY'' or ``UTF-8''. With ``BINARY'' there is no character conversion, with ``UTF-8'' names are converted to UTF-8. d393 3 a395 3 ``all'', ``LIBARCHIVE'', or ``SCHILY''. By default, both ``LIBARCHIVE.xattr'' and ``SCHILY.xattr'' headers are written. d406 1 a406 1 Set to ``true'' to disable output of the warcinfo record. d410 1 a410 1 ``none'', ``md5'', and ``sha1'' (default). d413 1 a413 2 ``none'', ``bzip2'', ``gzip'' (default), ``lzma'' and ``xz''. d419 1 a419 1 values are ``none'', ``md5'' and ``sha1'' (default). d422 4 a425 4 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. d428 4 a431 4 the compression level. Values between 0 and 9 are sup- ported. A compression level of 0 switches the compres- sion method to ``store'', other values will enable ``deflate'' compression with the given level. d436 3 a438 3 ``zipcrypt'' (traditional zip encryption), ``aes128'' (WinZip AES-128 encryption) and ``aes256'' (WinZip AES-256 encryption). d441 1 a441 1 features that may not be compatible with other Zip imple- d451 4 a454 4 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 selec- tively enables these extensions only as needed. In par- d460 2 a461 2 Zip64 extensions even for small files that would not oth- erwise require them. This is primarily useful for test- d466 2 a467 2 with size greater than 4 GiB, it will reject any new entries once the total archive size reaches 4 GiB, and it d476 1 a476 1 ISO9660 archive will use kernel.img as the boot image for El Torito boot- d501 1 a501 1 BSD January 31, 2020 BSD @ 1.5 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 @d5 1 a5 1 archive_write_set_option, archive_write_set_options — functions control‐ d28 1 a28 1 These functions provide a way for libarchive clients to configure spe‐ d32 3 a34 2 Specifies an option that will be passed to currently-registered filters (including decompression filters) or format readers. d36 1 a36 1 If option and value are both NULL, these functions will do noth‐ d57 2 a58 2 ARCHIVE_FATAL, ARCHIVE_FATAL will be returned immediately. Oth‐ erwise, greater of the two values will be returned. d70 1 a70 1 of “1”. d79 9 d91 39 a129 1 the gzip compression level. d133 31 a163 15 the compression level. 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 d172 1 a172 1 the ISO9660 metadata as holding the application identi‐ d187 1 a187 1 The specified string will be used as the Volume Identi‐ d191 2 a192 2 These options are used to make an ISO9660 image that can be di‐ rectly booted on various systems. d197 1 a197 1 The name that will be used for the El Torito boot cata‐ d218 2 a219 2 the boot image is assumed to be a bootable hard disk im‐ age. If the value is no-emulation, the boot image is d221 2 a222 2 image is exactly 1.2MB, 1.44MB, or 2.88MB, then the de‐ fault is fd, otherwise the default is no-emulation. d226 2 a227 2 If enabled, allows filenames to begin with a leading pe‐ riod. If disabled, filenames that begin with a leading d230 1 a230 1 not impact names stored in the Rockridge or Joliet exten‐ d233 2 a234 2 If enabled, allows filenames to contain lowercase charac‐ ters. If disabled, filenames will be forced to upper‐ d240 3 a242 3 If disabled, additional periods will be converted to un‐ derscore characters. This does not impact names stored in the Rockridge or Joliet extension area. Default: dis‐ d247 1 a247 1 If disabled,trailing periods will be converted to under‐ d249 1 a249 1 the Rockridge or Joliet extension area. Default: dis‐ d259 1 a259 1 If disabled, such characters will be converted to under‐ d263 1 a263 1 If disabled, version numbers will be suppressed, in vio‐ d268 1 a268 1 This enables support for file size and file name exten‐ d273 2 a274 2 The most compliant form of ISO9660 image. File‐ names are limited to 8.3 uppercase format, direc‐ d291 1 a291 1 set of directory information about each file. In partic‐ d310 1 a310 1 the Rockridge or Joliet extension area. Default: dis‐ d316 1 a316 1 arbitrary 8-bit characters. These extensions also sup‐ d320 1 a320 1 The zisofs extensions permit each file to be independently com‐ d327 2 a328 2 Ranges from 0 (least effort) to 9 (most effort). De‐ fault: 6 d335 1 a335 1 the file uncompressed if the compression does not actu‐ d341 1 a341 1 the mkzftree utility and sets up the necessary file meta‐ d346 1 a346 1 using zisofs=direct. This option can be provided multi‐ d348 56 d406 17 a422 4 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. d425 1 a425 1 features that may not be compatible with other Zip imple‐ d432 2 a433 1 This sets the character set used for filenames. d435 4 a438 4 for entries larger than 4 GiB. They also provide ex‐ tended file offset and archive size information when ar‐ chives exceed 4 GiB. By default, the Zip writer selec‐ tively enables these extensions only as needed. In par‐ d444 2 a445 2 Zip64 extensions even for small files that would not oth‐ erwise require them. This is primarily useful for test‐ d450 2 a451 2 with size greater than 4 GiB, it will reject any new en‐ tries once the total archive size reaches 4 GiB, and it d460 1 a460 1 ISO9660 archive will use kernel.img as the boot image for El Torito boot‐ d475 1 a475 1 tar(1), libarchive(3), archive_read_set_options(3), archive_write(3) d485 1 a485 1 BSD February 2, 2012 BSD @ 1.4 log @Merge for libarchive-3.3.2. @ text @d127 2 a128 2 These options are used to make an ISO9660 image that can be directly booted on various systems. d154 2 a155 2 the boot image is assumed to be a bootable hard disk image. If the value is no-emulation, the boot image is d157 2 a158 2 image is exactly 1.2MB, 1.44MB, or 2.88MB, then the default is fd, otherwise the default is no-emulation. d162 2 a163 2 If enabled, allows filenames to begin with a leading period. If disabled, filenames that begin with a leading d176 2 a177 2 If disabled, additional periods will be converted to underscore characters. This does not impact names stored d263 2 a264 2 Ranges from 0 (least effort) to 9 (most effort). Default: 6 d301 3 a303 3 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 selec‐ d316 2 a317 2 with size greater than 4 GiB, it will reject any new entries once the total archive size reaches 4 GiB, and it @ 1.3 log @Merge libarchive-3.3.1. @ text @d3 3 a5 3 1mNAME0m 1marchive_write_set_filter_option22m, 1marchive_write_set_format_option22m, 1marchive_write_set_option22m, 1marchive_write_set_options 22m— functions control‐ d8 1 a8 1 1mLIBRARY0m d11 12 a22 12 1mSYNOPSIS0m 4mint0m 1marchive_write_set_filter_option22m(4mstruct24m 4marchive24m 4m*24m, 4mconst24m 4mchar24m 4m*module24m, 4mconst24m 4mchar24m 4m*option24m, 4mconst24m 4mchar24m 4m*value24m); 4mint0m 1marchive_write_set_format_option22m(4mstruct24m 4marchive24m 4m*24m, 4mconst24m 4mchar24m 4m*module24m, 4mconst24m 4mchar24m 4m*option24m, 4mconst24m 4mchar24m 4m*value24m); 4mint0m 1marchive_write_set_option22m(4mstruct24m 4marchive24m 4m*24m, 4mconst24m 4mchar24m 4m*module24m, 4mconst24m 4mchar24m 4m*option24m, 4mconst24m 4mchar24m 4m*value24m); d24 2 a25 2 4mint0m 1marchive_write_set_options22m(4mstruct24m 4marchive24m 4m*24m, 4mconst24m 4mchar24m 4m*options24m); d27 1 a27 1 1mDESCRIPTION0m d31 1 a31 1 1marchive_write_set_filter_option22m(), 1marchive_write_set_format_option22m() d35 3 a37 3 If 4moption24m and 4mvalue24m are both NULL, these functions will do noth‐ ing and 1mARCHIVE_OK 22mwill be returned. If 4moption24m is NULL but 4mvalue0m is not, these functions will do nothing and 1mARCHIVE_FAILED 22mwill d40 3 a42 3 If 4mmodule24m is not NULL, 4moption24m and 4mvalue24m will be provided to the filter or reader named 4mmodule24m. The return value will be either 1mARCHIVE_OK 22mif the option was successfully handled or 1mARCHIVE_WARN0m d44 1 a44 1 not be handled. If there is no such module, 1mARCHIVE_FAILED 22mwill d47 4 a50 4 If 4mmodule24m is NULL, 4moption24m and 4mvalue24m will be provided to every registered module. If any module returns 1mARCHIVE_FATAL22m, this value will be returned immediately. Otherwise, 1mARCHIVE_OK 22mwill be returned if any module accepts the option, and 1mARCHIVE_FAILED0m d53 4 a56 4 1marchive_write_set_option22m() Calls 1marchive_write_set_format_option22m(), then 1marchive_write_set_filter_option22m(). If either function returns 1mARCHIVE_FATAL22m, 1mARCHIVE_FATAL 22mwill be returned immediately. Oth‐ d59 3 a61 3 1marchive_write_set_options22m() 4moptions24m is a comma-separated list of options. If 4moptions24m is NULL or empty, 1mARCHIVE_OK 22mwill be returned immediately. d64 1 a64 1 4moption=value0m d68 1 a68 1 4moption24m The option will be provided to every module with a value d70 1 a70 1 4m!option0m d73 1 a73 1 4mmodule:option=value24m, 4mmodule:option24m, 4mmodule:!option0m d75 1 a75 1 provided only to modules whose name matches 4mmodule24m. d77 1 a77 1 1mOPTIONS0m d79 1 a79 1 1mcompression-level0m d83 1 a83 1 1mcompression-level0m d87 3 a89 3 1mcksum22m, 1mdevice22m, 1mflags22m, 1mgid22m, 1mgname22m, 1mindent22m, 1mlink22m, 1mmd522m, 1mmode22m, 1mnlink22m, 1mrmd16022m, 1msha122m, 1msha25622m, 1msha38422m, 1msha51222m, 1msize22m, 1mtime22m, 1muid22m, 1muname0m d95 3 a97 3 1mall 22mEnables all of the above keywords. 1muse-set0m Enables generation of 1m/set 22mlines that specify default d99 1 a99 1 1mindent 22mXXX needs explanation XXX d102 1 a102 1 1mabstract-file22m=4mfilename0m d106 1 a106 1 1mapplication-id22m=4mfilename0m d110 1 a110 1 1mbiblio-file22m=4mfilename0m d114 1 a114 1 1mcopyright-file22m=4mfilename0m d118 1 a118 1 1mpublisher22m=4mfilename0m d122 1 a122 1 1mvolume-id22m=4mstring0m d129 1 a129 1 1mboot22m=4mfilename0m d132 1 a132 1 1mboot-catalog22m=4mname0m d134 3 a136 3 log. Default: 4mboot.catalog0m 1mboot-info-table0m The boot image file provided by the 1mboot22m=4mfilename24m option d139 1 a139 1 1mboot-load-seg22m=4mhexadecimal-number0m d141 1 a141 1 1mboot-load-size22m=4mdecimal-number0m d150 1 a150 1 1mboot-type22m=4mvalue0m d152 2 a153 2 image: If the 4mvalue24m is 1mfd22m, then the boot image is assumed to be a bootable floppy image. If the 4mvalue24m is 1mhd22m, then d155 1 a155 1 image. If the 4mvalue24m is 1mno-emulation22m, the boot image is d158 1 a158 1 default is 1mfd22m, otherwise the default is 1mno-emulation.0m d161 1 a161 1 1mallow-ldots0m d168 1 a168 1 1mallow-lowercase0m d173 1 a173 1 1mallow-multidot0m d180 1 a180 1 1mallow-period0m d187 1 a187 1 1mallow-pvd-lowercase0m d192 1 a192 1 1mallow-sharp-tilde0m d197 1 a197 1 1mallow-vernum0m d203 1 a203 1 1miso-level0m d208 1 a208 1 1miso-level=10m d214 1 a214 1 1miso-level=20m d219 2 a220 2 1miso-level=30m As with 1miso-level=222m, except that files may exceed d222 2 a223 2 1miso-level=40m As with 1miso-level=322m, except that filenames may be d226 1 a226 1 1mjoliet 22mMicrosoft's Joliet extensions store a completely separate d230 1 a230 1 1mlimit-depth0m d235 1 a235 1 1mlimit-dirs0m d239 1 a239 1 1mpad 22mIf enabled, 300 kiB of zero bytes will be appended to the d241 1 a241 1 1mrelaxed-filenames0m d244 1 a244 1 1mallow-lowercase 22mis also specified). This violates d248 1 a248 1 1mrockridge0m d261 1 a261 1 1mcompression-level22m=number d265 2 a266 2 1mzisofs 22mSynonym for 1mzisofs=direct22m. 1mzisofs=direct0m d268 1 a268 1 1mzisofs=indirect22m, this is handled entirely within d275 1 a275 1 1mzisofs=indirect0m d277 1 a277 1 the 1mmkzftree 22mutility and sets up the necessary file meta‐ d280 1 a280 1 1mzisofs-exclude22m=4mfilename0m d282 1 a282 1 using 1mzisofs=direct22m. This option can be provided multi‐ d285 1 a285 1 1mcompression0m d290 1 a290 1 1mexperimental0m d294 1 a294 1 1mfakecrc320m d298 1 a298 1 1mhdrcharset0m d300 1 a300 1 1mzip64 22mZip64 extensions provide additional file size information d314 1 a314 1 Disabling this option with 1m!zip64 22mwill force the Zip d323 1 a323 1 1mEXAMPLES0m d326 1 a326 1 ISO9660 archive will use 4mkernel.img24m as the boot image for El Torito boot‐ d336 1 a336 1 1mERRORS0m d338 1 a338 1 1marchive_errno22m() and 1marchive_error_string22m() functions. d340 1 a340 1 1mSEE ALSO0m d343 2 a344 2 1mHISTORY0m The 1mlibarchive 22mlibrary first appeared in FreeBSD 5.3. d346 1 a346 1 1mAUTHORS0m d350 1 a350 1 1mBUGS0m @ 1.2 log @Update for libarchive 3.2.1. @ text @d3 3 a5 3 NAME archive_write_set_filter_option, archive_write_set_format_option, archive_write_set_option, archive_write_set_options — functions control‐ d8 1 a8 1 LIBRARY d11 12 a22 12 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); d24 2 a25 2 int archive_write_set_options(struct archive *, const char *options); d27 1 a27 1 DESCRIPTION d31 1 a31 1 archive_write_set_filter_option(), archive_write_set_format_option() d35 3 a37 3 If option and value are both NULL, these functions will do noth‐ ing and ARCHIVE_OK will be returned. If option is NULL but value is not, these functions will do nothing and ARCHIVE_FAILED will d40 3 a42 3 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 d44 1 a44 1 not be handled. If there is no such module, ARCHIVE_FAILED will d47 4 a50 4 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 d53 4 a56 4 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. Oth‐ d59 3 a61 3 archive_write_set_options() options is a comma-separated list of options. If options is NULL or empty, ARCHIVE_OK will be returned immediately. d64 1 a64 1 option=value d68 1 a68 1 option The option will be provided to every module with a value d70 1 a70 1 !option d73 1 a73 1 module:option=value, module:option, module:!option d75 1 a75 1 provided only to modules whose name matches module. d77 1 a77 1 OPTIONS d79 1 a79 1 compression-level d83 1 a83 1 compression-level d87 3 a89 3 cksum, device, flags, gid, gname, indent, link, md5, mode, nlink, rmd160, sha1, sha256, sha384, sha512, size, time, uid, uname d95 3 a97 3 all Enables all of the above keywords. use-set Enables generation of /set lines that specify default d99 1 a99 1 indent XXX needs explanation XXX d102 1 a102 1 abstract-file=filename d106 1 a106 1 application-id=filename d110 1 a110 1 biblio-file=filename d114 1 a114 1 copyright-file=filename d118 1 a118 1 publisher=filename d122 1 a122 1 volume-id=string d129 1 a129 1 boot=filename d132 1 a132 1 boot-catalog=name d134 3 a136 3 log. Default: boot.catalog boot-info-table The boot image file provided by the boot=filename option d139 1 a139 1 boot-load-seg=hexadecimal-number d141 1 a141 1 boot-load-size=decimal-number d150 1 a150 1 boot-type=value d152 2 a153 2 image: If the value is fd, then the boot image is assumed to be a bootable floppy image. If the value is hd, then d155 1 a155 1 image. If the value is no-emulation, the boot image is d158 1 a158 1 default is fd, otherwise the default is no-emulation. d161 1 a161 1 allow-ldots d168 1 a168 1 allow-lowercase d173 1 a173 1 allow-multidot d180 1 a180 1 allow-period d187 1 a187 1 allow-pvd-lowercase d192 1 a192 1 allow-sharp-tilde d197 1 a197 1 allow-vernum d203 1 a203 1 iso-level d208 1 a208 1 iso-level=1 d214 1 a214 1 iso-level=2 d219 2 a220 2 iso-level=3 As with iso-level=2, except that files may exceed d222 2 a223 2 iso-level=4 As with iso-level=3, except that filenames may be d226 1 a226 1 joliet Microsoft's Joliet extensions store a completely separate d230 1 a230 1 limit-depth d235 1 a235 1 limit-dirs d239 1 a239 1 pad If enabled, 300 kiB of zero bytes will be appended to the d241 1 a241 1 relaxed-filenames d244 1 a244 1 allow-lowercase is also specified). This violates d248 1 a248 1 rockridge d261 1 a261 1 compression-level=number d265 2 a266 2 zisofs Synonym for zisofs=direct. zisofs=direct d268 1 a268 1 zisofs=indirect, this is handled entirely within d275 1 a275 1 zisofs=indirect d277 1 a277 1 the mkzftree utility and sets up the necessary file meta‐ d280 1 a280 1 zisofs-exclude=filename d282 1 a282 1 using zisofs=direct. This option can be provided multi‐ d285 1 a285 1 compression d290 1 a290 1 experimental d294 1 a294 1 fakecrc32 d298 1 a298 1 hdrcharset d300 1 a300 1 zip64 Zip64 extensions provide additional file size information d314 1 a314 1 Disabling this option with !zip64 will force the Zip d323 1 a323 1 EXAMPLES d326 1 a326 1 ISO9660 archive will use kernel.img as the boot image for El Torito boot‐ d336 1 a336 1 ERRORS d338 1 a338 1 archive_errno() and archive_error_string() functions. d340 1 a340 1 SEE ALSO d343 2 a344 2 HISTORY The libarchive library first appeared in FreeBSD 5.3. d346 1 a346 1 AUTHORS d350 1 a350 1 BUGS @ 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 @d6 1 a6 1 ling options for reading archives d41 5 a45 3 filter or reader named module. The return value will be that of the module. If there is no such module, ARCHIVE_FAILED will be returned. d154 1 a154 1 the the boot image is assumed to be a bootable hard disk d284 38 d337 1 a337 1 Detailed error codes and textual descriptions are available from the @ 1.1.1.1 log @Import libarchive-3.2.1: - security fixes and other bugfixes - support for multhreading in xz 5.2+ @ text @d6 1 a6 1 ling options for writing archives d41 3 a43 5 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. d152 1 a152 1 the boot image is assumed to be a bootable hard disk a281 38 Format 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 imple‐ mentations. 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 selec‐ tively enables these extensions only as needed. In par‐ ticular, 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 oth‐ erwise require them. This is primarily useful for test‐ ing. 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. d297 1 a297 1 More detailed error codes and textual descriptions are available from the @ 1.1.1.2 log @Import libarchive-3.3.1. @ text @d3 3 a5 3 1mNAME0m 1marchive_write_set_filter_option22m, 1marchive_write_set_format_option22m, 1marchive_write_set_option22m, 1marchive_write_set_options 22m— functions control‐ d8 1 a8 1 1mLIBRARY0m d11 12 a22 12 1mSYNOPSIS0m 4mint0m 1marchive_write_set_filter_option22m(4mstruct24m 4marchive24m 4m*24m, 4mconst24m 4mchar24m 4m*module24m, 4mconst24m 4mchar24m 4m*option24m, 4mconst24m 4mchar24m 4m*value24m); 4mint0m 1marchive_write_set_format_option22m(4mstruct24m 4marchive24m 4m*24m, 4mconst24m 4mchar24m 4m*module24m, 4mconst24m 4mchar24m 4m*option24m, 4mconst24m 4mchar24m 4m*value24m); 4mint0m 1marchive_write_set_option22m(4mstruct24m 4marchive24m 4m*24m, 4mconst24m 4mchar24m 4m*module24m, 4mconst24m 4mchar24m 4m*option24m, 4mconst24m 4mchar24m 4m*value24m); d24 2 a25 2 4mint0m 1marchive_write_set_options22m(4mstruct24m 4marchive24m 4m*24m, 4mconst24m 4mchar24m 4m*options24m); d27 1 a27 1 1mDESCRIPTION0m d31 1 a31 1 1marchive_write_set_filter_option22m(), 1marchive_write_set_format_option22m() d35 3 a37 3 If 4moption24m and 4mvalue24m are both NULL, these functions will do noth‐ ing and 1mARCHIVE_OK 22mwill be returned. If 4moption24m is NULL but 4mvalue0m is not, these functions will do nothing and 1mARCHIVE_FAILED 22mwill d40 3 a42 3 If 4mmodule24m is not NULL, 4moption24m and 4mvalue24m will be provided to the filter or reader named 4mmodule24m. The return value will be either 1mARCHIVE_OK 22mif the option was successfully handled or 1mARCHIVE_WARN0m d44 1 a44 1 not be handled. If there is no such module, 1mARCHIVE_FAILED 22mwill d47 4 a50 4 If 4mmodule24m is NULL, 4moption24m and 4mvalue24m will be provided to every registered module. If any module returns 1mARCHIVE_FATAL22m, this value will be returned immediately. Otherwise, 1mARCHIVE_OK 22mwill be returned if any module accepts the option, and 1mARCHIVE_FAILED0m d53 4 a56 4 1marchive_write_set_option22m() Calls 1marchive_write_set_format_option22m(), then 1marchive_write_set_filter_option22m(). If either function returns 1mARCHIVE_FATAL22m, 1mARCHIVE_FATAL 22mwill be returned immediately. Oth‐ d59 3 a61 3 1marchive_write_set_options22m() 4moptions24m is a comma-separated list of options. If 4moptions24m is NULL or empty, 1mARCHIVE_OK 22mwill be returned immediately. d64 1 a64 1 4moption=value0m d68 1 a68 1 4moption24m The option will be provided to every module with a value d70 1 a70 1 4m!option0m d73 1 a73 1 4mmodule:option=value24m, 4mmodule:option24m, 4mmodule:!option0m d75 1 a75 1 provided only to modules whose name matches 4mmodule24m. d77 1 a77 1 1mOPTIONS0m d79 1 a79 1 1mcompression-level0m d83 1 a83 1 1mcompression-level0m d87 3 a89 3 1mcksum22m, 1mdevice22m, 1mflags22m, 1mgid22m, 1mgname22m, 1mindent22m, 1mlink22m, 1mmd522m, 1mmode22m, 1mnlink22m, 1mrmd16022m, 1msha122m, 1msha25622m, 1msha38422m, 1msha51222m, 1msize22m, 1mtime22m, 1muid22m, 1muname0m d95 3 a97 3 1mall 22mEnables all of the above keywords. 1muse-set0m Enables generation of 1m/set 22mlines that specify default d99 1 a99 1 1mindent 22mXXX needs explanation XXX d102 1 a102 1 1mabstract-file22m=4mfilename0m d106 1 a106 1 1mapplication-id22m=4mfilename0m d110 1 a110 1 1mbiblio-file22m=4mfilename0m d114 1 a114 1 1mcopyright-file22m=4mfilename0m d118 1 a118 1 1mpublisher22m=4mfilename0m d122 1 a122 1 1mvolume-id22m=4mstring0m d129 1 a129 1 1mboot22m=4mfilename0m d132 1 a132 1 1mboot-catalog22m=4mname0m d134 3 a136 3 log. Default: 4mboot.catalog0m 1mboot-info-table0m The boot image file provided by the 1mboot22m=4mfilename24m option d139 1 a139 1 1mboot-load-seg22m=4mhexadecimal-number0m d141 1 a141 1 1mboot-load-size22m=4mdecimal-number0m d150 1 a150 1 1mboot-type22m=4mvalue0m d152 2 a153 2 image: If the 4mvalue24m is 1mfd22m, then the boot image is assumed to be a bootable floppy image. If the 4mvalue24m is 1mhd22m, then d155 1 a155 1 image. If the 4mvalue24m is 1mno-emulation22m, the boot image is d158 1 a158 1 default is 1mfd22m, otherwise the default is 1mno-emulation.0m d161 1 a161 1 1mallow-ldots0m d168 1 a168 1 1mallow-lowercase0m d173 1 a173 1 1mallow-multidot0m d180 1 a180 1 1mallow-period0m d187 1 a187 1 1mallow-pvd-lowercase0m d192 1 a192 1 1mallow-sharp-tilde0m d197 1 a197 1 1mallow-vernum0m d203 1 a203 1 1miso-level0m d208 1 a208 1 1miso-level=10m d214 1 a214 1 1miso-level=20m d219 2 a220 2 1miso-level=30m As with 1miso-level=222m, except that files may exceed d222 2 a223 2 1miso-level=40m As with 1miso-level=322m, except that filenames may be d226 1 a226 1 1mjoliet 22mMicrosoft's Joliet extensions store a completely separate d230 1 a230 1 1mlimit-depth0m d235 1 a235 1 1mlimit-dirs0m d239 1 a239 1 1mpad 22mIf enabled, 300 kiB of zero bytes will be appended to the d241 1 a241 1 1mrelaxed-filenames0m d244 1 a244 1 1mallow-lowercase 22mis also specified). This violates d248 1 a248 1 1mrockridge0m d261 1 a261 1 1mcompression-level22m=number d265 2 a266 2 1mzisofs 22mSynonym for 1mzisofs=direct22m. 1mzisofs=direct0m d268 1 a268 1 1mzisofs=indirect22m, this is handled entirely within d275 1 a275 1 1mzisofs=indirect0m d277 1 a277 1 the 1mmkzftree 22mutility and sets up the necessary file meta‐ d280 1 a280 1 1mzisofs-exclude22m=4mfilename0m d282 1 a282 1 using 1mzisofs=direct22m. This option can be provided multi‐ d285 1 a285 1 1mcompression0m d290 1 a290 1 1mexperimental0m d294 1 a294 1 1mfakecrc320m d298 1 a298 1 1mhdrcharset0m d300 1 a300 1 1mzip64 22mZip64 extensions provide additional file size information d314 1 a314 1 Disabling this option with 1m!zip64 22mwill force the Zip d323 1 a323 1 1mEXAMPLES0m d326 1 a326 1 ISO9660 archive will use 4mkernel.img24m as the boot image for El Torito boot‐ d336 1 a336 1 1mERRORS0m d338 1 a338 1 1marchive_errno22m() and 1marchive_error_string22m() functions. d340 1 a340 1 1mSEE ALSO0m d343 2 a344 2 1mHISTORY0m The 1mlibarchive 22mlibrary first appeared in FreeBSD 5.3. d346 1 a346 1 1mAUTHORS0m d350 1 a350 1 1mBUGS0m @ 1.1.1.3 log @Import libarchive-3.3.2 + 9de5f3 + f9dacbf: - Support NFS4 ACLs on Linux - Bugfixes @ text @d3 3 a5 3 NAME archive_write_set_filter_option, archive_write_set_format_option, archive_write_set_option, archive_write_set_options — functions control‐ d8 1 a8 1 LIBRARY d11 12 a22 12 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); d24 2 a25 2 int archive_write_set_options(struct archive *, const char *options); d27 1 a27 1 DESCRIPTION d31 1 a31 1 archive_write_set_filter_option(), archive_write_set_format_option() d35 3 a37 3 If option and value are both NULL, these functions will do noth‐ ing and ARCHIVE_OK will be returned. If option is NULL but value is not, these functions will do nothing and ARCHIVE_FAILED will d40 3 a42 3 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 d44 1 a44 1 not be handled. If there is no such module, ARCHIVE_FAILED will d47 4 a50 4 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 d53 4 a56 4 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. Oth‐ d59 3 a61 3 archive_write_set_options() options is a comma-separated list of options. If options is NULL or empty, ARCHIVE_OK will be returned immediately. d64 1 a64 1 option=value d68 1 a68 1 option The option will be provided to every module with a value d70 1 a70 1 !option d73 1 a73 1 module:option=value, module:option, module:!option d75 1 a75 1 provided only to modules whose name matches module. d77 1 a77 1 OPTIONS d79 1 a79 1 compression-level d83 1 a83 1 compression-level d87 3 a89 3 cksum, device, flags, gid, gname, indent, link, md5, mode, nlink, rmd160, sha1, sha256, sha384, sha512, size, time, uid, uname d95 3 a97 3 all Enables all of the above keywords. use-set Enables generation of /set lines that specify default d99 1 a99 1 indent XXX needs explanation XXX d102 1 a102 1 abstract-file=filename d106 1 a106 1 application-id=filename d110 1 a110 1 biblio-file=filename d114 1 a114 1 copyright-file=filename d118 1 a118 1 publisher=filename d122 1 a122 1 volume-id=string d129 1 a129 1 boot=filename d132 1 a132 1 boot-catalog=name d134 3 a136 3 log. Default: boot.catalog boot-info-table The boot image file provided by the boot=filename option d139 1 a139 1 boot-load-seg=hexadecimal-number d141 1 a141 1 boot-load-size=decimal-number d150 1 a150 1 boot-type=value d152 2 a153 2 image: If the value is fd, then the boot image is assumed to be a bootable floppy image. If the value is hd, then d155 1 a155 1 image. If the value is no-emulation, the boot image is d158 1 a158 1 default is fd, otherwise the default is no-emulation. d161 1 a161 1 allow-ldots d168 1 a168 1 allow-lowercase d173 1 a173 1 allow-multidot d180 1 a180 1 allow-period d187 1 a187 1 allow-pvd-lowercase d192 1 a192 1 allow-sharp-tilde d197 1 a197 1 allow-vernum d203 1 a203 1 iso-level d208 1 a208 1 iso-level=1 d214 1 a214 1 iso-level=2 d219 2 a220 2 iso-level=3 As with iso-level=2, except that files may exceed d222 2 a223 2 iso-level=4 As with iso-level=3, except that filenames may be d226 1 a226 1 joliet Microsoft's Joliet extensions store a completely separate d230 1 a230 1 limit-depth d235 1 a235 1 limit-dirs d239 1 a239 1 pad If enabled, 300 kiB of zero bytes will be appended to the d241 1 a241 1 relaxed-filenames d244 1 a244 1 allow-lowercase is also specified). This violates d248 1 a248 1 rockridge d261 1 a261 1 compression-level=number d265 2 a266 2 zisofs Synonym for zisofs=direct. zisofs=direct d268 1 a268 1 zisofs=indirect, this is handled entirely within d275 1 a275 1 zisofs=indirect d277 1 a277 1 the mkzftree utility and sets up the necessary file meta‐ d280 1 a280 1 zisofs-exclude=filename d282 1 a282 1 using zisofs=direct. This option can be provided multi‐ d285 1 a285 1 compression d290 1 a290 1 experimental d294 1 a294 1 fakecrc32 d298 1 a298 1 hdrcharset d300 1 a300 1 zip64 Zip64 extensions provide additional file size information d314 1 a314 1 Disabling this option with !zip64 will force the Zip d323 1 a323 1 EXAMPLES d326 1 a326 1 ISO9660 archive will use kernel.img as the boot image for El Torito boot‐ d336 1 a336 1 ERRORS d338 1 a338 1 archive_errno() and archive_error_string() functions. d340 1 a340 1 SEE ALSO d343 2 a344 2 HISTORY The libarchive library first appeared in FreeBSD 5.3. d346 1 a346 1 AUTHORS d350 1 a350 1 BUGS @ 1.1.1.4 log @Import libarchive 3.4.0 @ text @d127 2 a128 2 These options are used to make an ISO9660 image that can be di‐ rectly booted on various systems. d154 2 a155 2 the boot image is assumed to be a bootable hard disk im‐ age. If the value is no-emulation, the boot image is d157 2 a158 2 image is exactly 1.2MB, 1.44MB, or 2.88MB, then the de‐ fault is fd, otherwise the default is no-emulation. d162 2 a163 2 If enabled, allows filenames to begin with a leading pe‐ riod. If disabled, filenames that begin with a leading d176 2 a177 2 If disabled, additional periods will be converted to un‐ derscore characters. This does not impact names stored d263 2 a264 2 Ranges from 0 (least effort) to 9 (most effort). De‐ fault: 6 d301 3 a303 3 for entries larger than 4 GiB. They also provide ex‐ tended file offset and archive size information when ar‐ chives exceed 4 GiB. By default, the Zip writer selec‐ d316 2 a317 2 with size greater than 4 GiB, it will reject any new en‐ tries once the total archive size reaches 4 GiB, and it @ 1.1.1.5 log @Import libarchive 3.7.2 @ text @d32 2 a33 3 Specifies an option that will be passed to the currently-regis‐ tered filters (including decompression filters) or format read‐ ers. d48 1 a48 1 registered module. If any module returns ARCHIVE_FATAL, this d55 3 a57 3 archive_write_set_filter_option(). If either function returns ARCHIVE_FATAL, ARCHIVE_FATAL will be returned immediately. Oth‐ erwise, the greater of the two values will be returned. a77 9 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. d81 1 a81 39 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. d85 15 a99 40 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 compres‐ sion. 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 li‐ brary 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 compres‐ sion. If set to 0, zstd will attempt to detect and use the number of physical CPU cores. Format 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 en‐ tries. compression-level The value is interpreted as a decimal integer specifying the compression level. Values between 0 and 9 are sup‐ ported. The interpretation of the compression level de‐ pends 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. d167 1 a167 1 sion area. Default: disabled. d178 1 a178 1 in the Rockridge or Joliet extension area. Default: dis‐ d183 1 a183 1 If disabled, trailing periods will be converted to under‐ d229 1 a229 1 to 255 characters. Default: enabled. d245 1 a245 1 ISO9660 standards. This does not impact names stored in d267 1 a267 1 Compress each file in the archive. Unlike a283 63 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 con‐ verted 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 writ‐ ten. 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). a289 13 compression-level The value is interpreted as a decimal integer specifying the compression level. Values between 0 and 9 are sup‐ ported. A compression level of 0 switches the compres‐ sion 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). d299 1 a299 2 The value is used as a character set name that will be used when translating file names. d341 1 a341 1 tar(1), archive_read_set_options(3), archive_write(3), libarchive(3) d351 1 a351 1 BSD January 31, 2020 BSD @ 1.1.1.6 log @libarchive: import version 3.7.3 @ text @d155 3 a157 4 The value is one of “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 d163 2 a164 3 ported, with the exception of bzip2 which only supports values between 1 and 9. The interpretation of the com‐ pression level depends on the chosen compression method. @ 1.1.1.7 log @libarchove: import version 3.7.7 @ text @d1 1 a1 1 4mARCHIVE_WRITE_OPTIONS24m(3) Library Functions Manual 4mARCHIVE_WRITE_OPTIONS24m(3) d3 498 a500 502 1mNAME0m archive_write_set_filter_option, archive_write_set_format_option, archive_write_set_option, archive_write_set_options — functions con‐ trolling options for writing archives 1mLIBRARY0m Streaming Archive Library (libarchive, -larchive) 1mSYNOPSIS0m 4mint0m 1marchive_write_set_filter_option22m(4mstruct24m 4marchive24m 4m*24m, 4mconst24m 4mchar24m 4m*module24m, 4mconst24m 4mchar24m 4m*option24m, 4mconst24m 4mchar24m 4m*value24m); 4mint0m 1marchive_write_set_format_option22m(4mstruct24m 4marchive24m 4m*24m, 4mconst24m 4mchar24m 4m*module24m, 4mconst24m 4mchar24m 4m*option24m, 4mconst24m 4mchar24m 4m*value24m); 4mint0m 1marchive_write_set_option22m(4mstruct24m 4marchive24m 4m*24m, 4mconst24m 4mchar24m 4m*module24m, 4mconst24m 4mchar24m 4m*option24m, 4mconst24m 4mchar24m 4m*value24m); 4mint0m 1marchive_write_set_options22m(4mstruct24m 4marchive24m 4m*24m, 4mconst24m 4mchar24m 4m*options24m); 1mDESCRIPTION0m These functions provide a way for libarchive clients to configure spe‐ cific write modules. 1marchive_write_set_filter_option22m(), 1marchive_write_set_format_option22m() Specifies an option that will be passed to the currently-regis‐ tered filters (including decompression filters) or format read‐ ers. If 4moption24m and 4mvalue24m are both NULL, these functions will do nothing and 1mARCHIVE_OK 22mwill be returned. If 4moption24m is NULL but 4mvalue24m is not, these functions will do nothing and 1mARCHIVE_FAILED 22mwill be returned. If 4mmodule24m is not NULL, 4moption24m and 4mvalue24m will be provided to the filter or reader named 4mmodule24m. The return value will be either 1mARCHIVE_OK 22mif the option was successfully handled or 1mARCHIVE_WARN 22mif the option was unrecognized by the module or could otherwise not be handled. If there is no such module, 1mARCHIVE_FAILED 22mwill be returned. If 4mmodule24m is NULL, 4moption24m and 4mvalue24m will be provided to every registered module. If any module returns 1mARCHIVE_FATAL22m, this value will be returned immediately. Otherwise, 1mARCHIVE_OK 22mwill be returned if any module accepts the option, and 1mARCHIVE_FAILED 22min all other cases. 1marchive_write_set_option22m() Calls 1marchive_write_set_format_option22m(), then 1marchive_write_set_filter_option22m(). If either function returns 1mARCHIVE_FATAL22m, 1mARCHIVE_FATAL 22mwill be returned immediately. Otherwise, the greater of the two values will be returned. 1marchive_write_set_options22m() 4moptions24m is a comma-separated list of options. If 4moptions24m is NULL or empty, 1mARCHIVE_OK 22mwill be returned immediately. Individual options have one of the following forms: 4moption=value0m The option/value pair will be provided to every module. Modules that do not accept an option with this name will ignore it. 4moption24m The option will be provided to every module with a value of “1”. 4m!option0m The option will be provided to every module with a NULL value. 4mmodule:option=value24m, 4mmodule:option24m, 4mmodule:!option0m As above, but the corresponding option and value will be provided only to modules whose name matches 4mmodule24m. 1mOPTIONS0m Filter b64encode 1mmode 22mThe value is interpreted as octal digits specifying the file mode. 1mname 22mThe value specifies the file name. Filter bzip2 1mcompression-level0m The value is interpreted as a decimal integer specify‐ ing the bzip2 compression level. Supported values are from 1 to 9. Filter gzip 1mcompression-level0m The value is interpreted as a decimal integer specify‐ ing the gzip compression level. Supported values are from 0 to 9. 1mtimestamp0m Store timestamp. This is enabled by default. Filter lrzip 1mcompression22m=4mtype0m Use 4mtype24m as compression method. Supported values are “bzip2”, “gzipi”, “lzo” (ultra fast), and “zpaq” (best, extremely slow). 1mcompression-level0m The value is interpreted as a decimal integer specify‐ ing the lrzip compression level. Supported values are from 1 to 9. Filter lz4 1mcompression-level0m The value is interpreted as a decimal integer specify‐ ing the lz4 compression level. Supported values are from 0 to 9. 1mstream-checksum0m Enable stream checksum. This is enabled by default. 1mblock-checksum0m Enable block checksum. This is disabled by default. 1mblock-size0m The value is interpreted as a decimal integer specify‐ ing the lz4 compression block size. Supported values are from 4 to 7 (default). 1mblock-dependence0m Use the previous block of the block being compressed for a compression dictionary to improve compression ra‐ tio. This is disabled by default. Filter lzop 1mcompression-level0m The value is interpreted as a decimal integer specify‐ ing the lzop compression level. Supported values are from 1 to 9. Filter uuencode 1mmode 22mThe value is interpreted as octal digits specifying the file mode. 1mname 22mThe value specifies the file name. Filter xz 1mcompression-level0m The value is interpreted as a decimal integer specify‐ ing the compression level. Supported values are from 0 to 9. 1mthreads0m The value is interpreted as a decimal integer specify‐ ing the number of threads for multi-threaded lzma com‐ pression. If supported, the default value is read from 1mlzma_cputhreads22m(). Filter zstd 1mcompression-level0m The value is interpreted as a decimal integer specify‐ ing the compression level. Supported values depend on the library version, common values are from 1 to 22. 1mlong 22mEnables long distance matching. The value is inter‐ preted 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. 1mthreads0m The value is interpreted as a decimal integer specify‐ ing the number of threads for multi-threaded zstd com‐ pression. If set to 0, zstd will attempt to detect and use the number of physical CPU cores. Format 7zip 1mcompression0m The value is one of “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 set‐ ting is ignored for directories, symbolic links, and other special entries. 1mcompression-level0m The value is interpreted as a decimal integer specify‐ ing the compression level. Values between 0 and 9 are supported, with the exception of bzip2 which only sup‐ ports values between 1 and 9. The interpretation of the compression level depends on the chosen compression method. Format bin 1mhdrcharset0m The value is used as a character set name that will be used when translating file names. Format gnutar 1mhdrcharset0m 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. 1mabstract-file22m=4mfilename0m The file with the specified name will be identified in the ISO9660 metadata as holding the abstract for this volume. Default: none. 1mapplication-id22m=4mfilename0m The file with the specified name will be identified in the ISO9660 metadata as holding the application identi‐ fier for this volume. Default: none. 1mbiblio-file22m=4mfilename0m The file with the specified name will be identified in the ISO9660 metadata as holding the bibliography for this volume. Default: none. 1mcopyright-file22m=4mfilename0m The file with the specified name will be identified in the ISO9660 metadata as holding the copyright for this volume. Default: none. 1mpublisher22m=4mfilename0m The file with the specified name will be identified in the ISO9660 metadata as holding the publisher informa‐ tion for this volume. Default: none. 1mvolume-id22m=4mstring0m The specified string will be used as the Volume Identi‐ fier 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 di‐ rectly booted on various systems. 1mboot22m=4mfilename0m The file matching this name will be used as the El Torito boot image file. 1mboot-catalog22m=4mname0m The name that will be used for the El Torito boot cata‐ log. Default: 4mboot.catalog0m 1mboot-info-table0m The boot image file provided by the 1mboot22m=4mfilename24m op‐ tion will be edited with appropriate boot information in bytes 8 through 64. Default: disabled 1mboot-load-seg22m=4mhexadecimal-number0m The load segment for a no-emulation boot image. 1mboot-load-size22m=4mdecimal-number0m 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 intelli‐ gent 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. 1mboot-type22m=4mvalue0m Specifies the boot semantics used by the El Torito boot image: If the 4mvalue24m is 1mfd22m, then the boot image is as‐ sumed to be a bootable floppy image. If the 4mvalue24m is 1mhd22m, then the boot image is assumed to be a bootable hard disk image. If the 4mvalue24m is 1mno-emulation22m, the boot image is used without floppy or hard disk emula‐ tion. If the boot image is exactly 1.2MB, 1.44MB, or 2.88MB, then the default is 1mfd22m, otherwise the default is 1mno-emulation22m. Format iso9660 - filename and size extensions Various extensions to the base ISO9660 format. 1mallow-ldots0m If enabled, allows filenames to begin with a leading period. If disabled, filenames that begin with a lead‐ ing period will have that period replaced by an under‐ score character in the standard ISO9660 namespace. This does not impact names stored in the Rockridge or Joliet extension area. Default: disabled. 1mallow-lowercase0m If enabled, allows filenames to contain lowercase char‐ acters. If disabled, filenames will be forced to up‐ percase. This does not impact names stored in the Rockridge or Joliet extension area. Default: disabled. 1mallow-multidot0m 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. De‐ fault: disabled. 1mallow-period0m If enabled, allows filenames to contain trailing period characters, in violation of the ISO9660 specification. If disabled, trailing periods will be converted to un‐ derscore characters. This does not impact names stored in the Rockridge or Joliet extension area. Default: disabled. 1mallow-pvd-lowercase0m If enabled, the Primary Volume Descriptor may contain lowercase ASCII characters, in violation of the ISO9660 specification. If disabled, characters will be con‐ verted to uppercase ASCII. Default: disabled. 1mallow-sharp-tilde0m If enabled, sharp and tilde characters will be permit‐ ted in filenames, in violation if the ISO9660 specifi‐ cation. If disabled, such characters will be converted to underscore characters. Default: disabled. 1mallow-vernum0m If enabled, version numbers will be included with files. If disabled, version numbers will be sup‐ pressed, in violation of the ISO9660 standard. This does not impact names stored in the Rockridge or Joliet extension area. Default: enabled. 1miso-level0m This enables support for file size and file name exten‐ sions in the core ISO9660 area. The name extensions specified here do not affect the names stored in the Rockridge or Joliet extension areas. 1miso-level=10m 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. 1miso-level=20m Filenames are limited to 30 uppercase charac‐ ters with a 30-character extension, directory names are limited to 30 characters, files are limited to 4 GiB. 1miso-level=30m As with 1miso-level=222m, except that files may ex‐ ceed 4 GiB. 1miso-level=40m As with 1miso-level=322m, except that filenames may be up to 193 characters and may include arbi‐ trary 8-bit characters. 1mjoliet 22mMicrosoft's Joliet extensions store a completely sepa‐ rate set of directory information about each file. In particular, this information includes Unicode filenames of up to 255 characters. Default: enabled. 1mlimit-depth0m If enabled, libarchive will use directory relocation records to ensure that no pathname exceeds the ISO9660 limit of 8 directory levels. If disabled, no reloca‐ tion will occur. Default: enabled. 1mlimit-dirs0m 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 1mpad 22mIf enabled, 300 kiB of zero bytes will be appended to the end of the archive. Default: enabled 1mrelaxed-filenames0m If enabled, all 7-bit ASCII characters are permitted in filenames (except lowercase characters unless 1mallow-lowercase 22mis also specified). This violates ISO9660 standards. This does not impact names stored in the Rockridge or Joliet extension area. Default: disabled. 1mrockridge0m 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. De‐ fault: enabled. Format iso9660 - zisofs support The zisofs extensions permit each file to be independently com‐ pressed 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 dis‐ abled by default. 1mcompression-level22m=number The compression level used by the deflate compressor. Ranges from 0 (least effort) to 9 (most effort). De‐ fault: 6 1mzisofs 22mSynonym for 1mzisofs=direct22m. 1mzisofs=direct0m Compress each file in the archive. Unlike 1mzisofs=indirect22m, 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. 1mzisofs=indirect0m Recognizes files that have already been compressed with the 1mmkzftree 22mutility and sets up the necessary file metadata so that readers will correctly identify these as zisofs-compressed files. 1mzisofs-exclude22m=4mfilename0m Specifies a filename that should not be compressed when using 1mzisofs=direct22m. This option can be provided mul‐ tiple times to suppress compression on many files. Format mtree 1mcksum22m, 1mdevice22m, 1mflags22m, 1mgid22m, 1mgname22m, 1mindent22m, 1mlink22m, 1mmd522m, 1mmode22m, 1mnlink22m, 1mrmd16022m, 1msha122m, 1msha25622m, 1msha38422m, 1msha51222m, 1msize22m, 1mtime22m, 1muid22m, 1muname0m Enable a particular keyword in the mtree output. Pre‐ fix with an exclamation mark to disable the correspond‐ ing keyword. The default is equivalent to “device, flags, gid, gname, link, mode, nlink, size, time, type, uid, uname”. 1mall 22mEnables all of the above keywords. 1muse-set0m Enables generation of 1m/set 22mlines that specify default values for the following files and/or directories. 1mindent 22mXXX needs explanation XXX Format newc 1mhdrcharset0m The value is used as a character set name that will be used when translating file names. Format odc 1mhdrcharset0m The value is used as a character set name that will be used when translating file names. Format pwb 1mhdrcharset0m The value is used as a character set name that will be used when translating file names. Format pax 1mhdrcharset0m 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. 1mxattrheader0m When storing extended attributes, this option config‐ ures which headers should be written. The value is one of “all”, “LIBARCHIVE”, or “SCHILY”. By default, both “LIBARCHIVE.xattr” and “SCHILY.xattr” headers are writ‐ ten. Format ustar 1mhdrcharset0m The value is used as a character set name that will be used when translating file, group and user names. Format v7tar 1mhdrcharset0m The value is used as a character set name that will be used when translating file, group and user names. Format warc 1momit-warcinfo0m Set to “true” to disable output of the warcinfo record. Format xar 1mchecksum22m=4mtype0m Use 4mtype24m as file checksum method. Supported values are “none”, “md5”, and “sha1” (default). 1mcompression22m=4mtype0m Use 4mtype24m as compression method. Supported values are “none”, “bzip2”, “gzip” (default), “lzma” and “xz”. 1mcompression_level0m The value is a decimal integer from 1 to 9 specifying the compression level. 1mtoc-checksum22m=4mtype0m Use 4mtype24m as table of contents checksum method. Sup‐ ported values are “none”, “md5” and “sha1” (default). Format zip 1mcompression0m 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. 1mcompression-level0m The value is interpreted as a decimal integer specify‐ ing the compression level. Values between 0 and 9 are supported. A compression level of 0 switches the com‐ pression method to “store”, other values will enable “deflate” compression with the given level. 1mencryption0m Enable encryption using traditional zip encryption. 1mencryption22m=4mtype0m Use 4mtype24m as encryption type. Supported values are “zipcrypt” (traditional zip encryption), “aes128” (WinZip AES-128 encryption) and “aes256” (WinZip AES-256 encryption). 1mexperimental0m This boolean option enables or disables experimental Zip features that may not be compatible with other Zip implementations. 1mfakecrc320m This boolean option disables CRC calculations. All CRC fields are set to zero. It should not be used except for testing purposes. 1mhdrcharset0m The value is used as a character set name that will be used when translating file names. 1mzip64 22mZip64 extensions provide additional file size informa‐ tion 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 se‐ lectively 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 pos‐ sibility 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 1m!zip64 22mwill 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. 1mEXAMPLES0m 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 4mkernel.img24m as the boot image for El Torito booting, and that the gzip compressor should use the maximum compres‐ sion 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); 1mERRORS0m More detailed error codes and textual descriptions are available from the 1marchive_errno22m() and 1marchive_error_string22m() functions. 1mSEE ALSO0m 4mtar24m(1), 4marchive_read_set_options24m(3), 4marchive_write24m(3), 4mlibarchive24m(3) 1mHISTORY0m The 1mlibarchive 22mlibrary first appeared in FreeBSD 5.3. 1mAUTHORS0m The options support for libarchive was originally implemented by Michihiro NAKAJIMA. d502 2 a503 2 1mBUGS0m Debian January 31, 2020 4mARCHIVE_WRITE_OPTIONS24m(3) @ 1.1.1.8 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 @d153 1 a153 1 use the number of active physical CPU cores. d157 5 a161 5 “bzip2”, “lzma1”, “lzma2”, “ppmd”, or “zstd” to indi‐ cate 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. d163 6 a168 14 The value is interpreted as a decimal integer specify‐ ing the compression level. Values between 0 and 9 are supported, with the exception of bzip2 which only sup‐ ports values between 1 and 9, and zstd which may sup‐ port negative values depending on the library version and commonly used values 1 through 22. The interpreta‐ tion of the compression level depends on the chosen compression method. 1mthreads0m The value is interpreted as a decimal integer specify‐ ing the number of threads for multi-threaded compres‐ sion (for compressors like zstd that support it). If set to 0, an attempt will be made to discover the num‐ ber of CPU cores. d171 1 a171 1 The value is used as a character set name that will be d175 1 a175 1 The value is used as a character set name that will be d180 2 a181 2 The file with the specified name will be identified in the ISO9660 metadata as holding the abstract for this d184 1 a184 1 The file with the specified name will be identified in d188 2 a189 2 The file with the specified name will be identified in the ISO9660 metadata as holding the bibliography for d192 2 a193 2 The file with the specified name will be identified in the ISO9660 metadata as holding the copyright for this d196 2 a197 2 The file with the specified name will be identified in the ISO9660 metadata as holding the publisher informa‐ d201 1 a201 1 fier in the ISO9660 metadata. It is limited to 32 d207 1 a207 1 The file matching this name will be used as the El d213 2 a214 2 The boot image file provided by the 1mboot22m=4mfilename24m op‐ tion will be edited with appropriate boot information d219 8 a226 8 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 intelli‐ gent 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 d230 7 a236 7 image: If the 4mvalue24m is 1mfd22m, then the boot image is as‐ sumed to be a bootable floppy image. If the 4mvalue24m is 1mhd22m, then the boot image is assumed to be a bootable hard disk image. If the 4mvalue24m is 1mno-emulation22m, the boot image is used without floppy or hard disk emula‐ tion. If the boot image is exactly 1.2MB, 1.44MB, or 2.88MB, then the default is 1mfd22m, otherwise the default d241 1 a241 1 If enabled, allows filenames to begin with a leading d243 3 a245 3 ing period will have that period replaced by an under‐ score character in the standard ISO9660 namespace. This does not impact names stored in the Rockridge or d249 2 a250 2 acters. If disabled, filenames will be forced to up‐ percase. This does not impact names stored in the d254 4 a257 4 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. De‐ d261 2 a262 2 characters, in violation of the ISO9660 specification. If disabled, trailing periods will be converted to un‐ d264 1 a264 1 in the Rockridge or Joliet extension area. Default: d267 1 a267 1 If enabled, the Primary Volume Descriptor may contain d269 1 a269 1 specification. If disabled, characters will be con‐ d272 2 a273 2 If enabled, sharp and tilde characters will be permit‐ ted in filenames, in violation if the ISO9660 specifi‐ d277 3 a279 3 If enabled, version numbers will be included with files. If disabled, version numbers will be sup‐ pressed, in violation of the ISO9660 standard. This d284 2 a285 2 sions in the core ISO9660 area. The name extensions specified here do not affect the names stored in the d289 3 a291 3 Filenames are limited to 8.3 uppercase format, directory names are limited to 8 uppercase characters, files are limited to 4 GiB, the d294 3 a296 3 Filenames are limited to 30 uppercase charac‐ ters with a 30-character extension, directory names are limited to 30 characters, files are d299 1 a299 1 As with 1miso-level=222m, except that files may ex‐ d302 2 a303 2 As with 1miso-level=322m, except that filenames may be up to 193 characters and may include arbi‐ d305 2 a306 2 1mjoliet 22mMicrosoft's Joliet extensions store a completely sepa‐ rate set of directory information about each file. In d310 3 a312 3 If enabled, libarchive will use directory relocation records to ensure that no pathname exceeds the ISO9660 limit of 8 directory levels. If disabled, no reloca‐ d316 1 a316 1 more than 65536 directories. If disabled, there is no d318 1 a318 1 1mpad 22mIf enabled, 300 kiB of zero bytes will be appended to d322 1 a322 1 filenames (except lowercase characters unless d324 2 a325 2 ISO9660 standards. This does not impact names stored in the Rockridge or Joliet extension area. Default: d328 3 a330 3 The Rockridge extensions store an additional set of POSIX-style file information with each file, including mtime, atime, ctime, permissions, and long filenames d336 3 a338 3 pressed 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 dis‐ d341 2 a342 2 The compression level used by the deflate compressor. Ranges from 0 (least effort) to 9 (most effort). De‐ d346 4 a349 4 Compress each file in the archive. Unlike 1mzisofs=indirect22m, this is handled entirely within libarchive and does not require a separate utility. For best results, libarchive tests each file and will d352 1 a352 1 will never be compressed. Note that boot image files d356 2 a357 2 the 1mmkzftree 22mutility and sets up the necessary file metadata so that readers will correctly identify these d361 1 a361 1 using 1mzisofs=direct22m. This option can be provided mul‐ d364 2 a365 2 1mcksum22m, 1mdevice22m, 1mflags22m, 1mgid22m, 1mgname22m, 1mindent22m, 1mlink22m, 1mmd522m, 1mmode22m, 1mnlink22m, 1mrmd16022m, 1msha122m, 1msha25622m, 1msha38422m, 1msha51222m, 1msize22m, d367 1 a367 1 Enable a particular keyword in the mtree output. Pre‐ d369 1 a369 1 ing keyword. The default is equivalent to “device, d374 1 a374 1 Enables generation of 1m/set 22mlines that specify default d379 1 a379 1 The value is used as a character set name that will be d383 1 a383 1 The value is used as a character set name that will be d387 1 a387 1 The value is used as a character set name that will be d391 4 a394 4 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 d397 3 a399 3 When storing extended attributes, this option config‐ ures which headers should be written. The value is one of “all”, “LIBARCHIVE”, or “SCHILY”. By default, both d404 1 a404 1 The value is used as a character set name that will be d408 1 a408 1 The value is used as a character set name that will be d418 1 a418 1 Use 4mtype24m as compression method. Supported values are d421 1 a421 1 The value is a decimal integer from 1 to 9 specifying d424 1 a424 1 Use 4mtype24m as table of contents checksum method. Sup‐ d428 4 a431 5 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. d437 1 a437 10 “deflate”, “bzip2”, “lzma”, or “zstd” compression (in order of priority, depending on what libraries are linked) with the given level. 1mthreads0m The value is interpreted as a decimal integer specify‐ ing 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 spe‐ cial one requesting to detect and use as many threads as the number of active physical CPU cores. d441 3 a443 3 Use 4mtype24m as encryption type. Supported values are “zipcrypt” (traditional zip encryption), “aes128” (WinZip AES-128 encryption) and “aes256” (WinZip d446 2 a447 2 This boolean option enables or disables experimental Zip features that may not be compatible with other Zip d451 1 a451 1 fields are set to zero. It should not be used except d454 1 a454 1 The value is used as a character set name that will be d456 5 a460 5 1mzip64 22mZip64 extensions provide additional file size informa‐ tion 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 se‐ lectively enables these extensions only as needed. In d465 3 a467 3 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 d470 4 a473 4 Disabling this option with 1m!zip64 22mwill 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 d475 2 a476 2 size. In particular, this can improve compatibility when generating archives where the entry sizes are not d482 2 a483 2 ISO9660 archive will use 4mkernel.img24m as the boot image for El Torito booting, and that the gzip compressor should use the maximum compres‐ d493 1 a493 1 More detailed error codes and textual descriptions are available from d503 1 a503 1 The options support for libarchive was originally implemented by @ 1.1.1.9 log @libarchive: imported version 3.8.9 @ text @a397 13 1malign 22mPad the extended header of each regular file so that the file data that follows begins on a multiple of the given number of bytes within the uncompressed archive stream. The value must be a power of two and a multi‐ ple of 512. Because the alignment is applied to the uncompressed stream, it is independent of any compres‐ sion filter: the decompressed archive is aligned re‐ gardless of whether the archive is compressed. This allows tools to share file contents out of an uncom‐ pressed archive (or an uncompressed copy of one) using reflinks or 4mcopy_file_range24m(2), at the cost of some ex‐ tra padding. Files shorter than the alignment are not padded. d399 4 a402 4 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 d405 3 a407 3 When storing extended attributes, this option config‐ ures which headers should be written. The value is one of “all”, “LIBARCHIVE”, or “SCHILY”. By default, both d412 1 a412 1 The value is used as a character set name that will be d416 1 a416 1 The value is used as a character set name that will be d424 1 a424 2 “none”, “md5”, “sha1” (default), “sha256”, and “sha512”. d433 1 a433 2 ported values are “none”, “md5”, “sha1” (default), “sha256”, and “sha512”. d436 4 a439 4 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 d442 6 a447 6 The value is interpreted as a decimal integer specify‐ ing the compression level. Values between 0 and 9 are supported. A compression level of 0 switches the com‐ pression method to “store”, other values will enable “deflate”, “bzip2”, “lzma”, or “zstd” compression (in order of priority, depending on what libraries are d450 5 a454 5 The value is interpreted as a decimal integer specify‐ ing 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 spe‐ cial one requesting to detect and use as many threads d459 3 a461 3 Use 4mtype24m as encryption type. Supported values are “zipcrypt” (traditional zip encryption), “aes128” (WinZip AES-128 encryption) and “aes256” (WinZip d464 2 a465 2 This boolean option enables or disables experimental Zip features that may not be compatible with other Zip d469 1 a469 1 fields are set to zero. It should not be used except d472 1 a472 1 The value is used as a character set name that will be d474 5 a478 5 1mzip64 22mZip64 extensions provide additional file size informa‐ tion 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 se‐ lectively enables these extensions only as needed. In d483 3 a485 3 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 d488 4 a491 4 Disabling this option with 1m!zip64 22mwill 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 d493 2 a494 2 size. In particular, this can improve compatibility when generating archives where the entry sizes are not d500 2 a501 2 ISO9660 archive will use 4mkernel.img24m as the boot image for El Torito booting, and that the gzip compressor should use the maximum compres‐ d511 1 a511 1 More detailed error codes and textual descriptions are available from d521 1 a521 1 The options support for libarchive was originally implemented by @