archive_write_filter (3)

Leading comments

Copyright (c) 2003-2011 Tim Kientzle
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or ...

(The comments found at the beginning of the groff file "man3/archive_write_filter.3".)

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 - functions enabling output filters

LIBRARY

Streaming Archive Library (libarchive, -larchive)

SYNOPSIS

In archive.h Ft int Fn archive_write_add_filter_b64encode struct archive * Ft int Fn archive_write_add_filter_bzip2 struct archive * Ft int Fn archive_write_add_filter_compress struct archive * Ft int Fn archive_write_add_filter_grzip struct archive * Ft int Fn archive_write_add_filter_gzip struct archive * Ft int Fn archive_write_add_filter_lrzip struct archive * Ft int Fn archive_write_add_filter_lz4 struct archive * Ft int Fn archive_write_add_filter_lzip struct archive * Ft int Fn archive_write_add_filter_lzma struct archive * Ft int Fn archive_write_add_filter_lzop struct archive * Ft int Fn archive_write_add_filter_none struct archive * Ft int Fn archive_write_add_filter_program struct archive * const char * cmd Ft int Fn archive_write_add_filter_uuencode struct archive * Ft int Fn archive_write_add_filter_xz struct archive *

DESCRIPTION

Fn archive_write_add_filter_bzip2 , Fn archive_write_add_filter_compress , Fn archive_write_add_filter_grzip , Fn archive_write_add_filter_gzip , Fn archive_write_add_filter_lrzip , Fn archive_write_add_filter_lz4 , Fn archive_write_add_filter_lzip , Fn archive_write_add_filter_lzma , Fn archive_write_add_filter_lzop , Fn archive_write_add_filter_xz ,

The resulting archive will be compressed as specified. Note that the compressed output is always properly blocked.

Fn archive_write_add_filter_b64encode , Fn archive_write_add_filter_uuencode ,

The output will be encoded as specified. The encoded output is always properly blocked.

Fn archive_write_add_filter_none

This is never necessary. It is provided only for backwards compatibility.

Fn archive_write_add_filter_program

The archive will be fed into the specified compression program. 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 Fn archive_errno and Fn archive_error_string functions.

SEE ALSO

tar(1), libarchive(3), archive_write3, archive_write_format3, archive_write_set_options3, cpio(5), mtree(5), tar(5)