progress.1

   1 .\"     $NetBSD: progress.1,v 1.8 2004/03/25 20:29:51 hubertf Exp $
   2 .\"
   3 .\" Copyright (c) 2003 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to The NetBSD Foundation
   7 .\" by John Hawkinson.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\" 3. Neither the name of The NetBSD Foundation nor the names of its
  18 .\"    contributors may be used to endorse or promote products derived
  19 .\"    from this software without specific prior written permission.
  20 .\"
  21 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  22 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  23 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  24 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  25 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  26 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  27 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  28 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  29 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  30 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  31 .\" POSSIBILITY OF SUCH DAMAGE.
  32 .\"
  33 .Dd March 5, 2004
  34 .Dt PROGRESS 1
  35 .Os
  36 .Sh NAME
  37 .Nm progress
  38 .Nd feed input to a command, displaying a progress bar
  39 .Sh SYNOPSIS
  40 .Nm
  41 .Op Fl z
  42 .Op Fl f Ar file
  43 .Op Fl l Ar length
  44 .Op Fl p Ar prefix
  45 .Ar cmd
  46 .Op Ar args ...
  47 .Sh DESCRIPTION
  48 The
  49 .Nm
  50 utility opens a pipe to
  51 .Ar cmd
  52 and feeds an input stream into it, while displaying a progress bar to
  53 standard output.
  54 If no filename is specified,
  55 .Nm
  56 reads from standard input.
  57 Where feasible,
  58 .Nm
  59 .Xr fstat 2 Ns s
  60 the input to determine the length, so a time estimate can be calculated.
  61 .Pp
  62 If no length is specified or determined,
  63 .Nm
  64 simply displays a count of the data and the data rate.
  65 .Pp
  66 The options are as follows:
  67 .Bl -tag -width XlXlengthXX
  68 .It Fl f Ar file
  69 Read from the specified
  70 .Ar file
  71 instead of standard input.
  72 .It Fl l Ar length
  73 Use the specified length for the time estimate, rather than attempting to
  74 .Xr fstat 2
  75 the input.
  76 .It Fl p Ar prefix
  77 Print the given
  78 .Dq prefix
  79 text before (left of) the progress bar.
  80 .It Fl z
  81 Filter the input through
  82 .Xr gunzip 1 .
  83 If
  84 .Fl f
  85 is specified, calculate the length using
  86 .Ic gzip -l .
  87 .El
  88 .Sh EXIT STATUS
  89 .Nm
  90 exits 0 on success.
  91 .Sh EXAMPLES
  92 The command
  93 .Ic progress -zf file.tar.gz tar xf -
  94 will extract the
  95 .Pa file.tar.gz
  96 displaying the progress bar as time passes:
  97 .Bd -literal
  98   0% |                                 |     0       0.00 KB/s    --:-- ETA
  99  40% |**********                       |   273 KB  271.95 KB/s    00:01 ETA
 100  81% |*************************        |   553 KB  274.61 KB/s    00:00 ETA
 101 100% |*********************************|   680 KB  264.59 KB/s    00:00 ETA
 102 .Ed
 103 .Pp
 104 If it is preferred to monitor the progress of the decompression
 105 process (unlikely), then
 106 .Ic progress -f file.tar.gz tar zxf -
 107 could be used.
 108 .Sh SEE ALSO
 109 .Xr ftp 1
 110 .Sh HISTORY
 111 .Nm
 112 first appeared in
 113 .Nx 1.6.1 .
 114 The dynamic progress bar display code is part of
 115 .Xr ftp 1 .
 116 .Sh AUTHORS
 117 .Nm
 118 was written by
 119 .An John Hawkinson
 120 .Aq jhawk@NetBSD.org .
 121 .Xr ftp 1 Ns 's
 122 dynamic progress bar was written by Luke Mewburn.
 123 .Sh BUGS
 124 Since the progress bar is displayed asynchronously, it may be
 125 difficult to read some error messages, both those produced by the
 126 pipeline, as well as those produced by
 127 .Nm
 128 itself.