contrib/libarchive/libarchive/archive_read_new.3

   1 .\" Copyright (c) 2003-2011 Tim Kientzle
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD: head/lib/libarchive/archive_read.3 191595 2009-04-27 20:13:13Z kientzle $
  26 .\"
  27 .Dd March 20, 2011
  28 .Dt ARCHIVE_READ_NEW 3
  29 .Os
  30 .Sh NAME
  31 .Nm archive_read_new
  32 .Nd functions for reading streaming archives
  33 .Sh SYNOPSIS
  34 .In archive.h
  35 .Ft struct archive *
  36 .Fn archive_read_new "void"
  37 .Sh DESCRIPTION
  38 Allocates and initializes a
  39 .Tn struct archive
  40 object suitable for reading from an archive.
  41 .Dv NULL
  42 is returned on error.
  43 .Pp
  44 A complete description of the
  45 .Tn struct archive
  46 object can be found in the overview manual page for
  47 .Xr libarchive 3 .
  48 .\" .Sh ERRORS
  49 .Sh SEE ALSO
  50 .Xr tar 1 ,
  51 .Xr libarchive 3 ,
  52 .Xr archive_read_data 3 ,
  53 .Xr archive_read_filter 3 ,
  54 .Xr archive_read_format 3 ,
  55 .Xr archive_read_set_options 3 ,
  56 .Xr archive_util 3 ,
  57 .Xr tar 5