1<!-- Creator : groff version 1.22.4 --> 2<!-- CreationDate: Sun Aug 22 23:03:26 2021 --> 3<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" 4"http://www.w3.org/TR/html4/loose.dtd"> 5<html> 6<head> 7<meta name="generator" content="groff -Thtml, see www.gnu.org"> 8<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> 9<meta name="Content-Style" content="text/css"> 10<style type="text/css"> 11 p { margin-top: 0; margin-bottom: 0; vertical-align: top } 12 pre { margin-top: 0; margin-bottom: 0; vertical-align: top } 13 table { margin-top: 0; margin-bottom: 0; vertical-align: top } 14 h1 { text-align: center } 15</style> 16<title></title> 17</head> 18<body> 19 20<hr> 21 22 23<p>ARCHIVE_WRITE_FILTER(3) BSD Library Functions Manual 24ARCHIVE_WRITE_FILTER(3)</p> 25 26<p style="margin-top: 1em"><b>NAME</b></p> 27 28 29<p style="margin-left:6%;"><b>archive_write_add_filter_b64encode</b>, 30<b>archive_write_add_filter_by_name</b>, 31<b>archive_write_add_filter_bzip2</b>, 32<b>archive_write_add_filter_compress</b>, 33<b>archive_write_add_filter_grzip</b>, 34<b>archive_write_add_filter_gzip</b>, 35<b>archive_write_add_filter_lrzip</b>, 36<b>archive_write_add_filter_lz4</b>, 37<b>archive_write_add_filter_lzip</b>, 38<b>archive_write_add_filter_lzma</b>, 39<b>archive_write_add_filter_lzop</b>, 40<b>archive_write_add_filter_none</b>, 41<b>archive_write_add_filter_program</b>, 42<b>archive_write_add_filter_uuencode</b>, 43<b>archive_write_add_filter_xz</b>, 44<b>archive_write_add_filter_zstd</b> — functions 45enabling output filters</p> 46 47<p style="margin-top: 1em"><b>LIBRARY</b></p> 48 49<p style="margin-left:6%;">Streaming Archive Library 50(libarchive, -larchive)</p> 51 52<p style="margin-top: 1em"><b>SYNOPSIS</b></p> 53 54<p style="margin-left:6%;"><b>#include 55<archive.h></b></p> 56 57<p style="margin-left:6%; margin-top: 1em"><i>int</i></p> 58 59 60<p style="margin-left:12%;"><b>archive_write_add_filter_b64encode</b>(<i>struct archive *</i>);</p> 61 62<p style="margin-left:6%; margin-top: 1em"><i>int</i></p> 63 64 65<p style="margin-left:12%;"><b>archive_write_add_filter_bzip2</b>(<i>struct archive *</i>);</p> 66 67<p style="margin-left:6%; margin-top: 1em"><i>int</i></p> 68 69 70<p style="margin-left:12%;"><b>archive_write_add_filter_compress</b>(<i>struct archive *</i>);</p> 71 72<p style="margin-left:6%; margin-top: 1em"><i>int</i></p> 73 74 75<p style="margin-left:12%;"><b>archive_write_add_filter_grzip</b>(<i>struct archive *</i>);</p> 76 77<p style="margin-left:6%; margin-top: 1em"><i>int</i></p> 78 79 80<p style="margin-left:12%;"><b>archive_write_add_filter_gzip</b>(<i>struct archive *</i>);</p> 81 82<p style="margin-left:6%; margin-top: 1em"><i>int</i></p> 83 84 85<p style="margin-left:12%;"><b>archive_write_add_filter_lrzip</b>(<i>struct archive *</i>);</p> 86 87<p style="margin-left:6%; margin-top: 1em"><i>int</i></p> 88 89 90<p style="margin-left:12%;"><b>archive_write_add_filter_lz4</b>(<i>struct archive *</i>);</p> 91 92<p style="margin-left:6%; margin-top: 1em"><i>int</i></p> 93 94 95<p style="margin-left:12%;"><b>archive_write_add_filter_lzip</b>(<i>struct archive *</i>);</p> 96 97<p style="margin-left:6%; margin-top: 1em"><i>int</i></p> 98 99 100<p style="margin-left:12%;"><b>archive_write_add_filter_lzma</b>(<i>struct archive *</i>);</p> 101 102<p style="margin-left:6%; margin-top: 1em"><i>int</i></p> 103 104 105<p style="margin-left:12%;"><b>archive_write_add_filter_lzop</b>(<i>struct archive *</i>);</p> 106 107<p style="margin-left:6%; margin-top: 1em"><i>int</i></p> 108 109 110<p style="margin-left:12%;"><b>archive_write_add_filter_none</b>(<i>struct archive *</i>);</p> 111 112<p style="margin-left:6%; margin-top: 1em"><i>int</i></p> 113 114 115<p style="margin-left:12%;"><b>archive_write_add_filter_program</b>(<i>struct archive *</i>, 116<i>const char * cmd</i>);</p> 117 118<p style="margin-left:6%; margin-top: 1em"><i>int</i></p> 119 120 121<p style="margin-left:12%;"><b>archive_write_add_filter_uuencode</b>(<i>struct archive *</i>);</p> 122 123<p style="margin-left:6%; margin-top: 1em"><i>int</i></p> 124 125 126<p style="margin-left:12%;"><b>archive_write_add_filter_xz</b>(<i>struct archive *</i>);</p> 127 128<p style="margin-left:6%; margin-top: 1em"><i>int</i></p> 129 130 131<p style="margin-left:12%;"><b>archive_write_add_filter_zstd</b>(<i>struct archive *</i>);</p> 132 133<p style="margin-top: 1em"><b>DESCRIPTION <br> 134archive_write_add_filter_bzip2</b>(), 135<b>archive_write_add_filter_compress</b>(), 136<b>archive_write_add_filter_grzip</b>(), 137<b>archive_write_add_filter_gzip</b>(), 138<b>archive_write_add_filter_lrzip</b>(), 139<b>archive_write_add_filter_lz4</b>(), 140<b>archive_write_add_filter_lzip</b>(), 141<b>archive_write_add_filter_lzma</b>(), 142<b>archive_write_add_filter_lzop</b>(), 143<b>archive_write_add_filter_xz</b>(), 144<b>archive_write_add_filter_zstd</b>(),</p> 145 146<p style="margin-left:17%;">The resulting archive will be 147compressed as specified. Note that the compressed output is 148always properly blocked.</p> 149 150 151<p style="margin-top: 1em"><b>archive_write_add_filter_b64encode</b>(), 152<b>archive_write_add_filter_uuencode</b>(),</p> 153 154<p style="margin-left:17%;">The output will be encoded as 155specified. The encoded output is always properly 156blocked.</p> 157 158 159<p style="margin-top: 1em"><b>archive_write_add_filter_none</b>()</p> 160 161<p style="margin-left:17%;">This is never necessary. It is 162provided only for backwards compatibility.</p> 163 164 165<p style="margin-top: 1em"><b>archive_write_add_filter_program</b>()</p> 166 167<p style="margin-left:17%;">The archive will be fed into 168the specified compression program. The output of that 169program is blocked and written to the client write 170callbacks.</p> 171 172<p style="margin-top: 1em"><b>RETURN VALUES</b></p> 173 174<p style="margin-left:6%;">These functions return 175<b>ARCHIVE_OK</b> on success, or <b>ARCHIVE_FATAL</b>.</p> 176 177<p style="margin-top: 1em"><b>ERRORS</b></p> 178 179<p style="margin-left:6%;">Detailed error codes and textual 180descriptions are available from the <b>archive_errno</b>() 181and <b>archive_error_string</b>() functions.</p> 182 183<p style="margin-top: 1em"><b>SEE ALSO</b></p> 184 185<p style="margin-left:6%;">tar(1), archive_write(3), 186archive_write_format(3), archive_write_set_options(3), 187libarchive(3), cpio(5), mtree(5), tar(5)</p> 188 189<p style="margin-left:6%; margin-top: 1em">BSD 190August 14, 2014 BSD</p> 191<hr> 192</body> 193</html> 194