1<!-- Creator : groff version 1.22.4 --> 2<!-- CreationDate: Sun Aug 22 23:03:25 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_READ_FILTER(3) BSD Library Functions Manual 24ARCHIVE_READ_FILTER(3)</p> 25 26<p style="margin-top: 1em"><b>NAME</b></p> 27 28 29<p style="margin-left:6%;"><b>archive_read_support_filter_all</b>, 30<b>archive_read_support_filter_bzip2</b>, 31<b>archive_read_support_filter_compress</b>, 32<b>archive_read_support_filter_gzip</b>, 33<b>archive_read_support_filter_lz4</b>, 34<b>archive_read_support_filter_lzma</b>, 35<b>archive_read_support_filter_none</b>, 36<b>archive_read_support_filter_rpm</b>, 37<b>archive_read_support_filter_uu</b>, 38<b>archive_read_support_filter_xz</b>, 39<b>archive_read_support_filter_zstd</b>, 40<b>archive_read_support_filter_program</b>, 41<b>archive_read_support_filter_program_signature</b> — 42functions for reading streaming archives</p> 43 44<p style="margin-top: 1em"><b>LIBRARY</b></p> 45 46<p style="margin-left:6%;">Streaming Archive Library 47(libarchive, -larchive)</p> 48 49<p style="margin-top: 1em"><b>SYNOPSIS</b></p> 50 51<p style="margin-left:6%;"><b>#include 52<archive.h></b></p> 53 54<p style="margin-left:6%; margin-top: 1em"><i>int</i></p> 55 56 57<p style="margin-left:12%;"><b>archive_read_support_filter_all</b>(<i>struct archive *</i>);</p> 58 59<p style="margin-left:6%; margin-top: 1em"><i>int</i></p> 60 61 62<p style="margin-left:12%;"><b>archive_read_support_filter_by_code</b>(<i>struct archive *</i>, 63<i>int</i>);</p> 64 65<p style="margin-left:6%; margin-top: 1em"><i>int</i></p> 66 67 68<p style="margin-left:12%;"><b>archive_read_support_filter_bzip2</b>(<i>struct archive *</i>);</p> 69 70<p style="margin-left:6%; margin-top: 1em"><i>int</i></p> 71 72 73<p style="margin-left:12%;"><b>archive_read_support_filter_compress</b>(<i>struct archive *</i>);</p> 74 75<p style="margin-left:6%; margin-top: 1em"><i>int</i></p> 76 77 78<p style="margin-left:12%;"><b>archive_read_support_filter_grzip</b>(<i>struct archive *</i>);</p> 79 80<p style="margin-left:6%; margin-top: 1em"><i>int</i></p> 81 82 83<p style="margin-left:12%;"><b>archive_read_support_filter_gzip</b>(<i>struct archive *</i>);</p> 84 85<p style="margin-left:6%; margin-top: 1em"><i>int</i></p> 86 87 88<p style="margin-left:12%;"><b>archive_read_support_filter_lrzip</b>(<i>struct archive *</i>);</p> 89 90<p style="margin-left:6%; margin-top: 1em"><i>int</i></p> 91 92 93<p style="margin-left:12%;"><b>archive_read_support_filter_lz4</b>(<i>struct archive *</i>);</p> 94 95<p style="margin-left:6%; margin-top: 1em"><i>int</i></p> 96 97 98<p style="margin-left:12%;"><b>archive_read_support_filter_lzma</b>(<i>struct archive *</i>);</p> 99 100<p style="margin-left:6%; margin-top: 1em"><i>int</i></p> 101 102 103<p style="margin-left:12%;"><b>archive_read_support_filter_lzop</b>(<i>struct archive *</i>);</p> 104 105<p style="margin-left:6%; margin-top: 1em"><i>int</i></p> 106 107 108<p style="margin-left:12%;"><b>archive_read_support_filter_none</b>(<i>struct archive *</i>);</p> 109 110<p style="margin-left:6%; margin-top: 1em"><i>int</i></p> 111 112 113<p style="margin-left:12%;"><b>archive_read_support_filter_rpm</b>(<i>struct archive *</i>);</p> 114 115<p style="margin-left:6%; margin-top: 1em"><i>int</i></p> 116 117 118<p style="margin-left:12%;"><b>archive_read_support_filter_uu</b>(<i>struct archive *</i>);</p> 119 120<p style="margin-left:6%; margin-top: 1em"><i>int</i></p> 121 122 123<p style="margin-left:12%;"><b>archive_read_support_filter_xz</b>(<i>struct archive *</i>);</p> 124 125<p style="margin-left:6%; margin-top: 1em"><i>int</i></p> 126 127 128<p style="margin-left:12%;"><b>archive_read_support_filter_zstd</b>(<i>struct archive *</i>);</p> 129 130<p style="margin-left:6%; margin-top: 1em"><i>int</i></p> 131 132 133<p><b>archive_read_support_filter_program</b>(<i>struct archive *</i>, 134<i>const char *cmd</i>);</p> 135 136<p style="margin-left:6%; margin-top: 1em"><i>int</i></p> 137 138 139<p><b>archive_read_support_filter_program_signature</b>(<i>struct archive *</i>, 140<i>const char *cmd</i>, 141<i>const void *signature</i>, 142<i>size_t signature_length</i>);</p> 143 144<p style="margin-top: 1em"><b>DESCRIPTION <br> 145archive_read_support_filter_bzip2</b>(), 146<b>archive_read_support_filter_compress</b>(), 147<b>archive_read_support_filter_grzip</b>(), 148<b>archive_read_support_filter_gzip</b>(), 149<b>archive_read_support_filter_lrzip</b>(), 150<b>archive_read_support_filter_lz4</b>(), 151<b>archive_read_support_filter_lzma</b>(), 152<b>archive_read_support_filter_lzop</b>(), 153<b>archive_read_support_filter_none</b>(), 154<b>archive_read_support_filter_rpm</b>(), 155<b>archive_read_support_filter_uu</b>(), 156<b>archive_read_support_filter_xz</b>(), 157<b>archive_read_support_filter_zstd</b>(),</p> 158 159<p style="margin-left:17%;">Enables auto-detection code and 160decompression support for the specified compression. These 161functions may fall back on external programs if an 162appropriate library was not available at build time. 163Decompression using an external program is usually slower 164than decompression through built-in libraries. Note that 165“none” is always enabled by default.</p> 166 167<p><b>archive_read_support_filter_all</b>()</p> 168 169<p style="margin-left:17%;">Enables all available 170decompression filters.</p> 171 172<p><b>archive_read_support_filter_by_code</b>()</p> 173 174<p style="margin-left:17%;">Enables a single filter 175specified by the filter code. This function does not work 176with <b>ARCHIVE_FILTER_PROGRAM</b>. Note: In 177statically-linked executables, this will cause your program 178to include support for every filter. If executable size is a 179concern, you may wish to avoid using this function.</p> 180 181<p><b>archive_read_support_filter_program</b>()</p> 182 183<p style="margin-left:17%;">Data is fed through the 184specified external program before being dearchived. Note 185that this disables automatic detection of the compression 186format, so it makes no sense to specify this in conjunction 187with any other decompression option.</p> 188 189 190<p><b>archive_read_support_filter_program_signature</b>()</p> 191 192<p style="margin-left:17%;">This feeds data through the 193specified external program but only if the initial bytes of 194the data match the specified signature value.</p> 195 196<p style="margin-top: 1em"><b>RETURN VALUES</b></p> 197 198<p style="margin-left:6%;">These functions return 199<b>ARCHIVE_OK</b> if the compression is fully supported, 200<b>ARCHIVE_WARN</b> if the compression is supported only 201through an external program.</p> 202 203 204<p style="margin-left:6%; margin-top: 1em"><b>archive_read_support_filter_none</b>() 205always succeeds.</p> 206 207<p style="margin-top: 1em"><b>ERRORS</b></p> 208 209<p style="margin-left:6%;">Detailed error codes and textual 210descriptions are available from the <b>archive_errno</b>() 211and <b>archive_error_string</b>() functions.</p> 212 213<p style="margin-top: 1em"><b>SEE ALSO</b></p> 214 215<p style="margin-left:6%;">archive_read(3), 216archive_read_data(3), archive_read_format(3), 217archive_read_format(3), libarchive(3)</p> 218 219<p style="margin-left:6%; margin-top: 1em">BSD June 9, 2202020 BSD</p> 221<hr> 222</body> 223</html> 224