Move "--extra-display" and "--stats" to the "Output modifiers" section, since they are not really display switches that directly affect the terminal progress display.

This commit is contained in:
Andrew Wood
2024-12-02 17:36:16 +00:00
parent 2dac3d1128
commit 503a559b2a
3 changed files with 45 additions and 45 deletions
+19 -19
View File
@@ -179,25 +179,6 @@ Ignore all of the above options and instead use the format string
\fIFORMAT\fR to determine the output format.
See the \fBFORMATTING\fR section below.
.TP
.BI \-x\ SPEC \fR,\ \fB\-\-extra\-display\ SPEC
As well as displaying progress to the terminal, also write it to \fISPEC\fR.
The \fISPEC\fR must start with a comma-separated list of destinations, and
can optionally be followed by a colon and a format string.
The destinations can be \fBwindowtitle\fR or \fBwindow\fR for the xterm
window title, and \fBprocesstitle\fR, \fBproctitle\fR, \fBprocess\fR, or
\fBproc\fR for the process title displayed by \fBps\fR(1).
If a format string is not supplied, the same format is used as for the
terminal.
For example, \*(lq\fB\-x\~'window,process:%t\~%b\~%r'\fR\*(rq will show the
elapsed time, bytes transferred, and rate, in both the window title and the
process title.
.TP
.B \-v, \-\-stats
At the end of the transfer, write an additional line showing the transfer
rate minimum, maximum, mean, and standard deviation.
The values are always in bytes per second (or bits, with
\*(lq\fB\-\-bits\fR\*(rq).
.TP
.B \-n, \-\-numeric
Numeric output.
Instead of giving a visual indication of progress, write an integer
@@ -312,6 +293,25 @@ Useful in conjunction with \*(lq\fB\-\-cursor\fR\*(rq if you have a
complicated pipeline and you want to be able to tell different parts of it
apart.
.TP
.BI \-x\ SPEC \fR,\ \fB\-\-extra\-display\ SPEC
As well as displaying progress to the terminal, also write it to \fISPEC\fR.
The \fISPEC\fR must start with a comma-separated list of destinations, and
can optionally be followed by a colon and a format string.
The destinations can be \fBwindowtitle\fR or \fBwindow\fR for the xterm
window title, and \fBprocesstitle\fR, \fBproctitle\fR, \fBprocess\fR, or
\fBproc\fR for the process title displayed by \fBps\fR(1).
If a format string is not supplied, the same format is used as for the
terminal.
For example, \*(lq\fB\-x\~'window,process:%t\~%b\~%r'\fR\*(rq will show the
elapsed time, bytes transferred, and rate, in both the window title and the
process title.
.TP
.B \-v, \-\-stats
At the end of the transfer, write an additional line showing the transfer
rate minimum, maximum, mean, and standard deviation.
The values are always in bytes per second (or bits, with
\*(lq\fB\-\-bits\fR\*(rq).
.TP
.B \-f, \-\-force
Force output.
Normally, \fBpv\fR will not output any visual display if standard error is
+20 -20
View File
@@ -119,26 +119,6 @@ are explicitly switched on will be shown.
*FORMAT* to determine the output format. See the **FORMATTING**
section below.
**-x SPEC, \--extra-display SPEC**
: As well as displaying progress to the terminal, also write it to
*SPEC*. The *SPEC* must start with a comma-separated list of
destinations, and can optionally be followed by a colon and a format
string. The destinations can be **windowtitle** or **window** for
the xterm window title, and **processtitle**, **proctitle**,
**process**, or **proc** for the process title displayed by
**ps**(1). If a format string is not supplied, the same format is
used as for the terminal. For example,
"**-x \'window,process:%t %b %r\'**" will show the elapsed time,
bytes transferred, and rate, in both the window title and the
process title.
**-v, \--stats**
: At the end of the transfer, write an additional line showing the
transfer rate minimum, maximum, mean, and standard deviation. The
values are always in bytes per second (or bits, with "**\--bits**").
**-n, \--numeric**
: Numeric output. Instead of giving a visual indication of progress,
@@ -255,6 +235,26 @@ are explicitly switched on will be shown.
with "**\--cursor**" if you have a complicated pipeline and you want
to be able to tell different parts of it apart.
**-x SPEC, \--extra-display SPEC**
: As well as displaying progress to the terminal, also write it to
*SPEC*. The *SPEC* must start with a comma-separated list of
destinations, and can optionally be followed by a colon and a format
string. The destinations can be **windowtitle** or **window** for
the xterm window title, and **processtitle**, **proctitle**,
**process**, or **proc** for the process title displayed by
**ps**(1). If a format string is not supplied, the same format is
used as for the terminal. For example,
"**-x \'window,process:%t %b %r\'**" will show the elapsed time,
bytes transferred, and rate, in both the window title and the
process title.
**-v, \--stats**
: At the end of the transfer, write an additional line showing the
transfer rate minimum, maximum, mean, and standard deviation. The
values are always in bytes per second (or bits, with "**\--bits**").
**-f, \--force**
: Force output. Normally, **pv** will not output any visual display if
+6 -6
View File
@@ -310,12 +310,6 @@ void display_help(void)
{ "-F", "--format", N_("FORMAT"),
N_("set output format to FORMAT"),
{ 0, 0, 0, 0} },
{ "-x", "--extra-display", N_("SPEC"),
N_("also send progress to SPEC"),
{ 0, 0, 0, 0} },
{ "-v", "--stats", NULL,
N_("output transfer statistics at the end"),
{ 0, 0, 0, 0} },
{ "-n", "--numeric", NULL,
N_("output percentages, not visual information"),
{ 0, 0, 0, 0} },
@@ -362,6 +356,12 @@ void display_help(void)
{ "-N", "--name", N_("NAME"),
N_("prefix visual information with NAME"),
{ 0, 0, 0, 0} },
{ "-x", "--extra-display", N_("SPEC"),
N_("also send progress to SPEC"),
{ 0, 0, 0, 0} },
{ "-v", "--stats", NULL,
N_("output transfer statistics at the end"),
{ 0, 0, 0, 0} },
{ "-f", "--force", NULL,
N_("output even if standard error is not a terminal"),
{ 0, 0, 0, 0} },