1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
|
PV(1) User Manuals PV(1)
NAME
pv - monitor the progress of data through a pipe
SYNOPSIS
pv [OPTION] [FILE]...
pv [-h|-l|-V]
DESCRIPTION
pv allows a user to see the progress of data through a
pipeline, by giving information such as time elapsed, per
centage completed (with progress bar), current throughput
rate, total data transferred, and ETA.
To use it, insert it in a pipeline between two processes,
with the appropriate options. Its standard input will be
passed through to its standard output and progress will be
shown on standard error.
pv will copy each supplied FILE in turn to standard output
(- means standard input), or if no FILEs are specified
just standard input is copied. This is the same behaviour
as cat(1).
A simple example to watch how quickly a file is trans
ferred using nc(1):
pv file | nc -w 1 somewhere.com 3000
A similar example, transferring a file from another pro
cess and passing the expected size to pv:
cat file | pv -s 12345 | nc -w 1 somewhere.com 3000
A more complicated example using numeric output to feed
into the dialog(1) program for a full-screen progress dis
play:
(tar cf - . \
| pv -n -s `du -sb . | awk '{print $1}'` \
| gzip -9 > out.tgz) 2>&1 \
| dialog --gauge 'Progress' 7 70
Frequent use of this third form is not recommended as it
may cause the programmer to overheat.
OPTIONS
pv takes many options, which are divided into display
switches, output modifiers, and general options.
DISPLAY SWITCHES
If no display switches are specified, pv behaves as if -p,
-t, -e, -r, and -b had been given (i.e. everything is
switched on). Otherwise, only those display types that are
explicitly switched on will be shown.
-p, --progress
Turn the progress bar on. If standard input is not
a file and no size was given (with the -s modi
fier), the progress bar cannot indicate how close
to completion the transfer is, so it will just move
left and right to indicate that data is moving.
-t, --timer
Turn the timer on. This will display the total
elapsed time that pv has been running for.
-e, --eta
Turn the ETA timer on. This will attempt to guess,
based on previous transfer rates and the total data
size, how long it will be before completion. This
option will have no effect if the total data size
cannot be determined.
-r, --rate
Turn the rate counter on. This will display the
current rate of data transfer.
-b, --bytes
Turn the total byte counter on. This will display
the total amount of data transferred so far.
-n, --numeric
Numeric output. Instead of giving a visual indica
tion of progress, pv will give an integer percent
age, one per line, on standard error, suitable for
piping (via convoluted redirection) into dialog(1).
Note that -f is not required if -n is being used.
-q, --quiet
No output. Useful if the -L option is being used
on its own to just limit the transfer rate of a
pipe.
OUTPUT MODIFIERS
-L RATE, --rate-limit RATE
Limit the transfer to a maximum of RATE bytes per
second. A suffix of "k", "m", "g", or "t" can be
added to denote kilobytes (*1024), megabytes, and
so on.
-W, --wait
Wait until the first byte has been transferred
before showing any progress information or calcu
lating any ETAs. Useful if the program you are
piping to or from requires extra information before
it starts, eg piping data into gpg(1) or mcrypt(1)
which require a passphrase before data can be pro
cessed.
-s SIZE, --size SIZE
Assume the total amount of data to be transferred
is SIZE bytes when calculating percentages and
ETAs. The same suffixes of "k", "m" etc can be
used as with -L.
-i SEC, --interval SEC
Wait SEC seconds between updates. The default is
to update every second. Note that this can be a
decimal such as 0.1.
-w WIDTH, --width WIDTH
Assume the terminal is WIDTH characters wide,
instead of trying to work it out (or assuming 80 if
it cannot be guessed).
-H HEIGHT, --height HEIGHT
Assume the terminal is HEIGHT rows high, instead of
trying to work it out (or assuming 25 if it cannot
be guessed).
-N NAME, --name NAME
Prefix the output information with NAME. Useful in
conjunction with -c if you have a complicated
pipeline and you want to be able to tell different
parts of it apart.
-f, --force
Force output. Normally, pv will not output any
visual display if standard error is not a terminal.
This option forces it to do so.
-c, --cursor
Use cursor positioning escape sequences instead of
just using carriage returns. This is useful in
conjunction with -N (name) if you are using multi
ple pv invocations in a single, long, pipeline.
GENERAL OPTIONS
-h, --help
Print a usage message on standard output and exit
successfully.
-l, --license
Print details of the program's license on standard
output and exit successfully.
-V, --version
Print version information on standard output and
exit successfully.
AUTHORS
Andrew Wood <andrew.wood@ivarch.com>
http://www.ivarch.com/
Cedric Delfosse <cedric@debian.org>
(Debian package maintainer)
Eduardo Aguiar <eduardo.oliveira@sondabrasil.com.br>
(provided Portuguese [Brazilian] translation)
Stephane Lacasse <tecknojunky@tecknojunky.com>
(provided French translation)
http://www.tecknojunky.com/
Marcos Kreinacke <m.kreinacke@nettec-systeme.net>
(provided German translation)
Bartosz Fenski <fenio@o2.pl>
(provided Polish translation, along with Krystian Zubel)
http://skawina.eu.org/
Joshua Jensen
(reported RPM installation bug)
Boris Folgmann
(reported cursor handling bug)
http://www.folgmann.com/en/
Mathias Gumz
(reported NLS bug)
BUGS
If you find any bugs, please contact the primary author,
either by email or by using the contact form on the web
site.
SEE ALSO
cat(1), dialog(1)
The documentation for pv is also maintained as a Texinfo
manual. If the info and pv programs are properly
installed at your site, the command
info pv
should give you access to the Texinfo manual.
LICENSE
This is free software, distributed under the ARTISTIC
license.
Linux November 2004 PV(1)
|
