progress: Port for Linux and Darwin

[bsd-progress.git] / progress.1

diff --git a/progress.1 b/progress.1
index b015e3ec5cee732c185e877fd593fb1f8ca40ffc..028bda94fb811d6b97de4da787880e47052c650c 100644 (file)
--- a/progress.1
+++ b/progress.1
@@ -1,6 +1,6 @@
-.\"    $NetBSD: progress.1,v 1.10 2006/01/12 20:33:20 garbled Exp $
+.\"    $NetBSD: progress.1,v 1.15 2014/04/13 01:45:34 snj Exp $

 .\"
 .\"

-.\" Copyright (c) 2003,2004 The NetBSD Foundation, Inc.
+.\" Copyright (c) 2003-2007 The NetBSD Foundation, Inc.

 .\" All rights reserved.
 .\"
 .\" This code is derived from software contributed to The NetBSD Foundation
 .\" All rights reserved.
 .\"
 .\" This code is derived from software contributed to The NetBSD Foundation


@@ -14,9 +14,6 @@
 .\" 2. Redistributions in binary form must reproduce the above copyright
 .\"    notice, this list of conditions and the following disclaimer in the
 .\"    documentation and/or other materials provided with the distribution.
 .\" 2. Redistributions in binary form must reproduce the above copyright
 .\"    notice, this list of conditions and the following disclaimer in the
 .\"    documentation and/or other materials provided with the distribution.

-.\" 3. Neither the name of The NetBSD Foundation nor the names of its
-.\"    contributors may be used to endorse or promote products derived
-.\"    from this software without specific prior written permission.

 .\"
 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 .\"
 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED


@@ -30,7 +27,7 @@
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 .\" POSSIBILITY OF SUCH DAMAGE.
 .\"
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 .\" POSSIBILITY OF SUCH DAMAGE.
 .\"

-.Dd April 3, 2004
+.Dd June 6, 2007

 .Dt PROGRESS 1
 .Os
 .Sh NAME
 .Dt PROGRESS 1
 .Os
 .Sh NAME


@@ -39,6 +36,7 @@
 .Sh SYNOPSIS
 .Nm
 .Op Fl ez
 .Sh SYNOPSIS
 .Nm
 .Op Fl ez

+.Op Fl b Ar buffersize

 .Op Fl f Ar file
 .Op Fl l Ar length
 .Op Fl p Ar prefix
 .Op Fl f Ar file
 .Op Fl l Ar length
 .Op Fl p Ar prefix


@@ -65,6 +63,11 @@ simply displays a count of the data and the data rate.
 .Pp
 The options are as follows:
 .Bl -tag -width XlXlengthXX
 .Pp
 The options are as follows:
 .Bl -tag -width XlXlengthXX

+.It Fl b Ar buffersize
+Read in buffers of the specified size (default 64k).
+An optional suffix (per
+.Xr strsuftoll 3 )
+may be given.

 .It Fl e
 Display progress to standard error instead of standard output.
 .It Fl f Ar file
 .It Fl e
 Display progress to standard error instead of standard output.
 .It Fl f Ar file


@@ -91,8 +94,7 @@ is specified, calculate the length using
 .Ic gzip -l .
 .El
 .Sh EXIT STATUS
 .Ic gzip -l .
 .El
 .Sh EXIT STATUS

-.Nm
-exits 0 on success.
+.Ex -std

 .Sh EXAMPLES
 The command
 .Dl progress -zf file.tar.gz tar xf -
 .Sh EXAMPLES
 The command
 .Dl progress -zf file.tar.gz tar xf -


@@ -100,10 +102,10 @@ will extract the
 .Pa file.tar.gz
 displaying the progress bar as time passes:
 .Bd -literal
 .Pa file.tar.gz
 displaying the progress bar as time passes:
 .Bd -literal

-  0% |                                 |     0       0.00 KB/s    --:-- ETA
- 40% |**********                       |   273 KB  271.95 KB/s    00:01 ETA
- 81% |*************************        |   553 KB  274.61 KB/s    00:00 ETA
-100% |*********************************|   680 KB  264.59 KB/s    00:00 ETA
+  0% |                               |     0        0.00 KiB/s    --:-- ETA
+ 40% |********                       |   273 KiB  271.95 KiB/s    00:01 ETA
+ 81% |***********************        |   553 KiB  274.61 KiB/s    00:00 ETA
+100% |*******************************|   680 KiB  264.59 KiB/s    00:00 ETA

 .Ed
 .Pp
 If it is preferred to monitor the progress of the decompression
 .Ed
 .Pp
 If it is preferred to monitor the progress of the decompression


@@ -114,7 +116,7 @@ could be used.
 The command
 .Dl dd if=/dev/rwd0d ibs=64k | \e
 .Dl progress -l 120g dd of=/dev/rwd1d obs=64k
 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
+will copy the 120 GiB disk

 .Sy wd0
 .Pa ( /dev/rwd0d )
 to
 .Sy wd0
 .Pa ( /dev/rwd0d )
 to