diff options
Diffstat (limited to 'archivers/libarchive/files/doc/text/archive_read_disk.3.txt')
| -rw-r--r-- | archivers/libarchive/files/doc/text/archive_read_disk.3.txt | 150 |
1 files changed, 75 insertions, 75 deletions
diff --git a/archivers/libarchive/files/doc/text/archive_read_disk.3.txt b/archivers/libarchive/files/doc/text/archive_read_disk.3.txt index ab2cf7ae898..f4f63425f54 100644 --- a/archivers/libarchive/files/doc/text/archive_read_disk.3.txt +++ b/archivers/libarchive/files/doc/text/archive_read_disk.3.txt @@ -1,93 +1,93 @@ ARCHIVE_READ_DISK(3) BSD Library Functions Manual ARCHIVE_READ_DISK(3) -NAME - archive_read_disk_new, archive_read_disk_set_symlink_logical, - archive_read_disk_set_symlink_physical, - archive_read_disk_set_symlink_hybrid, archive_read_disk_entry_from_file, - archive_read_disk_gname, 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 — functions for reading objects +1mNAME0m + 1marchive_read_disk_new22m, 1marchive_read_disk_set_symlink_logical22m, + 1marchive_read_disk_set_symlink_physical22m, + 1marchive_read_disk_set_symlink_hybrid22m, 1marchive_read_disk_entry_from_file22m, + 1marchive_read_disk_gname22m, 1marchive_read_disk_uname22m, + 1marchive_read_disk_set_uname_lookup22m, 1marchive_read_disk_set_gname_lookup22m, + 1marchive_read_disk_set_standard_lookup22m, 1marchive_read_close22m, + 1marchive_read_finish22m, 1marchive_read_free 22m— functions for reading objects from disk -LIBRARY +1mLIBRARY0m Streaming Archive Library (libarchive, -larchive) -SYNOPSIS - #include <archive.h> +1mSYNOPSIS0m + 1m#include <archive.h>0m - struct archive * - archive_read_disk_new(void); + 4mstruct24m 4marchive24m 4m*0m + 1marchive_read_disk_new22m(4mvoid24m); - int - archive_read_disk_set_symlink_logical(struct archive *); + 4mint0m + 1marchive_read_disk_set_symlink_logical22m(4mstruct24m 4marchive24m 4m*24m); - int - archive_read_disk_set_symlink_physical(struct archive *); + 4mint0m + 1marchive_read_disk_set_symlink_physical22m(4mstruct24m 4marchive24m 4m*24m); - int - archive_read_disk_set_symlink_hybrid(struct archive *); + 4mint0m + 1marchive_read_disk_set_symlink_hybrid22m(4mstruct24m 4marchive24m 4m*24m); - int - archive_read_disk_gname(struct archive *, gid_t); + 4mconst24m 4mchar24m 4m*0m + 1marchive_read_disk_gname22m(4mstruct24m 4marchive24m 4m*24m, 4mgid_t24m); - int - archive_read_disk_uname(struct archive *, uid_t); + 4mconst24m 4mchar24m 4m*0m + 1marchive_read_disk_uname22m(4mstruct24m 4marchive24m 4m*24m, 4muid_t24m); - int - archive_read_disk_set_gname_lookup(struct archive *, void *, - const char *(*lookup)(void *, gid_t), void (*cleanup)(void *)); + 4mint0m + 1marchive_read_disk_set_gname_lookup22m(4mstruct24m 4marchive24m 4m*24m, 4mvoid24m 4m*24m, + 4mconst24m 4mchar24m 4m*(*lookup)(void24m 4m*,24m 4mgid_t)24m, 4mvoid24m 4m(*cleanup)(void24m 4m*)24m); - int - archive_read_disk_set_uname_lookup(struct archive *, void *, - const char *(*lookup)(void *, uid_t), void (*cleanup)(void *)); + 4mint0m + 1marchive_read_disk_set_uname_lookup22m(4mstruct24m 4marchive24m 4m*24m, 4mvoid24m 4m*24m, + 4mconst24m 4mchar24m 4m*(*lookup)(void24m 4m*,24m 4muid_t)24m, 4mvoid24m 4m(*cleanup)(void24m 4m*)24m); - int - archive_read_disk_set_standard_lookup(struct archive *); + 4mint0m + 1marchive_read_disk_set_standard_lookup22m(4mstruct24m 4marchive24m 4m*24m); - int - archive_read_disk_entry_from_file(struct archive *, - struct archive_entry *, int fd, const struct stat *); + 4mint0m + 1marchive_read_disk_entry_from_file22m(4mstruct24m 4marchive24m 4m*24m, + 4mstruct24m 4marchive_entry24m 4m*24m, 4mint24m 4mfd24m, 4mconst24m 4mstruct24m 4mstat24m 4m*24m); - int - archive_read_close(struct archive *); + 4mint0m + 1marchive_read_close22m(4mstruct24m 4marchive24m 4m*24m); - int - archive_read_finish(struct archive *); + 4mint0m + 1marchive_read_finish22m(4mstruct24m 4marchive24m 4m*24m); - int - archive_read_free(struct archive *); + 4mint0m + 1marchive_read_free22m(4mstruct24m 4marchive24m 4m*24m); -DESCRIPTION +1mDESCRIPTION0m These functions provide an API for reading information about objects on disk. In particular, they provide an interface for populating struct archive_entry objects. - archive_read_disk_new() + 1marchive_read_disk_new22m() Allocates and initializes a struct archive object suitable for reading object information from disk. - archive_read_disk_set_symlink_logical(), - archive_read_disk_set_symlink_physical(), - archive_read_disk_set_symlink_hybrid() + 1marchive_read_disk_set_symlink_logical22m(), + 1marchive_read_disk_set_symlink_physical22m(), + 1marchive_read_disk_set_symlink_hybrid22m() This sets the mode used for handling symbolic links. The “logical” mode follows all symbolic links. The “physical” mode does not follow any symbolic links. The “hybrid” mode currently behaves identically to the “logical” mode. - archive_read_disk_gname(), archive_read_disk_uname() + 1marchive_read_disk_gname22m(), 1marchive_read_disk_uname22m() Returns a user or group name given a gid or uid value. By default, these always return a NULL string. - archive_read_disk_set_gname_lookup(), - archive_read_disk_set_uname_lookup() + 1marchive_read_disk_set_gname_lookup22m(), + 1marchive_read_disk_set_uname_lookup22m() These allow you to override the functions used for user and group name lookups. You may also provide a void * pointer to a private data structure and a cleanup function for that data. The cleanup function will be invoked when the struct archive object is destroyed or when new lookup functions are registered. - archive_read_disk_set_standard_lookup() + 1marchive_read_disk_set_standard_lookup22m() This convenience function installs a standard set of user and group name lookup functions. These functions use getpwuid(3) and getgrgid(3) to convert ids to names, defaulting to NULL if the @@ -95,7 +95,7 @@ DESCRIPTION ple memory cache to reduce the number of calls to getpwuid(3) and getgrgid(3). - archive_read_disk_entry_from_file() + 1marchive_read_disk_entry_from_file22m() Populates a struct archive_entry object with information about a particular file. The archive_entry object must have already been created with archive_entry_new(3) and at least one of the source @@ -119,19 +119,19 @@ DESCRIPTION above. This affects the file ownership fields and ACL values in the struct archive_entry object. - archive_read_close() + 1marchive_read_close22m() Does nothing for archive_read_disk handles. - archive_read_finish() - This is a deprecated synonym for archive_read_free(). + 1marchive_read_finish22m() + This is a deprecated synonym for 1marchive_read_free22m(). - archive_read_free() - Invokes archive_read_close() if it was not invoked manually, then + 1marchive_read_free22m() + Invokes 1marchive_read_close22m() if it was not invoked manually, then releases all resources. - More information about the struct archive object and the overall design + More information about the 4mstruct24m 4marchive24m object and the overall design of the library can be found in the libarchive(3) overview. -EXAMPLE +1mEXAMPLE0m The following illustrates basic usage of the library by showing how to use it to copy an item on disk into an archive. @@ -160,50 +160,50 @@ EXAMPLE archive_entry_free(entry); } -RETURN VALUES - Most functions return ARCHIVE_OK (zero) on success, or one of several +1mRETURN VALUES0m + Most functions return 1mARCHIVE_OK 22m(zero) on success, or one of several negative error codes for errors. Specific error codes include: - ARCHIVE_RETRY for operations that might succeed if retried, ARCHIVE_WARN + 1mARCHIVE_RETRY 22mfor operations that might succeed if retried, 1mARCHIVE_WARN0m for unusual conditions that do not prevent further operations, and - ARCHIVE_FATAL for serious errors that make remaining operations impossi‐ + 1mARCHIVE_FATAL 22mfor serious errors that make remaining operations impossi‐ ble. - archive_read_disk_new() returns a pointer to a newly-allocated struct + 1marchive_read_disk_new22m() returns a pointer to a newly-allocated struct archive object or NULL if the allocation failed for any reason. - archive_read_disk_gname() and archive_read_disk_uname() return const char + 1marchive_read_disk_gname22m() and 1marchive_read_disk_uname22m() return const char * pointers to the textual name or NULL if the lookup failed for any rea‐ son. The returned pointer points to internal storage that may be reused on the next call to either of these functions; callers should copy the string if they need to continue accessing it. -ERRORS +1mERRORS0m Detailed error codes and textual descriptions are available from the - archive_errno() and archive_error_string() functions. + 1marchive_errno22m() and 1marchive_error_string22m() functions. -SEE ALSO +1mSEE ALSO0m archive_read(3), archive_util(3), archive_write(3), archive_write_disk(3), tar(1), libarchive(3) -HISTORY - The libarchive library first appeared in FreeBSD 5.3. The - archive_read_disk interface was added to libarchive 2.6 and first +1mHISTORY0m + The 1mlibarchive 22mlibrary first appeared in FreeBSD 5.3. The + 1marchive_read_disk 22minterface was added to 1mlibarchive 2.6 22mand first appeared in FreeBSD 8.0. -AUTHORS - The libarchive library was written by Tim Kientzle +1mAUTHORS0m + The 1mlibarchive 22mlibrary was written by Tim Kientzle <kientzle@FreeBSD.org>. -BUGS +1mBUGS0m The “standard” user name and group name lookup functions are not the defaults because getgrgid(3) and getpwuid(3) are sometimes too large for particular applications. The current design allows the application author to use a more compact implementation when appropriate. The full list of metadata read from disk by - archive_read_disk_entry_from_file() is necessarily system-dependent. + 1marchive_read_disk_entry_from_file22m() is necessarily system-dependent. - The archive_read_disk_entry_from_file() function reads as much informa‐ + The 1marchive_read_disk_entry_from_file22m() function reads as much informa‐ tion as it can from disk. Some method should be provided to limit this so that clients who do not need ACLs, for instance, can avoid the extra work needed to look up such information. @@ -213,4 +213,4 @@ BUGS such methods are implemented, the “hybrid” symbolic link mode will make sense. -BSD February 2, 2012 BSD +BSD December 30, 2016 BSD |