1.\" Copyright (c) 2003-2011 Tim Kientzle 2.\" All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 16.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23.\" SUCH DAMAGE. 24.\" 25.\" $FreeBSD$ 26.\" 27.Dd February 2, 2012 28.Dt ARCHIVE_WRITE_FILTER 3 29.Os 30.Sh NAME 31.Nm archive_write_add_filter_bzip2 , 32.Nm archive_write_add_filter_compress , 33.Nm archive_write_add_filter_gzip , 34.Nm archive_write_add_filter_lzip , 35.Nm archive_write_add_filter_lzma , 36.Nm archive_write_add_filter_none , 37.Nm archive_write_add_filter_program , 38.Nm archive_write_add_filter_xz 39.Sh LIBRARY 40Streaming Archive Library (libarchive, -larchive) 41.Sh SYNOPSIS 42.In archive.h 43.Ft int 44.Fn archive_write_add_filter_bzip2 "struct archive *" 45.Ft int 46.Fn archive_write_add_filter_compress "struct archive *" 47.Ft int 48.Fn archive_write_add_filter_gzip "struct archive *" 49.Ft int 50.Fn archive_write_add_filter_lzip "struct archive *" 51.Ft int 52.Fn archive_write_add_filter_lzma "struct archive *" 53.Ft int 54.Fn archive_write_add_filter_none "struct archive *" 55.Ft int 56.Fn archive_write_add_filter_program "struct archive *" "const char * cmd" 57.Ft int 58.Fn archive_write_add_filter_xz "struct archive *" 59.Sh DESCRIPTION 60.Bl -tag -width indent 61.It Xo 62.Fn archive_write_add_filter_bzip2 , 63.Fn archive_write_add_filter_compress , 64.Fn archive_write_add_filter_gzip , 65.Fn archive_write_add_filter_lzip , 66.Fn archive_write_add_filter_lzma , 67.Fn archive_write_add_filter_xz , 68.Xc 69The resulting archive will be compressed as specified. 70Note that the compressed output is always properly blocked. 71.It Fn archive_write_add_filter_none 72This is never necessary. 73It is provided only for backwards compatibility. 74.It Fn archive_write_add_filter_program 75The archive will be fed into the specified compression program. 76The output of that program is blocked and written to the client 77write callbacks. 78.El 79.Sh RETURN VALUES 80These functions return 81.Cm ARCHIVE_OK 82on success, or 83.Cm ARCHIVE_FATAL . 84.\" 85.Sh ERRORS 86Detailed error codes and textual descriptions are available from the 87.Fn archive_errno 88and 89.Fn archive_error_string 90functions. 91.\" 92.Sh SEE ALSO 93.Xr tar 1 , 94.Xr libarchive 3 , 95.Xr archive_write 3 , 96.Xr archive_write_format 3 , 97.Xr archive_write_set_options 3 , 98.Xr cpio 5 , 99.Xr mtree 5 , 100.Xr tar 5 101