doc/man/archive_write_filter.3

   1 .TH ARCHIVE_WRITE_FILTER 3 "August 14, 2014" ""
   2 .SH NAME
   3 .ad l
   4 \fB\%archive_write_add_filter_b64encode\fP,
   5 \fB\%archive_write_add_filter_by_name\fP,
   6 \fB\%archive_write_add_filter_bzip2\fP,
   7 \fB\%archive_write_add_filter_compress\fP,
   8 \fB\%archive_write_add_filter_grzip\fP,
   9 \fB\%archive_write_add_filter_gzip\fP,
  10 \fB\%archive_write_add_filter_lrzip\fP,
  11 \fB\%archive_write_add_filter_lz4\fP,
  12 \fB\%archive_write_add_filter_lzip\fP,
  13 \fB\%archive_write_add_filter_lzma\fP,
  14 \fB\%archive_write_add_filter_lzop\fP,
  15 \fB\%archive_write_add_filter_none\fP,
  16 \fB\%archive_write_add_filter_program\fP,
  17 \fB\%archive_write_add_filter_uuencode\fP,
  18 \fB\%archive_write_add_filter_xz\fP,
  19 \fB\%archive_write_add_filter_zstd\fP,
  20 \- functions enabling output filters
  21 .SH LIBRARY
  22 .ad l
  23 Streaming Archive Library (libarchive, -larchive)
  24 .SH SYNOPSIS
  25 .ad l
  26 \fB#include <archive.h>\fP
  27 .br
  28 \fIint\fP
  29 .br
  30 \fB\%archive_write_add_filter_b64encode\fP(\fI\%struct\ archive\ *\fP);
  31 .br
  32 \fIint\fP
  33 .br
  34 \fB\%archive_write_add_filter_bzip2\fP(\fI\%struct\ archive\ *\fP);
  35 .br
  36 \fIint\fP
  37 .br
  38 \fB\%archive_write_add_filter_compress\fP(\fI\%struct\ archive\ *\fP);
  39 .br
  40 \fIint\fP
  41 .br
  42 \fB\%archive_write_add_filter_grzip\fP(\fI\%struct\ archive\ *\fP);
  43 .br
  44 \fIint\fP
  45 .br
  46 \fB\%archive_write_add_filter_gzip\fP(\fI\%struct\ archive\ *\fP);
  47 .br
  48 \fIint\fP
  49 .br
  50 \fB\%archive_write_add_filter_lrzip\fP(\fI\%struct\ archive\ *\fP);
  51 .br
  52 \fIint\fP
  53 .br
  54 \fB\%archive_write_add_filter_lz4\fP(\fI\%struct\ archive\ *\fP);
  55 .br
  56 \fIint\fP
  57 .br
  58 \fB\%archive_write_add_filter_lzip\fP(\fI\%struct\ archive\ *\fP);
  59 .br
  60 \fIint\fP
  61 .br
  62 \fB\%archive_write_add_filter_lzma\fP(\fI\%struct\ archive\ *\fP);
  63 .br
  64 \fIint\fP
  65 .br
  66 \fB\%archive_write_add_filter_lzop\fP(\fI\%struct\ archive\ *\fP);
  67 .br
  68 \fIint\fP
  69 .br
  70 \fB\%archive_write_add_filter_none\fP(\fI\%struct\ archive\ *\fP);
  71 .br
  72 \fIint\fP
  73 .br
  74 \fB\%archive_write_add_filter_program\fP(\fI\%struct\ archive\ *\fP, \fI\%const\ char\ *\ cmd\fP);
  75 .br
  76 \fIint\fP
  77 .br
  78 \fB\%archive_write_add_filter_uuencode\fP(\fI\%struct\ archive\ *\fP);
  79 .br
  80 \fIint\fP
  81 .br
  82 \fB\%archive_write_add_filter_xz\fP(\fI\%struct\ archive\ *\fP);
  83 .br
  84 \fIint\fP
  85 .br
  86 \fB\%archive_write_add_filter_zstd\fP(\fI\%struct\ archive\ *\fP);
  87 .SH DESCRIPTION
  88 .ad l
  89 .RS 5
  90 .TP
  91 \fB\%archive_write_add_filter_bzip2\fP(),
  92 \fB\%archive_write_add_filter_compress\fP(),
  93 \fB\%archive_write_add_filter_grzip\fP(),
  94 \fB\%archive_write_add_filter_gzip\fP(),
  95 \fB\%archive_write_add_filter_lrzip\fP(),
  96 \fB\%archive_write_add_filter_lz4\fP(),
  97 \fB\%archive_write_add_filter_lzip\fP(),
  98 \fB\%archive_write_add_filter_lzma\fP(),
  99 \fB\%archive_write_add_filter_lzop\fP(),
 100 \fB\%archive_write_add_filter_xz\fP(),
 101 \fB\%archive_write_add_filter_zstd\fP(),
 102 The resulting archive will be compressed as specified.
 103 Note that the compressed output is always properly blocked.
 104 .TP
 105 \fB\%archive_write_add_filter_b64encode\fP(),
 106 \fB\%archive_write_add_filter_uuencode\fP(),
 107 The output will be encoded as specified.
 108 The encoded output is always properly blocked.
 109 .TP
 110 \fB\%archive_write_add_filter_none\fP()
 111 This is never necessary.
 112 It is provided only for backwards compatibility.
 113 .TP
 114 \fB\%archive_write_add_filter_program\fP()
 115 The archive will be fed into the specified compression program.
 116 The output of that program is blocked and written to the client
 117 write callbacks.
 118 .RE
 119 .SH RETURN VALUES
 120 .ad l
 121 These functions return
 122 \fBARCHIVE_OK\fP
 123 on success, or
 124 \fBARCHIVE_FATAL\fP.
 125 .SH ERRORS
 126 .ad l
 127 Detailed error codes and textual descriptions are available from the
 128 \fB\%archive_errno\fP()
 129 and
 130 \fB\%archive_error_string\fP()
 131 functions.
 132 .SH SEE ALSO
 133 .ad l
 134 \fBtar\fP(1),
 135 \fBlibarchive\fP(3),
 136 \fBarchive_write\fP(3),
 137 \fBarchive_write_format\fP(3),
 138 \fBarchive_write_set_options\fP(3),
 139 \fBcpio\fP(5),
 140 \fBmtree\fP(5),
 141 \fBtar\fP(5)