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_close ,
  32 .Nm archive_write_finish ,
  33 .Nm archive_write_free
  34 .Nd functions for creating archives
  35 .Sh LIBRARY
  36 Streaming Archive Library (libarchive, -larchive)
  37 .Sh SYNOPSIS
  38 .In archive.h
  39 .Ft int
  40 .Fn archive_write_close "struct archive *"
  41 .Ft int
  42 .Fn archive_write_finish "struct archive *"
  43 .Ft int
  44 .Fn archive_write_free "struct archive *"
  45 .Sh DESCRIPTION
  46 .Bl -tag -width indent
  47 .It Fn archive_write_close
  48 Complete the archive and invoke the close callback.
  49 .It Fn archive_write_finish
  50 This is a deprecated synonym for
  51 .Fn archive_write_free .
  52 .It Fn archive_write_free
  53 Invokes
  54 .Fn archive_write_close
  55 if necessary, then releases all resources.
  56 If you need detailed information about
  57 .Fn archive_write_close
  58 failures, you should be careful to call it separately, as
  59 you cannot obtain error information after
  60 .Fn archive_write_free
  61 returns.
  62 .El
  63 .\" .Sh EXAMPLE
  64 .Sh RETURN VALUES
  65 These functions return
  66 .Cm ARCHIVE_OK
  67 on success, or
  68 .Cm ARCHIVE_FATAL .
  69 .\"
  70 .Sh ERRORS
  71 Detailed error codes and textual descriptions are available from the
  72 .Fn archive_errno
  73 and
  74 .Fn archive_error_string
  75 functions.
  76 .\"
  77 .Sh SEE ALSO
  78 .Xr tar 1 ,
  79 .Xr libarchive 3 ,
  80 .Xr archive_write_set_options 3 ,
  81 .Xr cpio 5 ,
  82 .Xr mtree 5 ,
  83 .Xr tar 5