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_HEADER 3 29.Os 30.Sh NAME 31.Nm archive_write_header 32.Nd functions for creating archives 33.Sh LIBRARY 34Streaming Archive Library (libarchive, -larchive) 35.Sh SYNOPSIS 36.In archive.h 37.Ft int 38.Fn archive_write_header "struct archive *" "struct archive_entry *" 39.Sh DESCRIPTION 40Build and write a header using the data in the provided 41.Tn struct archive_entry 42structure. 43See 44.Xr archive_entry 3 45for information on creating and populating 46.Tn struct archive_entry 47objects. 48.\" .Sh EXAMPLE 49.Sh RETURN VALUES 50This function returns 51.Cm ARCHIVE_OK 52on success, or one of the following on error: 53.Cm ARCHIVE_RETRY 54for operations that might succeed if retried, 55.Cm ARCHIVE_WARN 56for unusual conditions that do not prevent further operations, and 57.Cm ARCHIVE_FATAL 58for serious errors that make remaining operations impossible. 59.\" 60.Sh ERRORS 61Detailed error codes and textual descriptions are available from the 62.Fn archive_errno 63and 64.Fn archive_error_string 65functions. 66.\" 67.Sh SEE ALSO 68.Xr tar 1 , 69.Xr archive_write_set_options 3 , 70.Xr libarchive 3 , 71.Xr cpio 5 , 72.Xr mtree 5 , 73.Xr tar 5 74