From 2a98b7a5939c636d0f78be03faa5ce05e7be50ba Mon Sep 17 00:00:00 2001 From: Johannes Altmanninger Date: Mon, 17 Jan 2022 05:29:49 +0100 Subject: [PATCH] docs synopsis: make all placeholder arguments uppercase man(1) uses lowercase placeholders but we usually don't. Additionally, the new synopsis autoformatting only recognizes placeholders if they are uppercase. Use uppercase for all placeholders. --- doc_src/cmds/break.rst | 2 +- doc_src/cmds/complete.rst | 2 +- doc_src/cmds/contains.rst | 2 +- doc_src/cmds/count.rst | 4 ++-- doc_src/cmds/echo.rst | 2 +- doc_src/cmds/exit.rst | 4 ++-- doc_src/cmds/fish_add_path.rst | 2 +- doc_src/cmds/fish_opt.rst | 2 +- doc_src/cmds/history.rst | 2 +- doc_src/cmds/not.rst | 2 +- doc_src/cmds/read.rst | 2 +- doc_src/cmds/realpath.rst | 2 +- doc_src/cmds/return.rst | 4 ++-- doc_src/cmds/set.rst | 12 ++++++------ doc_src/cmds/source.rst | 4 ++-- doc_src/cmds/trap.rst | 2 +- doc_src/cmds/type.rst | 2 +- doc_src/cmds/ulimit.rst | 2 +- doc_src/cmds/umask.rst | 2 +- 19 files changed, 28 insertions(+), 28 deletions(-) diff --git a/doc_src/cmds/break.rst b/doc_src/cmds/break.rst index b625caa76..e05a3341a 100644 --- a/doc_src/cmds/break.rst +++ b/doc_src/cmds/break.rst @@ -8,7 +8,7 @@ Synopsis .. synopsis:: - loop_construct + LOOP_CONSTRUCT [COMMANDS ...] break [COMMANDS ...] diff --git a/doc_src/cmds/complete.rst b/doc_src/cmds/complete.rst index 501dbe1c0..8cd617ef3 100644 --- a/doc_src/cmds/complete.rst +++ b/doc_src/cmds/complete.rst @@ -8,7 +8,7 @@ Synopsis .. synopsis:: - complete ((-c | --command) | (-p | --path)) COMMAND [options] + complete ((-c | --command) | (-p | --path)) COMMAND [OPTIONS] complete ((-C | --do-complete)) STRING Description diff --git a/doc_src/cmds/contains.rst b/doc_src/cmds/contains.rst index 7d79238c5..8a59ec982 100644 --- a/doc_src/cmds/contains.rst +++ b/doc_src/cmds/contains.rst @@ -8,7 +8,7 @@ Synopsis .. synopsis:: - contains [options] KEY [VALUES ...] + contains [OPTIONS] KEY [VALUES ...] Description ----------- diff --git a/doc_src/cmds/count.rst b/doc_src/cmds/count.rst index cda64bd3c..657dc8467 100644 --- a/doc_src/cmds/count.rst +++ b/doc_src/cmds/count.rst @@ -8,8 +8,8 @@ Synopsis .. synopsis:: - count string1 string2 ... - command | count + count STRING1 STRING2 ... + COMMAND | count count [...] < FILE Description diff --git a/doc_src/cmds/echo.rst b/doc_src/cmds/echo.rst index 9fb0adb05..f8bf8bd24 100644 --- a/doc_src/cmds/echo.rst +++ b/doc_src/cmds/echo.rst @@ -8,7 +8,7 @@ Synopsis .. synopsis:: - echo [options] [STRING] + echo [OPTIONS] [STRING] Description ----------- diff --git a/doc_src/cmds/exit.rst b/doc_src/cmds/exit.rst index f3f481c9a..d830da1bd 100644 --- a/doc_src/cmds/exit.rst +++ b/doc_src/cmds/exit.rst @@ -9,12 +9,12 @@ Synopsis .. synopsis:: - exit [code] + exit [CODE] Description ----------- -**exit** is a special builtin that causes the shell to exit. Either 255 or the *code* supplied is used, whichever is lesser. +**exit** is a special builtin that causes the shell to exit. Either 255 or the *CODE* supplied is used, whichever is lesser. Otherwise, the exit status will be that of the last command executed. If exit is called while sourcing a file (using the :ref:`source ` builtin) the rest of the file will be skipped, but the shell itself will not exit. diff --git a/doc_src/cmds/fish_add_path.rst b/doc_src/cmds/fish_add_path.rst index 9fedec533..a8b19b18e 100644 --- a/doc_src/cmds/fish_add_path.rst +++ b/doc_src/cmds/fish_add_path.rst @@ -10,7 +10,7 @@ Synopsis .. synopsis:: fish_add_path path ... - fish_add_path [(-g | --global) | (-U | --universal) | (-P | --path)] [(-m | --move)] [(-a | --append) | (-p | --prepend)] [(-v | --verbose) | (-n | --dry-run)] paths ... + fish_add_path [(-g | --global) | (-U | --universal) | (-P | --path)] [(-m | --move)] [(-a | --append) | (-p | --prepend)] [(-v | --verbose) | (-n | --dry-run)] PATHS ... Description diff --git a/doc_src/cmds/fish_opt.rst b/doc_src/cmds/fish_opt.rst index 140c5aaf2..80867648c 100644 --- a/doc_src/cmds/fish_opt.rst +++ b/doc_src/cmds/fish_opt.rst @@ -9,7 +9,7 @@ Synopsis .. synopsis:: fish_opt [--help] - fish_opt [(-slor | --multiple-vals=) optname] + fish_opt [(-slor | --multiple-vals=) OPTNAME] Description ----------- diff --git a/doc_src/cmds/history.rst b/doc_src/cmds/history.rst index cb4b36cbb..725d0e0ac 100644 --- a/doc_src/cmds/history.rst +++ b/doc_src/cmds/history.rst @@ -9,7 +9,7 @@ Synopsis .. synopsis:: history [search] [--show-time] [--case-sensitive] - [--exact | --prefix | --contains] [--max n] [--null] [--reverse] + [--exact | --prefix | --contains] [--max N] [--null] [--reverse] [SEARCH_STRING ...] history delete [--case-sensitive] [--exact | --prefix | --contains] SEARCH_STRING ... diff --git a/doc_src/cmds/not.rst b/doc_src/cmds/not.rst index 6e7a9c375..b99c55a73 100644 --- a/doc_src/cmds/not.rst +++ b/doc_src/cmds/not.rst @@ -8,7 +8,7 @@ Synopsis .. synopsis:: - not COMMAND [options ...] + not COMMAND [OPTIONS ...] Description diff --git a/doc_src/cmds/read.rst b/doc_src/cmds/read.rst index 1978ece47..3ac9c7298 100644 --- a/doc_src/cmds/read.rst +++ b/doc_src/cmds/read.rst @@ -8,7 +8,7 @@ Synopsis .. synopsis:: - read [options] [VARIABLE ...] + read [OPTIONS] [VARIABLE ...] Description ----------- diff --git a/doc_src/cmds/realpath.rst b/doc_src/cmds/realpath.rst index 3bf603246..92a624781 100644 --- a/doc_src/cmds/realpath.rst +++ b/doc_src/cmds/realpath.rst @@ -9,7 +9,7 @@ Synopsis .. synopsis:: - realpath [options] PATH + realpath [OPTIONS] PATH Description ----------- diff --git a/doc_src/cmds/return.rst b/doc_src/cmds/return.rst index 405336f09..307d5dafc 100644 --- a/doc_src/cmds/return.rst +++ b/doc_src/cmds/return.rst @@ -9,13 +9,13 @@ Synopsis .. synopsis:: - return [n] + return [N] Description ----------- :program:`return` halts a currently running function. -The exit status is set to ``n`` if it is given. +The exit status is set to ``N`` if it is given. If :program:`return` is invoked outside of a function or dot script it is equivalent to exit. It is often added inside of a conditional block such as an :ref:`if ` statement or a :ref:`switch ` statement to conditionally stop the executing function and return to the caller; it can also be used to specify the exit status of a function. diff --git a/doc_src/cmds/set.rst b/doc_src/cmds/set.rst index b5363c2e1..256275a41 100644 --- a/doc_src/cmds/set.rst +++ b/doc_src/cmds/set.rst @@ -8,12 +8,12 @@ Synopsis .. synopsis:: - set [scope options] - set [options] VARIABLE VALUES ... - set [options] VARIABLE[INDICES] VALUES ... - set (-q | --query) [scope options] VARIABLE ... - set (-e | --erase) [scope options] VARIABLE ... - set (-e | --erase) [scope options] VARIABLE[INDICES] ... + set [SCOPE_OPTIONS] + set [OPTIONS] VARIABLE VALUES ... + set [OPTIONS] VARIABLE[INDICES] VALUES ... + set (-q | --query) [SCOPE_OPTIONS] VARIABLE ... + set (-e | --erase) [SCOPE_OPTIONS] VARIABLE ... + set (-e | --erase) [SCOPE_OPTIONS] VARIABLE[INDICES] ... set (-S | --show) VARIABLE ... Description diff --git a/doc_src/cmds/source.rst b/doc_src/cmds/source.rst index 25fe67f9f..1a0092c3c 100644 --- a/doc_src/cmds/source.rst +++ b/doc_src/cmds/source.rst @@ -8,8 +8,8 @@ Synopsis .. synopsis:: - source FILE [arguments ...] - somecommand | source + source FILE [ARGUMENTS ...] + SOMECOMMAND | source Description diff --git a/doc_src/cmds/trap.rst b/doc_src/cmds/trap.rst index 117fb5974..ae08e231a 100644 --- a/doc_src/cmds/trap.rst +++ b/doc_src/cmds/trap.rst @@ -8,7 +8,7 @@ Synopsis .. synopsis:: - trap [options] [[ARG] REASON ... ] + trap [OPTIONS] [[ARG] REASON ... ] Description ----------- diff --git a/doc_src/cmds/type.rst b/doc_src/cmds/type.rst index 45bc17bc0..9d971f274 100644 --- a/doc_src/cmds/type.rst +++ b/doc_src/cmds/type.rst @@ -8,7 +8,7 @@ Synopsis .. synopsis:: - type [options] NAME [...] + type [OPTIONS] NAME [...] Description ----------- diff --git a/doc_src/cmds/ulimit.rst b/doc_src/cmds/ulimit.rst index 7ad3cd00d..bce1c4731 100644 --- a/doc_src/cmds/ulimit.rst +++ b/doc_src/cmds/ulimit.rst @@ -8,7 +8,7 @@ Synopsis .. synopsis:: - ulimit [options] [limit] + ulimit [OPTIONS] [LIMIT] Description diff --git a/doc_src/cmds/umask.rst b/doc_src/cmds/umask.rst index a455024e7..b6a1e9860 100644 --- a/doc_src/cmds/umask.rst +++ b/doc_src/cmds/umask.rst @@ -8,7 +8,7 @@ Synopsis .. synopsis:: - umask [options] [MASK] + umask [OPTIONS] [MASK] Description