diff options
Diffstat (limited to 'archivers/libarchive/files/doc/text/archive_read_extract.3.txt')
| -rw-r--r-- | archivers/libarchive/files/doc/text/archive_read_extract.3.txt | 23 |
1 files changed, 11 insertions, 12 deletions
diff --git a/archivers/libarchive/files/doc/text/archive_read_extract.3.txt b/archivers/libarchive/files/doc/text/archive_read_extract.3.txt index ca1fec5ad49..3f58d112ab1 100644 --- a/archivers/libarchive/files/doc/text/archive_read_extract.3.txt +++ b/archivers/libarchive/files/doc/text/archive_read_extract.3.txt @@ -29,12 +29,11 @@ DESCRIPTION archive_write_disk(3) interfaces. The first call to archive_read_extract() creates a restore object using archive_write_disk_new(3) and - archive_write_disk_set_standard_lookup(3), then transparently - invokes archive_write_disk_set_options(3), - archive_write_header(3), archive_write_data(3), and - archive_write_finish_entry(3) to create the entry on disk and - copy data into it. The flags argument is passed unmodified to - archive_write_disk_set_options(3). + archive_write_disk_set_standard_lookup(3), then transparently in‐ + vokes archive_write_disk_set_options(3), archive_write_header(3), + archive_write_data(3), and archive_write_finish_entry(3) to cre‐ + ate the entry on disk and copy data into it. The flags argument + is passed unmodified to archive_write_disk_set_options(3). archive_read_extract2() This is another version of archive_read_extract() that allows you to provide your own restore object. In particular, this allows @@ -49,18 +48,18 @@ DESCRIPTION updating progress displays during extraction. The progress func‐ tion will be invoked during the extraction of large regular files. The progress function will be invoked with the pointer - provided to this call. Generally, the data pointed to should - include a reference to the archive object and the archive_entry - object so that various statistics can be retrieved for the - progress display. + provided to this call. Generally, the data pointed to should in‐ + clude a reference to the archive object and the archive_entry ob‐ + ject so that various statistics can be retrieved for the progress + display. RETURN VALUES Most functions return zero on success, non-zero on error. The possible return codes include: ARCHIVE_OK (the operation succeeded), ARCHIVE_WARN (the operation succeeded but a non-critical error was encountered), ARCHIVE_EOF (end-of-archive was encountered), ARCHIVE_RETRY (the opera‐ - tion failed but can be retried), and ARCHIVE_FATAL (there was a fatal - error; the archive should be closed immediately). + tion failed but can be retried), and ARCHIVE_FATAL (there was a fatal er‐ + ror; the archive should be closed immediately). ERRORS Detailed error codes and textual descriptions are available from the |