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