summaryrefslogtreecommitdiff
path: root/libarchive/archive_read_filter.3
diff options
context:
space:
mode:
authorRoman Neuhauser <neuhauser@sigpipe.cz>2011-03-28 05:19:02 -0400
committerRoman Neuhauser <neuhauser@sigpipe.cz>2011-03-28 05:19:02 -0400
commitf70c17e82681b69f1553e02fc816528fc002c78d (patch)
tree37f87cbd5577e23c180c4e1bdbdeb7c72144992e /libarchive/archive_read_filter.3
parent8b723435f2531d2851a94ccaa70f605110ca05b9 (diff)
downloadlibarchive-f70c17e82681b69f1553e02fc816528fc002c78d.tar.gz
man pages: document archive_read_support_filter_XXX
not the deprecated archive_read_support_compression_XXX SVN-Revision: 3106
Diffstat (limited to 'libarchive/archive_read_filter.3')
-rw-r--r--libarchive/archive_read_filter.356
1 files changed, 28 insertions, 28 deletions
diff --git a/libarchive/archive_read_filter.3 b/libarchive/archive_read_filter.3
index ca4f31a0..bf514cf1 100644
--- a/libarchive/archive_read_filter.3
+++ b/libarchive/archive_read_filter.3
@@ -28,40 +28,40 @@
.Dt archive_read_filter 3
.Os
.Sh NAME
-.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_lzma ,
-.Nm archive_read_support_compression_none ,
-.Nm archive_read_support_compression_xz ,
-.Nm archive_read_support_compression_program ,
-.Nm archive_read_support_compression_program_signature
+.Nm archive_read_support_filter_all ,
+.Nm archive_read_support_filter_bzip2 ,
+.Nm archive_read_support_filter_compress ,
+.Nm archive_read_support_filter_gzip ,
+.Nm archive_read_support_filter_lzma ,
+.Nm archive_read_support_filter_none ,
+.Nm archive_read_support_filter_xz ,
+.Nm archive_read_support_filter_program ,
+.Nm archive_read_support_filter_program_signature
.Nd functions for reading streaming archives
.\"
.Sh SYNOPSIS
.In archive.h
.Ft int
-.Fn archive_read_support_compression_all "struct archive *"
+.Fn archive_read_support_filter_all "struct archive *"
.Ft int
-.Fn archive_read_support_compression_bzip2 "struct archive *"
+.Fn archive_read_support_filter_bzip2 "struct archive *"
.Ft int
-.Fn archive_read_support_compression_compress "struct archive *"
+.Fn archive_read_support_filter_compress "struct archive *"
.Ft int
-.Fn archive_read_support_compression_gzip "struct archive *"
+.Fn archive_read_support_filter_gzip "struct archive *"
.Ft int
-.Fn archive_read_support_compression_lzma "struct archive *"
+.Fn archive_read_support_filter_lzma "struct archive *"
.Ft int
-.Fn archive_read_support_compression_none "struct archive *"
+.Fn archive_read_support_filter_none "struct archive *"
.Ft int
-.Fn archive_read_support_compression_xz "struct archive *"
+.Fn archive_read_support_filter_xz "struct archive *"
.Ft int
-.Fo archive_read_support_compression_program
+.Fo archive_read_support_filter_program
.Fa "struct archive *"
.Fa "const char *cmd"
.Fc
.Ft int
-.Fo archive_read_support_compression_program_signature
+.Fo archive_read_support_filter_program_signature
.Fa "struct archive *"
.Fa "const char *cmd"
.Fa "const void *signature"
@@ -71,12 +71,12 @@
.Sh DESCRIPTION
.Bl -tag -compact -width indent
.It Xo
-.Fn archive_read_support_compression_bzip2 ,
-.Fn archive_read_support_compression_compress ,
-.Fn archive_read_support_compression_gzip ,
-.Fn archive_read_support_compression_lzma ,
-.Fn archive_read_support_compression_none ,
-.Fn archive_read_support_compression_xz
+.Fn archive_read_support_filter_bzip2 ,
+.Fn archive_read_support_filter_compress ,
+.Fn archive_read_support_filter_gzip ,
+.Fn archive_read_support_filter_lzma ,
+.Fn archive_read_support_filter_none ,
+.Fn archive_read_support_filter_xz
.Xc
Enables auto-detection code and decompression support for the
specified compression.
@@ -87,14 +87,14 @@ decompression through built-in libraries.
Note that
.Dq none
is always enabled by default.
-.It Fn archive_read_support_compression_all
+.It Fn archive_read_support_filter_all
Enables all available decompression filters.
-.It Fn archive_read_support_compression_program
+.It Fn archive_read_support_filter_program
Data is fed through the specified external program before being dearchived.
Note that this disables automatic detection of the compression format,
so it makes no sense to specify this in conjunction with any other
decompression option.
-.It Fn archive_read_support_compression_program_signature
+.It Fn archive_read_support_filter_program_signature
This feeds data through the specified external program
but only if the initial bytes of the data match the specified
signature value.
@@ -109,7 +109,7 @@ if the compression is fully supported,
.Cm ARCHIVE_WARN
if the compression is supported only through an external program.
.Pp
-.Fn archive_read_support_compression_none
+.Fn archive_read_support_filter_none
always succeeds.
.Pp
Detailed error codes and textual descriptions are available from the