summaryrefslogtreecommitdiff
path: root/archivers/libarchive/files/doc/text/libarchive.3.txt
diff options
context:
space:
mode:
Diffstat (limited to 'archivers/libarchive/files/doc/text/libarchive.3.txt')
-rw-r--r--archivers/libarchive/files/doc/text/libarchive.3.txt72
1 files changed, 36 insertions, 36 deletions
diff --git a/archivers/libarchive/files/doc/text/libarchive.3.txt b/archivers/libarchive/files/doc/text/libarchive.3.txt
index 484642460dc..0e23b188bd6 100644
--- a/archivers/libarchive/files/doc/text/libarchive.3.txt
+++ b/archivers/libarchive/files/doc/text/libarchive.3.txt
@@ -15,19 +15,19 @@ OVERVIEW
When reading an archive, the library automatically detects the format and
the compression. The library currently has read support for:
- · old-style tar archives,
- · most variants of the POSIX “ustar” format,
- · the POSIX “pax interchange” format,
- · GNU-format tar archives,
- · most common cpio archive formats,
- · ISO9660 CD images (including RockRidge and Joliet extensions),
- · Zip archives,
- · ar archives (including GNU/SysV and BSD extensions),
- · Microsoft CAB archives,
- · LHA archives,
- · mtree file tree descriptions,
- · RAR archives,
- · XAR archives.
+ • old-style tar archives,
+ • most variants of the POSIX “ustar” format,
+ • the POSIX “pax interchange” format,
+ • GNU-format tar archives,
+ • most common cpio archive formats,
+ • ISO9660 CD images (including RockRidge and Joliet extensions),
+ • Zip archives,
+ • ar archives (including GNU/SysV and BSD extensions),
+ • Microsoft CAB archives,
+ • LHA archives,
+ • mtree file tree descriptions,
+ • RAR archives,
+ • XAR archives.
The library automatically detects archives compressed with gzip(1),
bzip2(1), xz(1), lzip(1), or compress(1) and decompresses them transpar‐
ently. It can similarly detect and decode archives processed with
@@ -35,23 +35,23 @@ OVERVIEW
When writing an archive, you can specify the compression to be used and
the format to use. The library can write
- · POSIX-standard “ustar” archives,
- · POSIX “pax interchange format” archives,
- · POSIX octet-oriented cpio archives,
- · Zip archive,
- · two different variants of shar archives,
- · ISO9660 CD images,
- · 7-Zip archives,
- · ar archives,
- · mtree file tree descriptions,
- · XAR archives.
+ • POSIX-standard “ustar” archives,
+ • POSIX “pax interchange format” archives,
+ • POSIX octet-oriented cpio archives,
+ • Zip archive,
+ • two different variants of shar archives,
+ • ISO9660 CD images,
+ • 7-Zip archives,
+ • ar archives,
+ • mtree file tree descriptions,
+ • XAR archives.
Pax interchange format is an extension of the tar archive format that
eliminates essentially all of the limitations of historic tar formats in
a standard fashion that is supported by POSIX-compliant pax(1) implemen‐
tations on many systems as well as several newer implementations of
- tar(1). Note that the default write format will suppress the pax
- extended attributes for most entries; explicitly requesting pax format
- will enable those attributes for all entries.
+ tar(1). Note that the default write format will suppress the pax ex‐
+ tended attributes for most entries; explicitly requesting pax format will
+ enable those attributes for all entries.
The read and write APIs are accessed through the archive_read_XXX() func‐
tions and the archive_write_XXX() functions, respectively, and either can
@@ -68,8 +68,8 @@ WRITING AN ARCHIVE
See archive_write(3).
WRITING ENTRIES TO DISK
- The archive_write_disk(3) API allows you to write archive_entry(3)
- objects to disk using the same API used by archive_write(3). The
+ The archive_write_disk(3) API allows you to write archive_entry(3) ob‐
+ jects to disk using the same API used by archive_write(3). The
archive_write_disk(3) API is used internally by archive_read_extract();
using it directly can provide greater control over how entries get writ‐
ten to disk. This API also makes it possible to share code between ar‐
@@ -106,10 +106,10 @@ RETURN VALUES
The return value indicates the general severity of the error, ranging
from ARCHIVE_WARN, which indicates a minor problem that should probably
be reported to the user, to ARCHIVE_FATAL, which indicates a serious
- problem that will prevent any further operations on this archive. On
- error, the archive_errno() function can be used to retrieve a numeric
- error code (see errno(2)). The archive_error_string() returns a textual
- error message suitable for display.
+ problem that will prevent any further operations on this archive. On er‐
+ ror, the archive_errno() function can be used to retrieve a numeric error
+ code (see errno(2)). The archive_error_string() returns a textual error
+ message suitable for display.
archive_read_new() and archive_write_new() return pointers to an allo‐
cated and initialized struct archive object.
@@ -137,10 +137,10 @@ AUTHORS
BUGS
Some archive formats support information that is not supported by struct
- archive_entry. Such information cannot be fully archived or restored
- using this library. This includes, for example, comments, character
- sets, or the arbitrary key/value pairs that can appear in pax interchange
- format archives.
+ archive_entry. Such information cannot be fully archived or restored us‐
+ ing this library. This includes, for example, comments, character sets,
+ or the arbitrary key/value pairs that can appear in pax interchange for‐
+ mat archives.
Conversely, of course, not all of the information that can be stored in
an struct archive_entry is supported by all formats. For example, cpio