444807bb41
try to set ACLs even if fflag restore fails, first cut at reading Solaris tar ACLs Code improvement: merge gnu tar read support into main tar reader; this eliminates a lot of duplicate code and generalizes the tar reader to handle formats with GNU-like extensions. Style: Makefile cleanup, eliminate 'dmalloc' references, remove 'tartype' from archive_entry (this makes archive_entry more format-agnostic) Thanks to: David Magda for providing Solaris tar test files
214 lines
6.9 KiB
Groff
214 lines
6.9 KiB
Groff
.\" Copyright (c) 2003-2004 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 December 15, 2003
|
|
.Dt archive_entry 3
|
|
.Os
|
|
.Sh NAME
|
|
.Nm archive_entry_clear
|
|
.Nm archive_entry_clone
|
|
.Nm archive_entry_copy_gname_w
|
|
.Nm archive_entry_copy_hardlink_w
|
|
.Nm archive_entry_copy_pathname_w
|
|
.Nm archive_entry_copy_stat
|
|
.Nm archive_entry_copy_symlink_w
|
|
.Nm archive_entry_copy_uname_w
|
|
.Nm archive_entry_free
|
|
.Nm archive_entry_gname
|
|
.Nm archive_entry_gname_w
|
|
.Nm archive_entry_hardlink
|
|
.Nm archive_entry_hardlink_w
|
|
.Nm archive_entry_new
|
|
.Nm archive_entry_pathname
|
|
.Nm archive_entry_pathname_w
|
|
.Nm archive_entry_set_devmajor
|
|
.Nm archive_entry_set_devminor
|
|
.Nm archive_entry_set_gid
|
|
.Nm archive_entry_set_gname
|
|
.Nm archive_entry_set_hardlink
|
|
.Nm archive_entry_set_mode
|
|
.Nm archive_entry_set_pathname
|
|
.Nm archive_entry_set_symlink
|
|
.Nm archive_entry_set_uid
|
|
.Nm archive_entry_set_uname
|
|
.Nm archive_entry_size
|
|
.Nm archive_entry_stat
|
|
.Nm archive_entry_symlink
|
|
.Nm archive_entry_symlink_w
|
|
.Nm archive_entry_uname
|
|
.Nm archive_entry_uname_w
|
|
.Nd functions for manipulating archive entry descriptions
|
|
.Sh SYNOPSIS
|
|
.In archive_entry.h
|
|
.Ft void
|
|
.Fn archive_entry_clear "struct archive_entry *"
|
|
.Ft struct archive_entry *
|
|
.Fn archive_entry_clone "struct archive_entry *"
|
|
.Ft void
|
|
.Fn archive_entry_copy_gname_w "struct archive_entry *" "const wchar_t *"
|
|
.Ft void
|
|
.Fn archive_entry_copy_hardlink_w "struct archive_entry *" "const wchar_t *"
|
|
.Ft void
|
|
.Fn archive_entry_copy_pathname_w "struct archive_entry *" "const wchar_t *"
|
|
.Ft void
|
|
.Fn archive_entry_copy_stat "struct archive_entry *" "struct stat *"
|
|
.Ft void
|
|
.Fn archive_entry_copy_symlink_w "struct archive_entry *" "const wchar_t *"
|
|
.Ft void
|
|
.Fn archive_entry_copy_uname_w "struct archive_entry *" "const wchar_t *"
|
|
.Ft void
|
|
.Fn archive_entry_free "struct archive_entry *"
|
|
.Ft const char *
|
|
.Fn archive_entry_gname "struct archive_entry *"
|
|
.Ft const wchar_t *
|
|
.Fn archive_entry_gname_w "struct archive_entry *"
|
|
.Ft const char *
|
|
.Fn archive_entry_hardlink "struct archive_entry *"
|
|
.Ft const wchar_t *
|
|
.Fn archive_entry_hardlink_w "struct archive_entry *"
|
|
.Ft struct archive_entry *
|
|
.Fn archive_entry_new "void"
|
|
.Ft const char *
|
|
.Fn archive_entry_pathname "struct archive_entry *"
|
|
.Ft const wchar_t *
|
|
.Fn archive_entry_pathname_w "struct archive_entry *"
|
|
.Ft void
|
|
.Fn archive_entry_set_devmajor "struct archive_entry *" "dev_t"
|
|
.Ft void
|
|
.Fn archive_entry_set_devminor "struct archive_entry *" "dev_t"
|
|
.Ft void
|
|
.Fn archive_entry_set_gid "struct archive_entry *" "gid_t"
|
|
.Ft void
|
|
.Fn archive_entry_set_gname "struct archive_entry *" "const char *"
|
|
.Ft void
|
|
.Fn archive_entry_set_hardlink "struct archive_entry *" "const char *"
|
|
.Ft void
|
|
.Fn archive_entry_set_mode "struct archive_entry *" "mode_t"
|
|
.Ft void
|
|
.Fn archive_entry_set_pathname "struct archive_entry *" "const char *"
|
|
.Ft void
|
|
.Fn archive_entry_set_symlink "struct archive_entry *" "const char *"
|
|
.Ft void
|
|
.Fn archive_entry_set_uid "struct archive_entry *" "uid_t"
|
|
.Ft void
|
|
.Fn archive_entry_set_uname "struct archive_entry *" "const char *"
|
|
.Ft int64_t
|
|
.Fn archive_entry_size "struct archive_entry *"
|
|
.Ft const struct stat *
|
|
.Fn archive_entry_stat "struct archive_entry *"
|
|
.Ft const char *
|
|
.Fn archive_entry_symlink "struct archive_entry *"
|
|
.Ft const wchar_t *
|
|
.Fn archive_entry_symlink_w "struct archive_entry *"
|
|
.Ft const char *
|
|
.Fn archive_entry_uname "struct archive_entry *"
|
|
.Ft const wchar_t *
|
|
.Fn archive_entry_uname_w "struct archive_entry *"
|
|
.Sh DESCRIPTION
|
|
These functions create and manipulate data objects that
|
|
represent entries within an archive.
|
|
You can think of a
|
|
.Tn struct archive_entry
|
|
as a heavy-duty version of
|
|
.Tn struct stat :
|
|
it includes everything from
|
|
.Tn struct stat
|
|
plus associated pathname, textual group and user names, etc.
|
|
These objects are used by
|
|
.Xr libarchive 3
|
|
to represent the metadata associated with a particular
|
|
entry in an archive.
|
|
.Pp
|
|
Most of the functions here set or read entries
|
|
in an object. Such functions have one of the
|
|
following forms:
|
|
.Bl -tag -compact -width indent
|
|
.It Fn archive_entry_set_XXXX
|
|
Stores the provided data in the object.
|
|
In particular, for strings, the pointer is stored,
|
|
not the referenced string.
|
|
.It Fn archive_entry_copy_XXXX
|
|
As above, except that the referenced data is copied
|
|
into the object.
|
|
.It Fn archive_entry_XXXX
|
|
Returns the specified data.
|
|
In the case of strings, a const-qualified pointer to
|
|
the string is returned.
|
|
.El
|
|
The string data can be accessed as wide character strings
|
|
(which are suffixed with
|
|
.Cm _w )
|
|
or normal
|
|
.Va char
|
|
strings.
|
|
Note that these are different representations of the same
|
|
data:
|
|
For example, if you store a narrow string and read the corresponding
|
|
wide string, the object will transparently convert formats
|
|
using the current locale.
|
|
Similarly, if you store a wide string and then store a
|
|
narrow string for the same data, the previously-set wide string will
|
|
be discarded in favor of the new data.
|
|
.Pp
|
|
The remaining functions allocate, destroy, clear, and copy
|
|
.Va archive_entry
|
|
objects.
|
|
These functions are described below:
|
|
.Bl -tag -compact -width indent
|
|
.It Fn archive_entry_clear
|
|
Erases the object, resetting all internal fields to the
|
|
same state as a newly-created object.
|
|
This is provided to allow you to quickly recycle objects
|
|
without thrashing the heap.
|
|
.It Fn archive_entry_clone
|
|
A deep copy operation; all text fields are duplicated.
|
|
.It Fn archive_entry_free
|
|
Releases the
|
|
.Tn struct archive_entry
|
|
object.
|
|
.It Fn archive_entry_new
|
|
Allocate and return a blank
|
|
.Tn struct archive_entry
|
|
object.
|
|
.El
|
|
.\" .Sh EXAMPLE
|
|
.\" .Sh RETURN VALUES
|
|
.\" .Sh ERRORS
|
|
.Sh SEE ALSO
|
|
.Xr archive 3
|
|
.Sh HISTORY
|
|
The
|
|
.Nm libarchive
|
|
library first appeared in
|
|
.Fx 5.3 .
|
|
.Sh AUTHORS
|
|
.An -nosplit
|
|
The
|
|
.Nm libarchive
|
|
library was written by
|
|
.An Tim Kientzle Aq kientzle@acm.org .
|
|
.\" .Sh BUGS
|