#include inttypes.h, for strtoimax(3).

[bsd-progress.git] / progress.1

diff --git a/progress.1 b/progress.1
index 1497709bf6c51f6d7c9903508db0eb1bb73fedf1..346bbf454964638e386f32ac1e45f13507d4d1ff 100644 (file)
--- a/progress.1
+++ b/progress.1
@@ -1,6 +1,6 @@
-.\"    $NetBSD: progress.1,v 1.4 2003/02/10 23:59:16 grant Exp $
+.\"    $NetBSD: progress.1,v 1.11 2006/01/12 21:52:01 wiz Exp $
 .\"
-.\" Copyright (c) 2003 The NetBSD Foundation, Inc.
+.\" Copyright (c) 2003,2004 The NetBSD Foundation, Inc.
 .\" All rights reserved.
 .\"
 .\" This code is derived from software contributed to The NetBSD Foundation
@@ -30,7 +30,7 @@
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 .\" POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd January 21, 2003
+.Dd January 12, 2006
 .Dt PROGRESS 1
 .Os
 .Sh NAME
@@ -38,9 +38,10 @@
 .Nd feed input to a command, displaying a progress bar
 .Sh SYNOPSIS
 .Nm
-.Op Fl z
+.Op Fl ez
 .Op Fl f Ar file
 .Op Fl l Ar length
+.Op Fl p Ar prefix
 .Ar cmd
 .Op Ar args ...
 .Sh DESCRIPTION
@@ -64,6 +65,8 @@ simply displays a count of the data and the data rate.
 .Pp
 The options are as follows:
 .Bl -tag -width XlXlengthXX
+.It Fl e
+Display progress to standard error instead of standard output.
 .It Fl f Ar file
 Read from the specified
 .Ar file
@@ -72,9 +75,16 @@ instead of standard input.
 Use the specified length for the time estimate, rather than attempting to
 .Xr fstat 2
 the input.
+An optional suffix (per
+.Xr strsuftoll 3 )
+may be given.
+.It Fl p Ar prefix
+Print the given
+.Dq prefix
+text before (left of) the progress bar.
 .It Fl z
 Filter the input through
-.Xr gzip 1 .
+.Xr gunzip 1 .
 If
 .Fl f
 is specified, calculate the length using
@@ -85,7 +95,7 @@ is specified, calculate the length using
 exits 0 on success.
 .Sh EXAMPLES
 The command
-.Ic progress -zf file.tar.gz tar xf -
+.Dl progress -zf file.tar.gz tar xf -
 will extract the
 .Pa file.tar.gz
 displaying the progress bar as time passes:
@@ -98,10 +108,22 @@ displaying the progress bar as time passes:
 .Pp
 If it is preferred to monitor the progress of the decompression
 process (unlikely), then
-.Ic progress -f file.tar.gz tar zxf -
+.Dl progress -f file.tar.gz tar zxf -
 could be used.
+.Pp
+The command
+.Dl dd if=/dev/rwd0d ibs=64k | \e
+.Dl progress -l 120g dd of=/dev/rwd1d obs=64k
+will copy the 120 GB disk
+.Sy wd0
+.Pa ( /dev/rwd0d )
+to
+.Sy wd1
+.Pa ( /dev/rwd1d ) ,
+displaying a progress bar during the operation.
 .Sh SEE ALSO
-.Xr ftp 1
+.Xr ftp 1 ,
+.Xr strsuftoll 3
 .Sh HISTORY
 .Nm
 first appeared in
@@ -111,7 +133,8 @@ The dynamic progress bar display code is part of
 .Sh AUTHORS
 .Nm
 was written by
-.An John Hawkinson Aq jhawk@NetBSD.ORG .
+.An John Hawkinson
+.Aq jhawk@NetBSD.org .
 .Xr ftp 1 Ns 's
 dynamic progress bar was written by Luke Mewburn.
 .Sh BUGS