Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

archive_write_filter (3archive)

Name

archive_write_filter - archive_write_add_filter_b64encode, archive_write_add_filter_by_name, archive_write_add_filter_bzip2, archive_write_add_filter_compress, archive_write_add_filter_grzip, archive_write_add_filter_gzip, archive_write_add_filter_lrzip, archive_write_add_filter_lz4, archive_write_add_filter_lzip, archive_write_add_filter_lzma, archive_write_add_filter_lzop, archive_write_add_filter_none, archive_write_add_filter_program, archive_write_add_filter_uuencode, functions enabling output filters

Synopsis

#include <archive.h>
int
archive_write_add_filter_b64encode(struct archive *);
int
archive_write_add_filter_bzip2(struct archive *);
int
archive_write_add_filter_compress(struct archive *);
int
archive_write_add_filter_grzip(struct archive *);
int
archive_write_add_filter_gzip(struct archive *);
int
archive_write_add_filter_lrzip(struct archive *);
int
archive_write_add_filter_lz4(struct archive *);
int
archive_write_add_filter_lzip(struct archive *);
int
archive_write_add_filter_lzma(struct archive *);
int
archive_write_add_filter_lzop(struct archive *);
int
archive_write_add_filter_none(struct archive *);
int
archive_write_add_filter_program(struct archive *, const char * cmd);
int
archive_write_add_filter_uuencode(struct archive *);
int
archive_write_add_filter_xz(struct archive *);
int
archive_write_add_filter_zstd(struct archive *);

Description

                                                ARCHIVE_WRITE_FILTER(3archive)



NAME
       archive_write_add_filter_b64encode, archive_write_add_filter_by_name,
       archive_write_add_filter_bzip2, archive_write_add_filter_compress,
       archive_write_add_filter_grzip, archive_write_add_filter_gzip,
       archive_write_add_filter_lrzip, archive_write_add_filter_lz4,
       archive_write_add_filter_lzip, archive_write_add_filter_lzma,
       archive_write_add_filter_lzop, archive_write_add_filter_none,
       archive_write_add_filter_program, archive_write_add_filter_uuencode,
       archive_write_add_filter_xz, archive_write_add_filter_zstd - functions
       enabling output filters

LIBRARY
       Streaming Archive Library (libarchive, -larchive)

SYNOPSIS
       #include <archive.h>
       int
       archive_write_add_filter_b64encode(struct archive *);
       int
       archive_write_add_filter_bzip2(struct archive *);
       int
       archive_write_add_filter_compress(struct archive *);
       int
       archive_write_add_filter_grzip(struct archive *);
       int
       archive_write_add_filter_gzip(struct archive *);
       int
       archive_write_add_filter_lrzip(struct archive *);
       int
       archive_write_add_filter_lz4(struct archive *);
       int
       archive_write_add_filter_lzip(struct archive *);
       int
       archive_write_add_filter_lzma(struct archive *);
       int
       archive_write_add_filter_lzop(struct archive *);
       int
       archive_write_add_filter_none(struct archive *);
       int
       archive_write_add_filter_program(struct archive *, const char * cmd);
       int
       archive_write_add_filter_uuencode(struct archive *);
       int
       archive_write_add_filter_xz(struct archive *);
       int
       archive_write_add_filter_zstd(struct archive *);

DESCRIPTION
            archive_write_add_filter_bzip2(),
                   archive_write_add_filter_compress(),
                   archive_write_add_filter_grzip(),
                   archive_write_add_filter_gzip(),
                   archive_write_add_filter_lrzip(),
                   archive_write_add_filter_lz4(),
                   archive_write_add_filter_lzip(),
                   archive_write_add_filter_lzma(),
                   archive_write_add_filter_lzop(),
                   archive_write_add_filter_xz(),
                   archive_write_add_filter_zstd(), The resulting archive will
                   be compressed as specified.  Note that the compressed out-
                   put is always properly blocked.

            archive_write_add_filter_b64encode(),
                   archive_write_add_filter_uuencode(), The output will be
                   encoded as specified.  The encoded output is always prop-
                   erly blocked.

            archive_write_add_filter_none()
                   This is never necessary.  It is provided only for backwards
                   compatibility.

            archive_write_add_filter_program()
                   The archive will be fed into the specified compression pro-
                   gram.  The output of that program is blocked and written to
                   the client write callbacks.

RETURN VALUES
       These functions return ARCHIVE_OK on success, or ARCHIVE_FATAL.

ERRORS
       Detailed error codes and textual descriptions are available from the
       archive_errno() and archive_error_string() functions.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+--------------------+
       |ATTRIBUTE TYPE |  ATTRIBUTE VALUE   |
       +---------------+--------------------+
       |Availability   | library/libarchive |
       +---------------+--------------------+
       |Stability      | Uncommitted        |
       +---------------+--------------------+

SEE ALSO
       tar(1), archive_write(3), archive_write_format(3), ar-
       chive_write_set_options(3), libarchive(3), mtree(5)



NOTES
       Source code for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This software was built from source available at
       https://github.com/oracle/solaris-userland.  The original community
       source was downloaded from
       https://github.com/libarchive/libarchive/releases/down-
       load/v3.6.1/libarchive-3.6.1.tar.gz.

       Further information about this software can be found on the open source
       community website at http://www.libarchive.org/.



                                August 14, 2014
                                                ARCHIVE_WRITE_FILTER(3archive)