contrib/libarchive/libarchive/archive_write_set_options.3

   1 .\" Copyright (c) 2003-2010 Tim Kientzle
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd January 31, 2020
  28 .Dt ARCHIVE_WRITE_OPTIONS 3
  29 .Os
  30 .Sh NAME
  31 .Nm archive_write_set_filter_option ,
  32 .Nm archive_write_set_format_option ,
  33 .Nm archive_write_set_option ,
  34 .Nm archive_write_set_options
  35 .Nd functions controlling options for writing archives
  36 .Sh LIBRARY
  37 Streaming Archive Library (libarchive, -larchive)
  38 .Sh SYNOPSIS
  39 .Ft int
  40 .Fo archive_write_set_filter_option
  41 .Fa "struct archive *"
  42 .Fa "const char *module"
  43 .Fa "const char *option"
  44 .Fa "const char *value"
  45 .Fc
  46 .Ft int
  47 .Fo archive_write_set_format_option
  48 .Fa "struct archive *"
  49 .Fa "const char *module"
  50 .Fa "const char *option"
  51 .Fa "const char *value"
  52 .Fc
  53 .Ft int
  54 .Fo archive_write_set_option
  55 .Fa "struct archive *"
  56 .Fa "const char *module"
  57 .Fa "const char *option"
  58 .Fa "const char *value"
  59 .Fc
  60 .Ft int
  61 .Fo archive_write_set_options
  62 .Fa "struct archive *"
  63 .Fa "const char *options"
  64 .Fc
  65 .Sh DESCRIPTION
  66 These functions provide a way for libarchive clients to configure
  67 specific write modules.
  68 .Bl -tag -width indent
  69 .It Xo
  70 .Fn archive_write_set_filter_option ,
  71 .Fn archive_write_set_format_option
  72 .Xc
  73 Specifies an option that will be passed to the currently-registered
  74 filters (including decompression filters) or format readers.
  75 .Pp
  76 If
  77 .Ar option
  78 and
  79 .Ar value
  80 are both
  81 .Dv NULL ,
  82 these functions will do nothing and
  83 .Cm ARCHIVE_OK
  84 will be returned.
  85 If
  86 .Ar option
  87 is
  88 .Dv NULL
  89 but
  90 .Ar value
  91 is not, these functions will do nothing and
  92 .Cm ARCHIVE_FAILED
  93 will be returned.
  94 .Pp
  95 If
  96 .Ar module
  97 is not
  98 .Dv NULL ,
  99 .Ar option
 100 and
 101 .Ar value
 102 will be provided to the filter or reader named
 103 .Ar module .
 104 The return value will be either
 105 .Cm ARCHIVE_OK
 106 if the option was successfully handled or
 107 .Cm ARCHIVE_WARN
 108 if the option was unrecognized by the module or could otherwise
 109 not be handled.
 110 If there is no such module,
 111 .Cm ARCHIVE_FAILED
 112 will be returned.
 113 .Pp
 114 If
 115 .Ar module
 116 is
 117 .Dv NULL ,
 118 .Ar option
 119 and
 120 .Ar value
 121 will be provided to every registered module.
 122 If any module returns
 123 .Cm ARCHIVE_FATAL ,
 124 this value will be returned immediately.
 125 Otherwise,
 126 .Cm ARCHIVE_OK
 127 will be returned if any module accepts the option, and
 128 .Cm ARCHIVE_FAILED
 129 in all other cases.
 130 .\"
 131 .It Fn archive_write_set_option
 132 Calls
 133 .Fn archive_write_set_format_option ,
 134 then
 135 .Fn archive_write_set_filter_option .
 136 If either function returns
 137 .Cm ARCHIVE_FATAL ,
 138 .Cm ARCHIVE_FATAL
 139 will be returned
 140 immediately.
 141 Otherwise, the greater of the two values will be returned.
 142 .\"
 143 .It Fn archive_write_set_options
 144 .Ar options
 145 is a comma-separated list of options.
 146 If
 147 .Ar options
 148 is
 149 .Dv NULL
 150 or empty,
 151 .Cm ARCHIVE_OK
 152 will be returned immediately.
 153 .Pp
 154 Individual options have one of the following forms:
 155 .Bl -tag -compact -width indent
 156 .It Ar option=value
 157 The option/value pair will be provided to every module.
 158 Modules that do not accept an option with this name will ignore it.
 159 .It Ar option
 160 The option will be provided to every module with a value of
 161 .Dq 1 .
 162 .It Ar !option
 163 The option will be provided to every module with a NULL value.
 164 .It Ar module:option=value , Ar module:option , Ar module:!option
 165 As above, but the corresponding option and value will be provided
 166 only to modules whose name matches
 167 .Ar module .
 168 .El
 169 .El
 170 .\"
 171 .Sh OPTIONS
 172 .Bl -tag -compact -width indent
 173 .It Filter b64encode
 174 .Bl -tag -compact -width indent
 175 .It Cm mode
 176 The value is interpreted as octal digits specifying the file mode.
 177 .It Cm name
 178 The value specifies the file name.
 179 .El
 180 .It Filter bzip2
 181 .Bl -tag -compact -width indent
 182 .It Cm compression-level
 183 The value is interpreted as a decimal integer specifying the
 184 bzip2 compression level. Supported values are from 1 to 9.
 185 .El
 186 .It Filter gzip
 187 .Bl -tag -compact -width indent
 188 .It Cm compression-level
 189 The value is interpreted as a decimal integer specifying the
 190 gzip compression level. Supported values are from 0 to 9.
 191 .It Cm timestamp
 192 Store timestamp. This is enabled by default.
 193 .El
 194 .It Filter lrzip
 195 .Bl -tag -compact -width indent
 196 .It Cm compression Ns = Ns Ar type
 197 Use
 198 .Ar type
 199 as compression method.
 200 Supported values are
 201 .Dq bzip2 ,
 202 .Dq gzipi ,
 203 .Dq lzo
 204 .Pq ultra fast ,
 205 and
 206 .Dq zpaq
 207 .Pq best, extremely slow .
 208 .It Cm compression-level
 209 The value is interpreted as a decimal integer specifying the
 210 lrzip compression level. Supported values are from 1 to 9.
 211 .El
 212 .It Filter lz4
 213 .Bl -tag -compact -width indent
 214 .It Cm compression-level
 215 The value is interpreted as a decimal integer specifying the
 216 lz4 compression level. Supported values are from 0 to 9.
 217 .It Cm stream-checksum
 218 Enable stream checksum. This is enabled by default.
 219 .It Cm block-checksum
 220 Enable block checksum. This is disabled by default.
 221 .It Cm block-size
 222 The value is interpreted as a decimal integer specifying the
 223 lz4 compression block size. Supported values are from 4 to 7
 224 .Pq default .
 225 .It Cm block-dependence
 226 Use the previous block of the block being compressed for
 227 a compression dictionary to improve compression ratio.
 228 This is disabled by default.
 229 .El
 230 .It Filter lzop
 231 .Bl -tag -compact -width indent
 232 .It Cm compression-level
 233 The value is interpreted as a decimal integer specifying the
 234 lzop compression level. Supported values are from 1 to 9.
 235 .El
 236 .It Filter uuencode
 237 .Bl -tag -compact -width indent
 238 .It Cm mode
 239 The value is interpreted as octal digits specifying the file mode.
 240 .It Cm name
 241 The value specifies the file name.
 242 .El
 243 .It Filter xz
 244 .Bl -tag -compact -width indent
 245 .It Cm compression-level
 246 The value is interpreted as a decimal integer specifying the
 247 compression level. Supported values are from 0 to 9.
 248 .It Cm threads
 249 The value is interpreted as a decimal integer specifying the
 250 number of threads for multi-threaded lzma compression.
 251 If supported, the default value is read from
 252 .Fn lzma_cputhreads .
 253 .El
 254 .It Filter zstd
 255 .Bl -tag -compact -width indent
 256 .It Cm compression-level
 257 The value is interpreted as a decimal integer specifying the
 258 compression level. Supported values are from 1 to 22.
 259 .El
 260 .It Format 7zip
 261 .Bl -tag -compact -width indent
 262 .It Cm compression
 263 The value is one of
 264 .Dq store ,
 265 .Dq deflate ,
 266 .Dq bzip2 ,
 267 .Dq lzma1 ,
 268 .Dq lzma2
 269 or
 270 .Dq ppmd
 271 to indicate how the following entries should be compressed.
 272 Note that this setting is ignored for directories, symbolic links,
 273 and other special entries.
 274 .It Cm compression-level
 275 The value is interpreted as a decimal integer specifying the
 276 compression level.
 277 Values between 0 and 9 are supported.
 278 The interpretation of the compression level depends on the chosen
 279 compression method.
 280 .El
 281 .It Format cpio
 282 .Bl -tag -compact -width indent
 283 .It Cm hdrcharset
 284 The value is used as a character set name that will be
 285 used when translating file names.
 286 .El
 287 .It Format gnutar
 288 .Bl -tag -compact -width indent
 289 .It Cm hdrcharset
 290 The value is used as a character set name that will be
 291 used when translating file, group and user names.
 292 .El
 293 .It Format iso9660 - volume metadata
 294 These options are used to set standard ISO9660 metadata.
 295 .Bl -tag -compact -width indent
 296 .It Cm abstract-file Ns = Ns Ar filename
 297 The file with the specified name will be identified in the ISO9660 metadata
 298 as holding the abstract for this volume.
 299 Default: none.
 300 .It Cm application-id Ns = Ns Ar filename
 301 The file with the specified name will be identified in the ISO9660 metadata
 302 as holding the application identifier for this volume.
 303 Default: none.
 304 .It Cm biblio-file Ns = Ns Ar filename
 305 The file with the specified name will be identified in the ISO9660 metadata
 306 as holding the bibliography for this volume.
 307 Default: none.
 308 .It Cm copyright-file Ns = Ns Ar filename
 309 The file with the specified name will be identified in the ISO9660 metadata
 310 as holding the copyright for this volume.
 311 Default: none.
 312 .It Cm publisher Ns = Ns Ar filename
 313 The file with the specified name will be identified in the ISO9660 metadata
 314 as holding the publisher information for this volume.
 315 Default: none.
 316 .It Cm volume-id Ns = Ns Ar string
 317 The specified string will be used as the Volume Identifier in the ISO9660 metadata.
 318 It is limited to 32 bytes.
 319 Default: none.
 320 .El
 321 .It Format iso9660 - boot support
 322 These options are used to make an ISO9660 image that can be directly
 323 booted on various systems.
 324 .Bl -tag -compact -width indent
 325 .It Cm boot Ns = Ns Ar filename
 326 The file matching this name will be used as the El Torito boot image file.
 327 .It Cm boot-catalog Ns = Ns Ar name
 328 The name that will be used for the El Torito boot catalog.
 329 Default:
 330 .Ar boot.catalog
 331 .It Cm boot-info-table
 332 The boot image file provided by the
 333 .Cm boot Ns = Ns Ar filename
 334 option will be edited with appropriate boot information in bytes 8 through 64.
 335 Default: disabled
 336 .It Cm boot-load-seg Ns = Ns Ar hexadecimal-number
 337 The load segment for a no-emulation boot image.
 338 .It Cm boot-load-size Ns = Ns Ar decimal-number
 339 The number of "virtual" 512-byte sectors to be loaded from a no-emulation boot image.
 340 Some very old BIOSes can only load very small images, setting this
 341 value to 4 will often allow such BIOSes to load the first part of
 342 the boot image (which will then need to be intelligent enough to
 343 load the rest of itself).
 344 This should not be needed unless you are trying to support systems with very old BIOSes.
 345 This defaults to the full size of the image.
 346 .It Cm boot-type Ns = Ns Ar value
 347 Specifies the boot semantics used by the El Torito boot image:
 348 If the
 349 .Ar value
 350 is
 351 .Cm fd ,
 352 then the boot image is assumed to be a bootable floppy image.
 353 If the
 354 .Ar value
 355 is
 356 .Cm hd ,
 357 then the boot image is assumed to be a bootable hard disk image.
 358 If the
 359 .Ar value
 360 is
 361 .Cm no-emulation ,
 362 the boot image is used without floppy or hard disk emulation.
 363 If the boot image is exactly 1.2MB, 1.44MB, or 2.88MB, then
 364 the default is
 365 .Cm fd ,
 366 otherwise the default is
 367 .Cm no-emulation .
 368 .El
 369 .It Format iso9660 - filename and size extensions
 370 Various extensions to the base ISO9660 format.
 371 .Bl -tag -compact -width indent
 372 .It Cm allow-ldots
 373 If enabled, allows filenames to begin with a leading period.
 374 If disabled, filenames that begin with a leading period will have
 375 that period replaced by an underscore character in the standard ISO9660
 376 namespace.
 377 This does not impact names stored in the Rockridge or Joliet extension area.
 378 Default: disabled.
 379 .It Cm allow-lowercase
 380 If enabled, allows filenames to contain lowercase characters.
 381 If disabled, filenames will be forced to uppercase.
 382 This does not impact names stored in the Rockridge or Joliet extension area.
 383 Default: disabled.
 384 .It Cm allow-multidot
 385 If enabled, allows filenames to contain multiple period characters, in violation of the ISO9660 specification.
 386 If disabled, additional periods will be converted to underscore characters.
 387 This does not impact names stored in the Rockridge or Joliet extension area.
 388 Default: disabled.
 389 .It Cm allow-period
 390 If enabled, allows filenames to contain trailing period characters, in violation of the ISO9660 specification.
 391 If disabled, trailing periods will be converted to underscore characters.
 392 This does not impact names stored in the Rockridge or Joliet extension area.
 393 Default: disabled.
 394 .It Cm allow-pvd-lowercase
 395 If enabled, the Primary Volume Descriptor may contain lowercase ASCII characters, in violation of the ISO9660 specification.
 396 If disabled, characters will be converted to uppercase ASCII.
 397 Default: disabled.
 398 .It Cm allow-sharp-tilde
 399 If enabled, sharp and tilde characters will be permitted in filenames, in violation if the ISO9660 specification.
 400 If disabled, such characters will be converted to underscore characters.
 401 Default: disabled.
 402 .It Cm allow-vernum
 403 If enabled, version numbers will be included with files.
 404 If disabled, version numbers will be suppressed, in violation of the ISO9660 standard.
 405 This does not impact names stored in the Rockridge or Joliet extension area.
 406 Default: enabled.
 407 .It Cm iso-level
 408 This enables support for file size and file name extensions in the
 409 core ISO9660 area.
 410 The name extensions specified here do not affect the names stored in the Rockridge or Joliet extension areas.
 411 .Bl -tag -compact -width indent
 412 .It Cm iso-level=1
 413 The most compliant form of ISO9660 image.
 414 Filenames are limited to 8.3 uppercase format,
 415 directory names are limited to 8 uppercase characters,
 416 files are limited to 4 GiB,
 417 the complete ISO9660 image cannot exceed 4 GiB.
 418 .It Cm iso-level=2
 419 Filenames are limited to 30 uppercase characters with a 30-character extension,
 420 directory names are limited to 30 characters,
 421 files are limited to 4 GiB.
 422 .It Cm iso-level=3
 423 As with
 424 .Cm iso-level=2 ,
 425 except that files may exceed 4 GiB.
 426 .It Cm iso-level=4
 427 As with
 428 .Cm iso-level=3 ,
 429 except that filenames may be up to 193 characters
 430 and may include arbitrary 8-bit characters.
 431 .El
 432 .It Cm joliet
 433 Microsoft's Joliet extensions store a completely separate set of directory information about each file.
 434 In particular, this information includes Unicode filenames of up to 255 characters.
 435 Default: enabled.
 436 .It Cm limit-depth
 437 If enabled, libarchive will use directory relocation records to ensure that
 438 no pathname exceeds the ISO9660 limit of 8 directory levels.
 439 If disabled, no relocation will occur.
 440 Default: enabled.
 441 .It Cm limit-dirs
 442 If enabled, libarchive will cause an error if there are more than
 443 65536 directories.
 444 If disabled, there is no limit on the number of directories.
 445 Default: enabled
 446 .It Cm pad
 447 If enabled, 300 kiB of zero bytes will be appended to the end of the archive.
 448 Default: enabled
 449 .It Cm relaxed-filenames
 450 If enabled, all 7-bit ASCII characters are permitted in filenames
 451 (except lowercase characters unless
 452 .Cm allow-lowercase
 453 is also specified).
 454 This violates ISO9660 standards.
 455 This does not impact names stored in the Rockridge or Joliet extension area.
 456 Default: disabled.
 457 .It Cm rockridge
 458 The Rockridge extensions store an additional set of POSIX-style file
 459 information with each file, including mtime, atime, ctime, permissions,
 460 and long filenames with arbitrary 8-bit characters.
 461 These extensions also support symbolic links and other POSIX file types.
 462 Default: enabled.
 463 .El
 464 .It Format iso9660 - zisofs support
 465 The zisofs extensions permit each file to be independently compressed
 466 using a gzip-compatible compression.
 467 This can provide significant size savings, but requires the reading
 468 system to have support for these extensions.
 469 These extensions are disabled by default.
 470 .Bl -tag -compact -width indent
 471 .It Cm compression-level Ns = Ns number
 472 The compression level used by the deflate compressor.
 473 Ranges from 0 (least effort) to 9 (most effort).
 474 Default: 6
 475 .It Cm zisofs
 476 Synonym for
 477 .Cm zisofs=direct .
 478 .It Cm zisofs=direct
 479 Compress each file in the archive.
 480 Unlike
 481 .Cm zisofs=indirect ,
 482 this is handled entirely within libarchive and does not require a
 483 separate utility.
 484 For best results, libarchive tests each file and will store
 485 the file uncompressed if the compression does not actually save any space.
 486 In particular, files under 2k will never be compressed.
 487 Note that boot image files are never compressed.
 488 .It Cm zisofs=indirect
 489 Recognizes files that have already been compressed with the
 490 .Cm mkzftree
 491 utility and sets up the necessary file metadata so that
 492 readers will correctly identify these as zisofs-compressed files.
 493 .It Cm zisofs-exclude Ns = Ns Ar filename
 494 Specifies a filename that should not be compressed when using
 495 .Cm zisofs=direct .
 496 This option can be provided multiple times to suppress compression
 497 on many files.
 498 .El
 499 .It Format mtree
 500 .Bl -tag -compact -width indent
 501 .It Cm cksum , Cm device , Cm flags , Cm gid , Cm gname , Cm indent , Cm link , Cm md5 , Cm mode , Cm nlink , Cm rmd160 , Cm sha1 , Cm sha256 , Cm sha384 , Cm sha512 , Cm size , Cm time , Cm uid , Cm uname
 502 Enable a particular keyword in the mtree output.
 503 Prefix with an exclamation mark to disable the corresponding keyword.
 504 The default is equivalent to
 505 .Dq device, flags, gid, gname, link, mode, nlink, size, time, type, uid, uname .
 506 .It Cm all
 507 Enables all of the above keywords.
 508 .It Cm use-set
 509 Enables generation of
 510 .Cm /set
 511 lines that specify default values for the following files and/or directories.
 512 .It Cm indent
 513 XXX needs explanation XXX
 514 .El
 515 .It Format newc
 516 .Bl -tag -compact -width indent
 517 .It Cm hdrcharset
 518 The value is used as a character set name that will be
 519 used when translating file names.
 520 .El
 521 .It Format pax
 522 .Bl -tag -compact -width indent
 523 .It Cm hdrcharset
 524 The value is used as a character set name that will be
 525 used when translating file, group and user names.
 526 The value is one of
 527 .Dq BINARY
 528 or
 529 .Dq UTF-8 .
 530 With
 531 .Dq BINARY
 532 there is no character conversion, with
 533 .Dq UTF-8
 534 names are converted to UTF-8.
 535 .It Cm xattrheader
 536 When storing extended attributes, this option configures which
 537 headers should be written. The value is one of
 538 .Dq all ,
 539 .Dq LIBARCHIVE ,
 540 or
 541 .Dq SCHILY .
 542 By default, both
 543 .Dq LIBARCHIVE.xattr
 544 and
 545 .Dq SCHILY.xattr
 546 headers are written.
 547 .El
 548 .It Format ustar
 549 .Bl -tag -compact -width indent
 550 .It Cm hdrcharset
 551 The value is used as a character set name that will be
 552 used when translating file, group and user names.
 553 .El
 554 .It Format v7tar
 555 .Bl -tag -compact -width indent
 556 .It Cm hdrcharset
 557 The value is used as a character set name that will be
 558 used when translating file, group and user names.
 559 .El
 560 .It Format warc
 561 .Bl -tag -compact -width indent
 562 .It Cm omit-warcinfo
 563 Set to
 564 .Dq true
 565 to disable output of the warcinfo record.
 566 .El
 567 .It Format xar
 568 .Bl -tag -compact -width indent
 569 .It Cm checksum Ns = Ns Ar type
 570 Use
 571 .Ar type
 572 as file checksum method.
 573 Supported values are
 574 .Dq none ,
 575 .Dq md5 ,
 576 and
 577 .Dq sha1
 578 .Pq default .
 579 .It Cm compression Ns = Ns Ar type
 580 Use
 581 .Ar type
 582 as compression method.
 583 Supported values are
 584 .Dq none ,
 585 .Dq bzip2 ,
 586 .Dq gzip
 587 .Pq default ,
 588 .Dq lzma
 589 and
 590 .Dq xz .
 591 .It Cm compression_level
 592 The value is a decimal integer from 1 to 9 specifying the compression level.
 593 .It Cm toc-checksum Ns = Ns Ar type
 594 Use
 595 .Ar type
 596 as table of contents checksum method.
 597 Supported values are
 598 .Dq none ,
 599 .Dq md5
 600 and
 601 .Dq sha1
 602 .Pq default .
 603 .El
 604 .It Format zip
 605 .Bl -tag -compact -width indent
 606 .It Cm compression
 607 The value is either
 608 .Dq store
 609 or
 610 .Dq deflate
 611 to indicate how the following entries should be compressed.
 612 Note that this setting is ignored for directories, symbolic links,
 613 and other special entries.
 614 .It Cm compression-level
 615 The value is interpreted as a decimal integer specifying the
 616 compression level.
 617 Values between 0 and 9 are supported.
 618 A compression level of 0 switches the compression method to
 619 .Dq store ,
 620 other values will enable
 621 .Dq deflate
 622 compression with the given level.
 623 .It Cm encryption
 624 Enable encryption using traditional zip encryption.
 625 .It Cm encryption Ns = Ns Ar type
 626 Use
 627 .Ar type
 628 as encryption type.
 629 Supported values are
 630 .Dq zipcrypt
 631 .Pq traditional zip encryption ,
 632 .Dq aes128
 633 .Pq WinZip AES-128 encryption
 634 and
 635 .Dq aes256
 636 .Pq WinZip AES-256 encryption .
 637 .It Cm experimental
 638 This boolean option enables or disables experimental Zip features
 639 that may not be compatible with other Zip implementations.
 640 .It Cm fakecrc32
 641 This boolean option disables CRC calculations.
 642 All CRC fields are set to zero.
 643 It should not be used except for testing purposes.
 644 .It Cm hdrcharset
 645 The value is used as a character set name that will be
 646 used when translating file names.
 647 .It Cm zip64
 648 Zip64 extensions provide additional file size information
 649 for entries larger than 4 GiB.
 650 They also provide extended file offset and archive size information
 651 when archives exceed 4 GiB.
 652 By default, the Zip writer selectively enables these extensions only as needed.
 653 In particular, if the file size is unknown, the Zip writer will
 654 include Zip64 extensions to guard against the possibility that the
 655 file might be larger than 4 GiB.
 656 .Pp
 657 Setting this boolean option will force the writer to use Zip64 extensions
 658 even for small files that would not otherwise require them.
 659 This is primarily useful for testing.
 660 .Pp
 661 Disabling this option with
 662 .Cm !zip64
 663 will force the Zip writer to avoid Zip64 extensions:
 664 It will reject files with size greater than 4 GiB,
 665 it will reject any new entries once the total archive size reaches 4 GiB,
 666 and it will not use Zip64 extensions for files with unknown size.
 667 In particular, this can improve compatibility when generating archives
 668 where the entry sizes are not known in advance.
 669 .El
 670 .El
 671 .Sh EXAMPLES
 672 The following example creates an archive write handle to
 673 create a gzip-compressed ISO9660 format image.
 674 The two options here specify that the ISO9660 archive will use
 675 .Ar kernel.img
 676 as the boot image for El Torito booting, and that the gzip
 677 compressor should use the maximum compression level.
 678 .Bd -literal -offset indent
 679 a = archive_write_new();
 680 archive_write_add_filter_gzip(a);
 681 archive_write_set_format_iso9660(a);
 682 archive_write_set_options(a, "boot=kernel.img,compression=9");
 683 archive_write_open_filename(a, filename, blocksize);
 684 .Ed
 685 .\"
 686 .Sh ERRORS
 687 More detailed error codes and textual descriptions are available from the
 688 .Fn archive_errno
 689 and
 690 .Fn archive_error_string
 691 functions.
 692 .\"
 693 .Sh SEE ALSO
 694 .Xr tar 1 ,
 695 .Xr archive_read_set_options 3 ,
 696 .Xr archive_write 3 ,
 697 .Xr libarchive 3
 698 .Sh HISTORY
 699 The
 700 .Nm libarchive
 701 library first appeared in
 702 .Fx 5.3 .
 703 .Sh AUTHORS
 704 .An -nosplit
 705 The options support for libarchive was originally implemented by
 706 .An Michihiro NAKAJIMA .
 707 .Sh BUGS