doc/man/archive_read_filter.3

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