From 73bc1ab139d203d8bc7eea107c3ffe767811e16f Mon Sep 17 00:00:00 2001 From: Andrew Wood Date: Tue, 10 Dec 2024 21:05:59 +0000 Subject: [PATCH] Classify --watchfd and --remote as "alternative operating modes" rather than "data transfer modifiers" since they change the way PV runs entirely. --- docs/pv.1 | 5 ++++- docs/pv.1.md | 4 +++- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/pv.1 b/docs/pv.1 index edacdc4..1e9c83e 100644 --- a/docs/pv.1 +++ b/docs/pv.1 @@ -338,6 +338,9 @@ size, so you can see its progress. Note that when doing this with relatively small amounts of data, \*(lq\fB\-\-no-splice\fR\*(rq may be preferable so that pipe buffering doesn't affect the progress display. +.\" +.\" +.SS "Alternative operating modes" .TP .BI \-d\ PID\fR[\fB:\fR\fIFD\fR],\ \fB\-\-watchfd\ PID\fR[\fB:\fR\fIFD\fR] Instead of transferring data, watch file descriptor \fIFD\fR of process @@ -363,7 +366,7 @@ Note that some options cannot be changed while running, such as \*(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. .\" -.SS "General options" +.SS "Other options" .TP .BI \-P\ FILE \fR,\ \fB\-\-pidfile\ FILE Save the process ID of \fBpv\fR in \fIFILE\fR. diff --git a/docs/pv.1.md b/docs/pv.1.md index 9f970d8..ec13b66 100644 --- a/docs/pv.1.md +++ b/docs/pv.1.md @@ -347,6 +347,8 @@ are explicitly switched on will be shown. be preferable so that pipe buffering doesn\'t affect the progress display. +## Alternative operating modes + **-d PID\[:FD\], \--watchfd PID\[:FD\]** : Instead of transferring data, watch file descriptor *FD* of process @@ -372,7 +374,7 @@ are explicitly switched on will be shown. "**\--delay-start**", "**\--skip-errors**", and "**\--stop-at-size**". -## General options +## Other options **-P FILE, \--pidfile FILE**