diff options
author | Marc Espie <espie@cvs.openbsd.org> | 2023-05-16 10:51:37 +0000 |
---|---|---|
committer | Marc Espie <espie@cvs.openbsd.org> | 2023-05-16 10:51:37 +0000 |
commit | 74e8b1594ad241f0e756a02e0b6a4ec8d55dd355 (patch) | |
tree | d653b2c1e9c3e142bbca5ddea523959568116151 /usr.sbin/pkg_add | |
parent | 083f152715eb1c20ce9790973a7fe20fddf2d11d (diff) |
reflect reality better: document set_description and friends
Diffstat (limited to 'usr.sbin/pkg_add')
-rw-r--r-- | usr.sbin/pkg_add/OpenBSD/Ustar.pod | 16 |
1 files changed, 12 insertions, 4 deletions
diff --git a/usr.sbin/pkg_add/OpenBSD/Ustar.pod b/usr.sbin/pkg_add/OpenBSD/Ustar.pod index 1888abb0e48..d96941eba02 100644 --- a/usr.sbin/pkg_add/OpenBSD/Ustar.pod +++ b/usr.sbin/pkg_add/OpenBSD/Ustar.pod @@ -1,4 +1,4 @@ -$OpenBSD: Ustar.pod,v 1.1 2020/12/20 15:30:58 daniel Exp $ +$OpenBSD: Ustar.pod,v 1.2 2023/05/16 10:51:36 espie Exp $ =head1 NAME @@ -99,13 +99,21 @@ In case of errors, the archive will call C<$state-E<gt>fatal> with a suitable error message that contains the last index name processed. The user may set an optional archive description with C<set_description>. -The C<create> method can take an optional C<$callback> argument, which will -be called regularly while extracting large objects, as C<&$callback($donesize)>, -with C<$donesize> the number of bytes already extracted. +The archive object can take a description through C<$arc-E<gt>set_description> +which will be used in error messages related to archive extraction or creation. + +The archive object can be embued with a C<$callback> through +C<$arch-E<gt>set_callback>, which will be called regularly while +extracting large objects, as C<&$callback($donesize)>, +with C<$donesize> the number of bytes already extracted, for use in +progressmeter-style user interactions. Small files can also be directly extracted to a scalar using C<$v = $o-E<gt>contents>. +Actual file objects can also be directly extracted to a temporary file using +C<$oE<gt>extract_to_fh($fh)>. + Actual writing is performed through C<$o-E<gt>write> and is not mandatory either. |