doc/html/archive_read_filter.3.html

   1 <!-- Creator     : groff version 1.22.3 -->
   2 <!-- CreationDate: Sat Feb 25 11:22:03 2017 -->
   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
  24 ARCHIVE_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_program</b>,
  40 <b>archive_read_support_filter_program_signature</b> &mdash;
  41 functions for reading streaming archives</p>
  42
  43 <p style="margin-top: 1em"><b>LIBRARY</b></p>
  44
  45 <p style="margin-left:6%;">Streaming Archive Library
  46 (libarchive, -larchive)</p>
  47
  48 <p style="margin-top: 1em"><b>SYNOPSIS</b></p>
  49
  50 <p style="margin-left:6%;"><b>#include
  51 &lt;archive.h&gt;</b></p>
  52
  53 <p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
  54
  55
  56 <p style="margin-left:12%;"><b>archive_read_support_filter_all</b>(<i>struct&nbsp;archive&nbsp;*</i>);</p>
  57
  58 <p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
  59
  60
  61 <p style="margin-left:12%;"><b>archive_read_support_filter_bzip2</b>(<i>struct&nbsp;archive&nbsp;*</i>);</p>
  62
  63 <p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
  64
  65
  66 <p style="margin-left:12%;"><b>archive_read_support_filter_compress</b>(<i>struct&nbsp;archive&nbsp;*</i>);</p>
  67
  68 <p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
  69
  70
  71 <p style="margin-left:12%;"><b>archive_read_support_filter_grzip</b>(<i>struct&nbsp;archive&nbsp;*</i>);</p>
  72
  73 <p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
  74
  75
  76 <p style="margin-left:12%;"><b>archive_read_support_filter_gzip</b>(<i>struct&nbsp;archive&nbsp;*</i>);</p>
  77
  78 <p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
  79
  80
  81 <p style="margin-left:12%;"><b>archive_read_support_filter_lrzip</b>(<i>struct&nbsp;archive&nbsp;*</i>);</p>
  82
  83 <p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
  84
  85
  86 <p style="margin-left:12%;"><b>archive_read_support_filter_lz4</b>(<i>struct&nbsp;archive&nbsp;*</i>);</p>
  87
  88 <p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
  89
  90
  91 <p style="margin-left:12%;"><b>archive_read_support_filter_lzma</b>(<i>struct&nbsp;archive&nbsp;*</i>);</p>
  92
  93 <p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
  94
  95
  96 <p style="margin-left:12%;"><b>archive_read_support_filter_lzop</b>(<i>struct&nbsp;archive&nbsp;*</i>);</p>
  97
  98 <p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
  99
 100
 101 <p style="margin-left:12%;"><b>archive_read_support_filter_none</b>(<i>struct&nbsp;archive&nbsp;*</i>);</p>
 102
 103 <p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
 104
 105
 106 <p style="margin-left:12%;"><b>archive_read_support_filter_rpm</b>(<i>struct&nbsp;archive&nbsp;*</i>);</p>
 107
 108 <p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
 109
 110
 111 <p style="margin-left:12%;"><b>archive_read_support_filter_uu</b>(<i>struct&nbsp;archive&nbsp;*</i>);</p>
 112
 113 <p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
 114
 115
 116 <p style="margin-left:12%;"><b>archive_read_support_filter_xz</b>(<i>struct&nbsp;archive&nbsp;*</i>);</p>
 117
 118 <p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
 119
 120
 121 <p><b>archive_read_support_filter_program</b>(<i>struct&nbsp;archive&nbsp;*</i>,
 122 <i>const&nbsp;char&nbsp;*cmd</i>);</p>
 123
 124 <p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
 125
 126
 127 <p><b>archive_read_support_filter_program_signature</b>(<i>struct&nbsp;archive&nbsp;*</i>,
 128 <i>const&nbsp;char&nbsp;*cmd</i>,
 129 <i>const&nbsp;void&nbsp;*signature</i>,
 130 <i>size_t&nbsp;signature_length</i>);</p>
 131
 132 <p style="margin-top: 1em"><b>DESCRIPTION <br>
 133 archive_read_support_filter_bzip2</b>(),
 134 <b>archive_read_support_filter_compress</b>(),
 135 <b>archive_read_support_filter_grzip</b>(),
 136 <b>archive_read_support_filter_gzip</b>(),
 137 <b>archive_read_support_filter_lrzip</b>(),
 138 <b>archive_read_support_filter_lz4</b>(),
 139 <b>archive_read_support_filter_lzma</b>(),
 140 <b>archive_read_support_filter_lzop</b>(),
 141 <b>archive_read_support_filter_none</b>(),
 142 <b>archive_read_support_filter_rpm</b>(),
 143 <b>archive_read_support_filter_uu</b>(),
 144 <b>archive_read_support_filter_xz</b>()</p>
 145
 146 <p style="margin-left:17%;">Enables auto-detection code and
 147 decompression support for the specified compression. These
 148 functions may fall back on external programs if an
 149 appropriate library was not available at build time.
 150 Decompression using an external program is usually slower
 151 than decompression through built-in libraries. Note that
 152 &lsquo;&lsquo;none&rsquo;&rsquo; is always enabled by
 153 default.</p>
 154
 155 <p><b>archive_read_support_filter_all</b>()</p>
 156
 157 <p style="margin-left:17%;">Enables all available
 158 decompression filters.</p>
 159
 160 <p><b>archive_read_support_filter_program</b>()</p>
 161
 162 <p style="margin-left:17%;">Data is fed through the
 163 specified external program before being dearchived. Note
 164 that this disables automatic detection of the compression
 165 format, so it makes no sense to specify this in conjunction
 166 with any other decompression option.</p>
 167
 168
 169 <p><b>archive_read_support_filter_program_signature</b>()</p>
 170
 171 <p style="margin-left:17%;">This feeds data through the
 172 specified external program but only if the initial bytes of
 173 the data match the specified signature value.</p>
 174
 175 <p style="margin-top: 1em"><b>RETURN VALUES</b></p>
 176
 177 <p style="margin-left:6%;">These functions return
 178 <b>ARCHIVE_OK</b> if the compression is fully supported,
 179 <b>ARCHIVE_WARN</b> if the compression is supported only
 180 through an external program.</p>
 181
 182
 183 <p style="margin-left:6%; margin-top: 1em"><b>archive_read_support_filter_none</b>()
 184 always succeeds.</p>
 185
 186 <p style="margin-top: 1em"><b>ERRORS</b></p>
 187
 188 <p style="margin-left:6%;">Detailed error codes and textual
 189 descriptions are available from the <b>archive_errno</b>()
 190 and <b>archive_error_string</b>() functions.</p>
 191
 192 <p style="margin-top: 1em"><b>SEE ALSO</b></p>
 193
 194 <p style="margin-left:6%;">libarchive(3), archive_read(3),
 195 archive_read_data(3), archive_read_format(3),
 196 archive_read_format(3)</p>
 197
 198 <p style="margin-left:6%; margin-top: 1em">BSD
 199 August&nbsp;14, 2014 BSD</p>
 200 <hr>
 201 </body>
 202 </html>