From 97db9d5c38e03487278d6ec67cb1fc4ac812c8bd Mon Sep 17 00:00:00 2001 From: Johannes Altmanninger Date: Sun, 9 Jan 2022 11:03:31 +0100 Subject: [PATCH] docs synopses: fix alignment of continuation lines MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This corrects what looks like wrong alignment of some synopsis lines. (I think the alignment is not a bad idea but it makes us do more manual work, maybe we can automate that in future. We still need to figure out how to translate it to HTML.) "man -l build/user_doc/man/man1/history.1" before: string match [-a | --all] [-e | --entire] [-i | --ignore-case] [-r | --regex] [-n | --index] [-q | --quiet] [-v | --invert] PATTERN [STRING…] and after: string match [-a | --all] [-e | --entire] [-i | --ignore-case] [-r | --regex] [-n | --index] [-q | --quiet] [-v | --invert] PATTERN [STRING…] Also make the lines align the same way in the RST source by carefully choosing the position of the backslash. I'm not sure why we used two backslashes per line. Use only one; this gives us no choice of where to put it so both source and man page output are aligned. Change tabs to spaces to make the alignment in the source work. --- doc_src/cmds/history.rst | 6 +++--- doc_src/cmds/string-match.rst | 4 ++-- doc_src/cmds/string-pad.rst | 2 +- doc_src/cmds/string-repeat.rst | 2 +- doc_src/cmds/string-replace.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 | 18 +++++++++--------- 9 files changed, 21 insertions(+), 21 deletions(-) diff --git a/doc_src/cmds/history.rst b/doc_src/cmds/history.rst index 0b5128ac7..46be50164 100644 --- a/doc_src/cmds/history.rst +++ b/doc_src/cmds/history.rst @@ -7,10 +7,10 @@ Synopsis -------- | ``history`` [**search**] [**--show-time**] [**--case-sensitive**] - \ \ [**--exact** | **--prefix** | **--contains**] [**--max** *n*] [**--null**] [**--reverse**] - \ \ [*SEARCH_STRING* ...] + \ [**--exact** | **--prefix** | **--contains**] [**--max** *n*] [**--null**] [**--reverse**] + \ [*SEARCH_STRING* ...] | ``history`` **delete** [**--case-sensitive**] - \ \ [**--exact** | **--prefix** | **--contains**] *SEARCH_STRING* ... + \ [**--exact** | **--prefix** | **--contains**] *SEARCH_STRING* ... | ``history`` **merge** | ``history`` **save** | ``history`` **clear** diff --git a/doc_src/cmds/string-match.rst b/doc_src/cmds/string-match.rst index 61249facc..555ca6468 100644 --- a/doc_src/cmds/string-match.rst +++ b/doc_src/cmds/string-match.rst @@ -7,8 +7,8 @@ Synopsis .. BEGIN SYNOPSIS ``string`` match [**-a** | **--all**] [**-e** | **--entire**] [**-i** | **--ignore-case**] - \ \ [**-r** | **--regex**] [**-n** | **--index**] [**-q** | **--quiet**] [**-v** | **--invert**] - \ \ *PATTERN* [*STRING* ...] + \ [**-r** | **--regex**] [**-n** | **--index**] [**-q** | **--quiet**] [**-v** | **--invert**] + \ *PATTERN* [*STRING* ...] .. END SYNOPSIS diff --git a/doc_src/cmds/string-pad.rst b/doc_src/cmds/string-pad.rst index 032138b63..4daaccbf6 100644 --- a/doc_src/cmds/string-pad.rst +++ b/doc_src/cmds/string-pad.rst @@ -7,7 +7,7 @@ Synopsis .. BEGIN SYNOPSIS ``string`` pad [**-r** | **--right**] [(**-c** | **--char**) *CHAR*] [(**-w** | **--width**) *INTEGER*] - \ \ [*STRING* ...] + \ [*STRING* ...] .. END SYNOPSIS diff --git a/doc_src/cmds/string-repeat.rst b/doc_src/cmds/string-repeat.rst index dd6a188a2..dce27c6ba 100644 --- a/doc_src/cmds/string-repeat.rst +++ b/doc_src/cmds/string-repeat.rst @@ -7,7 +7,7 @@ Synopsis .. BEGIN SYNOPSIS ``string`` repeat [(**-n** | **--count**) *COUNT*] [(**-m** | **--max**) *MAX*] [**-N** | **--no-newline**] - \ \ [**-q** | **--quiet**] [*STRING* ...] + \ [**-q** | **--quiet**] [*STRING* ...] .. END SYNOPSIS diff --git a/doc_src/cmds/string-replace.rst b/doc_src/cmds/string-replace.rst index 96fc6087b..0dcc6039e 100644 --- a/doc_src/cmds/string-replace.rst +++ b/doc_src/cmds/string-replace.rst @@ -7,7 +7,7 @@ Synopsis .. BEGIN SYNOPSIS ``string`` replace [**-a** | **--all**] [**-f** | **--filter**] [**-i** | **--ignore-case**] - \ \ [**-r** | **--regex**] [**-q** | **--quiet**] *PATTERN* *REPLACE* [*STRING* ...] + \ [**-r** | **--regex**] [**-q** | **--quiet**] *PATTERN* *REPLACE* [*STRING* ...] .. END SYNOPSIS diff --git a/doc_src/cmds/string-split.rst b/doc_src/cmds/string-split.rst index 4e2ccd53b..70e68b30b 100644 --- a/doc_src/cmds/string-split.rst +++ b/doc_src/cmds/string-split.rst @@ -7,9 +7,9 @@ Synopsis .. BEGIN SYNOPSIS | ``string`` split [(**-m** | **--max**) *MAX*] [**-n** | **--no-empty**] [**-q** | **--quiet**] - \ \ [**-r** | **--right**] *SEP* [*STRING* ...] + \ [**-r** | **--right**] *SEP* [*STRING* ...] | ``string`` split0 [(**-m** | **--max**) *MAX*] [**-n** | **--no-empty**] [**-q** | **--quiet**] - \ \ [**-r** | **--right**] [*STRING* ...] + \ [**-r** | **--right**] [*STRING* ...] .. END SYNOPSIS diff --git a/doc_src/cmds/string-sub.rst b/doc_src/cmds/string-sub.rst index 1a0301111..368a0419a 100644 --- a/doc_src/cmds/string-sub.rst +++ b/doc_src/cmds/string-sub.rst @@ -7,7 +7,7 @@ Synopsis .. BEGIN SYNOPSIS ``string`` sub [(**-s** | **--start**) *START*] [(**-l** | **--length**) *LENGTH*] - \ [**-q** | **--quiet**] [*STRING* ...] + \ [**-q** | **--quiet**] [*STRING* ...] .. END SYNOPSIS diff --git a/doc_src/cmds/string-trim.rst b/doc_src/cmds/string-trim.rst index d1cc677a2..89832ac7a 100644 --- a/doc_src/cmds/string-trim.rst +++ b/doc_src/cmds/string-trim.rst @@ -7,7 +7,7 @@ Synopsis .. BEGIN SYNOPSIS ``string`` trim [**-l** | **--left**] [**-r** | **--right**] [(**-c** | **--chars**) *CHARS*] - \ \ [**-q** | **--quiet**] [*STRING* ...] + \ [**-q** | **--quiet**] [*STRING* ...] .. END SYNOPSIS diff --git a/doc_src/cmds/string.rst b/doc_src/cmds/string.rst index 7a363e6e6..b101d6e7a 100644 --- a/doc_src/cmds/string.rst +++ b/doc_src/cmds/string.rst @@ -13,22 +13,22 @@ Synopsis | ``string`` length [**-q** | **--quiet**] [*STRING* ...] | ``string`` lower [**-q** | **--quiet**] [*STRING* ...] | ``string`` match [**-a** | **--all**] [**-e** | **--entire**] [**-i** | **--ignore-case**] - \ \ [**-r** | **--regex**] [**-n** | **--index**] [**-q** | **--quiet**] [**-v** | **--invert**] - \ \ *PATTERN* [*STRING* ...] + \ [**-r** | **--regex**] [**-n** | **--index**] [**-q** | **--quiet**] [**-v** | **--invert**] + \ *PATTERN* [*STRING* ...] | ``string`` pad [**-r** | **--right**] [**-c** | **--char** *CHAR*] [**-w** | **--width** *INTEGER*] - \ \ [*STRING* ...] + \ [*STRING* ...] | ``string`` repeat [(**-n** | **--count**) *COUNT*] [(**-m** | **--max**) *MAX*] [**-N** | **--no-newline**] - \ \ [**-q** | **--quiet**] [*STRING* ...] + \ [**-q** | **--quiet**] [*STRING* ...] | ``string`` replace [**-a** | **--all**] [**-f** | **--filter**] [**-i** | **--ignore-case**] - \ \ [**-r** | **--regex**] [**-q** | **--quiet**] *PATTERN* *REPLACE* [*STRING* ...] + \ [**-r** | **--regex**] [**-q** | **--quiet**] *PATTERN* *REPLACE* [*STRING* ...] | ``string`` split [(**-m** | **--max**) *MAX*] [**-n** | **--no-empty**] [**-q** | **--quiet**] - \ \ [**-r** | **--right**] *SEP* [*STRING* ...] + \ [**-r** | **--right**] *SEP* [*STRING* ...] | ``string`` split0 [(**-m** | **--max**) *MAX*] [**-n** | **--no-empty**] [**-q** | **--quiet**] - \ \ [**-r** | **--right**] [*STRING* ...] + \ [**-r** | **--right**] [*STRING* ...] | ``string`` sub [(**-s** | **--start**) *START*] [(**-l** | **--length**) *LENGTH*] - \ [**-q** | **--quiet**] [*STRING* ...] + \ [**-q** | **--quiet**] [*STRING* ...] | ``string`` trim [**-l** | **--left**] [**-r** | **--right**] [(**-c** | **--chars**) *CHARS*] - \ \ [**-q** | **--quiet**] [*STRING* ...] + \ [**-q** | **--quiet**] [*STRING* ...] | ``string`` unescape [**--style=**] [*STRING* ...] | ``string`` upper [**-q** | **--quiet**] [*STRING* ...]