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.Dd February 2, 2012 26.Dt ARCHIVE_WRITE_FREE 3 27.Os 28.Sh NAME 29.Nm archive_write_fail , 30.Nm archive_write_close , 31.Nm archive_write_finish , 32.Nm archive_write_free 33.Nd functions for creating archives 34.Sh LIBRARY 35Streaming Archive Library (libarchive, -larchive) 36.Sh SYNOPSIS 37.In archive.h 38.Ft int 39.Fn archive_write_fail "struct archive *" 40.Ft int 41.Fn archive_write_close "struct archive *" 42.Ft int 43.Fn archive_write_finish "struct archive *" 44.Ft int 45.Fn archive_write_free "struct archive *" 46.Sh DESCRIPTION 47.Bl -tag -width indent 48.It Fn archive_write_fail 49Always returns 50.Cm ARCHIVE_FATAL . 51This marks the archive object as being unusable; 52after calling this function, the only call that can succeed is 53.Fn archive_write_free 54to release the resources. 55This can be used to speed recovery when the archive creation 56must be aborted. 57Note that the created archive is likely to be malformed in this case; 58.It Fn archive_write_close 59Complete the archive and invoke the close callback. 60.It Fn archive_write_finish 61This is a deprecated synonym for 62.Fn archive_write_free . 63.It Fn archive_write_free 64Invokes 65.Fn archive_write_close 66if necessary, then releases all resources. 67If you need detailed information about 68.Fn archive_write_close 69failures, you should be careful to call it separately, as 70you cannot obtain error information after 71.Fn archive_write_free 72returns. 73.El 74.\" .Sh EXAMPLE 75.Sh RETURN VALUES 76These functions return 77.Cm ARCHIVE_OK 78on success, or 79.Cm ARCHIVE_FATAL . 80.\" 81.Sh ERRORS 82Detailed error codes and textual descriptions are available from the 83.Fn archive_errno 84and 85.Fn archive_error_string 86functions. 87.\" 88.Sh SEE ALSO 89.Xr tar 1 , 90.Xr archive_write_set_options 3 , 91.Xr libarchive 3 , 92.Xr cpio 5 , 93.Xr mtree 5 , 94.Xr tar 5 95