Mirrors/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell synced 2024-12-27 05:13:10 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs synopsis: make all placeholder arguments uppercase

Browse source 
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.
This commit is contained in:
Johannes Altmanninger 2022-01-17 05:29:49 +01:00 committed by David Adam
parent c0d1e41313
commit 2a98b7a593
19 changed files with 28 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc_src/cmds/break.rst
View file

@ -8,7 +8,7 @@ Synopsis
.. synopsis::
loop_construct
LOOP_CONSTRUCT
[COMMANDS ...]
break
[COMMANDS ...]

2
doc_src/cmds/complete.rst
View file

@ -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

2
doc_src/cmds/contains.rst
View file

@ -8,7 +8,7 @@ Synopsis
.. synopsis::
contains [options] KEY [VALUES ...]
contains [OPTIONS] KEY [VALUES ...]
Description
-----------

4
doc_src/cmds/count.rst
View file

@ -8,8 +8,8 @@ Synopsis
.. synopsis::
count string1 string2 ...
command | count
count STRING1 STRING2 ...
COMMAND | count
count [...] < FILE
Description

2
doc_src/cmds/echo.rst
View file

@ -8,7 +8,7 @@ Synopsis
.. synopsis::
echo [options] [STRING]
echo [OPTIONS] [STRING]
Description
-----------

4
doc_src/cmds/exit.rst
View file

@ -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 <cmd-source>` builtin) the rest of the file will be skipped, but the shell itself will not exit.

2
doc_src/cmds/fish_add_path.rst
View file

@ -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

2
doc_src/cmds/fish_opt.rst
View file

@ -9,7 +9,7 @@ Synopsis
.. synopsis::
fish_opt [--help]
fish_opt [(-slor | --multiple-vals=) optname]
fish_opt [(-slor | --multiple-vals=) OPTNAME]
Description
-----------

2
doc_src/cmds/history.rst
View file

@ -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 ...

2
doc_src/cmds/not.rst
View file

@ -8,7 +8,7 @@ Synopsis
.. synopsis::
not COMMAND [options ...]
not COMMAND [OPTIONS ...]
Description

2
doc_src/cmds/read.rst
View file

@ -8,7 +8,7 @@ Synopsis
.. synopsis::
read [options] [VARIABLE ...]
read [OPTIONS] [VARIABLE ...]
Description
-----------

2
doc_src/cmds/realpath.rst
View file

@ -9,7 +9,7 @@ Synopsis
.. synopsis::
realpath [options] PATH
realpath [OPTIONS] PATH
Description
-----------

4
doc_src/cmds/return.rst
View file

@ -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 <cmd-if>` statement or a :ref:`switch <cmd-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.

12
doc_src/cmds/set.rst
View file

@ -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

4
doc_src/cmds/source.rst
View file

@ -8,8 +8,8 @@ Synopsis
.. synopsis::
source FILE [arguments ...]
somecommand | source
source FILE [ARGUMENTS ...]
SOMECOMMAND | source
Description

2
doc_src/cmds/trap.rst
View file

@ -8,7 +8,7 @@ Synopsis
.. synopsis::
trap [options] [[ARG] REASON ... ]
trap [OPTIONS] [[ARG] REASON ... ]
Description
-----------

2
doc_src/cmds/type.rst
View file

@ -8,7 +8,7 @@ Synopsis
.. synopsis::
type [options] NAME [...]
type [OPTIONS] NAME [...]
Description
-----------

2
doc_src/cmds/ulimit.rst
View file

@ -8,7 +8,7 @@ Synopsis
.. synopsis::
ulimit [options] [limit]
ulimit [OPTIONS] [LIMIT]
Description

2
doc_src/cmds/umask.rst
View file

@ -8,7 +8,7 @@ Synopsis
.. synopsis::
umask [options] [MASK]
umask [OPTIONS] [MASK]
Description