Fixing up archive_read_format's man page. (#2518)

Adding the requested updates to the man pages.

Fixes libarchive#2507.

diff --git a/README.md b/README.md
index 4b05b0d144343f5862ee1d3cc818e52385f1e5e2..8bb6fe193fc1cb8d7ab1d3345d4bb4d397109caa 100644 (file)
--- a/README.md
+++ b/README.md
@@ -85,13 +85,14 @@ Currently, the library automatically detects and reads the following formats:
   * PWB binary cpio
   * ISO9660 CD-ROM images (with optional Rockridge or Joliet extensions)
   * ZIP archives (with uncompressed or "deflate" compressed entries, including support for encrypted Zip archives)
-  * ZIPX archives (with support for bzip2, ppmd8, lzma and xz compressed entries)
+  * ZIPX archives (with support for bzip2, zstd, ppmd8, lzma and xz compressed entries)
   * GNU and BSD 'ar' archives
   * 'mtree' format
   * 7-Zip archives (including archives that use zstandard compression)
   * Microsoft CAB format
   * LHA and LZH archives
   * RAR and RAR 5.0 archives (with some limitations due to RAR's proprietary status)
+  * WARC archives
   * XAR archives
 
 The library also detects and handles any of the following before evaluating the archive:
@@ -125,11 +126,13 @@ The library can create archives in any of the following formats:
   * 'mtree' format
   * ISO9660 format
   * 7-Zip archives (including archives that use zstandard compression)
+  * WARC archives
   * XAR archives
 
 When creating archives, the result can be filtered with any of the following:
 
   * uuencode
+  * base64
   * gzip compression
   * bzip2 compression
   * compress/LZW compression

diff --git a/libarchive/archive.h b/libarchive/archive.h
index 2067fa80d920ee363871489b94ac66e8f9942dbc..105df69e9da1bd624bd2798520ca12d6b7abdb71 100644 (file)
--- a/libarchive/archive.h
+++ b/libarchive/archive.h
@@ -101,7 +101,7 @@ typedef ssize_t la_ssize_t;
 /* Use the platform types for time_t */
 #define __LA_TIME_T time_t
 #else
-/* Use 64-bytes integer types for time_t */
+/* Use 64-bits integer types for time_t */
 #define __LA_TIME_T la_int64_t
 #endif
 
@@ -109,7 +109,7 @@ typedef ssize_t la_ssize_t;
 /* Use the platform types for dev_t */
 #define __LA_DEV_T dev_t
 #else
-/* Use 64-bytes integer types for dev_t */
+/* Use 64-bits integer types for dev_t */
 #define __LA_DEV_T la_int64_t
 #endif
 
@@ -468,6 +468,8 @@ __LA_DECL int archive_read_support_format_by_code(struct archive *, int);
 __LA_DECL int archive_read_support_format_cab(struct archive *);
 __LA_DECL int archive_read_support_format_cpio(struct archive *);
 __LA_DECL int archive_read_support_format_empty(struct archive *);
+/* archive_read_support_format_gnutar() is an alias for historical reasons
+ * of archive_read_support_format_tar(). */
 __LA_DECL int archive_read_support_format_gnutar(struct archive *);
 __LA_DECL int archive_read_support_format_iso9660(struct archive *);
 __LA_DECL int archive_read_support_format_lha(struct archive *);

diff --git a/libarchive/archive_entry.h b/libarchive/archive_entry.h
index 8a3215dccef11c9fc243a81d67cfe521c6a41756..fb6c26fac8d29fa6540376dc4d5b6cc2c19f4246 100644 (file)
--- a/libarchive/archive_entry.h
+++ b/libarchive/archive_entry.h
@@ -103,7 +103,7 @@ typedef ssize_t la_ssize_t;
 /* Use the platform types for time_t */
 #define __LA_TIME_T time_t
 #else
-/* Use 64-bytes integer types for time_t */
+/* Use 64-bits integer types for time_t */
 #define __LA_TIME_T la_int64_t
 #endif
 
@@ -111,7 +111,7 @@ typedef ssize_t la_ssize_t;
 /* Use the platform types for dev_t */
 #define __LA_DEV_T dev_t
 #else
-/* Use 64-bytes integer types for dev_t */
+/* Use 64-bits integer types for dev_t */
 #define __LA_DEV_T la_int64_t
 #endif
 

diff --git a/libarchive/archive_read_format.3 b/libarchive/archive_read_format.3
index 990293c831315d637285719722a364e27ce864f6..660cc74acb36d88d0360f280d696e13b1542b32b 100644 (file)
--- a/libarchive/archive_read_format.3
+++ b/libarchive/archive_read_format.3
@@ -37,8 +37,10 @@
 .Nm archive_read_support_format_lha ,
 .Nm archive_read_support_format_mtree ,
 .Nm archive_read_support_format_rar ,
+.Nm archive_read_support_format_rar5 ,
 .Nm archive_read_support_format_raw ,
 .Nm archive_read_support_format_tar ,
+.Nm archive_read_support_format_warc ,
 .Nm archive_read_support_format_xar ,
 .Nm archive_read_support_format_zip
 .Nd functions for reading streaming archives
@@ -70,10 +72,14 @@ Streaming Archive Library (libarchive, -larchive)
 .Ft int
 .Fn archive_read_support_format_rar "struct archive *"
 .Ft int
+.Fn archive_read_support_format_rar5 "struct archive *"
+.Ft int
 .Fn archive_read_support_format_raw "struct archive *"
 .Ft int
 .Fn archive_read_support_format_tar "struct archive *"
 .Ft int
+.Fn archive_read_support_format_warc "struct archive *"
+.Ft int
 .Fn archive_read_support_format_xar "struct archive *"
 .Ft int
 .Fn archive_read_support_format_zip "struct archive *"
@@ -89,8 +95,10 @@ Streaming Archive Library (libarchive, -larchive)
 .Fn archive_read_support_format_lha ,
 .Fn archive_read_support_format_mtree ,
 .Fn archive_read_support_format_rar ,
+.Fn archive_read_support_format_rar5 ,
 .Fn archive_read_support_format_raw ,
 .Fn archive_read_support_format_tar ,
+.Fn archive_read_support_format_warc ,
 .Fn archive_read_support_format_xar ,
 .Fn archive_read_support_format_zip
 .Xc
@@ -100,6 +108,13 @@ For example,
 .Fn archive_read_support_format_tar
 enables support for a variety of standard tar formats, old-style tar,
 ustar, pax interchange format, and many common variants.
+.Fn archive_read_support_format_zip
+enables support for both the streaming and the seeking zip readers,
+which can separately be enabled by respectively
+.Fn archive_read_support_format_zip_streamable
+and
+.Fn archive_read_support_format_zip_seekable
+.
 .It Fn archive_read_support_format_all
 Enables support for all available formats except the
 .Dq raw