diff options
Diffstat (limited to 'archivers/libarchive/files/doc/text/archive_write_disk.3.txt')
| -rw-r--r-- | archivers/libarchive/files/doc/text/archive_write_disk.3.txt | 64 |
1 files changed, 32 insertions, 32 deletions
diff --git a/archivers/libarchive/files/doc/text/archive_write_disk.3.txt b/archivers/libarchive/files/doc/text/archive_write_disk.3.txt index ab9aca41f10..1c21375cfe9 100644 --- a/archivers/libarchive/files/doc/text/archive_write_disk.3.txt +++ b/archivers/libarchive/files/doc/text/archive_write_disk.3.txt @@ -37,13 +37,13 @@ SYNOPSIS DESCRIPTION These functions provide a complete API for creating objects on disk from - struct archive_entry descriptions. They are most naturally used when - extracting objects from an archive using the archive_read() interface. - The general process is to read struct archive_entry objects from an ar‐ - chive, then write those objects to a struct archive object created using - the archive_write_disk() family functions. This interface is deliber‐ - ately very similar to the archive_write() interface used to write objects - to a streaming archive. + struct archive_entry descriptions. They are most naturally used when ex‐ + tracting objects from an archive using the archive_read() interface. The + general process is to read struct archive_entry objects from an archive, + then write those objects to a struct archive object created using the + archive_write_disk() family functions. This interface is deliberately + very similar to the archive_write() interface used to write objects to a + streaming archive. archive_write_disk_new() Allocates and initializes a struct archive object suitable for @@ -52,38 +52,38 @@ DESCRIPTION archive_write_disk_set_skip_file() Records the device and inode numbers of a file that should not be overwritten. This is typically used to ensure that an extraction - process does not overwrite the archive from which objects are - being read. This capability is technically unnecessary but can - be a significant performance optimization in practice. + process does not overwrite the archive from which objects are be‐ + ing read. This capability is technically unnecessary but can be + a significant performance optimization in practice. archive_write_disk_set_options() The options field consists of a bitwise OR of one or more of the following values: ARCHIVE_EXTRACT_ACL - Attempt to restore Access Control Lists. By default, - extended ACLs are ignored. + Attempt to restore Access Control Lists. By default, ex‐ + tended ACLs are ignored. ARCHIVE_EXTRACT_CLEAR_NOCHANGE_FFLAGS Before removing a file system object prior to replacing it, clear platform-specific file flags which might pre‐ vent its removal. ARCHIVE_EXTRACT_FFLAGS - Attempt to restore file attributes (file flags). By - default, file attributes are ignored. See chattr(1) + Attempt to restore file attributes (file flags). By de‐ + fault, file attributes are ignored. See chattr(1) (Linux) or chflags(1) (FreeBSD, Mac OS X) for more infor‐ mation on file attributes. ARCHIVE_EXTRACT_MAC_METADATA Mac OS X specific. Restore metadata using copyfile(3). By default, copyfile(3) metadata is ignored. ARCHIVE_EXTRACT_NO_OVERWRITE - Existing files on disk will not be overwritten. By - default, existing regular files are truncated and over‐ - written; existing directories will have their permissions - updated; other pre-existing objects are unlinked and - recreated from scratch. + Existing files on disk will not be overwritten. By de‐ + fault, existing regular files are truncated and overwrit‐ + ten; existing directories will have their permissions up‐ + dated; other pre-existing objects are unlinked and recre‐ + ated from scratch. ARCHIVE_EXTRACT_OWNER The user and group IDs should be set on the restored - file. By default, the user and group IDs are not - restored. + file. By default, the user and group IDs are not re‐ + stored. ARCHIVE_EXTRACT_PERM Full permissions (including SGID, SUID, and sticky bits) should be restored exactly as specified, without obeying @@ -101,8 +101,8 @@ DESCRIPTION ARCHIVE_EXTRACT_SECURE_NODOTDOT Refuse to extract a path that contains a .. element any‐ where within it. The default is to not refuse such - paths. Note that paths ending in .. always cause an - error, regardless of this flag. + paths. Note that paths ending in .. always cause an er‐ + ror, regardless of this flag. ARCHIVE_EXTRACT_SECURE_SYMLINKS Refuse to extract any object whose final location would be altered by a symlink on disk. This is intended to @@ -119,12 +119,12 @@ DESCRIPTION it finds and return an error only if such symlink could not be removed. ARCHIVE_EXTRACT_TIME - The timestamps (mtime, ctime, and atime) should be - restored. By default, they are ignored. Note that - restoring of atime is not currently supported. + The timestamps (mtime, ctime, and atime) should be re‐ + stored. By default, they are ignored. Note that restor‐ + ing of atime is not currently supported. ARCHIVE_EXTRACT_UNLINK - Existing files on disk will be unlinked before any - attempt to create them. In some cases, this can prove to + Existing files on disk will be unlinked before any at‐ + tempt to create them. In some cases, this can prove to be a significant performance improvement. By default, existing files are truncated and rewritten, but the file is not recreated. In particular, the default behavior @@ -182,8 +182,8 @@ SEE ALSO HISTORY The libarchive library first appeared in FreeBSD 5.3. The - archive_write_disk interface was added to libarchive 2.0 and first - appeared in FreeBSD 6.3. + archive_write_disk interface was added to libarchive 2.0 and first ap‐ + peared in FreeBSD 6.3. AUTHORS The libarchive library was written by Tim Kientzle <kientzle@acm.org>. @@ -212,8 +212,8 @@ BUGS with a single request. Of course, this does not work if the ARCHIVE_EXTRACT_NODOTDOT option is specified. - Implicit directories are always created obeying the current umask. - Explicit objects are created obeying the current umask unless + Implicit directories are always created obeying the current umask. Ex‐ + plicit objects are created obeying the current umask unless ARCHIVE_EXTRACT_PERM is specified, in which case they current umask is ignored. |