contrib/libarchive/libarchive/archive_write_free.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_FREE 3
  29 .Os
  30 .Sh NAME
  31 .Nm archive_write_fail ,
  32 .Nm archive_write_close ,
  33 .Nm archive_write_finish ,
  34 .Nm archive_write_free
  35 .Nd functions for creating archives
  36 .Sh LIBRARY
  37 Streaming Archive Library (libarchive, -larchive)
  38 .Sh SYNOPSIS
  39 .In archive.h
  40 .Ft int
  41 .Fn archive_write_fail "struct archive *"
  42 .Ft int
  43 .Fn archive_write_close "struct archive *"
  44 .Ft int
  45 .Fn archive_write_finish "struct archive *"
  46 .Ft int
  47 .Fn archive_write_free "struct archive *"
  48 .Sh DESCRIPTION
  49 .Bl -tag -width indent
  50 .It Fn archive_write_fail
  51 Always returns
  52 .Cm ARCHIVE_FATAL .
  53 This marks the archive object as being unusable;
  54 after calling this function, the only call that can succeed is
  55 .Fn archive_write_free
  56 to release the resources.
  57 This can be used to speed recovery when the archive creation
  58 must be aborted.
  59 Note that the created archive is likely to be malformed in this case;
  60 .It Fn archive_write_close
  61 Complete the archive and invoke the close callback.
  62 .It Fn archive_write_finish
  63 This is a deprecated synonym for
  64 .Fn archive_write_free .
  65 .It Fn archive_write_free
  66 Invokes
  67 .Fn archive_write_close
  68 if necessary, then releases all resources.
  69 If you need detailed information about
  70 .Fn archive_write_close
  71 failures, you should be careful to call it separately, as
  72 you cannot obtain error information after
  73 .Fn archive_write_free
  74 returns.
  75 .El
  76 .\" .Sh EXAMPLE
  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_set_options 3 ,
  94 .Xr cpio 5 ,
  95 .Xr mtree 5 ,
  96 .Xr tar 5