New --bar-style option; replace "default" with "plain" or with a lookup against the selected default, as appropriate.

This commit is contained in:
Andrew Wood
2024-12-14 00:06:30 +00:00
parent e3382b1a62
commit 8fa9df6e7a
21 changed files with 568 additions and 414 deletions
+2 -1
View File
@@ -1,7 +1,8 @@
### UNRELEASED
* *feature:* new **--bar-style** option to change the default bar style ([#15](https://codeberg.org/a-j-wood/pv/issues/15))
* *feature:* new bar formats "**%{bar-plain}**", "**%{bar-block}**", "**%{bar-granular}**", "**%{bar-shaded}**" ([#15](https://codeberg.org/a-j-wood/pv/issues/15))
* *feature:* allow decimal values such as "1.5G" with "**--size**", "**--rate-limit**", "**--buffer-size**", and "**error-skip-block**" ([#35](https://codeberg.org/a-j-wood/pv/issues/35))
* *feature:* new bar formats "**%{bar-default}**", "**%{bar-block}**", "**%{bar-granular}**", "**%{bar-shaded}**"
* *docs:* simplified the synopsis section of the manual
### 1.9.15 - 8 December 2024
+25 -12
View File
@@ -204,6 +204,14 @@ 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 \-u\ STYLE \fR,\ \fB\-\-bar\-style\ STYLE
Change the default progress bar style shown by \*(lq\fB\-\-progress\fR\*(rq,
or by the \*(lq\fB\-\-format\fR\*(rq sequences \*(lq\fB%{progress}\fR\*(rq
or \*(lq\fB%{progress\-bar\-only}\fR\*(rq, to \fISTYLE\fR.
The \fISTYLE\fR can be one of \fBplain\fR (the default), \fBblock\fR,
\fBgranular\fR, or \fBshaded\fR.
These styles are described in 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
@@ -391,37 +399,42 @@ Equivalent to \*(lq\fB\-\-progress\fR\*(rq.
Expands to fill the remaining space unless prefixed by a number to set the
width, such as \*(lq\fB%20p\fR\*(rq or \*(lq\fB%20{progress}\fR\*(rq.
.TP
.BR %{progress-bar-only} ", " %{bar} ", " %{bar-default}
.BR %{progress\-bar\-only}
Progress bar, without any sides, and without any percentage displayed
afterwards.
Expands to fill the remaining space unless prefixed by a number.
.TP
.B %{progress-amount-only}
.B %{progress\-amount\-only}
The percentage completion (or maximum rate, with \*(lq\fB\-\-gauge\fR\*(rq
when the size is unknown).
.TP
.B %{bar-block}
.B %{bar\-plain}
Progress bar in the standard plain format, without any sides, and without
any percentage displayed afterwards.
Expands to fill the remaining space unless prefixed by a number.
.TP
.B %{bar\-block}
Progress bar using Unicode full blocks, without any sides, and without any
percentage displayed afterwards.
Expands to fill the remaining space unless prefixed by a number.
If UTF-8 output is not available, the default format is used.
If UTF-8 output is not available, the plain format is used.
.TP
.B %{bar-granular}
.B %{bar\-granular}
Progress bar using Unicode full blocks, and 1/8th blocks for partial fills,
providing a more granular display.
Like the other \*(lq%{bar}\*(rq strings this shows the bar without any
sides, and without any percentage displayed afterwards, and expands to fill
the remaining space unless prefixed by a number.
If UTF-8 output is not available, the default format is used.
If UTF-8 output is not available, the plain format is used.
.TP
.B %{bar-shaded}
.B %{bar\-shaded}
Progress bar using Unicode full blocks and shade characters - dark and
medium shade are used for partial fills, and the light shade is used for the
background.
Like the other \*(lq%{bar}\*(rq strings this shows the bar without any
sides, and without any percentage displayed afterwards, and expands to fill
the remaining space unless prefixed by a number.
If UTF-8 output is not available, the default format is used.
If UTF-8 output is not available, the plain format is used.
.TP
.BR %t ", " %{timer}
Elapsed time.
@@ -439,7 +452,7 @@ Equivalent to \*(lq\fB\-\-fineta\fR\*(rq.
Current data transfer rate.
Equivalent to \*(lq\fB\-\-rate\fR\*(rq.
.TP
.BR %a ", " %{average-rate}
.BR %a ", " %{average\-rate}
Average data transfer rate.
Equivalent to \*(lq\fB\-\-average\-rate\fR\*(rq.
.TP
@@ -449,19 +462,19 @@ Equivalent to \*(lq\fB\-\-bytes\fR\*(rq.
If \*(lq\fB\-\-bits\fR\*(rq was specified, \*(lq\fB%b\fR\*(rq shows the bits
transferred so far, not bytes.
.TP
.BR %T ", " %{buffer-percent}
.BR %T ", " %{buffer\-percent}
Percentage of the transfer buffer in use.
Equivalent to \*(lq\fB\-\-buffer\-percent\fR\*(rq.
Displays \*(lq{\-\-\-\-}\*(rq if the transfer is being done with
\fBsplice\fR(2), since splicing to or from pipes does not use the buffer.
.TP
.BR %nA ", " %n{last-written}
.BR %nA ", " %n{last\-written}
Show the last \fIn\fR bytes written (for example, \*(lq\fB%16A\fR\*(rq shows
the last 16 bytes).
Shows only dots if the transfer is being done with \fBsplice\fR(2), since
splicing to or from pipes does not use the buffer.
.TP
.BR %nL ", " %n{previous-line}
.BR %nL ", " %n{previous\-line}
Show the first \fIn\fR bytes of the most recently written line (for example,
\*(lq\fB%40L\fR\*(rq shows the first 40 bytes).
If no \fIn\fR is given, then this expands to fill the available space.
+18 -4
View File
@@ -209,6 +209,14 @@ 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.
**-u STYLE, \--bar-style STYLE**
: Change the default progress bar style shown by "**\--progress**", or
by the "**\--format**" sequences "**%{progress}**" or
"**%{progress-bar-only}**", to *STYLE*. The *STYLE* can be one of
**plain** (the default), **block**, **granular**, or **shaded**.
These styles are described in the **FORMATTING** section below.
**-x SPEC, \--extra-display SPEC**
: As well as displaying progress to the terminal, also write it to
@@ -403,7 +411,7 @@ contain the following sequences:
unless prefixed by a number to set the width, such as "**%20p**" or
"**%20{progress}**".
**%{progress-bar-only}**, **%{bar}**, **%{bar-default}**
**%{progress-bar-only}**
: Progress bar, without any sides, and without any percentage
displayed afterwards. Expands to fill the remaining space unless
@@ -414,12 +422,18 @@ contain the following sequences:
: The percentage completion (or maximum rate, with "**\--gauge**" when
the size is unknown).
**%{bar-plain}**
: Progress bar in the standard plain format, without any sides, and
without any percentage displayed afterwards. Expands to fill the
remaining space unless prefixed by a number.
**%{bar-block}**
: Progress bar using Unicode full blocks, without any sides, and
without any percentage displayed afterwards. Expands to fill the
remaining space unless prefixed by a number. If UTF-8 output is not
available, the default format is used.
available, the plain format is used.
**%{bar-granular}**
@@ -428,7 +442,7 @@ contain the following sequences:
strings this shows the bar without any sides, and without any
percentage displayed afterwards, and expands to fill the remaining
space unless prefixed by a number. If UTF-8 output is not available,
the default format is used.
the plain format is used.
**%{bar-shaded}**
@@ -437,7 +451,7 @@ contain the following sequences:
used for the background. Like the other "%{bar}" strings this shows
the bar without any sides, and without any percentage displayed
afterwards, and expands to fill the remaining space unless prefixed
by a number. If UTF-8 output is not available, the default format is
by a number. If UTF-8 output is not available, the plain format is
used.
**%t**, **%{timer}**