source-git / libarchive

Clone
Source Code
GIT

Blame doc/html/archive_entry.3.html

c8 c8s master
  1.   cc8190ec3d70c1de180e29fbbd40106e3d7cc46b
  2.   doc
  3.   html
  4.   archive_entry.3.html
Blob History Raw
Packit Service 1d0348
Packit Service 1d0348
Packit Service 1d0348
Packit Service 1d0348 
"http://www.w3.org/TR/html4/loose.dtd">
Packit Service 1d0348 
<html>
Packit Service 1d0348 
<head>
Packit Service 1d0348 
<meta name="generator" content="groff -Thtml, see www.gnu.org">
Packit Service 1d0348 
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
Packit Service 1d0348 
<meta name="Content-Style" content="text/css">
Packit Service 1d0348 
<style type="text/css">
Packit Service 1d0348 
       p       { margin-top: 0; margin-bottom: 0; vertical-align: top }
Packit Service 1d0348 
       pre     { margin-top: 0; margin-bottom: 0; vertical-align: top }
Packit Service 1d0348 
       table   { margin-top: 0; margin-bottom: 0; vertical-align: top }
Packit Service 1d0348 
       h1      { text-align: center }
Packit Service 1d0348 
</style>
Packit Service 1d0348 
<title></title>
Packit Service 1d0348 
</head>
Packit Service 1d0348 
<body>
Packit Service 1d0348
Packit Service 1d0348
Packit Service 1d0348
Packit Service 1d0348
Packit Service 1d0348 
ARCHIVE_ENTRY(3) BSD Library Functions Manual
Packit Service 1d0348 
ARCHIVE_ENTRY(3)
Packit Service 1d0348
Packit Service 1d0348 
NAME
Packit Service 1d0348
Packit Service 1d0348 
archive_entry_clear,
Packit Service 1d0348 
archive_entry_clone, archive_entry_free,
Packit Service 1d0348 
archive_entry_new, — functions for managing
Packit Service 1d0348 
archive entry descriptions
Packit Service 1d0348
Packit Service 1d0348 
LIBRARY
Packit Service 1d0348
Packit Service 1d0348 
Streaming Archive Library
Packit Service 1d0348 
(libarchive, -larchive)
Packit Service 1d0348
Packit Service 1d0348 
SYNOPSIS
Packit Service 1d0348
Packit Service 1d0348 
#include
Packit Service 1d0348 
<archive_entry.h>
Packit Service 1d0348
Packit Service 1d0348 
struct
Packit Service 1d0348 
archive_entry *
Packit Service 1d0348
Packit Service 1d0348
Packit Service 1d0348 
archive_entry_clear(struct archive_entry *);
Packit Service 1d0348
Packit Service 1d0348 
struct
Packit Service 1d0348 
archive_entry *
Packit Service 1d0348
Packit Service 1d0348
Packit Service 1d0348 
archive_entry_clone(struct archive_entry *);
Packit Service 1d0348
Packit Service 1d0348 
void
Packit Service 1d0348
Packit Service 1d0348
Packit Service 1d0348 
archive_entry_free(struct archive_entry *);
Packit Service 1d0348
Packit Service 1d0348 
struct
Packit Service 1d0348 
archive_entry *
Packit Service 1d0348
Packit Service 1d0348
Packit Service 1d0348 
archive_entry_new(void);
Packit Service 1d0348
Packit Service 1d0348 
DESCRIPTION
Packit Service 1d0348
Packit Service 1d0348 
These functions create and
Packit Service 1d0348 
manipulate data objects that represent entries within an
Packit Service 1d0348 
archive. You can think of a struct archive_entry as a
Packit Service 1d0348 
heavy-duty version of struct stat: it includes everything
Packit Service 1d0348 
from struct stat plus associated pathname, textual group and
Packit Service 1d0348 
user names, etc. These objects are used by libarchive(3) to
Packit Service 1d0348 
represent the metadata associated with a particular entry in
Packit Service 1d0348 
an archive.
Packit Service 1d0348
Packit Service 1d0348 
Create and
Packit Service 1d0348 
Destroy
Packit Service 1d0348 
There are functions to allocate, destroy, clear, and copy
Packit Service 1d0348 
archive_entry objects:
Packit Service 1d0348
Packit Service 1d0348 
archive_entry_clear()
Packit Service 1d0348
Packit Service 1d0348 
Erases the object, resetting
Packit Service 1d0348 
all internal fields to the same state as a newly-created
Packit Service 1d0348 
object. This is provided to allow you to quickly recycle
Packit Service 1d0348 
objects without thrashing the heap.
Packit Service 1d0348
Packit Service 1d0348 
archive_entry_clone()
Packit Service 1d0348
Packit Service 1d0348 
A deep copy operation; all text
Packit Service 1d0348 
fields are duplicated.
Packit Service 1d0348
Packit Service 1d0348 
archive_entry_free()
Packit Service 1d0348
Packit Service 1d0348 
Releases the struct
Packit Service 1d0348 
archive_entry object.
Packit Service 1d0348
Packit Service 1d0348 
archive_entry_new()
Packit Service 1d0348
Packit Service 1d0348 
Allocate and return a blank
Packit Service 1d0348 
struct archive_entry object.
Packit Service 1d0348
Packit Service 1d0348 
Function
Packit Service 1d0348 
groups
Packit Service 1d0348 
Due to high number of functions, the accessor functions can
Packit Service 1d0348 
be found in man pages grouped by the purpose.
Packit Service 1d0348
Packit Service 1d0348 
archive_entry_acl(3)
Packit Service 1d0348
Packit Service 1d0348 
Access Control
Packit Service 1d0348 
List manipulation
Packit Service 1d0348
Packit Service 1d0348 
archive_entry_paths(3)
Packit Service 1d0348
Packit Service 1d0348 
Path name
Packit Service 1d0348 
manipulation
Packit Service 1d0348
Packit Service 1d0348 
archive_entry_perms(3)
Packit Service 1d0348
Packit Service 1d0348 
User, group and
Packit Service 1d0348 
mode manipulation
Packit Service 1d0348
Packit Service 1d0348 
archive_entry_stat(3)
Packit Service 1d0348
Packit Service 1d0348 
Functions not
Packit Service 1d0348 
in the other groups and copying to/from struct
Packit Service 1d0348 
stat.
Packit Service 1d0348
Packit Service 1d0348 
archive_entry_time(3)
Packit Service 1d0348
Packit Service 1d0348 
Time field
Packit Service 1d0348 
manipulation
Packit Service 1d0348
Packit Service 1d0348 
Most of the
Packit Service 1d0348 
functions set or read entries in an object. Such functions
Packit Service 1d0348 
have one of the following forms:
Packit Service 1d0348
Packit Service 1d0348 
archive_entry_set_XXXX()
Packit Service 1d0348
Packit Service 1d0348 
Stores the provided data in the
Packit Service 1d0348 
object. In particular, for strings, the pointer is stored,
Packit Service 1d0348 
not the referenced string.
Packit Service 1d0348
Packit Service 1d0348 
archive_entry_copy_XXXX()
Packit Service 1d0348
Packit Service 1d0348 
As above, except that the
Packit Service 1d0348 
referenced data is copied into the object.
Packit Service 1d0348
Packit Service 1d0348 
archive_entry_XXXX()
Packit Service 1d0348
Packit Service 1d0348 
Returns the specified data. In
Packit Service 1d0348 
the case of strings, a const-qualified pointer to the string
Packit Service 1d0348 
is returned.
Packit Service 1d0348
Packit Service 1d0348 
String data can be set or
Packit Service 1d0348 
accessed as wide character strings or normal char
Packit Service 1d0348 
strings. The functions that use wide character strings are
Packit Service 1d0348 
suffixed with _w. Note that these are different
Packit Service 1d0348 
representations of the same data: For example, if you store
Packit Service 1d0348 
a narrow string and read the corresponding wide string, the
Packit Service 1d0348 
object will transparently convert formats using the current
Packit Service 1d0348 
locale. Similarly, if you store a wide string and then store
Packit Service 1d0348 
a narrow string for the same data, the previously-set wide
Packit Service 1d0348 
string will be discarded in favor of the new data.
Packit Service 1d0348
Packit Service 1d0348 
SEE ALSO
Packit Service 1d0348
Packit Service 1d0348 
archive_entry_acl(3),
Packit Service 1d0348 
archive_entry_paths(3), archive_entry_perms(3),
Packit Service 1d0348 
archive_entry_time(3) libarchive(3),
Packit Service 1d0348
Packit Service 1d0348 
HISTORY
Packit Service 1d0348
Packit Service 1d0348 
The libarchive library
Packit Service 1d0348 
first appeared in FreeBSD 5.3.
Packit Service 1d0348
Packit Service 1d0348 
AUTHORS
Packit Service 1d0348
Packit Service 1d0348 
The libarchive library
Packit Service 1d0348 
was written by Tim Kientzle <kientzle@acm.org>.
Packit Service 1d0348
Packit Service 1d0348 
BSD
Packit Service 1d0348 
February 2, 2012 BSD
Packit Service 1d0348
Packit Service 1d0348 
</body>
Packit Service 1d0348 
</html>

Powered by Pagure 5.14.1

SSH Hostkey/Fingerprint | Documentation