Use long options in examples where it makes sense to do so, for readability.

This commit is contained in:
Andrew Wood
2024-12-10 20:56:25 +00:00
parent ad54067b48
commit 0e24c9f453
2 changed files with 10 additions and 10 deletions
+5 -5
View File
@@ -495,7 +495,7 @@ expected size to \fBpv\fR:
.PP
.in +4
.EX
cat file | pv \-s 12345 | nc \-w 1 somewhere.com 3000
cat file | pv \-\-size 12345 | nc \-w 1 somewhere.com 3000
.EE
.in
.PP
@@ -505,7 +505,7 @@ A more complicated example using numeric output to feed into the
.in +4
.EX
(tar cf \- . \e
| pv \-n \-s $(du \-sb . | awk '{print $1}') \e
| pv \-\-numeric \-\-size $(du \-sb . | awk '{print $1}') \e
| gzip \-9 > out.tgz) 2>&1 \e
| dialog \-\-gauge 'Progress' 7 70
.EE
@@ -544,7 +544,7 @@ been given.
.PP
.in +4
.EX
pv \-d 1234:3
pv \-\-watchfd 1234:3
.EE
.in
.PP
@@ -552,7 +552,7 @@ pv \-d 1234:3
.PP
.in +4
.EX
pv \-d 1234
pv \-\-watchfd 1234
.EE
.in
.PP
@@ -561,7 +561,7 @@ the progress display:
.PP
.in +4
.EX
pv \-F '%a %p : %L' big.log | processing-script
pv \-\-format '%a %p : %L' big.log | processing-script
.EE
.in
.\"
+5 -5
View File
@@ -516,13 +516,13 @@ To watch how quickly a file is transferred using **nc**(1):
A similar example, transferring a file from another process and passing
the expected size to **pv**:
cat file | pv -s 12345 | nc -w 1 somewhere.com 3000
cat file | pv --size 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 display:
(tar cf - . \
| pv -n -s $(du -sb . | awk '{print $1}') \
| pv --numeric --size $(du -sb . | awk '{print $1}') \
| gzip -9 > out.tgz) 2>&1 \
| dialog --gauge 'Progress' 7 70
@@ -546,17 +546,17 @@ been given.
(Linux and macOS only): Watching file descriptor 3 opened by another
process 1234:
pv -d 1234:3
pv --watchfd 1234:3
(Linux and macOS only): Watching all file descriptors used by process
1234:
pv -d 1234
pv --watchfd 1234
Sending logs to a processing script, showing the most recent line as
part of the progress display:
pv -F '%a %p : %L' big.log | processing-script
pv --format '%a %p : %L' big.log | processing-script
# EXIT STATUS