doc/text/archive_read_filter.3.txt

   1 ARCHIVE_READ_FILTER(3)   BSD Library Functions Manual   ARCHIVE_READ_FILTER(3)
   2
   3 1mNAME0m
   4      1marchive_read_support_filter_all22m, 1marchive_read_support_filter_bzip222m,
   5      1marchive_read_support_filter_compress22m, 1marchive_read_support_filter_gzip22m,
   6      1marchive_read_support_filter_lz422m, 1marchive_read_support_filter_lzma22m,
   7      1marchive_read_support_filter_none22m, 1marchive_read_support_filter_rpm22m,
   8      1marchive_read_support_filter_uu22m, 1marchive_read_support_filter_xz22m,
   9      1marchive_read_support_filter_program22m,
  10      1marchive_read_support_filter_program_signature 22m— functions for reading
  11      streaming archives
  12
  13 1mLIBRARY0m
  14      Streaming Archive Library (libarchive, -larchive)
  15
  16 1mSYNOPSIS0m
  17      1m#include <archive.h>0m
  18
  19      4mint0m
  20      1marchive_read_support_filter_all22m(4mstruct24m 4marchive24m 4m*24m);
  21
  22      4mint0m
  23      1marchive_read_support_filter_bzip222m(4mstruct24m 4marchive24m 4m*24m);
  24
  25      4mint0m
  26      1marchive_read_support_filter_compress22m(4mstruct24m 4marchive24m 4m*24m);
  27
  28      4mint0m
  29      1marchive_read_support_filter_grzip22m(4mstruct24m 4marchive24m 4m*24m);
  30
  31      4mint0m
  32      1marchive_read_support_filter_gzip22m(4mstruct24m 4marchive24m 4m*24m);
  33
  34      4mint0m
  35      1marchive_read_support_filter_lrzip22m(4mstruct24m 4marchive24m 4m*24m);
  36
  37      4mint0m
  38      1marchive_read_support_filter_lz422m(4mstruct24m 4marchive24m 4m*24m);
  39
  40      4mint0m
  41      1marchive_read_support_filter_lzma22m(4mstruct24m 4marchive24m 4m*24m);
  42
  43      4mint0m
  44      1marchive_read_support_filter_lzop22m(4mstruct24m 4marchive24m 4m*24m);
  45
  46      4mint0m
  47      1marchive_read_support_filter_none22m(4mstruct24m 4marchive24m 4m*24m);
  48
  49      4mint0m
  50      1marchive_read_support_filter_rpm22m(4mstruct24m 4marchive24m 4m*24m);
  51
  52      4mint0m
  53      1marchive_read_support_filter_uu22m(4mstruct24m 4marchive24m 4m*24m);
  54
  55      4mint0m
  56      1marchive_read_support_filter_xz22m(4mstruct24m 4marchive24m 4m*24m);
  57
  58      4mint0m
  59      1marchive_read_support_filter_program22m(4mstruct24m 4marchive24m 4m*24m, 4mconst24m 4mchar24m 4m*cmd24m);
  60
  61      4mint0m
  62      1marchive_read_support_filter_program_signature22m(4mstruct24m 4marchive24m 4m*24m,
  63          4mconst24m 4mchar24m 4m*cmd24m, 4mconst24m 4mvoid24m 4m*signature24m, 4msize_t24m 4msignature_length24m);
  64
  65 1mDESCRIPTION0m
  66      1marchive_read_support_filter_bzip222m(),
  67              1marchive_read_support_filter_compress22m(),
  68              1marchive_read_support_filter_grzip22m(),
  69              1marchive_read_support_filter_gzip22m(),
  70              1marchive_read_support_filter_lrzip22m(),
  71              1marchive_read_support_filter_lz422m(),
  72              1marchive_read_support_filter_lzma22m(),
  73              1marchive_read_support_filter_lzop22m(),
  74              1marchive_read_support_filter_none22m(),
  75              1marchive_read_support_filter_rpm22m(),
  76              1marchive_read_support_filter_uu22m(),
  77              1marchive_read_support_filter_xz22m()
  78              Enables auto-detection code and decompression support for the
  79              specified compression.  These functions may fall back on external
  80              programs if an appropriate library was not available at build
  81              time.  Decompression using an external program is usually slower
  82              than decompression through built-in libraries.  Note that “none”
  83              is always enabled by default.
  84      1marchive_read_support_filter_all22m()
  85              Enables all available decompression filters.
  86      1marchive_read_support_filter_program22m()
  87              Data is fed through the specified external program before being
  88              dearchived.  Note that this disables automatic detection of the
  89              compression format, so it makes no sense to specify this in con‐
  90              junction with any other decompression option.
  91      1marchive_read_support_filter_program_signature22m()
  92              This feeds data through the specified external program but only
  93              if the initial bytes of the data match the specified signature
  94              value.
  95
  96 1mRETURN VALUES0m
  97      These functions return 1mARCHIVE_OK 22mif the compression is fully supported,
  98      1mARCHIVE_WARN 22mif the compression is supported only through an external
  99      program.
 100
 101      1marchive_read_support_filter_none22m() always succeeds.
 102
 103 1mERRORS0m
 104      Detailed error codes and textual descriptions are available from the
 105      1marchive_errno22m() and 1marchive_error_string22m() functions.
 106
 107 1mSEE ALSO0m
 108      libarchive(3), archive_read(3), archive_read_data(3),
 109      archive_read_format(3), archive_read_format(3)
 110
 111 BSD                             August 14, 2014                            BSD