|
Packit |
08bd4c |
ARCHIVE_ENTRY(3) manual page
|
|
Packit |
08bd4c |
== NAME ==
|
|
Packit |
08bd4c |
'''archive_entry_clear''',
|
|
Packit |
08bd4c |
'''archive_entry_clone''',
|
|
Packit |
08bd4c |
'''archive_entry_free''',
|
|
Packit |
08bd4c |
'''archive_entry_new''',
|
|
Packit |
08bd4c |
- functions for managing archive entry descriptions
|
|
Packit |
08bd4c |
== LIBRARY ==
|
|
Packit |
08bd4c |
Streaming Archive Library (libarchive, -larchive)
|
|
Packit |
08bd4c |
== SYNOPSIS ==
|
|
Packit |
08bd4c |
'''<nowiki>#include <archive_entry.h></nowiki>'''
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
''struct archive_entry *''
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
'''archive_entry_clear'''(''struct archive_entry *'');
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
''struct archive_entry *''
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
'''archive_entry_clone'''(''struct archive_entry *'');
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
''void''
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
'''archive_entry_free'''(''struct archive_entry *'');
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
''struct archive_entry *''
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
'''archive_entry_new'''(''void'');
|
|
Packit |
08bd4c |
== DESCRIPTION ==
|
|
Packit |
08bd4c |
These functions create and manipulate data objects that
|
|
Packit |
08bd4c |
represent entries within an archive.
|
|
Packit |
08bd4c |
You can think of a
|
|
Packit |
08bd4c |
'''struct archive_entry'''
|
|
Packit |
08bd4c |
as a heavy-duty version of
|
|
Packit |
08bd4c |
'''struct stat :'''
|
|
Packit |
08bd4c |
it includes everything from
|
|
Packit |
08bd4c |
'''struct stat'''
|
|
Packit |
08bd4c |
plus associated pathname, textual group and user names, etc.
|
|
Packit |
08bd4c |
These objects are used by
|
|
Packit |
08bd4c |
[[ManPageibarchive3]]
|
|
Packit |
08bd4c |
to represent the metadata associated with a particular
|
|
Packit |
08bd4c |
entry in an archive.
|
|
Packit |
08bd4c |
=== Create and Destroy===
|
|
Packit |
08bd4c |
There are functions to allocate, destroy, clear, and copy
|
|
Packit |
08bd4c |
''archive_entry''
|
|
Packit |
08bd4c |
objects:
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
'''archive_entry_clear'''()
|
|
Packit |
08bd4c |
Erases the object, resetting all internal fields to the
|
|
Packit |
08bd4c |
same state as a newly-created object.
|
|
Packit |
08bd4c |
This is provided to allow you to quickly recycle objects
|
|
Packit |
08bd4c |
without thrashing the heap.
|
|
Packit |
08bd4c |
'''archive_entry_clone'''()
|
|
Packit |
08bd4c |
A deep copy operation; all text fields are duplicated.
|
|
Packit |
08bd4c |
'''archive_entry_free'''()
|
|
Packit |
08bd4c |
Releases the
|
|
Packit |
08bd4c |
'''struct archive_entry'''
|
|
Packit |
08bd4c |
object.
|
|
Packit |
08bd4c |
'''archive_entry_new'''()
|
|
Packit |
08bd4c |
Allocate and return a blank
|
|
Packit |
08bd4c |
'''struct archive_entry'''
|
|
Packit |
08bd4c |
object.
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
=== Function groups===
|
|
Packit |
08bd4c |
Due to high number of functions, the accessor functions can be found in
|
|
Packit |
08bd4c |
man pages grouped by the purpose.
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
[[ManPagerchiventrycl3]]
|
|
Packit |
08bd4c |
Access Control List manipulation
|
|
Packit |
08bd4c |
[[ManPagerchiventryaths3]]
|
|
Packit |
08bd4c |
Path name manipulation
|
|
Packit |
08bd4c |
[[ManPagerchiventryerms3]]
|
|
Packit |
08bd4c |
User, group and mode manipulation
|
|
Packit |
08bd4c |
[[ManPagerchiventrytat3]]
|
|
Packit |
08bd4c |
Functions not in the other groups and copying to/from
|
|
Packit |
08bd4c |
''struct'' stat.
|
|
Packit |
08bd4c |
[[ManPagerchiventryime3]]
|
|
Packit |
08bd4c |
Time field manipulation
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
Most of the functions set or read entries in an object.
|
|
Packit |
08bd4c |
Such functions have one of the following forms:
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
'''archive_entry_set_XXXX'''()
|
|
Packit |
08bd4c |
Stores the provided data in the object.
|
|
Packit |
08bd4c |
In particular, for strings, the pointer is stored,
|
|
Packit |
08bd4c |
not the referenced string.
|
|
Packit |
08bd4c |
'''archive_entry_copy_XXXX'''()
|
|
Packit |
08bd4c |
As above, except that the referenced data is copied
|
|
Packit |
08bd4c |
into the object.
|
|
Packit |
08bd4c |
'''archive_entry_XXXX'''()
|
|
Packit |
08bd4c |
Returns the specified data.
|
|
Packit |
08bd4c |
In the case of strings, a const-qualified pointer to
|
|
Packit |
08bd4c |
the string is returned.
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
String data can be set or accessed as wide character strings
|
|
Packit |
08bd4c |
or normal
|
|
Packit |
08bd4c |
''char''
|
|
Packit |
08bd4c |
strings.
|
|
Packit |
08bd4c |
The functions that use wide character strings are suffixed with
|
|
Packit |
08bd4c |
'''_w'''.
|
|
Packit |
08bd4c |
Note that these are different representations of the same data:
|
|
Packit |
08bd4c |
For example, if you store a narrow string and read the corresponding
|
|
Packit |
08bd4c |
wide string, the object will transparently convert formats
|
|
Packit |
08bd4c |
using the current locale.
|
|
Packit |
08bd4c |
Similarly, if you store a wide string and then store a
|
|
Packit |
08bd4c |
narrow string for the same data, the previously-set wide string will
|
|
Packit |
08bd4c |
be discarded in favor of the new data.
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
== SEE ALSO ==
|
|
Packit |
08bd4c |
[[ManPagerchiventrycl3]],
|
|
Packit |
08bd4c |
[[ManPagerchiventryaths3]],
|
|
Packit |
08bd4c |
[[ManPagerchiventryerms3]],
|
|
Packit |
08bd4c |
[[ManPagerchiventryime3]]
|
|
Packit |
08bd4c |
[[ManPageibarchive3]],
|
|
Packit |
08bd4c |
== HISTORY ==
|
|
Packit |
08bd4c |
The
|
|
Packit |
08bd4c |
'''libarchive'''
|
|
Packit |
08bd4c |
library first appeared in
|
|
Packit |
08bd4c |
FreeBSD 5.3.
|
|
Packit |
08bd4c |
== AUTHORS ==
|
|
Packit |
08bd4c |
The
|
|
Packit |
08bd4c |
'''libarchive'''
|
|
Packit |
08bd4c |
library was written by
|
|
Packit |
08bd4c |
Tim Kientzle <kientzle@acm.org.>
|