contrib/libarchive/libarchive/archive_write_filter.3

   1 .\" Copyright (c) 2003-2011 Tim Kientzle
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd February 2, 2012
  28 .Dt ARCHIVE_WRITE_FILTER 3
  29 .Os
  30 .Sh NAME
  31 .Nm archive_write_add_filter_bzip2 ,
  32 .Nm archive_write_add_filter_compress ,
  33 .Nm archive_write_add_filter_gzip ,
  34 .Nm archive_write_add_filter_lzip ,
  35 .Nm archive_write_add_filter_lzma ,
  36 .Nm archive_write_add_filter_none ,
  37 .Nm archive_write_add_filter_program ,
  38 .Nm archive_write_add_filter_xz
  39 .Nd functions for writing streaming archives
  40 .Sh LIBRARY
  41 Streaming Archive Library (libarchive, -larchive)
  42 .Sh SYNOPSIS
  43 .In archive.h
  44 .Ft int
  45 .Fn archive_write_add_filter_bzip2 "struct archive *"
  46 .Ft int
  47 .Fn archive_write_add_filter_compress "struct archive *"
  48 .Ft int
  49 .Fn archive_write_add_filter_gzip "struct archive *"
  50 .Ft int
  51 .Fn archive_write_add_filter_lzip "struct archive *"
  52 .Ft int
  53 .Fn archive_write_add_filter_lzma "struct archive *"
  54 .Ft int
  55 .Fn archive_write_add_filter_none "struct archive *"
  56 .Ft int
  57 .Fn archive_write_add_filter_program "struct archive *" "const char * cmd"
  58 .Ft int
  59 .Fn archive_write_add_filter_xz "struct archive *"
  60 .Sh DESCRIPTION
  61 .Bl -tag -width indent
  62 .It Xo
  63 .Fn archive_write_add_filter_bzip2 ,
  64 .Fn archive_write_add_filter_compress ,
  65 .Fn archive_write_add_filter_gzip ,
  66 .Fn archive_write_add_filter_lzip ,
  67 .Fn archive_write_add_filter_lzma ,
  68 .Fn archive_write_add_filter_xz ,
  69 .Xc
  70 The resulting archive will be compressed as specified.
  71 Note that the compressed output is always properly blocked.
  72 .It Fn archive_write_add_filter_none
  73 This is never necessary.
  74 It is provided only for backwards compatibility.
  75 .It Fn archive_write_add_filter_program
  76 The archive will be fed into the specified compression program.
  77 The output of that program is blocked and written to the client
  78 write callbacks.
  79 .El
  80 .Sh RETURN VALUES
  81 These functions return
  82 .Cm ARCHIVE_OK
  83 on success, or
  84 .Cm ARCHIVE_FATAL .
  85 .\"
  86 .Sh ERRORS
  87 Detailed error codes and textual descriptions are available from the
  88 .Fn archive_errno
  89 and
  90 .Fn archive_error_string
  91 functions.
  92 .\"
  93 .Sh SEE ALSO
  94 .Xr tar 1 ,
  95 .Xr libarchive 3 ,
  96 .Xr archive_write 3 ,
  97 .Xr archive_write_format 3 ,
  98 .Xr archive_write_set_options 3 ,
  99 .Xr cpio 5 ,
 100 .Xr mtree 5 ,
 101 .Xr tar 5