| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091 |
- .\" Copyright (c) 2003-2011 Tim Kientzle
- .\" All rights reserved.
- .\"
- .\" Redistribution and use in source and binary forms, with or without
- .\" modification, are permitted provided that the following conditions
- .\" are met:
- .\" 1. Redistributions of source code must retain the above copyright
- .\" notice, this list of conditions and the following disclaimer.
- .\" 2. Redistributions in binary form must reproduce the above copyright
- .\" notice, this list of conditions and the following disclaimer in the
- .\" documentation and/or other materials provided with the distribution.
- .\"
- .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
- .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
- .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
- .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
- .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
- .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
- .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
- .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
- .\" SUCH DAMAGE.
- .\"
- .\" $FreeBSD$
- .\"
- .Dd February 2, 2012
- .Dt ARCHIVE_READ_HEADER 3
- .Os
- .Sh NAME
- .Nm archive_read_next_header ,
- .Nm archive_read_next_header2
- .Nd functions for reading streaming archives
- .Sh LIBRARY
- Streaming Archive Library (libarchive, -larchive)
- .Sh SYNOPSIS
- .In archive.h
- .Ft int
- .Fn archive_read_next_header "struct archive *" "struct archive_entry **"
- .Ft int
- .Fn archive_read_next_header2 "struct archive *" "struct archive_entry *"
- .\"
- .Sh DESCRIPTION
- .Bl -tag -compact -width indent
- .It Fn archive_read_next_header
- Read the header for the next entry and return a pointer to
- a
- .Tn struct archive_entry .
- This is a convenience wrapper around
- .Fn archive_read_next_header2
- that reuses an internal
- .Tn struct archive_entry
- object for each request.
- .It Fn archive_read_next_header2
- Read the header for the next entry and populate the provided
- .Tn struct archive_entry .
- .El
- .\"
- .Sh RETURN VALUES
- These functions return
- .Cm ARCHIVE_OK
- (the operation succeeded),
- .Cm ARCHIVE_WARN
- (the operation succeeded but a non-critical error was encountered),
- .Cm ARCHIVE_EOF
- (end-of-archive was encountered),
- .Cm ARCHIVE_RETRY
- (the operation failed but can be retried),
- and
- .Cm ARCHIVE_FATAL
- (there was a fatal error; the archive should be closed immediately).
- .\"
- .Sh ERRORS
- Detailed error codes and textual descriptions are available from the
- .Fn archive_errno
- and
- .Fn archive_error_string
- functions.
- .\"
- .Sh SEE ALSO
- .Xr tar 1 ,
- .Xr libarchive 3 ,
- .Xr archive_read 3 ,
- .Xr archive_read_data 3 ,
- .Xr archive_read_extract 3 ,
- .Xr archive_read_filter 3 ,
- .Xr archive_read_format 3 ,
- .Xr archive_read_open 3 ,
- .Xr archive_read_set_options 3 ,
- .Xr archive_util 3 ,
- .Xr tar 5
|
