mirrors/pv
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Document the %{bar-*} format sequences.

Browse Source
This commit is contained in:
Andrew Wood
2024-12-13 23:15:08 +00:00
parent 29c7a21725
commit e3382b1a62
2 changed files with 52 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/pv.1
+25 -2
View File
@@ -1,4 +1,4 @@
.TH PV 1 2024-12-10 pv-1.9.15 "User Commands"
.TH PV 1 2024-12-13 pv-1.9.15 "User Commands"
.\"
.SH NAME
pv \- monitor the progress of data through a pipe
@@ -391,7 +391,7 @@ 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
.B %{progress-bar-only}
.BR %{progress-bar-only} ", " %{bar} ", " %{bar-default}
Progress bar, without any sides, and without any percentage displayed
afterwards.
Expands to fill the remaining space unless prefixed by a number.
@@ -400,6 +400,29 @@ Expands to fill the remaining space unless prefixed by a number.
The percentage completion (or maximum rate, with \*(lq\fB\-\-gauge\fR\*(rq
when the size is unknown).
.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.
.TP
.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.
.TP
.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.
.TP
.BR %t ", " %{timer}
Elapsed time.
Equivalent to \*(lq\fB\-\-timer\fR\*(rq.
docs/pv.1.md
+27 -1
View File
@@ -403,7 +403,7 @@ contain the following sequences:
unless prefixed by a number to set the width, such as "**%20p**" or
"**%20{progress}**".
**%{progress-bar-only}**
**%{progress-bar-only}**, **%{bar}**, **%{bar-default}**
: Progress bar, without any sides, and without any percentage
displayed afterwards. Expands to fill the remaining space unless
@@ -414,6 +414,32 @@ contain the following sequences:
: The percentage completion (or maximum rate, with "**\--gauge**" when
the size is unknown).
**%{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.
**%{bar-granular}**
: Progress bar using Unicode full blocks, and 1/8th blocks for partial
fills, providing a more granular display. 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 used.
**%{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 "%{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
used.
**%t**, **%{timer}**
: Elapsed time. Equivalent to "**\--timer**".