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 March 23, 2011
  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 .Sh SYNOPSIS
  40 .In archive.h
  41 .Ft int
  42 .Fn archive_write_add_filter_bzip2 "struct archive *"
  43 .Ft int
  44 .Fn archive_write_add_filter_compress "struct archive *"
  45 .Ft int
  46 .Fn archive_write_add_filter_gzip "struct archive *"
  47 .Ft int
  48 .Fn archive_write_add_filter_lzip "struct archive *"
  49 .Ft int
  50 .Fn archive_write_add_filter_lzma "struct archive *"
  51 .Ft int
  52 .Fn archive_write_add_filter_none "struct archive *"
  53 .Ft int
  54 .Fn archive_write_add_filter_program "struct archive *" "const char * cmd"
  55 .Ft int
  56 .Fn archive_write_add_filter_xz "struct archive *"
  57 .Sh DESCRIPTION
  58 .Bl -tag -width indent
  59 .It Xo
  60 .Fn archive_write_add_filter_bzip2 ,
  61 .Fn archive_write_add_filter_compress ,
  62 .Fn archive_write_add_filter_gzip ,
  63 .Fn archive_write_add_filter_lzip ,
  64 .Fn archive_write_add_filter_lzma ,
  65 .Fn archive_write_add_filter_xz ,
  66 .Xc
  67 The resulting archive will be compressed as specified.
  68 Note that the compressed output is always properly blocked.
  69 .It Fn archive_write_add_filter_none
  70 This is never necessary.
  71 It is provided only for backwards compatibility.
  72 .It Fn archive_write_add_filter_program
  73 The archive will be fed into the specified compression program.
  74 The output of that program is blocked and written to the client
  75 write callbacks.
  76 .El
  77 .Sh RETURN VALUES
  78 These functions return
  79 .Cm ARCHIVE_OK
  80 on success, or
  81 .Cm ARCHIVE_FATAL .
  82 .\"
  83 .Sh ERRORS
  84 Detailed error codes and textual descriptions are available from the
  85 .Fn archive_errno
  86 and
  87 .Fn archive_error_string
  88 functions.
  89 .\"
  90 .Sh SEE ALSO
  91 .Xr tar 1 ,
  92 .Xr libarchive 3 ,
  93 .Xr archive_write 3 ,
  94 .Xr archive_write_format 3 ,
  95 .Xr archive_write_set_options 3 ,
  96 .Xr cpio 5 ,
  97 .Xr mtree 5 ,
  98 .Xr tar 5