|
|
|
|
.\" Copyright (c) 2003-2011 Tim Kientzle
|
|
|
|
|
.\" All rights reserved.
|
|
|
|
|
.\"
|
|
|
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
|
|
|
.\" modification, are permitted provided that the following conditions
|
|
|
|
|
.\" are met:
|
|
|
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
|
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
|
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
|
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
|
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
|
|
|
.\"
|
|
|
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
|
|
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
|
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
|
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
|
|
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
|
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
|
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
|
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
|
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
|
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
|
|
|
.\" SUCH DAMAGE.
|
|
|
|
|
.\"
|
|
|
|
|
.\" $FreeBSD$
|
|
|
|
|
.\"
|
|
|
|
|
.Dd February 14, 2013
|
|
|
|
|
.Dt ARCHIVE_WRITE_FORMAT 3
|
|
|
|
|
.Os
|
|
|
|
|
.Sh NAME
|
|
|
|
|
.Nm archive_write_set_format_cpio ,
|
|
|
|
|
.Nm archive_write_set_format_pax ,
|
|
|
|
|
.Nm archive_write_set_format_pax_restricted ,
|
|
|
|
|
.Nm archive_write_set_format_raw ,
|
|
|
|
|
.Nm archive_write_set_format_shar ,
|
|
|
|
|
.Nm archive_write_set_format_shar_dump ,
|
|
|
|
|
.Nm archive_write_set_format_ustar ,
|
|
|
|
|
.Nm archive_write_set_format_filter_by_ext ,
|
|
|
|
|
.Nm archive_write_set_format_filter_by_ext_def
|
|
|
|
|
.Nd functions for creating archives
|
|
|
|
|
.Sh LIBRARY
|
|
|
|
|
Streaming Archive Library (libarchive, -larchive)
|
|
|
|
|
.Sh SYNOPSIS
|
|
|
|
|
.In archive.h
|
|
|
|
|
.Ft int
|
|
|
|
|
.Fn archive_write_set_format_cpio "struct archive *"
|
|
|
|
|
.Ft int
|
|
|
|
|
.Fn archive_write_set_format_pax "struct archive *"
|
|
|
|
|
.Ft int
|
|
|
|
|
.Fn archive_write_set_format_pax_restricted "struct archive *"
|
|
|
|
|
.Ft int
|
|
|
|
|
.Fn archive_write_set_format_raw "struct archive *"
|
|
|
|
|
.Ft int
|
|
|
|
|
.Fn archive_write_set_format_shar "struct archive *"
|
|
|
|
|
.Ft int
|
|
|
|
|
.Fn archive_write_set_format_shar_dump "struct archive *"
|
|
|
|
|
.Ft int
|
|
|
|
|
.Fn archive_write_set_format_ustar "struct archive *"
|
|
|
|
|
.Ft int
|
|
|
|
|
.Fn archive_write_set_format_filter_by_ext "struct archive *" "const char *"
|
|
|
|
|
.Ft int
|
|
|
|
|
.Fn archive_write_set_format_filter_by_ext_def "struct archive *" "const char *" "const char *"
|
|
|
|
|
.Sh DESCRIPTION
|
|
|
|
|
These functions set the format that will be used for the archive.
|
|
|
|
|
.Pp
|
|
|
|
|
The library can write
|
|
|
|
|
POSIX octet-oriented cpio format archives,
|
|
|
|
|
POSIX-standard
|
|
|
|
|
.Dq pax interchange
|
|
|
|
|
format archives,
|
|
|
|
|
traditional
|
|
|
|
|
.Dq shar
|
|
|
|
|
archives,
|
|
|
|
|
enhanced
|
|
|
|
|
.Dq dump
|
|
|
|
|
shar archives that store a variety of file attributes and handle binary files,
|
|
|
|
|
and
|
|
|
|
|
POSIX-standard
|
|
|
|
|
.Dq ustar
|
|
|
|
|
archives.
|
|
|
|
|
The pax interchange format is a backwards-compatible tar format that
|
|
|
|
|
adds key/value attributes to each entry and supports arbitrary
|
|
|
|
|
filenames, linknames, uids, sizes, etc.
|
|
|
|
|
.Dq Restricted pax interchange format
|
|
|
|
|
is the library default; this is the same as pax format, but suppresses
|
|
|
|
|
the pax extended header for most normal files.
|
|
|
|
|
In most cases, this will result in ordinary ustar archives.
|
|
|
|
|
.Bl -tag -width indent
|
|
|
|
|
.It Xo
|
|
|
|
|
.Fn archive_write_set_format_filter_by_ext ,
|
|
|
|
|
.Fn archive_write_set_format_filter_by_ext_def
|
|
|
|
|
.Xc
|
|
|
|
|
Format and filter for archive can be set automatically, based on output file name extension.
|
|
|
|
|
The functions are platform dependent.
|
|
|
|
|
Supported extensions: .7z, .zip, .jar, .cpio, .iso, .a, .ar, .tar, .tgz, .tar.gz, .tar.bz2, .tar.xz
|
|
|
|
|
.\"
|
|
|
|
|
.Sh RETURN VALUES
|
|
|
|
|
These functions return
|
|
|
|
|
.Cm ARCHIVE_OK
|
|
|
|
|
on success, or
|
|
|
|
|
.Cm ARCHIVE_FATAL .
|
|
|
|
|
.\"
|
|
|
|
|
.Sh ERRORS
|
|
|
|
|
Detailed error codes and textual descriptions are available from the
|
|
|
|
|
.Fn archive_errno
|
|
|
|
|
and
|
|
|
|
|
.Fn archive_error_string
|
|
|
|
|
functions.
|
|
|
|
|
.\"
|
|
|
|
|
.Sh SEE ALSO
|
|
|
|
|
.Xr tar 1 ,
|
|
|
|
|
.Xr libarchive 3 ,
|
|
|
|
|
.Xr archive_write 3 ,
|
|
|
|
|
.Xr archive_write_set_options 3 ,
|
|
|
|
|
.Xr cpio 5 ,
|
|
|
|
|
.Xr mtree 5 ,
|
|
|
|
|
.Xr tar 5
|
