doc/wiki/ManPageArchiveReadFilter3.wiki

   1 ARCHIVE_READ_FILTER(3) manual page
   2 == NAME ==
   3 '''archive_read_support_filter_all''',
   4 '''archive_read_support_filter_bzip2''',
   5 '''archive_read_support_filter_compress''',
   6 '''archive_read_support_filter_gzip''',
   7 '''archive_read_support_filter_lz4''',
   8 '''archive_read_support_filter_lzma''',
   9 '''archive_read_support_filter_none''',
  10 '''archive_read_support_filter_rpm''',
  11 '''archive_read_support_filter_uu''',
  12 '''archive_read_support_filter_xz''',
  13 '''archive_read_support_filter_program''',
  14 '''archive_read_support_filter_program_signature'''
  15 - functions for reading streaming archives
  16 == LIBRARY ==
  17 Streaming Archive Library (libarchive, -larchive)
  18 == SYNOPSIS ==
  19 '''<nowiki>#include <archive.h></nowiki>'''
  20 <br>
  21 ''int''
  22 <br>
  23 '''archive_read_support_filter_all'''(''struct archive *'');
  24 <br>
  25 ''int''
  26 <br>
  27 '''archive_read_support_filter_bzip2'''(''struct archive *'');
  28 <br>
  29 ''int''
  30 <br>
  31 '''archive_read_support_filter_compress'''(''struct archive *'');
  32 <br>
  33 ''int''
  34 <br>
  35 '''archive_read_support_filter_grzip'''(''struct archive *'');
  36 <br>
  37 ''int''
  38 <br>
  39 '''archive_read_support_filter_gzip'''(''struct archive *'');
  40 <br>
  41 ''int''
  42 <br>
  43 '''archive_read_support_filter_lrzip'''(''struct archive *'');
  44 <br>
  45 ''int''
  46 <br>
  47 '''archive_read_support_filter_lz4'''(''struct archive *'');
  48 <br>
  49 ''int''
  50 <br>
  51 '''archive_read_support_filter_lzma'''(''struct archive *'');
  52 <br>
  53 ''int''
  54 <br>
  55 '''archive_read_support_filter_lzop'''(''struct archive *'');
  56 <br>
  57 ''int''
  58 <br>
  59 '''archive_read_support_filter_none'''(''struct archive *'');
  60 <br>
  61 ''int''
  62 <br>
  63 '''archive_read_support_filter_rpm'''(''struct archive *'');
  64 <br>
  65 ''int''
  66 <br>
  67 '''archive_read_support_filter_uu'''(''struct archive *'');
  68 <br>
  69 ''int''
  70 <br>
  71 '''archive_read_support_filter_xz'''(''struct archive *'');
  72 <br>
  73 ''int''
  74 <br>
  75 '''archive_read_support_filter_program'''(''struct archive *'', ''const char *cmd'');
  76 <br>
  77 ''int''
  78 <br>
  79 '''archive_read_support_filter_program_signature'''(''struct archive *'', ''const char *cmd'', ''const void *signature'', ''size_t signature_length'');
  80 == DESCRIPTION ==
  81 <dl>
  82 <dt>
  83 '''archive_read_support_filter_bzip2'''(),
  84 '''archive_read_support_filter_compress'''(),
  85 '''archive_read_support_filter_grzip'''(),
  86 '''archive_read_support_filter_gzip'''(),
  87 '''archive_read_support_filter_lrzip'''(),
  88 '''archive_read_support_filter_lz4'''(),
  89 '''archive_read_support_filter_lzma'''(),
  90 '''archive_read_support_filter_lzop'''(),
  91 '''archive_read_support_filter_none'''(),
  92 '''archive_read_support_filter_rpm'''(),
  93 '''archive_read_support_filter_uu'''(),
  94 '''archive_read_support_filter_xz'''()
  95 </dt> <dd>
  96 Enables auto-detection code and decompression support for the
  97 specified compression.
  98 These functions may fall back on external programs if an appropriate
  99 library was not available at build time.
 100 Decompression using an external program is usually slower than
 101 decompression through built-in libraries.
 102 Note that
 103 "none"
 104 is always enabled by default.
 105 </dd><dt>'''archive_read_support_filter_all'''()</dt><dd>
 106 Enables all available decompression filters.
 107 </dd><dt>'''archive_read_support_filter_program'''()</dt><dd>
 108 Data is fed through the specified external program before being dearchived.
 109 Note that this disables automatic detection of the compression format,
 110 so it makes no sense to specify this in conjunction with any other
 111 decompression option.
 112 </dd><dt>'''archive_read_support_filter_program_signature'''()</dt><dd>
 113 This feeds data through the specified external program
 114 but only if the initial bytes of the data match the specified
 115 signature value.
 116 </dd></dl>
 117 == RETURN VALUES ==
 118 These functions return
 119 '''ARCHIVE_OK'''
 120 if the compression is fully supported,
 121 '''ARCHIVE_WARN'''
 122 if the compression is supported only through an external program.
 123
 124 '''archive_read_support_filter_none'''()
 125 always succeeds.
 126 == ERRORS ==
 127 Detailed error codes and textual descriptions are available from the
 128 '''archive_errno'''()
 129 and
 130 '''archive_error_string'''()
 131 functions.
 132 == SEE ALSO ==
 133 [[ManPageLibarchive3]],
 134 [[ManPageArchiveRead3]],
 135 [[ManPageArchiveReadData3]],
 136 [[ManPageArchiveReadFormat3]],
 137 [[ManPageArchiveReadFormat3]]