92 lines
3.1 KiB
Groff
92 lines
3.1 KiB
Groff
.\" 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: head/lib/libarchive/archive_read.3 191595 2009-04-27 20:13:13Z kientzle $
|
|
.\"
|
|
.Dd March 20, 2011
|
|
.Dt archive_read_free 3
|
|
.Os
|
|
.Sh NAME
|
|
.Nm archive_read_close ,
|
|
.Nm archive_read_finish ,
|
|
.Nm archive_read_free
|
|
.Nd functions for reading streaming archives
|
|
.Sh SYNOPSIS
|
|
.In archive.h
|
|
.Ft int
|
|
.Fn archive_read_close "struct archive *"
|
|
.Ft int
|
|
.Fn archive_read_finish "struct archive *"
|
|
.Ft int
|
|
.Fn archive_read_free "struct archive *"
|
|
.\"
|
|
.Sh DESCRIPTION
|
|
.Bl -tag -compact -width indent
|
|
.It Fn archive_read_close
|
|
Complete the archive and invoke the close callback.
|
|
.It Fn archive_read_finish
|
|
This is a deprecated synonym for
|
|
.Fn archive_read_free .
|
|
The new name was introduced with libarchive 3.0.
|
|
Applications that need to compile with either libarchive 2
|
|
or libarchive 3 should continue to use the
|
|
.Fn archive_read_finish
|
|
name.
|
|
Both names will be supported until libarchive 4.0 is
|
|
released, which is not expected to occur earlier
|
|
than 2013.
|
|
.It Fn archive_read_free
|
|
Invokes
|
|
.Fn archive_read_close
|
|
if it was not invoked manually, then release all resources.
|
|
Note: In libarchive 1.x, this function was declared to return
|
|
.Ft void ,
|
|
which made it impossible to detect certain errors when
|
|
.Fn archive_read_close
|
|
was invoked implicitly from this function.
|
|
The declaration is corrected beginning with libarchive 2.0.
|
|
.El
|
|
.Sh RETURN VALUES
|
|
These functions return
|
|
.Cm ARCHIVE_OK
|
|
on success, or
|
|
.Cm ARCHIVE_FATAL .
|
|
.\"
|
|
.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 libarchive 3 ,
|
|
.Xr archive_read_new 3 ,
|
|
.Xr archive_read_data 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
|