Draft manual entry, help text, and option parsing for "--query" option (#101).

This commit is contained in:
Andrew Wood
2025-10-20 21:17:59 +01:00
parent fc379727cc
commit 3f1782a573
6 changed files with 59 additions and 1 deletions
+12
View File
@@ -11,6 +11,8 @@ pv \- monitor and manage the progress of data through a pipe
\fIPID\fR[:\fIFD\fR]|=\fINAME\fR|@\fILISTFILE\fR...
.PP
\fBpv\fR \fB\-R\fR|\fB\-\-remote\fR \fIPID\fR [\fIOPTION\fR]...
.PP
\fBpv\fR \fB\-Q\fR|\fB\-\-query\fR \fIPID\fR [\fIOPTION\fR]...
.\"
.SH DESCRIPTION
Show the progress of data through a pipeline by giving information such as
@@ -395,6 +397,16 @@ Note that some options cannot be changed while running, such as
\*(lq\fB\-\-cursor\fR\*(rq, \*(lq\fB\-\-line\-mode\fR\*(rq,
\*(lq\fB\-\-force\fR\*(rq, \*(lq\fB\-\-delay\-start\fR\*(rq,
\*(lq\fB\-\-skip\-errors\fR\*(rq, and \*(lq\fB\-\-stop\-at\-size\fR\*(rq.
.TP
.BI \-Q\ PID \fR,\ \fB\-\-query\ PID
Display the transfer progress of another instance of \fBpv\fR with process
ID \fIPID\fR.
Some output modifiers can only be used while querying another process if
they match those of that process - such as
\*(lq\fB\-\-line\-mode\fR\*(rq,
\*(lq\fB\-\-null\fR\*(rq, and
\*(lq\fB\-\-average\-rate\-window\fR\*(rq.
Data transfer modifiers will have no effect.
.\"
.SS "Other options"
.TP
+11
View File
@@ -11,6 +11,8 @@ pv - monitor and manage the progress of data through a pipe
**pv** **-R**\|**\--remote** *PID* \[*OPTION*\]\...
**pv** **-Q**\|**\--query** *PID* \[*OPTION*\]\...
# DESCRIPTION
Show the progress of data through a pipeline by giving information such
@@ -410,6 +412,15 @@ are explicitly switched on will be shown.
"**\--delay-start**", "**\--skip-errors**", and
"**\--stop-at-size**".
**-Q PID, \--query PID**
: Display the transfer progress of another instance of **pv** with
process ID *PID*. Some output modifiers can only be used while
querying another process if they match those of that process - such
as "**\--line-mode**", "**\--null**", and
"**\--average-rate-window**". Data transfer modifiers will have no
effect.
## Other options
**-P FILE, \--pidfile FILE**