From f8e8c23ac3d499fbffe6f7177c23d079f7ff224c Mon Sep 17 00:00:00 2001 From: Johannes Altmanninger Date: Sun, 9 Jan 2022 09:01:51 +0100 Subject: [PATCH] docs synopses: use parenthesis to indicate that short/long option pairs take same args Matches Git, see for example the -O option in git-grep(1). --- doc_src/cmds/bind.rst | 10 +++++----- doc_src/cmds/math.rst | 2 +- doc_src/cmds/string-pad.rst | 2 +- doc_src/cmds/string-repeat.rst | 2 +- doc_src/cmds/string-split.rst | 4 ++-- doc_src/cmds/string-sub.rst | 2 +- doc_src/cmds/string-trim.rst | 2 +- doc_src/cmds/string.rst | 10 +++++----- 8 files changed, 17 insertions(+), 17 deletions(-) diff --git a/doc_src/cmds/bind.rst b/doc_src/cmds/bind.rst index e2a91397b..e708704a1 100644 --- a/doc_src/cmds/bind.rst +++ b/doc_src/cmds/bind.rst @@ -6,11 +6,11 @@ Synopsis -------- | ``bind`` [(**-M** | **--mode**) *MODE*] [(*-m* | *--sets-mode*) **NEW_MODE**] [*--preset* | *--user*] [*-s* | *--silent*] [**-k** | **--key**] *SEQUENCE* *COMMAND* ... -| ``bind`` [**-M** | **--mode** *MODE*] [**-k** | **--key**] [**--preset**] [**--user**] *SEQUENCE* -| ``bind`` **-K** | **--key-names** [**-a** | **--all**] [**--preset**] [**--user**] -| ``bind`` **-f** | **--function-names** -| ``bind`` **-L** | **--list-modes** -| ``bind`` **-e** | **--erase** [**-M** | **--mode** *MODE*] [**--preset**] [**--user**] [**-a** | **--all**] | [**-k** | **--key**] *SEQUENCE* ... +| ``bind`` [(**-M** | **--mode**) *MODE*] [**-k** | **--key**] [**--preset**] [**--user**] *SEQUENCE* +| ``bind`` (**-K** | **--key-names**) [**-a** | **--all**] [**--preset**] [**--user**] +| ``bind`` (**-f** | **--function-names**) +| ``bind`` (**-L** | **--list-modes**) +| ``bind`` (**-e** | **--erase**) [(**-M** | **--mode**) *MODE*] [**--preset**] [**--user**] [**-a** | **--all**] | [**-k** | **--key**] *SEQUENCE* ... Description ----------- diff --git a/doc_src/cmds/math.rst b/doc_src/cmds/math.rst index 8553e37d6..e0bc7856e 100644 --- a/doc_src/cmds/math.rst +++ b/doc_src/cmds/math.rst @@ -6,7 +6,7 @@ math - perform mathematics calculations Synopsis -------- -``math`` [**-s** | **--scale** *N*] [**-b** | **--base** *BASE*] *EXPRESSION...* +``math`` [(**-s** | **--scale**) *N*] [(**-b** | **--base**) *BASE*] *EXPRESSION...* Description diff --git a/doc_src/cmds/string-pad.rst b/doc_src/cmds/string-pad.rst index ec107318a..5680e9f88 100644 --- a/doc_src/cmds/string-pad.rst +++ b/doc_src/cmds/string-pad.rst @@ -6,7 +6,7 @@ Synopsis .. BEGIN SYNOPSIS -``string`` pad [**-r** | **--right**] [**-c** | **--char** *CHAR*] [**-w** | **--width** *INTEGER*] +``string`` pad [**-r** | **--right**] [(**-c** | **--char**) *CHAR*] [(**-w** | **--width**) *INTEGER*] \ \ [*STRING*...] .. END SYNOPSIS diff --git a/doc_src/cmds/string-repeat.rst b/doc_src/cmds/string-repeat.rst index 11ba29bbb..6f64070b0 100644 --- a/doc_src/cmds/string-repeat.rst +++ b/doc_src/cmds/string-repeat.rst @@ -6,7 +6,7 @@ Synopsis .. BEGIN SYNOPSIS -``string`` repeat [**-n** | **--count** *COUNT*] [**-m** | **--max** *MAX*] [**-N** | **--no-newline**] +``string`` repeat [(**-n** | **--count**) *COUNT*] [(**-m** | **--max**) *MAX*] [**-N** | **--no-newline**] \ \ [**-q** | **--quiet**] [*STRING*...] .. END SYNOPSIS diff --git a/doc_src/cmds/string-split.rst b/doc_src/cmds/string-split.rst index 6a2ae06e9..ca24edd91 100644 --- a/doc_src/cmds/string-split.rst +++ b/doc_src/cmds/string-split.rst @@ -6,9 +6,9 @@ Synopsis .. BEGIN SYNOPSIS -| ``string`` split [**-m** | **--max** *MAX*] [**-n** | **--no-empty**] [**-q** | **--quiet**] +| ``string`` split [(**-m** | **--max**) *MAX*] [**-n** | **--no-empty**] [**-q** | **--quiet**] \ \ [**-r** | **--right**] *SEP* [*STRING*...] -| ``string`` split0 [**-m** | **--max** *MAX*] [**-n** | **--no-empty**] [**-q** | **--quiet**] +| ``string`` split0 [(**-m** | **--max**) *MAX*] [**-n** | **--no-empty**] [**-q** | **--quiet**] \ \ [**-r** | **--right**] [*STRING*...] .. END SYNOPSIS diff --git a/doc_src/cmds/string-sub.rst b/doc_src/cmds/string-sub.rst index aa9272622..a3bdbc01e 100644 --- a/doc_src/cmds/string-sub.rst +++ b/doc_src/cmds/string-sub.rst @@ -6,7 +6,7 @@ Synopsis .. BEGIN SYNOPSIS -``string`` sub [**-s** | **--start** *START*] [**-l** | **--length** *LENGTH*] +``string`` sub [(**-s** | **--start**) *START*] [(**-l** | **--length**) *LENGTH*] \ [**-q** | **--quiet**] [*STRING*...] .. END SYNOPSIS diff --git a/doc_src/cmds/string-trim.rst b/doc_src/cmds/string-trim.rst index 7a2aa6c1e..a8ac42570 100644 --- a/doc_src/cmds/string-trim.rst +++ b/doc_src/cmds/string-trim.rst @@ -6,7 +6,7 @@ Synopsis .. BEGIN SYNOPSIS -``string`` trim [**-l** | **--left**] [**-r** | **--right**] [**-c** | **--chars** *CHARS*] +``string`` trim [**-l** | **--left**] [**-r** | **--right**] [(**-c** | **--chars**) *CHARS*] \ \ [**-q** | **--quiet**] [*STRING*...] .. END SYNOPSIS diff --git a/doc_src/cmds/string.rst b/doc_src/cmds/string.rst index 8b65b1967..50dc2f96a 100644 --- a/doc_src/cmds/string.rst +++ b/doc_src/cmds/string.rst @@ -17,17 +17,17 @@ Synopsis \ \ *PATTERN* [*STRING*...] | ``string`` pad [**-r** | **--right**] [**-c** | **--char** *CHAR*] [**-w** | **--width** *INTEGER*] \ \ [*STRING*...] -| ``string`` repeat [**-n** | **--count** *COUNT*] [**-m** | **--max** *MAX*] [**-N** | **--no-newline**] +| ``string`` repeat [(**-n** | **--count**) *COUNT*] [(**-m** | **--max**) *MAX*] [**-N** | **--no-newline**] \ \ [**-q** | **--quiet**] [*STRING*...] | ``string`` replace [**-a** | **--all**] [**-f** | **--filter**] [**-i** | **--ignore-case**] \ \ [**-r** | **--regex**] [**-q** | **--quiet**] *PATTERN* *REPLACE* [*STRING*...] -| ``string`` split [**-m** | **--max** *MAX*] [**-n** | **--no-empty**] [**-q** | **--quiet**] +| ``string`` split [(**-m** | **--max**) *MAX*] [**-n** | **--no-empty**] [**-q** | **--quiet**] \ \ [**-r** | **--right**] *SEP* [*STRING*...] -| ``string`` split0 [**-m** | **--max** *MAX*] [**-n** | **--no-empty**] [**-q** | **--quiet**] +| ``string`` split0 [(**-m** | **--max**) *MAX*] [**-n** | **--no-empty**] [**-q** | **--quiet**] \ \ [**-r** | **--right**] [*STRING*...] -| ``string`` sub [**-s** | **--start** *START*] [**-l** | **--length** *LENGTH*] +| ``string`` sub [(**-s** | **--start**) *START*] [(**-l** | **--length**) *LENGTH*] \ [**-q** | **--quiet**] [*STRING*...] -| ``string`` trim [**-l** | **--left**] [**-r** | **--right**] [**-c** | **--chars** *CHARS*] +| ``string`` trim [**-l** | **--left**] [**-r** | **--right**] [(**-c** | **--chars**) *CHARS*] \ \ [**-q** | **--quiet**] [*STRING*...] | ``string`` unescape [**--style=**] [*STRING*...] | ``string`` upper [**-q** | **--quiet**] [*STRING*...]