summaryrefslogtreecommitdiff
path: root/lib/libarchive/archive_read.3
diff options
context:
space:
mode:
authorTim Kientzle <kientzle@FreeBSD.org>2004-05-13 06:01:14 +0000
committerTim Kientzle <kientzle@FreeBSD.org>2004-05-13 06:01:14 +0000
commit199984b3b27d7f50913e24a29b81ac0cf8f6b086 (patch)
tree9691b4723d8aed8daf1435d3e0403fb5001a0fc5 /lib/libarchive/archive_read.3
parent9cbb335cfd82d0cc01d456addfa8adc534b2e4f7 (diff)
downloadsrc-test2-199984b3b27d7f50913e24a29b81ac0cf8f6b086.tar.gz
src-test2-199984b3b27d7f50913e24a29b81ac0cf8f6b086.zip
Notes
Diffstat (limited to 'lib/libarchive/archive_read.3')
-rw-r--r--lib/libarchive/archive_read.312
1 files changed, 12 insertions, 0 deletions
diff --git a/lib/libarchive/archive_read.3 b/lib/libarchive/archive_read.3
index 28131cd4cb07..421b3f671673 100644
--- a/lib/libarchive/archive_read.3
+++ b/lib/libarchive/archive_read.3
@@ -47,6 +47,7 @@
.Nm archive_read_data_into_buffer ,
.Nm archive_read_data_into_file ,
.Nm archive_read_extract ,
+.Nm archive_read_extract_set_progress_callback ,
.Nm archive_read_finish
.Nd functions for reading tar archives
.Sh SYNOPSIS
@@ -90,6 +91,8 @@
.Ft int
.Fn archive_read_extract "struct archive *" "int flags"
.Ft void
+.Fn archive_read_extract_set_progress_callback "struct archive *" "void (*func)(void *)" "void *user_data"
+.Ft void
.Fn archive_read_finish "struct archive *"
.Sh DESCRIPTION
These functions provide a complete API for reading streaming archives.
@@ -202,6 +205,15 @@ By default, existing files are truncated and rewritten, but
the file is not recreated.
In particular, the default behavior does not break existing hard links.
.El
+.It Fn archive_read_extract_set_progress_callback
+Sets a pointer to a user-defined callback that can be used
+for updating progress displays during extraction.
+The progress function will be invoked during the extraction of large
+regular files.
+The progress function will be invoked with the pointer provided to this call.
+Generally, the data pointed to should include a reference to the archive
+object and the archive_entry object so that various statistics
+can be retrieved for the progress display.
.It Fn archive_read_finish
Complete the archive, invoke the close callback, and release
all resources.