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_FORMAT 3 29.Os 30.Sh NAME 31.Nm archive_write_set_format_cpio , 32.Nm archive_write_set_format_pax , 33.Nm archive_write_set_format_pax_restricted , 34.Nm archive_write_set_format_shar , 35.Nm archive_write_set_format_shar_dump , 36.Nm archive_write_set_format_ustar 37.Nd functions for creating archives 38.Sh LIBRARY 39Streaming Archive Library (libarchive, -larchive) 40.Sh SYNOPSIS 41.In archive.h 42.Ft int 43.Fn archive_write_set_format_cpio "struct archive *" 44.Ft int 45.Fn archive_write_set_format_pax "struct archive *" 46.Ft int 47.Fn archive_write_set_format_pax_restricted "struct archive *" 48.Ft int 49.Fn archive_write_set_format_shar "struct archive *" 50.Ft int 51.Fn archive_write_set_format_shar_dump "struct archive *" 52.Ft int 53.Fn archive_write_set_format_ustar "struct archive *" 54.Sh DESCRIPTION 55These functions set the format that will be used for the archive. 56.Pp 57The library can write 58POSIX octet-oriented cpio format archives, 59POSIX-standard 60.Dq pax interchange 61format archives, 62traditional 63.Dq shar 64archives, 65enhanced 66.Dq dump 67shar archives that store a variety of file attributes and handle binary files, 68and 69POSIX-standard 70.Dq ustar 71archives. 72The pax interchange format is a backwards-compatible tar format that 73adds key/value attributes to each entry and supports arbitrary 74filenames, linknames, uids, sizes, etc. 75.Dq Restricted pax interchange format 76is the library default; this is the same as pax format, but suppresses 77the pax extended header for most normal files. 78In most cases, this will result in ordinary ustar archives. 79.\" 80.Sh RETURN VALUES 81These functions return 82.Cm ARCHIVE_OK 83on success, or 84.Cm ARCHIVE_FATAL . 85.\" 86.Sh ERRORS 87Detailed error codes and textual descriptions are available from the 88.Fn archive_errno 89and 90.Fn archive_error_string 91functions. 92.\" 93.Sh SEE ALSO 94.Xr tar 1 , 95.Xr libarchive 3 , 96.Xr archive_write 3 , 97.Xr archive_write_set_options 3 , 98.Xr cpio 5 , 99.Xr mtree 5 , 100.Xr tar 5 101