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 August 14, 2014 28.Dt ARCHIVE_WRITE_FILTER 3 29.Os 30.Sh NAME 31.Nm archive_write_add_filter_b64encode , 32.Nm archive_write_add_filter_by_name , 33.Nm archive_write_add_filter_bzip2 , 34.Nm archive_write_add_filter_compress , 35.Nm archive_write_add_filter_grzip , 36.Nm archive_write_add_filter_gzip , 37.Nm archive_write_add_filter_lrzip , 38.Nm archive_write_add_filter_lz4 , 39.Nm archive_write_add_filter_lzip , 40.Nm archive_write_add_filter_lzma , 41.Nm archive_write_add_filter_lzop , 42.Nm archive_write_add_filter_none , 43.Nm archive_write_add_filter_program , 44.Nm archive_write_add_filter_uuencode , 45.Nm archive_write_add_filter_xz , 46.Nm archive_write_add_filter_zstd 47.Nd functions enabling output filters 48.Sh LIBRARY 49Streaming Archive Library (libarchive, -larchive) 50.Sh SYNOPSIS 51.In archive.h 52.Ft int 53.Fn archive_write_add_filter_b64encode "struct archive *" 54.Ft int 55.Fn archive_write_add_filter_bzip2 "struct archive *" 56.Ft int 57.Fn archive_write_add_filter_compress "struct archive *" 58.Ft int 59.Fn archive_write_add_filter_grzip "struct archive *" 60.Ft int 61.Fn archive_write_add_filter_gzip "struct archive *" 62.Ft int 63.Fn archive_write_add_filter_lrzip "struct archive *" 64.Ft int 65.Fn archive_write_add_filter_lz4 "struct archive *" 66.Ft int 67.Fn archive_write_add_filter_lzip "struct archive *" 68.Ft int 69.Fn archive_write_add_filter_lzma "struct archive *" 70.Ft int 71.Fn archive_write_add_filter_lzop "struct archive *" 72.Ft int 73.Fn archive_write_add_filter_none "struct archive *" 74.Ft int 75.Fn archive_write_add_filter_program "struct archive *" "const char * cmd" 76.Ft int 77.Fn archive_write_add_filter_uuencode "struct archive *" 78.Ft int 79.Fn archive_write_add_filter_xz "struct archive *" 80.Ft int 81.Fn archive_write_add_filter_zstd "struct archive *" 82.Sh DESCRIPTION 83.Bl -tag -width indent 84.It Xo 85.Fn archive_write_add_filter_bzip2 , 86.Fn archive_write_add_filter_compress , 87.Fn archive_write_add_filter_grzip , 88.Fn archive_write_add_filter_gzip , 89.Fn archive_write_add_filter_lrzip , 90.Fn archive_write_add_filter_lz4 , 91.Fn archive_write_add_filter_lzip , 92.Fn archive_write_add_filter_lzma , 93.Fn archive_write_add_filter_lzop , 94.Fn archive_write_add_filter_xz , 95.Fn archive_write_add_filter_zstd , 96.Xc 97The resulting archive will be compressed as specified. 98Note that the compressed output is always properly blocked. 99.It Xo 100.Fn archive_write_add_filter_b64encode , 101.Fn archive_write_add_filter_uuencode , 102.Xc 103The output will be encoded as specified. 104The encoded output is always properly blocked. 105.It Fn archive_write_add_filter_none 106This is never necessary. 107It is provided only for backwards compatibility. 108.It Fn archive_write_add_filter_program 109The archive will be fed into the specified compression program. 110The output of that program is blocked and written to the client 111write callbacks. 112.El 113.Sh RETURN VALUES 114These functions return 115.Cm ARCHIVE_OK 116on success, or 117.Cm ARCHIVE_FATAL . 118.\" 119.Sh ERRORS 120Detailed error codes and textual descriptions are available from the 121.Fn archive_errno 122and 123.Fn archive_error_string 124functions. 125.\" 126.Sh SEE ALSO 127.Xr tar 1 , 128.Xr archive_write 3 , 129.Xr archive_write_format 3 , 130.Xr archive_write_set_options 3 , 131.Xr libarchive 3 , 132.Xr cpio 5 , 133.Xr mtree 5 , 134.Xr tar 5 135