summaryrefslogtreecommitdiff
path: root/archivers/libarchive/files/doc/wiki/ManPageArchiveReadDisk3.wiki
diff options
context:
space:
mode:
authorjoerg <joerg@pkgsrc.org>2017-08-01 22:21:09 +0000
committerjoerg <joerg@pkgsrc.org>2017-08-01 22:21:09 +0000
commit8ebf4e7079542370a0dd5eba7eed1790d20c7f96 (patch)
tree3c71484d8e555935fd266acfd45eff3b04d0f139 /archivers/libarchive/files/doc/wiki/ManPageArchiveReadDisk3.wiki
parentc8fcd52665c6781876ed54832bd7f6ea46348688 (diff)
downloadpkgsrc-8ebf4e7079542370a0dd5eba7eed1790d20c7f96.tar.gz
Import libarchive-3.3.2 + 9de5f3 + f9dacbf:
- Support NFS4 ACLs on Linux - Bugfixes
Diffstat (limited to 'archivers/libarchive/files/doc/wiki/ManPageArchiveReadDisk3.wiki')
-rw-r--r--archivers/libarchive/files/doc/wiki/ManPageArchiveReadDisk3.wiki94
1 files changed, 59 insertions, 35 deletions
diff --git a/archivers/libarchive/files/doc/wiki/ManPageArchiveReadDisk3.wiki b/archivers/libarchive/files/doc/wiki/ManPageArchiveReadDisk3.wiki
index bb7d01a3eb8..752181e182d 100644
--- a/archivers/libarchive/files/doc/wiki/ManPageArchiveReadDisk3.wiki
+++ b/archivers/libarchive/files/doc/wiki/ManPageArchiveReadDisk3.wiki
@@ -1,6 +1,7 @@
ARCHIVE_READ_DISK(3) manual page
== NAME ==
'''archive_read_disk_new''',
+'''archive_read_disk_set_behavior''',
'''archive_read_disk_set_symlink_logical''',
'''archive_read_disk_set_symlink_physical''',
'''archive_read_disk_set_symlink_hybrid''',
@@ -9,10 +10,7 @@ ARCHIVE_READ_DISK(3) manual page
'''archive_read_disk_uname''',
'''archive_read_disk_set_uname_lookup''',
'''archive_read_disk_set_gname_lookup''',
-'''archive_read_disk_set_standard_lookup''',
-'''archive_read_close''',
-'''archive_read_finish''',
-'''archive_read_free'''
+'''archive_read_disk_set_standard_lookup'''
- functions for reading objects from disk
== LIBRARY ==
Streaming Archive Library (libarchive, -larchive)
@@ -25,6 +23,10 @@ Streaming Archive Library (libarchive, -larchive)
<br>
''int''
<br>
+'''archive_read_disk_set_behavior'''(''struct archive *'', ''int'');
+<br>
+''int''
+<br>
'''archive_read_disk_set_symlink_logical'''(''struct archive *'');
<br>
''int''
@@ -58,18 +60,6 @@ Streaming Archive Library (libarchive, -larchive)
''int''
<br>
'''archive_read_disk_entry_from_file'''(''struct archive *'', ''struct archive_entry *'', ''int fd'', ''const struct stat *'');
-<br>
-''int''
-<br>
-'''archive_read_close'''(''struct archive *'');
-<br>
-''int''
-<br>
-'''archive_read_finish'''(''struct archive *'');
-<br>
-''int''
-<br>
-'''archive_read_free'''(''struct archive *'');
== DESCRIPTION ==
These functions provide an API for reading information about
objects on disk.
@@ -81,6 +71,51 @@ objects.
Allocates and initializes a
'''struct archive'''
object suitable for reading object information from disk.
+</dd><dt>'''archive_read_disk_set_behavior'''()</dt><dd>
+Configures various behavior options when reading entries from disk.
+The flags field consists of a bitwise OR of one or more of the
+following values:
+<dl>
+<dt>'''ARCHIVE_READDISK_HONOR_NODUMP'''</dt><dd>
+Skip files and directories with the nodump file attribute (file flag) set.
+By default, the nodump file atrribute is ignored.
+</dd><dt>'''ARCHIVE_READDISK_MAC_COPYFILE'''</dt><dd>
+Mac OS X specific. Read metadata (ACLs and extended attributes) with
+[[copyfile(3)|http://www.freebsd.org/cgi/man.cgi?query=copyfile&sektion=3]].
+By default, metadata is read using
+[[copyfile(3)|http://www.freebsd.org/cgi/man.cgi?query=copyfile&sektion=3]].
+</dd><dt>'''ARCHIVE_READDISK_NO_ACL'''</dt><dd>
+Do not read Access Control Lists.
+By default, ACLs are read from disk.
+</dd><dt>'''ARCHIVE_READDISK_NO_FFLAGS'''</dt><dd>
+Do not read file attributes (file flags).
+By default, file attributes are read from disk.
+See
+[[chattr(1)|http://www.freebsd.org/cgi/man.cgi?query=chattr&sektion=1]]
+(Linux)
+or
+[[chflags(1)|http://www.freebsd.org/cgi/man.cgi?query=chflags&sektion=1]]
+(FreeBSD, Mac OS X)
+for more information on file attributes.
+</dd><dt>'''ARCHIVE_READDISK_NO_TRAVERSE_MOUNTS'''</dt><dd>
+Do not traverse mount points.
+By defaut, moint points are traversed.
+</dd><dt>'''ARCHIVE_READDISK_NO_XATTR'''</dt><dd>
+Do not read extended file attributes (xattrs).
+By default, extended file attributes are read from disk.
+See
+[[xattr(7)|http://www.freebsd.org/cgi/man.cgi?query=xattr&sektion=7]]
+(Linux,)
+[[xattr(2)|http://www.freebsd.org/cgi/man.cgi?query=xattr&sektion=2]]
+(Mac OS X,)
+or
+[[getextattr(8)|http://www.freebsd.org/cgi/man.cgi?query=getextattr&sektion=8]]
+(FreeBSD)
+for more information on extended file attributes.
+</dd><dt>'''ARCHIVE_READDISK_RESTORE_ATIME'''</dt><dd>
+Restore access time of traversed files.
+By default, access time of traversed files is not restored.
+</dd></dl>
</dd><dt>
'''archive_read_disk_set_symlink_logical'''(),
'''archive_read_disk_set_symlink_physical'''(),
@@ -138,7 +173,7 @@ object with information about a particular file.
The
'''archive_entry'''
object must have already been created with
-[[ManPageArchiveEntryNew3]]
+[[ManPagerchiventryew3]]
and at least one of the source path or path fields must already be set.
(If both are set, the source path will be used.)
@@ -164,22 +199,11 @@ using the currently registered lookup functions above.
This affects the file ownership fields and ACL values in the
'''struct archive_entry'''
object.
-</dd><dt>'''archive_read_close'''()</dt><dd>
-Does nothing for
-'''archive_read_disk'''
-handles.
-</dd><dt>'''archive_read_finish'''()</dt><dd>
-This is a deprecated synonym for
-'''archive_read_free'''().
-</dd><dt>'''archive_read_free'''()</dt><dd>
-Invokes
-'''archive_read_close'''()
-if it was not invoked manually, then releases all resources.
</dd></dl>
More information about the
''struct'' archive
object and the overall design of the library can be found in the
-[[ManPageLibarchive3]]
+[[ManPageibarchive3]]
overview.
== EXAMPLE ==
The following illustrates basic usage of the library by
@@ -243,12 +267,12 @@ and
'''archive_error_string'''()
functions.
== SEE ALSO ==
-[[ManPageArchiveRead3]],
-[[ManPageArchiveUtil3]],
-[[ManPageArchiveWrite3]],
-[[ManPageArchiveWriteDisk3]],
+[[ManPagerchiveead3]],
+[[ManPagerchivetil3]],
+[[ManPagerchiverite3]],
+[[ManPagerchiveriteisk3]],
[[ManPageBsdtar1]],
-[[ManPageLibarchive3]]
+[[ManPageibarchive3]]
== HISTORY ==
The
'''libarchive'''
@@ -289,7 +313,7 @@ to look up such information.
This API should provide a set of methods for walking a directory tree.
That would make it a direct parallel of the
-[[ManPageArchiveRead3]]
+[[ManPagerchiveead3]]
API.
When such methods are implemented, the
"hybrid"