From a2191ff270a21ebb3b99c2924f6f6c97d0c78e9a Mon Sep 17 00:00:00 2001 From: Andrew Wood Date: Tue, 21 Oct 2025 23:01:46 +0100 Subject: [PATCH] Mention --query where --remote was mentioned, since it has the same requirements (#101). --- docs/pv.1 | 22 +++++++++++----------- docs/pv.1.md | 20 +++++++++++--------- 2 files changed, 22 insertions(+), 20 deletions(-) diff --git a/docs/pv.1 b/docs/pv.1 index 742d28b..21ada56 100644 --- a/docs/pv.1 +++ b/docs/pv.1 @@ -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//\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//\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 diff --git a/docs/pv.1.md b/docs/pv.1.md index 4160617..48d7fcc 100644 --- a/docs/pv.1.md +++ b/docs/pv.1.md @@ -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/\/* or -*\$HOME/* can be written to, for inter-process communication. +The "**\--remote**" and "**\--query**" options require that either +*/run/user/\/* 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