Blame doc/html/archive_entry.3.html

Packit 08bd4c
Packit 08bd4c
Packit 08bd4c
Packit 08bd4c
"http://www.w3.org/TR/html4/loose.dtd">
Packit 08bd4c
<html>
Packit 08bd4c
<head>
Packit 08bd4c
<meta name="generator" content="groff -Thtml, see www.gnu.org">
Packit 08bd4c
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
Packit 08bd4c
<meta name="Content-Style" content="text/css">
Packit 08bd4c
<style type="text/css">
Packit 08bd4c
       p       { margin-top: 0; margin-bottom: 0; vertical-align: top }
Packit 08bd4c
       pre     { margin-top: 0; margin-bottom: 0; vertical-align: top }
Packit 08bd4c
       table   { margin-top: 0; margin-bottom: 0; vertical-align: top }
Packit 08bd4c
       h1      { text-align: center }
Packit 08bd4c
</style>
Packit 08bd4c
<title></title>
Packit 08bd4c
</head>
Packit 08bd4c
<body>
Packit 08bd4c
Packit 08bd4c

Packit 08bd4c
Packit 08bd4c
Packit 08bd4c

ARCHIVE_ENTRY(3) BSD Library Functions Manual

Packit 08bd4c
ARCHIVE_ENTRY(3)

Packit 08bd4c
Packit 08bd4c

NAME

Packit 08bd4c
Packit 08bd4c

archive_entry_clear,

Packit 08bd4c
archive_entry_clone, archive_entry_free,
Packit 08bd4c
archive_entry_new, — functions for managing
Packit 08bd4c
archive entry descriptions

Packit 08bd4c
Packit 08bd4c

LIBRARY

Packit 08bd4c
Packit 08bd4c

Streaming Archive Library

Packit 08bd4c
(libarchive, -larchive)

Packit 08bd4c
Packit 08bd4c

SYNOPSIS

Packit 08bd4c
Packit 08bd4c

#include

Packit 08bd4c
<archive_entry.h>

Packit 08bd4c
Packit 08bd4c

struct

Packit 08bd4c
archive_entry *

Packit 08bd4c
Packit 08bd4c
Packit 08bd4c

archive_entry_clear(struct archive_entry *);

Packit 08bd4c
Packit 08bd4c

struct

Packit 08bd4c
archive_entry *

Packit 08bd4c
Packit 08bd4c
Packit 08bd4c

archive_entry_clone(struct archive_entry *);

Packit 08bd4c
Packit 08bd4c

void

Packit 08bd4c
Packit 08bd4c
Packit 08bd4c

archive_entry_free(struct archive_entry *);

Packit 08bd4c
Packit 08bd4c

struct

Packit 08bd4c
archive_entry *

Packit 08bd4c
Packit 08bd4c
Packit 08bd4c

archive_entry_new(void);

Packit 08bd4c
Packit 08bd4c

DESCRIPTION

Packit 08bd4c
Packit 08bd4c

These functions create and

Packit 08bd4c
manipulate data objects that represent entries within an
Packit 08bd4c
archive. You can think of a struct archive_entry as a
Packit 08bd4c
heavy-duty version of struct stat: it includes everything
Packit 08bd4c
from struct stat plus associated pathname, textual group and
Packit 08bd4c
user names, etc. These objects are used by libarchive(3) to
Packit 08bd4c
represent the metadata associated with a particular entry in
Packit 08bd4c
an archive.

Packit 08bd4c
Packit 08bd4c

Create and

Packit 08bd4c
Destroy 
Packit 08bd4c
There are functions to allocate, destroy, clear, and copy
Packit 08bd4c
archive_entry objects:

Packit 08bd4c
Packit 08bd4c

archive_entry_clear()

Packit 08bd4c
Packit 08bd4c

Erases the object, resetting

Packit 08bd4c
all internal fields to the same state as a newly-created
Packit 08bd4c
object. This is provided to allow you to quickly recycle
Packit 08bd4c
objects without thrashing the heap.

Packit 08bd4c
Packit 08bd4c

archive_entry_clone()

Packit 08bd4c
Packit 08bd4c

A deep copy operation; all text

