From e99a58b430ad20341dc06c675dfe6ee915f9559f Mon Sep 17 00:00:00 2001
From: Andrew Wood <ivarch657@gmail.com>
Date: Tue, 10 Dec 2024 20:44:43 +0000
Subject: [PATCH] Remove the SY macros from the manual since they are not
 universally supported, and replace the technically correct and complete, but
 user-hostile, synopsis with a simplified version that lists the main modes of
 operation.

---
 docs/NEWS.md |  4 +++
 docs/pv.1    | 95 ++--------------------------------------------------
 docs/pv.1.md | 30 ++---------------
 3 files changed, 9 insertions(+), 120 deletions(-)

diff --git a/docs/NEWS.md b/docs/NEWS.md
index 56eff05..55e025c 100644
--- a/docs/NEWS.md
+++ b/docs/NEWS.md
@@ -1,3 +1,7 @@
+### UNRELEASED
+
+ * *docs:* simplified the synopsis section of the manual
+
 ### 1.9.15 - 8 December 2024
 
  * *feature:* new **--format** sequence "**%nL**", showing the most recent line written ([#121](https://codeberg.org/a-j-wood/pv/issues/121))
diff --git a/docs/pv.1 b/docs/pv.1
index 8c0e1b3..9349caf 100644
--- a/docs/pv.1
+++ b/docs/pv.1
@@ -1,4 +1,4 @@
-.TH PV 1 2024-12-08 pv-1.9.15 "User Commands"
+.TH PV 1 2024-12-10 pv-1.9.15 "User Commands"
 .\"
 .SH NAME
 pv \- monitor the progress of data through a pipe
@@ -7,98 +7,9 @@ pv \- monitor the progress of data through a pipe
 .B pv
 [\fIOPTION\fR]... [\fIFILE\fR]...
 .PP
-.SY pv
-.OP \-pteIrab8kTv
-.OP \-A NUM
-.OP \-F FORMAT
-.OP \-x SPEC
-.OP \-Wgl0fc
-.OP \-D SEC
-.OP \-s SIZE
-.OP \-i SEC
-.OP \-m SEC
-.OP \-w WIDTH
-.OP \-H HEIGHT
-.OP \-N NAME
-.OP \-o FILE
-.OP \-L RATE
-.OP \-B BYTES
-.OP \-CESYKX
-.OP \-Z BYTES
-.OP \-U FILE
-.OP \-P FILE
-.RI [ FILE
-\&.\|.\|.\&]
+\fBpv\fR \fB\-d\fR|\fB\-\-watchfd\fR \fIPID\fR[:\fIFD\fR] [\fIOPTION\fR]...
 .PP
-.SY pv
-.B \-n
-.OP \-trbv
-.OP \-Wl0
-.OP \-D SEC
-.OP \-s SIZE
-.OP \-i SEC
-.OP \-o FILE
-.OP \-L RATE
-.OP \-B BYTES
-.OP \-CESYKX
-.OP \-Z BYTES
-.OP \-U FILE
-.OP \-P FILE
-.RI [ FILE
-\&.\|.\|.\&]
-.PP
-.SY pv
-.B \-q
-.OP \-v
-.OP \-s SIZE
-.OP \-o FILE
-.OP \-L RATE
-.OP \-B BYTES
-.OP \-CESYKX
-.OP \-Z BYTES
-.OP \-U FILE
-.OP \-P FILE
-.RI [ FILE
-\&.\|.\|.\&]
-.PP
-.SY pv
-.B \-R
-.I PID
-.OP \-pteIrabT
-.OP \-A NUM
-.OP \-F FORMAT
-.OP \-s SIZE
-.OP \-i SEC
-.OP \-w WIDTH
-.OP \-H HEIGHT
-.OP \-N NAME
-.OP \-L RATE
-.OP \-B BYTES
-.PP
-.SY pv
-.B \-d
-.I PID:FD
-.OP \-pteIrab8kTnq
-.OP \-F FORMAT
-.OP \-i SEC
-.OP \-w WIDTH
-.OP \-H HEIGHT
-.PP
-.SY pv
-.B \-d
-.I PID
-.OP \-pteIrab8kTnq
-.OP \-F FORMAT
-.OP \-i SEC
-.OP \-w WIDTH
-.OP \-H HEIGHT
-.PP
-.SY pv
-.B \-h
-.PP
-.SY pv
-.B \-V
-.YS
+\fBpv\fR \fB\-R\fR|\fB\-\-remote\fR \fIPID\fR [\fIOPTION\fR]...
 .\"
 .SH DESCRIPTION
 Show the progress of data through a pipeline by giving information such as
diff --git a/docs/pv.1.md b/docs/pv.1.md
index 670f0f5..50eb96b 100644
--- a/docs/pv.1.md
+++ b/docs/pv.1.md
@@ -6,35 +6,9 @@ pv - monitor the progress of data through a pipe
 
 **pv** \[*OPTION*\]\... \[*FILE*\]\...
 
-**pv** \[ **-pteIrab8kTv** \] \[ **-A** NUM \] \[ **-F** FORMAT \] \[
-**-x** SPEC \] \[ **-Wgl0fc** \] \[ **-D** SEC \] \[ **-s** SIZE \] \[
-**-i** SEC \] \[ **-m** SEC \] \[ **-w** WIDTH \] \[ **-H** HEIGHT \] \[
-**-N** NAME \] \[ **-o** FILE \] \[ **-L** RATE \] \[ **-B** BYTES \] \[
-**-CESYKX** \] \[ **-Z** BYTES \] \[ **-U** FILE \] \[ **-P** FILE \]
-[*FILE* . . .\]
+**pv** **-d**\|**\--watchfd** *PID*\[:*FD*\] \[*OPTION*\]\...
 
-**pv** **-n** \[ **-trbv** \] \[ **-Wl0** \] \[ **-D** SEC \] \[ **-s**
-SIZE \] \[ **-i** SEC \] \[ **-o** FILE \] \[ **-L** RATE \] \[ **-B**
-BYTES \] \[ **-CESYKX** \] \[ **-Z** BYTES \] \[ **-U** FILE \] \[
-**-P** FILE \] \[*FILE* . . .\]
-
-**pv** **-q** \[ **-v** \] \[ **-s** SIZE \] \[ **-o** FILE \] \[ **-L**
-RATE \] \[ **-B** BYTES \] \[ **-CESYKX** \] \[ **-Z** BYTES \] \[
-**-U** FILE \] \[ **-P** FILE \] \[*FILE* . . .\]
-
-**pv** **-R** *PID* \[ **-pteIrabT** \] \[ **-A** NUM \] \[ **-F**
-FORMAT \] \[ **-s** SIZE \] \[ **-i** SEC \] \[ **-w** WIDTH \] \[
-**-H** HEIGHT \] \[ **-N** NAME \] \[ **-L** RATE \] \[ **-B** BYTES \]
-
-**pv** **-d** *PID:FD* \[ **-pteIrab8kTnq** \] \[ **-F** FORMAT \] \[
-**-i** SEC \] \[ **-w** WIDTH \] \[ **-H** HEIGHT \]
-
-**pv** **-d** *PID* \[ **-pteIrab8kTnq** \] \[ **-F** FORMAT \] \[
-**-i** SEC \] \[ **-w** WIDTH \] \[ **-H** HEIGHT \]
-
-**pv** **-h**
-
-**pv** **-V**
+**pv** **-R**\|**\--remote** *PID* \[*OPTION*\]\...
 
 # DESCRIPTION