From 134372c1c00682f9f98cd23a54b427370dbedebb Mon Sep 17 00:00:00 2001 From: Roman Neuhauser Date: Mon, 28 Mar 2011 05:14:17 -0400 Subject: archive_read_format.3: archive_read_support_format_XXX SVN-Revision: 3083 --- libarchive/archive_read.3 | 68 +++++++---------------------------------------- 1 file changed, 9 insertions(+), 59 deletions(-) (limited to 'libarchive/archive_read.3') diff --git a/libarchive/archive_read.3 b/libarchive/archive_read.3 index a70fee46..3e62b81e 100644 --- a/libarchive/archive_read.3 +++ b/libarchive/archive_read.3 @@ -29,15 +29,6 @@ .Os .Sh NAME .Nm archive_read_new , -.Nm archive_read_support_format_all , -.Nm archive_read_support_format_ar , -.Nm archive_read_support_format_cpio , -.Nm archive_read_support_format_empty , -.Nm archive_read_support_format_iso9660 , -.Nm archive_read_support_format_mtree, -.Nm archive_read_support_format_raw, -.Nm archive_read_support_format_tar , -.Nm archive_read_support_format_zip , .Nm archive_read_open , .Nm archive_read_open2 , .Nm archive_read_open_fd , @@ -65,24 +56,6 @@ .Ft struct archive * .Fn archive_read_new "void" .Ft int -.Fn archive_read_support_format_all "struct archive *" -.Ft int -.Fn archive_read_support_format_ar "struct archive *" -.Ft int -.Fn archive_read_support_format_cpio "struct archive *" -.Ft int -.Fn archive_read_support_format_empty "struct archive *" -.Ft int -.Fn archive_read_support_format_iso9660 "struct archive *" -.Ft int -.Fn archive_read_support_format_mtree "struct archive *" -.Ft int -.Fn archive_read_support_format_raw "struct archive *" -.Ft int -.Fn archive_read_support_format_tar "struct archive *" -.Ft int -.Fn archive_read_support_format_zip "struct archive *" -.Ft int .Fo archive_read_open .Fa "struct archive *" .Fa "void *client_data" @@ -163,44 +136,20 @@ The general process is to first create the object, set options, initialize the reader, iterate over the archive headers and associated data, then close the archive and release all resources. +.Pp The following summary describes the functions in approximately the -order they would be used: +order they would be used, with the caveat that functions enabling filters +and archive formats and option setting functions, which must be called +before the archive is opened, are described in +.Xr archive_read_filter 3 +and +.Xr archive_read_format 3 : +.\" .Bl -tag -compact -width indent .It Fn archive_read_new Allocates and initializes a .Tn struct archive object suitable for reading from an archive. -.It Xo -.Fn archive_read_support_format_all , -.Fn archive_read_support_format_ar , -.Fn archive_read_support_format_cpio , -.Fn archive_read_support_format_empty , -.Fn archive_read_support_format_iso9660 , -.Fn archive_read_support_format_mtree , -.Fn archive_read_support_format_tar , -.Fn archive_read_support_format_zip -.Xc -Enables support---including auto-detection code---for the -specified archive format. -For example, -.Fn archive_read_support_format_tar -enables support for a variety of standard tar formats, old-style tar, -ustar, pax interchange format, and many common variants. -For convenience, -.Fn archive_read_support_format_all -enables support for all available formats. -Only empty archives are supported by default. -.It Fn archive_read_support_format_raw -The -.Dq raw -format handler allows libarchive to be used to read arbitrary data. -It treats any data stream as an archive with a single entry. -The pathname of this entry is -.Dq data ; -all other entry fields are unset. -This is not enabled by -.Fn archive_read_support_format_all -in order to avoid erroneous handling of damaged archives. .It Fn archive_read_open The same as .Fn archive_read_open2 , @@ -580,6 +529,7 @@ to be returned.) .Xr tar 1 , .Xr libarchive 3 , .Xr archive_read_filter 3 , +.Xr archive_read_format 3 , .Xr archive_read_set_options 3 , .Xr archive_util 3 , .Xr tar 5 -- cgit v1.2.1