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

Mention --query where --remote was mentioned, since it has the same requirements (#101).

Browse Source
This commit is contained in:
Andrew Wood
2025-10-21 23:01:46 +01:00
parent 8361ed1fe2
commit a2191ff270
2 changed files with 22 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/pv.1
+11 -11
View File
@@ -707,8 +707,8 @@ pv \-\-numeric \-\-format '{"elapsed":%t,"bytes":%b,"rate":%r,"percentage":%{pro
.in
.\"
.SH EXIT STATUS
An exit status of 1 indicates a problem with the \*(lq\fB\-\-remote\fR\*(rq
or \*(lq\fB\-\-pidfile\fR\*(rq options.
An exit status of 1 indicates a problem with the \*(lq\fB\-\-remote\fR\*(rq,
\*(lq\fB\-\-query\fR\*(rq, or \*(lq\fB\-\-pidfile\fR\*(rq options.
.PP
Any other exit status is a bitmask of the following:
.TP 5
@@ -737,10 +737,10 @@ The following environment variables may affect \fBpv\fR:
.TP
.B HOME
The current user's home directory.
This may be used by \*(lq\fB\-\-remote\fR\*(rq to exchange messages between
\fBpv\fR instances: if the \fI/run/user/UID/\fR directory does not exist
(where \fIUID\fR is the current user ID), then \fI$HOME/.pv/\fR will be used
instead.
This may be used by \*(lq\fB\-\-remote\fR\*(rq and \*(lq\fB\-\-query\fR\*(rq
to exchange messages between \fBpv\fR instances: if the \fI/run/user/UID/\fR
directory does not exist (where \fIUID\fR is the current user ID), then
\fI$HOME/.pv/\fR will be used instead.
.TP
.BR TMPDIR ", " TMP
The directory to create per-tty lock files for the terminal when using
@@ -784,9 +784,9 @@ issue #105
.UE
for full details.
.PP
The \*(lq\fB\-\-remote\fR\*(rq option requires that either
\fI/run/user/<uid>/\fR or \fI$HOME/\fR can be written to, for inter-process
communication.
The \*(lq\fB\-\-remote\fR\*(rq and \*(lq\fB\-\-query\fR\*(rq options require
that either \fI/run/user/<uid>/\fR or \fI$HOME/\fR can be written to, for
inter-process communication.
.PP
The \*(lq\fB\-\-size\fR\*(rq option has no effect if used with
\*(lq\fB\-\-watchfd\fR\~\fIPID\fR\*(rq to watch all file descriptors of a
@@ -814,8 +814,8 @@ have a suffix.
.PP
Numbers passed to \*(lq\fB\-\-last\-written\fR\*(rq,
\*(lq\fB\-\-width\fR\*(rq, \*(lq\fB\-\-height\fR\*(rq,
\*(lq\fB\-\-average\-rate\-window\fR\*(rq, and \*(lq\fB\-\-remote\fR\*(rq
must be integers with no suffix.
\*(lq\fB\-\-average\-rate\-window\fR\*(rq, \*(lq\fB\-\-remote\fR\*(rq, and
\*(lq\fB\-\-query\fR\*(rq must be integers with no suffix.
.PP
When \*(lq\fB\-\-sparse\fR\*(rq is in effect and output is being written to
a file, that file may look like it has stopped growing if inspected with
docs/pv.1.md
+11 -9
View File
@@ -674,8 +674,8 @@ Showing progress as lines of JSON data:
# EXIT STATUS
An exit status of 1 indicates a problem with the "**\--remote**" or
"**\--pidfile**" options.
An exit status of 1 indicates a problem with the "**\--remote**",
"**\--query**", or "**\--pidfile**" options.
Any other exit status is a bitmask of the following:
@@ -713,9 +713,10 @@ The following environment variables may affect **pv**:
**HOME**
: The current user\'s home directory. This may be used by
"**\--remote**" to exchange messages between **pv** instances: if
the */run/user/UID/* directory does not exist (where *UID* is the
current user ID), then *\$HOME/.pv/* will be used instead.
"**\--remote**" and "**\--query**" to exchange messages between
**pv** instances: if the */run/user/UID/* directory does not exist
(where *UID* is the current user ID), then *\$HOME/.pv/* will be
used instead.
**TMPDIR**, **TMP**
@@ -747,8 +748,9 @@ brackets to force the use of a subshell:
Refer to [issue #105](https://codeberg.org/ivarch/pv/issues/105) for
full details.
The "**\--remote**" option requires that either */run/user/\<uid\>/* or
*\$HOME/* can be written to, for inter-process communication.
The "**\--remote**" and "**\--query**" options require that either
*/run/user/\<uid\>/* or *\$HOME/* can be written to, for inter-process
communication.
The "**\--size**" option has no effect if used with
"**\--watchfd** *PID*" to watch all file descriptors of a process, but
@@ -772,8 +774,8 @@ Numbers passed to "**\--interval**" and "**\--delay-start**" may be
integers or decimals, but may not have a suffix.
Numbers passed to "**\--last-written**", "**\--width**",
"**\--height**", "**\--average-rate-window**", and "**\--remote**" must
be integers with no suffix.
"**\--height**", "**\--average-rate-window**", "**\--remote**", and
"**\--query**" must be integers with no suffix.
When "**\--sparse**" is in effect and output is being written to a file,
that file may look like it has stopped growing if inspected with