Packit 08bd4c
fields are duplicated.

Packit 08bd4c
Packit 08bd4c

archive_entry_free()

Packit 08bd4c
Packit 08bd4c

Releases the struct

Packit 08bd4c
archive_entry object.

Packit 08bd4c
Packit 08bd4c

archive_entry_new()

Packit 08bd4c
Packit 08bd4c

Allocate and return a blank

Packit 08bd4c
struct archive_entry object.

Packit 08bd4c
Packit 08bd4c

Function

Packit 08bd4c
groups 
Packit 08bd4c
Due to high number of functions, the accessor functions can
Packit 08bd4c
be found in man pages grouped by the purpose.

Packit 08bd4c
Packit 08bd4c

archive_entry_acl(3)

Packit 08bd4c
Packit 08bd4c

Access Control

Packit 08bd4c
List manipulation

Packit 08bd4c
Packit 08bd4c

archive_entry_paths(3)

Packit 08bd4c
Packit 08bd4c

Path name

Packit 08bd4c
manipulation

Packit 08bd4c
Packit 08bd4c

archive_entry_perms(3)

Packit 08bd4c
Packit 08bd4c

User, group and

Packit 08bd4c
mode manipulation

Packit 08bd4c
Packit 08bd4c

archive_entry_stat(3)

Packit 08bd4c
Packit 08bd4c

Functions not

Packit 08bd4c
in the other groups and copying to/from struct
Packit 08bd4c
stat.

Packit 08bd4c
Packit 08bd4c

archive_entry_time(3)

Packit 08bd4c
Packit 08bd4c

Time field

Packit 08bd4c
manipulation

Packit 08bd4c
Packit 08bd4c

Most of the

Packit 08bd4c
functions set or read entries in an object. Such functions
Packit 08bd4c
have one of the following forms:

Packit 08bd4c
Packit 08bd4c

archive_entry_set_XXXX()

Packit 08bd4c
Packit 08bd4c

Stores the provided data in the

Packit 08bd4c
object. In particular, for strings, the pointer is stored,
Packit 08bd4c
not the referenced string.

Packit 08bd4c
Packit 08bd4c

archive_entry_copy_XXXX()

Packit 08bd4c
Packit 08bd4c

As above, except that the

Packit 08bd4c
referenced data is copied into the object.

Packit 08bd4c
Packit 08bd4c

archive_entry_XXXX()

Packit 08bd4c
Packit 08bd4c

Returns the specified data. In

Packit 08bd4c
the case of strings, a const-qualified pointer to the string
Packit 08bd4c
is returned.

Packit 08bd4c
Packit 08bd4c

String data can be set or

Packit 08bd4c
accessed as wide character strings or normal char
Packit 08bd4c
strings. The functions that use wide character strings are
Packit 08bd4c
suffixed with _w. Note that these are different
Packit 08bd4c
representations of the same data: For example, if you store
Packit 08bd4c
a narrow string and read the corresponding wide string, the
Packit 08bd4c
object will transparently convert formats using the current
Packit 08bd4c
locale. Similarly, if you store a wide string and then store
Packit 08bd4c
a narrow string for the same data, the previously-set wide
Packit 08bd4c
string will be discarded in favor of the new data.

Packit 08bd4c
Packit 08bd4c

SEE ALSO

Packit 08bd4c
Packit 08bd4c

archive_entry_acl(3),

Packit 08bd4c
archive_entry_paths(3), archive_entry_perms(3),
Packit 08bd4c
archive_entry_time(3) libarchive(3),

Packit 08bd4c
Packit 08bd4c

HISTORY

Packit 08bd4c
Packit 08bd4c

The libarchive library

Packit 08bd4c
first appeared in FreeBSD 5.3.

Packit 08bd4c
Packit 08bd4c

AUTHORS

Packit 08bd4c
Packit 08bd4c

The libarchive library

Packit 08bd4c
was written by Tim Kientzle <kientzle@acm.org>.

Packit 08bd4c
Packit 08bd4c

BSD

Packit 08bd4c
February 2, 2012 BSD

Packit 08bd4c

Packit 08bd4c
</body>
Packit 08bd4c
</html>