summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoseph Koshy <jkoshy@FreeBSD.org>2008-03-10 14:45:29 +0000
committerJoseph Koshy <jkoshy@FreeBSD.org>2008-03-10 14:45:29 +0000
commitc7f03ab04083e7798b0439ec030c47291c2fa19f (patch)
treea6b2072456653ea126e19685f71fc17be4cf0434
parent80c4d6eba39575eb0cd757bcfabe0c593e097247 (diff)
Notes
-rw-r--r--lib/libarchive/archive_read.382
1 files changed, 70 insertions, 12 deletions
diff --git a/lib/libarchive/archive_read.3 b/lib/libarchive/archive_read.3
index 735e7eee6564..43cfddf1e981 100644
--- a/lib/libarchive/archive_read.3
+++ b/lib/libarchive/archive_read.3
@@ -75,7 +75,10 @@
.Ft int
.Fn archive_read_support_compression_none "struct archive *"
.Ft int
-.Fn archive_read_support_compression_program "struct archive *" "const char *cmd"
+.Fo archive_read_support_compression_program
+.Fa "struct archive *"
+.Fa "const char *cmd"
+.Fc
.Ft int
.Fn archive_read_support_format_all "struct archive *"
.Ft int
@@ -89,15 +92,32 @@
.Ft int
.Fn archive_read_support_format_zip "struct archive *"
.Ft int
-.Fn archive_read_open "struct archive *" "void *client_data" "archive_open_callback *" "archive_read_callback *" "archive_close_callback *"
+.Fo archive_read_open
+.Fa "struct archive *"
+.Fa "void *client_data"
+.Fa "archive_open_callback *"
+.Fa "archive_read_callback *"
+.Fa "archive_close_callback *"
+.Fc
.Ft int
-.Fn archive_read_open2 "struct archive *" "void *client_data" "archive_open_callback *" "archive_read_callback *" "archive_skip_callback *" "archive_close_callback *"
+.Fo archive_read_open2
+.Fa "struct archive *"
+.Fa "void *client_data"
+.Fa "archive_open_callback *"
+.Fa "archive_read_callback *"
+.Fa "archive_skip_callback *"
+.Fa "archive_close_callback *"
+.Fc
.Ft int
.Fn archive_read_open_FILE "struct archive *" "FILE *file"
.Ft int
.Fn archive_read_open_fd "struct archive *" "int fd" "size_t block_size"
.Ft int
-.Fn archive_read_open_filename "struct archive *" "const char *filename" "size_t block_size"
+.Fo archive_read_open_filename
+.Fa "struct archive *"
+.Fa "const char *filename"
+.Fa "size_t block_size"
+.Fc
.Ft int
.Fn archive_read_open_memory "struct archive *" "void *buff" "size_t size"
.Ft int
@@ -105,7 +125,12 @@
.Ft ssize_t
.Fn archive_read_data "struct archive *" "void *buff" "size_t len"
.Ft int
-.Fn archive_read_data_block "struct archive *" "const void **buff" "size_t *len" "off_t *offset"
+.Fo archive_read_data_block
+.Fa "struct archive *"
+.Fa "const void **buff"
+.Fa "size_t *len"
+.Fa "off_t *offset"
+.Fc
.Ft int
.Fn archive_read_data_skip "struct archive *"
.\" #if ARCHIVE_API_VERSION < 3
@@ -115,9 +140,17 @@
.Ft int
.Fn archive_read_data_into_fd "struct archive *" "int fd"
.Ft int
-.Fn archive_read_extract "struct archive *" "struct archive_entry *" "int flags"
+.Fo archive_read_extract
+.Fa "struct archive *"
+.Fa "struct archive_entry *"
+.Fa "int flags"
+.Fc
.Ft void
-.Fn archive_read_extract_set_progress_callback "struct archive *" "void (*func)(void *)" "void *user_data"
+.Fo archive_read_extract_set_progress_callback
+.Fa "struct archive *"
+.Fa "void (*func)(void *)"
+.Fa "void *user_data"
+.Fc
.Ft int
.Fn archive_read_close "struct archive *"
.Ft int
@@ -136,7 +169,13 @@ order they would be used:
Allocates and initializes a
.Tn struct archive
object suitable for reading from an archive.
-.It Fn archive_read_support_compression_all , Fn archive_read_support_compression_bzip2 , Fn archive_read_support_compression_compress , Fn archive_read_support_compression_gzip , Fn archive_read_support_compression_none
+.It Xo
+.Fn archive_read_support_compression_all ,
+.Fn archive_read_support_compression_bzip2 ,
+.Fn archive_read_support_compression_compress ,
+.Fn archive_read_support_compression_gzip ,
+.Fn archive_read_support_compression_none
+.Xc
Enables auto-detection code and decompression support for the
specified compression.
Note that
@@ -150,7 +189,14 @@ Data is fed through the specified external program before being dearchived.
Note that this disables automatic detection of the compression format,
so it makes no sense to specify this in conjunction with any other
decompression option.
-.It Fn archive_read_support_format_all , Fn archive_read_support_format_cpio , Fn archive_read_support_format_empty , Fn archive_read_support_format_iso9660 , Fn archive_read_support_format_tar, Fn archive_read_support_format_zip
+.It Xo
+.Fn archive_read_support_format_all ,
+.Fn archive_read_support_format_cpio ,
+.Fn archive_read_support_format_empty ,
+.Fn archive_read_support_format_iso9660 ,
+.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,
@@ -311,14 +357,26 @@ The callback functions must match the following prototypes:
.Bl -item -offset indent
.It
.Ft typedef ssize_t
-.Fn archive_read_callback "struct archive *" "void *client_data" "const void **buffer"
+.Fo archive_read_callback
+.Fa "struct archive *"
+.Fa "void *client_data"
+.Fa "const void **buffer"
+.Fc
.It
.\" #if ARCHIVE_API_VERSION < 2
.Ft typedef int
-.Fn archive_skip_callback "struct archive *" "void *client_data" "size_t request"
+.Fo archive_skip_callback
+.Fa "struct archive *"
+.Fa "void *client_data"
+.Fa "size_t request"
+.Fc
.\" #else
.\" .Ft typedef off_t
-.\" .Fn archive_skip_callback "struct archive *" "void *client_data" "off_t request"
+.\" .Fo archive_skip_callback
+.\" .Fa "struct archive *"
+.\" .Fa "void *client_data"
+.\" .Fa "off_t request"
+.\" .Fc
.\" #endif
.It
.Ft typedef int