2011-12-20 03:30:59 +04:00
|
|
|
.\" Copyright (c) 2003-2011 Tim Kientzle
|
|
|
|
.\" All rights reserved.
|
|
|
|
.\"
|
|
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
|
|
.\" modification, are permitted provided that the following conditions
|
|
|
|
.\" are met:
|
|
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
|
|
.\"
|
|
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
|
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
|
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
|
|
.\" SUCH DAMAGE.
|
|
|
|
.\"
|
|
|
|
.\" $FreeBSD$
|
|
|
|
.\"
|
2015-10-21 11:47:34 +03:00
|
|
|
.Dd August 14, 2014
|
2011-12-31 22:54:34 +04:00
|
|
|
.Dt ARCHIVE_READ_FILTER 3
|
2011-12-20 03:30:59 +04:00
|
|
|
.Os
|
|
|
|
.Sh NAME
|
|
|
|
.Nm archive_read_support_filter_all ,
|
|
|
|
.Nm archive_read_support_filter_bzip2 ,
|
|
|
|
.Nm archive_read_support_filter_compress ,
|
|
|
|
.Nm archive_read_support_filter_gzip ,
|
2015-10-21 11:47:34 +03:00
|
|
|
.Nm archive_read_support_filter_lz4 ,
|
2011-12-20 03:30:59 +04:00
|
|
|
.Nm archive_read_support_filter_lzma ,
|
|
|
|
.Nm archive_read_support_filter_none ,
|
2015-10-21 11:47:34 +03:00
|
|
|
.Nm archive_read_support_filter_rpm ,
|
|
|
|
.Nm archive_read_support_filter_uu ,
|
2011-12-20 03:30:59 +04:00
|
|
|
.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
|
|
|
|
.\"
|
2013-02-09 21:17:57 +04:00
|
|
|
.Sh LIBRARY
|
|
|
|
Streaming Archive Library (libarchive, -larchive)
|
2011-12-20 03:30:59 +04:00
|
|
|
.Sh SYNOPSIS
|
|
|
|
.In archive.h
|
|
|
|
.Ft int
|
|
|
|
.Fn archive_read_support_filter_all "struct archive *"
|
|
|
|
.Ft int
|
|
|
|
.Fn archive_read_support_filter_bzip2 "struct archive *"
|
|
|
|
.Ft int
|
|
|
|
.Fn archive_read_support_filter_compress "struct archive *"
|
|
|
|
.Ft int
|
2016-04-30 20:26:35 +03:00
|
|
|
.Fn archive_read_support_filter_grzip "struct archive *"
|
|
|
|
.Ft int
|
2011-12-20 03:30:59 +04:00
|
|
|
.Fn archive_read_support_filter_gzip "struct archive *"
|
|
|
|
.Ft int
|
2016-04-30 20:26:35 +03:00
|
|
|
.Fn archive_read_support_filter_lrzip "struct archive *"
|
|
|
|
.Ft int
|
2015-10-21 11:47:34 +03:00
|
|
|
.Fn archive_read_support_filter_lz4 "struct archive *"
|
|
|
|
.Ft int
|
2011-12-20 03:30:59 +04:00
|
|
|
.Fn archive_read_support_filter_lzma "struct archive *"
|
|
|
|
.Ft int
|
2015-10-21 11:47:34 +03:00
|
|
|
.Fn archive_read_support_filter_lzop "struct archive *"
|
|
|
|
.Ft int
|
2011-12-20 03:30:59 +04:00
|
|
|
.Fn archive_read_support_filter_none "struct archive *"
|
|
|
|
.Ft int
|
2015-10-21 11:47:34 +03:00
|
|
|
.Fn archive_read_support_filter_rpm "struct archive *"
|
|
|
|
.Ft int
|
|
|
|
.Fn archive_read_support_filter_uu "struct archive *"
|
|
|
|
.Ft int
|
2011-12-20 03:30:59 +04:00
|
|
|
.Fn archive_read_support_filter_xz "struct archive *"
|
|
|
|
.Ft int
|
|
|
|
.Fo archive_read_support_filter_program
|
|
|
|
.Fa "struct archive *"
|
|
|
|
.Fa "const char *cmd"
|
|
|
|
.Fc
|
|
|
|
.Ft int
|
|
|
|
.Fo archive_read_support_filter_program_signature
|
|
|
|
.Fa "struct archive *"
|
|
|
|
.Fa "const char *cmd"
|
|
|
|
.Fa "const void *signature"
|
|
|
|
.Fa "size_t signature_length"
|
|
|
|
.Fc
|
|
|
|
.\"
|
|
|
|
.Sh DESCRIPTION
|
|
|
|
.Bl -tag -compact -width indent
|
|
|
|
.It Xo
|
|
|
|
.Fn archive_read_support_filter_bzip2 ,
|
|
|
|
.Fn archive_read_support_filter_compress ,
|
2016-04-30 20:26:35 +03:00
|
|
|
.Fn archive_read_support_filter_grzip ,
|
2011-12-20 03:30:59 +04:00
|
|
|
.Fn archive_read_support_filter_gzip ,
|
2016-04-30 20:26:35 +03:00
|
|
|
.Fn archive_read_support_filter_lrzip ,
|
2015-10-21 11:47:34 +03:00
|
|
|
.Fn archive_read_support_filter_lz4 ,
|
2011-12-20 03:30:59 +04:00
|
|
|
.Fn archive_read_support_filter_lzma ,
|
2015-10-21 11:47:34 +03:00
|
|
|
.Fn archive_read_support_filter_lzop ,
|
2011-12-20 03:30:59 +04:00
|
|
|
.Fn archive_read_support_filter_none ,
|
2015-10-21 11:47:34 +03:00
|
|
|
.Fn archive_read_support_filter_rpm ,
|
|
|
|
.Fn archive_read_support_filter_uu ,
|
2011-12-20 03:30:59 +04:00
|
|
|
.Fn archive_read_support_filter_xz
|
|
|
|
.Xc
|
|
|
|
Enables auto-detection code and decompression support for the
|
|
|
|
specified compression.
|
|
|
|
These functions may fall back on external programs if an appropriate
|
|
|
|
library was not available at build time.
|
|
|
|
Decompression using an external program is usually slower than
|
|
|
|
decompression through built-in libraries.
|
|
|
|
Note that
|
|
|
|
.Dq none
|
|
|
|
is always enabled by default.
|
|
|
|
.It Fn archive_read_support_filter_all
|
|
|
|
Enables all available decompression filters.
|
|
|
|
.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_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.
|
|
|
|
.El
|
|
|
|
.\"
|
|
|
|
.\". Sh EXAMPLE
|
|
|
|
.\"
|
|
|
|
.Sh RETURN VALUES
|
|
|
|
These functions return
|
|
|
|
.Cm ARCHIVE_OK
|
|
|
|
if the compression is fully supported,
|
|
|
|
.Cm ARCHIVE_WARN
|
|
|
|
if the compression is supported only through an external program.
|
|
|
|
.Pp
|
|
|
|
.Fn archive_read_support_filter_none
|
|
|
|
always succeeds.
|
|
|
|
.\"
|
|
|
|
.Sh ERRORS
|
|
|
|
Detailed error codes and textual descriptions are available from the
|
|
|
|
.Fn archive_errno
|
|
|
|
and
|
|
|
|
.Fn archive_error_string
|
|
|
|
functions.
|
|
|
|
.\"
|
|
|
|
.Sh SEE ALSO
|
|
|
|
.Xr libarchive 3 ,
|
|
|
|
.Xr archive_read 3 ,
|
|
|
|
.Xr archive_read_data 3 ,
|
|
|
|
.Xr archive_read_format 3 ,
|
|
|
|
.Xr archive_read_format 3
|