From 8019776e5be827a784ddf31d7b9efe4936f8b3e4 Mon Sep 17 00:00:00 2001 From: Tim Kientzle Date: Sun, 10 Apr 2016 18:32:13 -0700 Subject: [PATCH] Manpage updates --- libarchive/archive_write_filter.3 | 17 ++++- libarchive/archive_write_format.3 | 115 ++++++++++++++++++++++-------- libarchive/libarchive-formats.5 | 29 +++++--- tar/bsdtar.1 | 9 +-- 4 files changed, 126 insertions(+), 44 deletions(-) diff --git a/libarchive/archive_write_filter.3 b/libarchive/archive_write_filter.3 index 83bd2c64f..869dc46b6 100644 --- a/libarchive/archive_write_filter.3 +++ b/libarchive/archive_write_filter.3 @@ -29,9 +29,12 @@ .Os .Sh NAME .Nm archive_write_add_filter_b64encode , +.Nm archive_write_add_filter_by_name , .Nm archive_write_add_filter_bzip2 , .Nm archive_write_add_filter_compress , +.Nm archive_write_add_filter_grzip , .Nm archive_write_add_filter_gzip , +.Nm archive_write_add_filter_lrzip , .Nm archive_write_add_filter_lz4 , .Nm archive_write_add_filter_lzip , .Nm archive_write_add_filter_lzma , @@ -51,8 +54,12 @@ Streaming Archive Library (libarchive, -larchive) .Ft int .Fn archive_write_add_filter_compress "struct archive *" .Ft int +.Fn archive_write_add_filter_grzip "struct archive *" +.Ft int .Fn archive_write_add_filter_gzip "struct archive *" .Ft int +.Fn archive_write_add_filter_lrzip "struct archive *" +.Ft int .Fn archive_write_add_filter_lz4 "struct archive *" .Ft int .Fn archive_write_add_filter_lzip "struct archive *" @@ -71,19 +78,25 @@ Streaming Archive Library (libarchive, -larchive) .Sh DESCRIPTION .Bl -tag -width indent .It Xo -.Fn archive_write_add_filter_b64encode , .Fn archive_write_add_filter_bzip2 , .Fn archive_write_add_filter_compress , +.Fn archive_write_add_filter_grzip , .Fn archive_write_add_filter_gzip , +.Fn archive_write_add_filter_lrzip , .Fn archive_write_add_filter_lz4 , .Fn archive_write_add_filter_lzip , .Fn archive_write_add_filter_lzma , .Fn archive_write_add_filter_lzop , -.Fn archive_write_add_filter_uuencode , .Fn archive_write_add_filter_xz , .Xc The resulting archive will be compressed as specified. Note that the compressed output is always properly blocked. +.It Xo +.Fn archive_write_add_filter_b64encode , +.Fn archive_write_add_filter_uuencode , +.Xc +The output will be encoded as specified. +The encoded output is always properly blocked. .It Fn archive_write_add_filter_none This is never necessary. It is provided only for backwards compatibility. diff --git a/libarchive/archive_write_format.3 b/libarchive/archive_write_format.3 index 4bd116340..d4ba6abff 100644 --- a/libarchive/archive_write_format.3 +++ b/libarchive/archive_write_format.3 @@ -28,23 +28,63 @@ .Dt ARCHIVE_WRITE_FORMAT 3 .Os .Sh NAME +.Nm archive_write_set_format , +.Nm archive_write_set_format_7zip , +.Nm archive_write_set_format_ar , +.Nm archive_write_set_format_ar_bsd , +.Nm archive_write_set_format_ar_svr4 , +.Nm archive_write_set_format_by_name , .Nm archive_write_set_format_cpio , +.Nm archive_write_set_format_cpio_newc , +.Nm archive_write_set_format_filter_by_ext , +.Nm archive_write_set_format_filter_by_ext_def , +.Nm archive_write_set_format_gnutar , +.Nm archive_write_set_format_iso9660 , +.Nm archive_write_set_format_mtree , +.Nm archive_write_set_format_mtree_classic , +.Nm archive_write_set_format_mtree_default , .Nm archive_write_set_format_pax , .Nm archive_write_set_format_pax_restricted , .Nm archive_write_set_format_raw , .Nm archive_write_set_format_shar , .Nm archive_write_set_format_shar_dump , .Nm archive_write_set_format_ustar , -.Nm archive_write_set_format_filter_by_ext , -.Nm archive_write_set_format_filter_by_ext_def +.Nm archive_write_set_format_v7tar , +.Nm archive_write_set_format_warc , +.Nm archive_write_set_format_xar , +.Nm archive_write_set_format_zip , .Nd functions for creating archives .Sh LIBRARY Streaming Archive Library (libarchive, -larchive) .Sh SYNOPSIS .In archive.h .Ft int +.Fn archive_write_set_format "struct archive *" "int code" +.Ft int +.Fn archive_write_set_format_7zip "struct archive *" +.Ft int +.Fn archive_write_set_format_ar "struct archive *" +.Ft int +.Fn archive_write_set_format_ar_bsd "struct archive *" +.Ft int +.Fn archive_write_set_format_ar_svr4 "struct archive *" +.Ft int +.Fn archive_write_set_format_by_name "struct archive *" "const char *name" +.Ft int .Fn archive_write_set_format_cpio "struct archive *" .Ft int +.Fn archive_write_set_format_cpio_newc "struct archive *" +.Ft int +.Fn archive_write_set_format_filter_by_ext "struct archive *" "const char *filename" +.Ft int +.Fn archive_write_set_format_filter_by_ext_def "struct archive *" "const char *filename" "const char *def_ext" +.Ft int +.Fn archive_write_set_format_gnutar "struct archive *" +.Ft int +.Fn archive_write_set_format_iso9660 "struct archive *" +.Ft int +.Fn archive_write_set_format_mtree "struct archive *" +.Ft int .Fn archive_write_set_format_pax "struct archive *" .Ft int .Fn archive_write_set_format_pax_restricted "struct archive *" @@ -57,42 +97,60 @@ Streaming Archive Library (libarchive, -larchive) .Ft int .Fn archive_write_set_format_ustar "struct archive *" .Ft int -.Fn archive_write_set_format_filter_by_ext "struct archive *" "const char *" +.Fn archive_write_set_format_v7tar "struct archive *" +.Ft int +.Fn archive_write_set_format_warc "struct archive *" .Ft int -.Fn archive_write_set_format_filter_by_ext_def "struct archive *" "const char *" "const char *" +.Fn archive_write_set_format_xar "struct archive *" +.Ft int +.Fn archive_write_set_format_zip "struct archive *" .Sh DESCRIPTION These functions set the format that will be used for the archive. .Pp -The library can write -POSIX octet-oriented cpio format archives, -POSIX-standard -.Dq pax interchange -format archives, -traditional -.Dq shar -archives, -enhanced -.Dq dump -shar archives that store a variety of file attributes and handle binary files, -and -POSIX-standard -.Dq ustar -archives. -The pax interchange format is a backwards-compatible tar format that -adds key/value attributes to each entry and supports arbitrary -filenames, linknames, uids, sizes, etc. -.Dq Restricted pax interchange format -is the library default; this is the same as pax format, but suppresses -the pax extended header for most normal files. -In most cases, this will result in ordinary ustar archives. +The library can write a variety of common archive formats. + .Bl -tag -width indent +.It Fn archive_write_set_format +Sets the format based on the format code (see +.Pa archive.h +for the full list of format codes). +In particular, this can be used in conjunction with +.Fn archive_format +to create a new archive with the same format as an existing archive. +.It Fn archive_write_set_format_by_name +Sets the corresponding format based on the common name. .It Xo .Fn archive_write_set_format_filter_by_ext , .Fn archive_write_set_format_filter_by_ext_def .Xc -Format and filter for archive can be set automatically, based on output file name extension. -The functions are platform dependent. +Sets both filters and format based on the output filename. Supported extensions: .7z, .zip, .jar, .cpio, .iso, .a, .ar, .tar, .tgz, .tar.gz, .tar.bz2, .tar.xz +.It Xo +.Fn archive_write_set_format_7zip +.Fn archive_write_set_format_ar_bsd , +.Fn archive_write_set_format_ar_svr4 , +.Fn archive_write_set_format_cpio +.Fn archive_write_set_format_cpio_newc +.Fn archive_write_set_format_gnutar +.Fn archive_write_set_format_iso9660 +.Fn archive_write_set_format_mtree +.Fn archive_write_set_format_mtree_classic +.Fn archive_write_set_format_pax +.Fn archive_write_set_format_pax_restricted +.Fn archive_write_set_format_raw +.Fn archive_write_set_format_shar +.Fn archive_write_set_format_shar_dump +.Fn archive_write_set_format_ustar +.Fn archive_write_set_format_v7tar +.Fn archive_write_set_format_warc +.Fn archive_write_set_format_xar +.Fn archive_write_set_format_zip +.Xc +Set the format as specified. +More details on the formats supported by libarchive can be found in the +.Xr libarchive-formats 5 +manual page. +.El .\" .Sh RETURN VALUES These functions return @@ -113,5 +171,6 @@ functions. .Xr archive_write 3 , .Xr archive_write_set_options 3 , .Xr cpio 5 , +.Xr libarchive-formats 5 , .Xr mtree 5 , .Xr tar 5 diff --git a/libarchive/libarchive-formats.5 b/libarchive/libarchive-formats.5 index 4587e39f7..e619fe540 100644 --- a/libarchive/libarchive-formats.5 +++ b/libarchive/libarchive-formats.5 @@ -235,7 +235,7 @@ This format stores the header contents as octal values in ASCII. It is standard, portable, and immune from byte-order confusion. File sizes and mtime are limited to 33 bits (8GB file size), other fields are limited to 18 bits. -.It Cm SVR4 +.It Cm SVR4/newc The libarchive library can read both CRC and non-CRC variants of this format. The SVR4 format uses eight-digit hexadecimal values for @@ -388,8 +388,10 @@ area adjacent to the entry. Libarchive can read both extensions, including archives that may include both types of long filenames. Programs using libarchive can write GNU/SVR4 format -if they provide a filename table to be written into -the archive before any of the entries. +if they provide an entry called +.Pa // +containing a filename table to be written into the archive +before any of the entries. Any entries whose names are not in the filename table will be written using BSD-style long filenames. This can cause problems for programs such as @@ -430,18 +432,29 @@ using libarchive. If it cannot locate and open the file on disk, libarchive will return an error for any attempt to read the entry body. -.Ss LHA -XXX Information about libarchive's LHA support XXX +.Ss 7-Zip +Libarchive can read and write 7-Zip format archives. +TODO: Need more information .Ss CAB -XXX Information about libarchive's CAB support XXX -.Ss XAR -XXX Information about libarchive's XAR support XXX +Libarchive can read Microsoft Cabinet ( +.Dq CAB ) +format archives. +TODO: Need more information. +.Ss LHA +TODO: Information about libarchive's LHA support .Ss RAR Libarchive has limited support for reading RAR format archives. Currently, libarchive can read RARv3 format archives which have been either created uncompressed, or compressed using any of the compression methods supported by the RARv3 format. Libarchive can also read self-extracting RAR archives. +.Ss Warc +Libarchive can read and write +.Dq web archives . +TODO: Need more information +.Ss XAR +Libarchive can read and write the XAR format used by many Apple tools. +TODO: Need more information .Sh SEE ALSO .Xr ar 1 , .Xr cpio 1 , diff --git a/tar/bsdtar.1 b/tar/bsdtar.1 index 3c0c8deb8..9eadaaf88 100644 --- a/tar/bsdtar.1 +++ b/tar/bsdtar.1 @@ -510,7 +510,7 @@ A decimal integer from 1 to 9 specifying the lrzip compression level. .It Cm lz4:compression-level A decimal integer from 1 to 9 specifying the lzop compression level. .It Cm lz4:stream-checksum -Enalbe stream checksum. This is by default, use +Enable stream checksum. This is by default, use .Cm lz4:!stream-checksum to disable. .It Cm lz4:block-checksum @@ -595,9 +595,7 @@ and The .Pa passphrase is used to extract or create an encrypted archive. -Currently, zip is only a format that -.Nm -can handle encrypted archives. +Currently, zip is the only supported format that supports encryption. You shouldn't use this option unless you realize how insecure use of this option is. .It Fl Fl posix @@ -1168,8 +1166,7 @@ option is specified. There needs to be better support for file selection on both create and extract. .Pp -There is not yet any support for multi-volume archives or for archiving -sparse files. +There is not yet any support for multi-volume archives. .Pp Converting between dissimilar archive formats (such as tar and cpio) using the .Cm @ Ns Pa - -- 2.47.2