Document support for reading .Z compressed archives.

Correct a few other minor nits.
This commit is contained in:
Tim Kientzle 2004-05-27 04:21:52 +00:00
parent 5d425e1c12
commit 2023cfd41b
Notes: svn2git 2020-12-20 02:59:44 +00:00
svn path=/head/; revision=129768
2 changed files with 15 additions and 17 deletions

View file

@ -30,12 +30,12 @@
.Sh NAME
.Nm archive_read_new ,
.Nm archive_read_set_bytes_per_block ,
.Nm archive_read_support_compression_none ,
.Nm archive_read_support_compression_gzip ,
.Nm archive_read_support_compression_bzip2 ,
.Nm archive_read_support_compression_all ,
.Nm archive_read_support_compression_bzip2 ,
.Nm archive_read_support_compression_compress ,
.Nm archive_read_support_compression_gzip ,
.Nm archive_read_support_compression_none ,
.Nm archive_read_support_format_tar ,
.Nm archive_read_support_format_gnutar ,
.Nm archive_read_support_format_cpio ,
.Nm archive_read_support_format_all ,
.Nm archive_read_open ,
@ -57,18 +57,18 @@
.Ft int
.Fn archive_read_set_bytes_per_block "struct archive *" "int"
.Ft int
.Fn archive_read_support_compression_none "struct archive *"
.Ft int
.Fn archive_read_support_compression_gzip "struct archive *"
.Fn archive_read_support_compression_all "struct archive *"
.Ft int
.Fn archive_read_support_compression_bzip2 "struct archive *"
.Ft int
.Fn archive_read_support_compression_all "struct archive *"
.Fn archive_read_support_compression_compress "struct archive *"
.Ft int
.Fn archive_read_support_compression_gzip "struct archive *"
.Ft int
.Fn archive_read_support_compression_none "struct archive *"
.Ft int
.Fn archive_read_support_format_tar "struct archive *"
.Ft int
.Fn archive_read_support_format_gnutar "struct archive *"
.Ft int
.Fn archive_read_support_format_cpio "struct archive *"
.Ft int
.Fn archive_read_support_format_all "struct archive *"
@ -317,7 +317,7 @@ The possible return codes include:
.Cm ARCHIVE_READ_WARN
(the operation succeeded but a non-critical error was encountered)
.Cm ARCHIVE_READ_EOF
(the operation failed because end-of-archive was encountered),
(end-of-archive was encountered),
.Cm ARCHIVE_READ_RETRY
(the operation failed but can be retried),
and
@ -358,7 +358,7 @@ then return one of the non-zero values above.
(Note that the value eventually returned to the client may
not be the same; many errors that are not critical at the level
of basic I/O can prevent the archive from being properly read,
thus most errors eventually cause
thus most I/O errors eventually cause
.Cm ARCHIVE_FATAL
to be returned.)
.\" .Sh ERRORS

View file

@ -62,9 +62,10 @@ GNU-format tar archives,
POSIX octet-oriented cpio archives.
.El
The library automatically detects archives compressed with
.Xr gzip 1
.Xr gzip 1 ,
.Xr bzip2 1 ,
or
.Xr bzip2 1
.Xr compress 1
and decompresses them transparently.
.Pp
When writing an archive, you can specify the compression
@ -279,7 +280,6 @@ and
.Fn archive_error_string
functions can be used to obtain more information.
.Sh ENVIRONMENT
The library currently obeys no environment variables.
There are character set conversions within the
.Xr archive_entry
functions that are impacted by the currently-selected locale.
@ -318,5 +318,3 @@ old tar formats do not support large device numbers.
.Pp
The library cannot write pre-POSIX tar archives.
The support for GNU tar format is incomplete.
.Pp
Support for ACLs is still evolving and subject to change.