diff options
Diffstat (limited to 'archivers/libarchive/files/doc/text/archive_read_open.3.txt')
| -rw-r--r-- | archivers/libarchive/files/doc/text/archive_read_open.3.txt | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/archivers/libarchive/files/doc/text/archive_read_open.3.txt b/archivers/libarchive/files/doc/text/archive_read_open.3.txt index 10fcd7040c1..a6f74566bce 100644 --- a/archivers/libarchive/files/doc/text/archive_read_open.3.txt +++ b/archivers/libarchive/files/doc/text/archive_read_open.3.txt @@ -61,15 +61,15 @@ DESCRIPTION This is a deprecated synonym for archive_read_open_filename(). archive_read_open_filename() Like archive_read_open(), except that it accepts a simple file‐ - name and a block size. A NULL filename represents standard - input. This function is safe for use with tape drives or other + name and a block size. A NULL filename represents standard in‐ + put. This function is safe for use with tape drives or other blocked devices. archive_read_open_memory() Like archive_read_open(), except that it accepts a pointer and size of a block of memory containing the archive data. - A complete description of the struct archive and struct archive_entry - objects can be found in the overview manual page for libarchive(3). + A complete description of the struct archive and struct archive_entry ob‐ + jects can be found in the overview manual page for libarchive(3). CLIENT CALLBACKS The callback functions must match the following prototypes: @@ -88,8 +88,8 @@ CLIENT CALLBACKS The open callback is invoked by archive_open(). It should return ARCHIVE_OK if the underlying file or data source is successfully opened. - If the open fails, it should call archive_set_error() to register an - error code and message and return ARCHIVE_FATAL. + If the open fails, it should call archive_set_error() to register an er‐ + ror code and message and return ARCHIVE_FATAL. The read callback is invoked whenever the library requires raw bytes from the archive. The read callback should read data into a buffer, set the @@ -98,8 +98,8 @@ CLIENT CALLBACKS callback again only after it has consumed this data. The library imposes no constraints on the size of the data blocks returned. On end-of-file, the read callback should return zero. On error, the read callback should - invoke archive_set_error() to register an error code and message and - return -1. + invoke archive_set_error() to register an error code and message and re‐ + turn -1. The skip callback is invoked when the library wants to ignore a block of data. The return value is the number of bytes actually skipped, which |