From 02d82dcf850c5be0f1857339cb920a89a6f1c84f Mon Sep 17 00:00:00 2001 From: David Adam Date: Tue, 17 Sep 2019 17:59:04 +0800 Subject: [PATCH] docs: update all command synopsis formatting Adds synopses for those commands missing them. Moves all synopsis sections to code blocks. This improves the appearance, although highlighting as fish code may not be the ideal appearance. --- sphinx_doc_src/cmds/abbr.rst | 14 ++--- sphinx_doc_src/cmds/alias.rst | 8 +-- sphinx_doc_src/cmds/and.rst | 4 +- sphinx_doc_src/cmds/argparse.rst | 4 +- sphinx_doc_src/cmds/begin.rst | 4 +- sphinx_doc_src/cmds/bg.rst | 3 +- sphinx_doc_src/cmds/bind.rst | 18 +++---- sphinx_doc_src/cmds/block.rst | 4 +- sphinx_doc_src/cmds/break.rst | 4 +- sphinx_doc_src/cmds/breakpoint.rst | 4 +- sphinx_doc_src/cmds/builtin.rst | 5 +- sphinx_doc_src/cmds/case.rst | 6 +-- sphinx_doc_src/cmds/cd.rst | 3 +- sphinx_doc_src/cmds/cdh.rst | 5 +- sphinx_doc_src/cmds/command.rst | 3 +- sphinx_doc_src/cmds/commandline.rst | 3 +- sphinx_doc_src/cmds/complete.rst | 1 - sphinx_doc_src/cmds/contains.rst | 3 +- sphinx_doc_src/cmds/continue.rst | 3 +- sphinx_doc_src/cmds/count.rst | 7 +-- sphinx_doc_src/cmds/dirh.rst | 3 +- sphinx_doc_src/cmds/dirs.rst | 5 +- sphinx_doc_src/cmds/disown.rst | 3 +- sphinx_doc_src/cmds/echo.rst | 3 +- sphinx_doc_src/cmds/else.rst | 3 +- sphinx_doc_src/cmds/emit.rst | 3 +- sphinx_doc_src/cmds/end.rst | 11 ++-- sphinx_doc_src/cmds/eval.rst | 4 +- sphinx_doc_src/cmds/exec.rst | 3 +- sphinx_doc_src/cmds/exit.rst | 3 +- sphinx_doc_src/cmds/false.rst | 3 +- sphinx_doc_src/cmds/fg.rst | 3 +- sphinx_doc_src/cmds/fish.rst | 3 +- sphinx_doc_src/cmds/fish_config.rst | 6 +++ sphinx_doc_src/cmds/fish_git_prompt.rst | 9 ++++ sphinx_doc_src/cmds/fish_hg_prompt.rst | 9 ++++ sphinx_doc_src/cmds/fish_indent.rst | 4 +- sphinx_doc_src/cmds/fish_key_reader.rst | 3 +- sphinx_doc_src/cmds/fish_mode_prompt.rst | 10 +++- sphinx_doc_src/cmds/fish_svn_prompt.rst | 9 ++++ .../cmds/fish_update_completions.rst | 6 +++ sphinx_doc_src/cmds/fish_vcs_prompt.rst | 9 ++++ sphinx_doc_src/cmds/for.rst | 3 +- sphinx_doc_src/cmds/funced.rst | 3 +- sphinx_doc_src/cmds/funcsave.rst | 4 +- sphinx_doc_src/cmds/function.rst | 4 +- sphinx_doc_src/cmds/functions.rst | 11 ++-- sphinx_doc_src/cmds/help.rst | 3 +- sphinx_doc_src/cmds/history.rst | 13 ++--- sphinx_doc_src/cmds/if.rst | 9 ++-- sphinx_doc_src/cmds/isatty.rst | 3 +- sphinx_doc_src/cmds/jobs.rst | 4 +- sphinx_doc_src/cmds/math.rst | 4 +- sphinx_doc_src/cmds/nextd.rst | 4 +- sphinx_doc_src/cmds/not.rst | 4 +- sphinx_doc_src/cmds/open.rst | 4 +- sphinx_doc_src/cmds/or.rst | 3 +- sphinx_doc_src/cmds/popd.rst | 4 +- sphinx_doc_src/cmds/prevd.rst | 3 +- sphinx_doc_src/cmds/printf.rst | 3 +- sphinx_doc_src/cmds/prompt_pwd.rst | 5 +- sphinx_doc_src/cmds/psub.rst | 3 +- sphinx_doc_src/cmds/pushd.rst | 3 +- sphinx_doc_src/cmds/pwd.rst | 4 +- sphinx_doc_src/cmds/random.rst | 11 ++-- sphinx_doc_src/cmds/read.rst | 3 +- sphinx_doc_src/cmds/realpath.rst | 3 +- sphinx_doc_src/cmds/return.rst | 3 +- sphinx_doc_src/cmds/set.rst | 15 +++--- sphinx_doc_src/cmds/set_color.rst | 3 +- sphinx_doc_src/cmds/source.rst | 6 ++- sphinx_doc_src/cmds/status.rst | 54 +++++++------------ sphinx_doc_src/cmds/string.rst | 45 ++++++---------- sphinx_doc_src/cmds/suspend.rst | 3 +- sphinx_doc_src/cmds/switch.rst | 3 +- sphinx_doc_src/cmds/test.rst | 6 ++- sphinx_doc_src/cmds/trap.rst | 3 +- sphinx_doc_src/cmds/true.rst | 4 +- sphinx_doc_src/cmds/type.rst | 4 +- sphinx_doc_src/cmds/ulimit.rst | 4 +- sphinx_doc_src/cmds/umask.rst | 4 +- sphinx_doc_src/cmds/vared.rst | 3 +- sphinx_doc_src/cmds/wait.rst | 3 +- sphinx_doc_src/cmds/while.rst | 4 +- 84 files changed, 313 insertions(+), 193 deletions(-) diff --git a/sphinx_doc_src/cmds/abbr.rst b/sphinx_doc_src/cmds/abbr.rst index 638ad7b93..fd9a342d9 100644 --- a/sphinx_doc_src/cmds/abbr.rst +++ b/sphinx_doc_src/cmds/abbr.rst @@ -6,12 +6,14 @@ abbr - manage fish abbreviations Synopsis -------- -abbr --add [SCOPE] WORD EXPANSION -abbr --erase word -abbr --rename [SCOPE] OLD_WORD NEW_WORD -abbr --show -abbr --list -abbr --query WORD... +:: + + abbr --add [SCOPE] WORD EXPANSION + abbr --erase word + abbr --rename [SCOPE] OLD_WORD NEW_WORD + abbr --show + abbr --list + abbr --query WORD... Description ----------- diff --git a/sphinx_doc_src/cmds/alias.rst b/sphinx_doc_src/cmds/alias.rst index 0ed7988e9..e9d6adaae 100644 --- a/sphinx_doc_src/cmds/alias.rst +++ b/sphinx_doc_src/cmds/alias.rst @@ -6,9 +6,11 @@ alias - create a function Synopsis -------- -alias -alias [OPTIONS] NAME DEFINITION -alias [OPTIONS] NAME=DEFINITION +:: + + alias + alias [OPTIONS] NAME DEFINITION + alias [OPTIONS] NAME=DEFINITION Description diff --git a/sphinx_doc_src/cmds/and.rst b/sphinx_doc_src/cmds/and.rst index a0c1070f2..7fef3296f 100644 --- a/sphinx_doc_src/cmds/and.rst +++ b/sphinx_doc_src/cmds/and.rst @@ -6,7 +6,9 @@ and - conditionally execute a command Synopsis -------- -COMMAND1; and COMMAND2 +:: + + COMMAND1; and COMMAND2 Description diff --git a/sphinx_doc_src/cmds/argparse.rst b/sphinx_doc_src/cmds/argparse.rst index a27ae1a0d..61e6853c2 100644 --- a/sphinx_doc_src/cmds/argparse.rst +++ b/sphinx_doc_src/cmds/argparse.rst @@ -6,7 +6,9 @@ argparse - parse options passed to a fish script or function Synopsis -------- -argparse [OPTIONS] OPTION_SPEC... -- [ARG...] +:: + + argparse [OPTIONS] OPTION_SPEC... -- [ARG...] Description diff --git a/sphinx_doc_src/cmds/begin.rst b/sphinx_doc_src/cmds/begin.rst index b903b7408..542e00294 100644 --- a/sphinx_doc_src/cmds/begin.rst +++ b/sphinx_doc_src/cmds/begin.rst @@ -6,7 +6,9 @@ begin - start a new block of code Synopsis -------- -begin; [COMMANDS...;] end +:: + + begin; [COMMANDS...;] end Description diff --git a/sphinx_doc_src/cmds/bg.rst b/sphinx_doc_src/cmds/bg.rst index 2c5da16fe..d40efc573 100644 --- a/sphinx_doc_src/cmds/bg.rst +++ b/sphinx_doc_src/cmds/bg.rst @@ -6,8 +6,9 @@ bg - send jobs to background Synopsis -------- -bg [PID...] +:: + bg [PID...] Description ----------- diff --git a/sphinx_doc_src/cmds/bind.rst b/sphinx_doc_src/cmds/bind.rst index 62fa5cd9b..eab4ca094 100644 --- a/sphinx_doc_src/cmds/bind.rst +++ b/sphinx_doc_src/cmds/bind.rst @@ -6,18 +6,14 @@ bind - handle fish key bindings Synopsis -------- -``bind [(-M | --mode) MODE] [(-m | --sets-mode) NEW_MODE] [--preset | --user] [(-s | --silent)] [(-k | --key)] SEQUENCE COMMAND [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 [SEQUENCE...])`` +:: + bind [(-M | --mode) MODE] [(-m | --sets-mode) NEW_MODE] [--preset | --user] [(-s | --silent)] [(-k | --key)] SEQUENCE COMMAND [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 [SEQUENCE...]) Description ----------- diff --git a/sphinx_doc_src/cmds/block.rst b/sphinx_doc_src/cmds/block.rst index b0f055875..b813ef8b2 100644 --- a/sphinx_doc_src/cmds/block.rst +++ b/sphinx_doc_src/cmds/block.rst @@ -6,7 +6,9 @@ block - temporarily block delivery of events Synopsis -------- -block [OPTIONS...] +:: + + block [OPTIONS...] Description diff --git a/sphinx_doc_src/cmds/break.rst b/sphinx_doc_src/cmds/break.rst index 82bc2797d..7acfff689 100644 --- a/sphinx_doc_src/cmds/break.rst +++ b/sphinx_doc_src/cmds/break.rst @@ -6,7 +6,9 @@ break - stop the current inner loop Synopsis -------- -LOOP_CONSTRUCT; [COMMANDS...] break; [COMMANDS...] end +:: + + LOOP_CONSTRUCT; [COMMANDS...] break; [COMMANDS...] end Description diff --git a/sphinx_doc_src/cmds/breakpoint.rst b/sphinx_doc_src/cmds/breakpoint.rst index c51d2fa1c..aa465be6a 100644 --- a/sphinx_doc_src/cmds/breakpoint.rst +++ b/sphinx_doc_src/cmds/breakpoint.rst @@ -6,7 +6,9 @@ breakpoint - Launch debug mode Synopsis -------- -breakpoint +:: + + breakpoint Description diff --git a/sphinx_doc_src/cmds/builtin.rst b/sphinx_doc_src/cmds/builtin.rst index 8649961cb..b802ac61a 100644 --- a/sphinx_doc_src/cmds/builtin.rst +++ b/sphinx_doc_src/cmds/builtin.rst @@ -6,9 +6,10 @@ builtin - run a builtin command Synopsis -------- -builtin [OPTIONS...] BUILTINNAME -builtin --query BUILTINNAMES... +:: + builtin [OPTIONS...] BUILTINNAME + builtin --query BUILTINNAMES... Description ----------- diff --git a/sphinx_doc_src/cmds/case.rst b/sphinx_doc_src/cmds/case.rst index a5f0c85ae..155022c6b 100644 --- a/sphinx_doc_src/cmds/case.rst +++ b/sphinx_doc_src/cmds/case.rst @@ -6,8 +6,9 @@ case - conditionally execute a block of commands Synopsis -------- -switch VALUE; [case [WILDCARD...]; [COMMANDS...]; ...] end +:: + switch VALUE; [case [WILDCARD...]; [COMMANDS...]; ...] end Description ----------- @@ -20,14 +21,11 @@ Note that fish does not fall through on case statements. Only the first matching Note that command substitutions in a case statement will be evaluated even if its body is not taken. All substitutions, including command substitutions, must be performed before the value can be compared against the parameter. - Example ------- Say \$animal contains the name of an animal. Then this code would classify it: - - :: switch $animal diff --git a/sphinx_doc_src/cmds/cd.rst b/sphinx_doc_src/cmds/cd.rst index 404a5fce6..f6d4491a2 100644 --- a/sphinx_doc_src/cmds/cd.rst +++ b/sphinx_doc_src/cmds/cd.rst @@ -6,8 +6,9 @@ cd - change directory Synopsis -------- -cd [DIRECTORY] +:: + cd [DIRECTORY] Description ----------- diff --git a/sphinx_doc_src/cmds/cdh.rst b/sphinx_doc_src/cmds/cdh.rst index c1390a662..84ba35e1e 100644 --- a/sphinx_doc_src/cmds/cdh.rst +++ b/sphinx_doc_src/cmds/cdh.rst @@ -3,11 +3,12 @@ cdh - change to a recently visited directory ============================================ - Synopsis -------- -cdh [ directory ] +:: + + cdh [ directory ] Description diff --git a/sphinx_doc_src/cmds/command.rst b/sphinx_doc_src/cmds/command.rst index 8ff1a6eb1..b1df173fc 100644 --- a/sphinx_doc_src/cmds/command.rst +++ b/sphinx_doc_src/cmds/command.rst @@ -6,8 +6,9 @@ command - run a program Synopsis -------- -command [OPTIONS] COMMANDNAME [ARGS...] +:: + command [OPTIONS] COMMANDNAME [ARGS...] Description ----------- diff --git a/sphinx_doc_src/cmds/commandline.rst b/sphinx_doc_src/cmds/commandline.rst index ee012beff..e04459063 100644 --- a/sphinx_doc_src/cmds/commandline.rst +++ b/sphinx_doc_src/cmds/commandline.rst @@ -6,8 +6,9 @@ commandline - set or get the current command line buffer Synopsis -------- -commandline [OPTIONS] [CMD] +:: + commandline [OPTIONS] [CMD] Description ----------- diff --git a/sphinx_doc_src/cmds/complete.rst b/sphinx_doc_src/cmds/complete.rst index 09a402987..67ba062b3 100644 --- a/sphinx_doc_src/cmds/complete.rst +++ b/sphinx_doc_src/cmds/complete.rst @@ -24,7 +24,6 @@ Synopsis [( -d | --description ) DESCRIPTION] complete ( -C[STRING] | --do-complete[=STRING] ) - Description ----------- diff --git a/sphinx_doc_src/cmds/contains.rst b/sphinx_doc_src/cmds/contains.rst index 32b0354f4..71db0f9fc 100644 --- a/sphinx_doc_src/cmds/contains.rst +++ b/sphinx_doc_src/cmds/contains.rst @@ -6,8 +6,9 @@ contains - test if a word is present in a list Synopsis -------- -contains [OPTIONS] KEY [VALUES...] +:: + contains [OPTIONS] KEY [VALUES...] Description ----------- diff --git a/sphinx_doc_src/cmds/continue.rst b/sphinx_doc_src/cmds/continue.rst index bef361bbc..f870edcec 100644 --- a/sphinx_doc_src/cmds/continue.rst +++ b/sphinx_doc_src/cmds/continue.rst @@ -6,8 +6,9 @@ continue - skip the remainder of the current iteration of the current inner loop Synopsis -------- -LOOP_CONSTRUCT; [COMMANDS...;] continue; [COMMANDS...;] end +:: + LOOP_CONSTRUCT; [COMMANDS...;] continue; [COMMANDS...;] end Description ----------- diff --git a/sphinx_doc_src/cmds/count.rst b/sphinx_doc_src/cmds/count.rst index 150700313..4a1ff1948 100644 --- a/sphinx_doc_src/cmds/count.rst +++ b/sphinx_doc_src/cmds/count.rst @@ -6,10 +6,11 @@ count - count the number of elements of a list Synopsis -------- -count $VARIABLE -COMMAND | count -count < FILE +:: + count $VARIABLE + COMMAND | count + count < FILE Description ----------- diff --git a/sphinx_doc_src/cmds/dirh.rst b/sphinx_doc_src/cmds/dirh.rst index 7dd874b7b..449d24878 100644 --- a/sphinx_doc_src/cmds/dirh.rst +++ b/sphinx_doc_src/cmds/dirh.rst @@ -6,8 +6,9 @@ dirh - print directory history Synopsis -------- -dirh +:: + dirh Description ----------- diff --git a/sphinx_doc_src/cmds/dirs.rst b/sphinx_doc_src/cmds/dirs.rst index 286f2f679..1ddabb4e8 100644 --- a/sphinx_doc_src/cmds/dirs.rst +++ b/sphinx_doc_src/cmds/dirs.rst @@ -6,9 +6,10 @@ dirs - print directory stack Synopsis -------- -dirs -dirs -c +:: + dirs + dirs -c Description ----------- diff --git a/sphinx_doc_src/cmds/disown.rst b/sphinx_doc_src/cmds/disown.rst index f423b4563..575b1ac86 100644 --- a/sphinx_doc_src/cmds/disown.rst +++ b/sphinx_doc_src/cmds/disown.rst @@ -6,8 +6,9 @@ disown - remove a process from the list of jobs Synopsis -------- -``disown [ PID ... ]`` +:: + disown [ PID ... ] Description ----------- diff --git a/sphinx_doc_src/cmds/echo.rst b/sphinx_doc_src/cmds/echo.rst index 003761187..6f8d82d19 100644 --- a/sphinx_doc_src/cmds/echo.rst +++ b/sphinx_doc_src/cmds/echo.rst @@ -6,8 +6,9 @@ echo - display a line of text Synopsis -------- -echo [OPTIONS] [STRING] +:: + echo [OPTIONS] [STRING] Description ----------- diff --git a/sphinx_doc_src/cmds/else.rst b/sphinx_doc_src/cmds/else.rst index bfda1527e..fb1622488 100644 --- a/sphinx_doc_src/cmds/else.rst +++ b/sphinx_doc_src/cmds/else.rst @@ -6,8 +6,9 @@ else - execute command if a condition is not met Synopsis -------- -if CONDITION; COMMANDS_TRUE...; [else; COMMANDS_FALSE...;] end +:: + if CONDITION; COMMANDS_TRUE...; [else; COMMANDS_FALSE...;] end Description ----------- diff --git a/sphinx_doc_src/cmds/emit.rst b/sphinx_doc_src/cmds/emit.rst index 85dbc2a5e..0e00e8e87 100644 --- a/sphinx_doc_src/cmds/emit.rst +++ b/sphinx_doc_src/cmds/emit.rst @@ -6,8 +6,9 @@ emit - Emit a generic event Synopsis -------- -emit EVENT_NAME [ARGUMENTS...] +:: + emit EVENT_NAME [ARGUMENTS...] Description ----------- diff --git a/sphinx_doc_src/cmds/end.rst b/sphinx_doc_src/cmds/end.rst index 9da25489f..286223ed4 100644 --- a/sphinx_doc_src/cmds/end.rst +++ b/sphinx_doc_src/cmds/end.rst @@ -6,12 +6,13 @@ end - end a block of commands. Synopsis -------- -begin; [COMMANDS...] end -if CONDITION; COMMANDS_TRUE...; [else; COMMANDS_FALSE...;] end -while CONDITION; COMMANDS...; end -for VARNAME in [VALUES...]; COMMANDS...; end -switch VALUE; [case [WILDCARD...]; [COMMANDS...]; ...] end +:: + begin; [COMMANDS...] end + if CONDITION; COMMANDS_TRUE...; [else; COMMANDS_FALSE...;] end + while CONDITION; COMMANDS...; end + for VARNAME in [VALUES...]; COMMANDS...; end + switch VALUE; [case [WILDCARD...]; [COMMANDS...]; ...] end Description ----------- diff --git a/sphinx_doc_src/cmds/eval.rst b/sphinx_doc_src/cmds/eval.rst index b59fb5b14..e6fdae17f 100644 --- a/sphinx_doc_src/cmds/eval.rst +++ b/sphinx_doc_src/cmds/eval.rst @@ -6,7 +6,9 @@ eval - evaluate the specified commands Synopsis -------- -eval [COMMANDS...] +:: + + eval [COMMANDS...] Description diff --git a/sphinx_doc_src/cmds/exec.rst b/sphinx_doc_src/cmds/exec.rst index 7ad7b422d..37b7d9298 100644 --- a/sphinx_doc_src/cmds/exec.rst +++ b/sphinx_doc_src/cmds/exec.rst @@ -6,8 +6,9 @@ exec - execute command in current process Synopsis -------- -exec COMMAND [OPTIONS...] +:: + exec COMMAND [OPTIONS...] Description ----------- diff --git a/sphinx_doc_src/cmds/exit.rst b/sphinx_doc_src/cmds/exit.rst index d44ccd75f..47df52a75 100644 --- a/sphinx_doc_src/cmds/exit.rst +++ b/sphinx_doc_src/cmds/exit.rst @@ -6,8 +6,9 @@ exit - exit the shell Synopsis -------- -exit [STATUS] +:: + exit [STATUS] Description ----------- diff --git a/sphinx_doc_src/cmds/false.rst b/sphinx_doc_src/cmds/false.rst index 67fd17a22..e4b1cf326 100644 --- a/sphinx_doc_src/cmds/false.rst +++ b/sphinx_doc_src/cmds/false.rst @@ -6,8 +6,9 @@ false - return an unsuccessful result Synopsis -------- -false +:: + false Description ----------- diff --git a/sphinx_doc_src/cmds/fg.rst b/sphinx_doc_src/cmds/fg.rst index 88a7b1aca..3cbb4acf2 100644 --- a/sphinx_doc_src/cmds/fg.rst +++ b/sphinx_doc_src/cmds/fg.rst @@ -6,8 +6,9 @@ fg - bring job to foreground Synopsis -------- -fg [PID] +:: + fg [PID] Description ----------- diff --git a/sphinx_doc_src/cmds/fish.rst b/sphinx_doc_src/cmds/fish.rst index b33aa4696..3ea2bfc30 100644 --- a/sphinx_doc_src/cmds/fish.rst +++ b/sphinx_doc_src/cmds/fish.rst @@ -6,8 +6,9 @@ fish - the friendly interactive shell Synopsis -------- -fish [OPTIONS] [-c command] [FILE [ARGUMENTS...]] +:: + fish [OPTIONS] [-c command] [FILE [ARGUMENTS...]] Description ----------- diff --git a/sphinx_doc_src/cmds/fish_config.rst b/sphinx_doc_src/cmds/fish_config.rst index 7b2c57b76..c5a372c58 100644 --- a/sphinx_doc_src/cmds/fish_config.rst +++ b/sphinx_doc_src/cmds/fish_config.rst @@ -3,6 +3,12 @@ fish_config - start the web-based configuration interface ========================================================= +Synopsis +-------- + +:: + + fish_config [TAB] Description ----------- diff --git a/sphinx_doc_src/cmds/fish_git_prompt.rst b/sphinx_doc_src/cmds/fish_git_prompt.rst index cbf3bddd5..cd6723bfd 100644 --- a/sphinx_doc_src/cmds/fish_git_prompt.rst +++ b/sphinx_doc_src/cmds/fish_git_prompt.rst @@ -3,6 +3,15 @@ fish_git_prompt - output git information for use in a prompt ============================================================ +Synopsis +-------- + +:: + + function fish_prompt + echo -n (pwd)(fish_git_prompt) '$ ' + end + Description ----------- diff --git a/sphinx_doc_src/cmds/fish_hg_prompt.rst b/sphinx_doc_src/cmds/fish_hg_prompt.rst index c91582eac..06cbea5ef 100644 --- a/sphinx_doc_src/cmds/fish_hg_prompt.rst +++ b/sphinx_doc_src/cmds/fish_hg_prompt.rst @@ -3,6 +3,15 @@ fish_hg_prompt - output Mercurial information for use in a prompt ================================================================= +Synopsis +-------- + +:: + + function fish_prompt + echo -n (pwd)(fish_hg_prompt) '$ ' + end + Description ----------- diff --git a/sphinx_doc_src/cmds/fish_indent.rst b/sphinx_doc_src/cmds/fish_indent.rst index 73919a5b6..74be5d152 100644 --- a/sphinx_doc_src/cmds/fish_indent.rst +++ b/sphinx_doc_src/cmds/fish_indent.rst @@ -6,7 +6,9 @@ fish_indent - indenter and prettifier Synopsis -------- -fish_indent [OPTIONS] [FILE...] +:: + + fish_indent [OPTIONS] [FILE...] Description diff --git a/sphinx_doc_src/cmds/fish_key_reader.rst b/sphinx_doc_src/cmds/fish_key_reader.rst index 7d5e4d3d1..20ea98c4a 100644 --- a/sphinx_doc_src/cmds/fish_key_reader.rst +++ b/sphinx_doc_src/cmds/fish_key_reader.rst @@ -6,8 +6,9 @@ fish_key_reader - explore what characters keyboard keys send Synopsis -------- -fish_key_reader [OPTIONS] +:: + fish_key_reader [OPTIONS] Description ----------- diff --git a/sphinx_doc_src/cmds/fish_mode_prompt.rst b/sphinx_doc_src/cmds/fish_mode_prompt.rst index 965ff2e77..322e26316 100644 --- a/sphinx_doc_src/cmds/fish_mode_prompt.rst +++ b/sphinx_doc_src/cmds/fish_mode_prompt.rst @@ -3,13 +3,21 @@ fish_mode_prompt - define the appearance of the mode indicator ============================================================== +Synopsis +-------- +:: + + function fish_mode_prompt + echo -n "$fish_bind_mode " + end -The fish_mode_prompt function will output the mode indicator for use in vi-mode. Description ----------- +The ``fish_mode_prompt`` function outputs the mode indicator for use in vi-mode. + The default ``fish_mode_prompt`` function will output indicators about the current Vi editor mode displayed to the left of the regular prompt. Define your own function to customize the appearance of the mode indicator. You can also define an empty ``fish_mode_prompt`` function to remove the Vi mode indicators. The ``$fish_bind_mode variable`` can be used to determine the current mode. It will be one of ``default``, ``insert``, ``replace_one``, or ``visual``. diff --git a/sphinx_doc_src/cmds/fish_svn_prompt.rst b/sphinx_doc_src/cmds/fish_svn_prompt.rst index f955c0a58..66e056b07 100644 --- a/sphinx_doc_src/cmds/fish_svn_prompt.rst +++ b/sphinx_doc_src/cmds/fish_svn_prompt.rst @@ -3,6 +3,15 @@ fish_svn_prompt - output Subversion information for use in a prompt =================================================================== +Synopsis +-------- + +:: + + function fish_prompt + echo -n (pwd)(fish_svn_prompt) '$ ' + end + Description ----------- diff --git a/sphinx_doc_src/cmds/fish_update_completions.rst b/sphinx_doc_src/cmds/fish_update_completions.rst index b3f75b585..be0b57f0b 100644 --- a/sphinx_doc_src/cmds/fish_update_completions.rst +++ b/sphinx_doc_src/cmds/fish_update_completions.rst @@ -3,6 +3,12 @@ fish_update_completions - Update completions using manual pages =============================================================== +Synopsis +-------- + +:: + + fish_update_completions Description ----------- diff --git a/sphinx_doc_src/cmds/fish_vcs_prompt.rst b/sphinx_doc_src/cmds/fish_vcs_prompt.rst index 3cca83b35..e9facb769 100644 --- a/sphinx_doc_src/cmds/fish_vcs_prompt.rst +++ b/sphinx_doc_src/cmds/fish_vcs_prompt.rst @@ -3,6 +3,15 @@ fish_vcs_prompt - output version control system information for use in a prompt =============================================================================== +Synopsis +-------- + +:: + + function fish_prompt + echo -n (pwd)(fish_vcs_prompt) '$ ' + end + Description ----------- diff --git a/sphinx_doc_src/cmds/for.rst b/sphinx_doc_src/cmds/for.rst index 4c06c5912..3bd65fced 100644 --- a/sphinx_doc_src/cmds/for.rst +++ b/sphinx_doc_src/cmds/for.rst @@ -6,8 +6,9 @@ for - perform a set of commands multiple times. Synopsis -------- -for VARNAME in [VALUES...]; COMMANDS...; end +:: + for VARNAME in [VALUES...]; COMMANDS...; end Description ----------- diff --git a/sphinx_doc_src/cmds/funced.rst b/sphinx_doc_src/cmds/funced.rst index df205b015..4d82e4199 100644 --- a/sphinx_doc_src/cmds/funced.rst +++ b/sphinx_doc_src/cmds/funced.rst @@ -6,8 +6,9 @@ funced - edit a function interactively Synopsis -------- -funced [OPTIONS] NAME +:: + funced [OPTIONS] NAME Description ----------- diff --git a/sphinx_doc_src/cmds/funcsave.rst b/sphinx_doc_src/cmds/funcsave.rst index 34f9d63a8..e290f826c 100644 --- a/sphinx_doc_src/cmds/funcsave.rst +++ b/sphinx_doc_src/cmds/funcsave.rst @@ -6,7 +6,9 @@ funcsave - save the definition of a function to the user's autoload directory Synopsis -------- -funcsave FUNCTION_NAME +:: + + funcsave FUNCTION_NAME Description diff --git a/sphinx_doc_src/cmds/function.rst b/sphinx_doc_src/cmds/function.rst index 8259a65ba..173072e5c 100644 --- a/sphinx_doc_src/cmds/function.rst +++ b/sphinx_doc_src/cmds/function.rst @@ -6,7 +6,9 @@ function - create a function Synopsis -------- -function NAME [OPTIONS]; BODY; end +:: + + function NAME [OPTIONS]; BODY; end Description diff --git a/sphinx_doc_src/cmds/functions.rst b/sphinx_doc_src/cmds/functions.rst index 5a47852ac..adeaa7f42 100644 --- a/sphinx_doc_src/cmds/functions.rst +++ b/sphinx_doc_src/cmds/functions.rst @@ -6,12 +6,13 @@ functions - print or erase functions Synopsis -------- -functions [ -a | --all ] [ -n | --names ] -functions [ -D | --details ] [ -v ] FUNCTION -functions -c OLDNAME NEWNAME -functions -d DESCRIPTION FUNCTION -functions [ -e | -q ] FUNCTIONS... +:: + functions [ -a | --all ] [ -n | --names ] + functions [ -D | --details ] [ -v ] FUNCTION + functions -c OLDNAME NEWNAME + functions -d DESCRIPTION FUNCTION + functions [ -e | -q ] FUNCTIONS... Description ----------- diff --git a/sphinx_doc_src/cmds/help.rst b/sphinx_doc_src/cmds/help.rst index c9f55ad06..9074e7905 100644 --- a/sphinx_doc_src/cmds/help.rst +++ b/sphinx_doc_src/cmds/help.rst @@ -6,8 +6,9 @@ help - display fish documentation Synopsis -------- -help [SECTION] +:: + help [SECTION] Description ----------- diff --git a/sphinx_doc_src/cmds/history.rst b/sphinx_doc_src/cmds/history.rst index 68bd2c928..003ad0c92 100644 --- a/sphinx_doc_src/cmds/history.rst +++ b/sphinx_doc_src/cmds/history.rst @@ -6,13 +6,14 @@ history - Show and manipulate command history Synopsis -------- -history search [ --show-time ] [ --case-sensitive ] [ --exact | --prefix | --contains ] [ --max=n ] [ --null ] [ -R | --reverse ] [ "search string"... ] -history delete [ --show-time ] [ --case-sensitive ] [ --exact | --prefix | --contains ] "search string"... -history merge -history save -history clear -history ( -h | --help ) +:: + history search [ --show-time ] [ --case-sensitive ] [ --exact | --prefix | --contains ] [ --max=n ] [ --null ] [ -R | --reverse ] [ "search string"... ] + history delete [ --show-time ] [ --case-sensitive ] [ --exact | --prefix | --contains ] "search string"... + history merge + history save + history clear + history ( -h | --help ) Description ----------- diff --git a/sphinx_doc_src/cmds/if.rst b/sphinx_doc_src/cmds/if.rst index 617f94f7d..b80b4b067 100644 --- a/sphinx_doc_src/cmds/if.rst +++ b/sphinx_doc_src/cmds/if.rst @@ -6,11 +6,12 @@ if - conditionally execute a command Synopsis -------- -if CONDITION; COMMANDS_TRUE...; -[else if CONDITION2; COMMANDS_TRUE2...;] -[else; COMMANDS_FALSE...;] -end +:: + if CONDITION; COMMANDS_TRUE...; + [else if CONDITION2; COMMANDS_TRUE2...;] + [else; COMMANDS_FALSE...;] + end Description ----------- diff --git a/sphinx_doc_src/cmds/isatty.rst b/sphinx_doc_src/cmds/isatty.rst index 1d4711c36..69e940392 100644 --- a/sphinx_doc_src/cmds/isatty.rst +++ b/sphinx_doc_src/cmds/isatty.rst @@ -6,8 +6,9 @@ isatty - test if a file descriptor is a tty. Synopsis -------- -isatty [FILE DESCRIPTOR] +:: + isatty [FILE DESCRIPTOR] Description ----------- diff --git a/sphinx_doc_src/cmds/jobs.rst b/sphinx_doc_src/cmds/jobs.rst index 6595f669b..949f10704 100644 --- a/sphinx_doc_src/cmds/jobs.rst +++ b/sphinx_doc_src/cmds/jobs.rst @@ -6,7 +6,9 @@ jobs - print currently running jobs Synopsis -------- -jobs [OPTIONS] [PID] +:: + + jobs [OPTIONS] [PID] Description diff --git a/sphinx_doc_src/cmds/math.rst b/sphinx_doc_src/cmds/math.rst index 93d5ea8e5..a69036425 100644 --- a/sphinx_doc_src/cmds/math.rst +++ b/sphinx_doc_src/cmds/math.rst @@ -6,7 +6,9 @@ math - Perform mathematics calculations Synopsis -------- -math [-sN | --scale=N] [--] EXPRESSION +:: + + math [-sN | --scale=N] [--] EXPRESSION Description diff --git a/sphinx_doc_src/cmds/nextd.rst b/sphinx_doc_src/cmds/nextd.rst index 0c2457af6..f87b329ba 100644 --- a/sphinx_doc_src/cmds/nextd.rst +++ b/sphinx_doc_src/cmds/nextd.rst @@ -6,7 +6,9 @@ nextd - move forward through directory history Synopsis -------- -nextd [ -l | --list ] [POS] +:: + + nextd [ -l | --list ] [POS] Description diff --git a/sphinx_doc_src/cmds/not.rst b/sphinx_doc_src/cmds/not.rst index 55931a70b..0c13eb5de 100644 --- a/sphinx_doc_src/cmds/not.rst +++ b/sphinx_doc_src/cmds/not.rst @@ -6,7 +6,9 @@ not - negate the exit status of a job Synopsis -------- -not COMMAND [OPTIONS...] +:: + + not COMMAND [OPTIONS...] Description diff --git a/sphinx_doc_src/cmds/open.rst b/sphinx_doc_src/cmds/open.rst index 092a9f57d..43dcbb2d4 100644 --- a/sphinx_doc_src/cmds/open.rst +++ b/sphinx_doc_src/cmds/open.rst @@ -6,7 +6,9 @@ open - open file in its default application Synopsis -------- -open FILES... +:: + + open FILES... Description diff --git a/sphinx_doc_src/cmds/or.rst b/sphinx_doc_src/cmds/or.rst index 1cbdb8178..3184de82a 100644 --- a/sphinx_doc_src/cmds/or.rst +++ b/sphinx_doc_src/cmds/or.rst @@ -6,8 +6,9 @@ or - conditionally execute a command Synopsis -------- -COMMAND1; or COMMAND2 +:: + COMMAND1; or COMMAND2 Description ----------- diff --git a/sphinx_doc_src/cmds/popd.rst b/sphinx_doc_src/cmds/popd.rst index 29467fd47..24e8f65e0 100644 --- a/sphinx_doc_src/cmds/popd.rst +++ b/sphinx_doc_src/cmds/popd.rst @@ -6,7 +6,9 @@ popd - move through directory stack Synopsis -------- -popd +:: + + popd Description diff --git a/sphinx_doc_src/cmds/prevd.rst b/sphinx_doc_src/cmds/prevd.rst index 0bbf57157..20b83566e 100644 --- a/sphinx_doc_src/cmds/prevd.rst +++ b/sphinx_doc_src/cmds/prevd.rst @@ -6,8 +6,9 @@ prevd - move backward through directory history Synopsis -------- -prevd [ -l | --list ] [POS] +:: + prevd [ -l | --list ] [POS] Description ----------- diff --git a/sphinx_doc_src/cmds/printf.rst b/sphinx_doc_src/cmds/printf.rst index 10a4b4821..3bc539595 100644 --- a/sphinx_doc_src/cmds/printf.rst +++ b/sphinx_doc_src/cmds/printf.rst @@ -6,8 +6,9 @@ printf - display text according to a format string Synopsis -------- -printf format [argument...] +:: + printf FORMAT [ARGUMENT ...] Description ----------- diff --git a/sphinx_doc_src/cmds/prompt_pwd.rst b/sphinx_doc_src/cmds/prompt_pwd.rst index 9845c01fd..973caf61f 100644 --- a/sphinx_doc_src/cmds/prompt_pwd.rst +++ b/sphinx_doc_src/cmds/prompt_pwd.rst @@ -6,8 +6,11 @@ prompt_pwd - Print pwd suitable for prompt Synopsis -------- -prompt_pwd +:: + function fish_prompt + echo -n (prompt_pwd) '$ ' + end Description ----------- diff --git a/sphinx_doc_src/cmds/psub.rst b/sphinx_doc_src/cmds/psub.rst index dea5f2187..188dd6a9a 100644 --- a/sphinx_doc_src/cmds/psub.rst +++ b/sphinx_doc_src/cmds/psub.rst @@ -6,8 +6,9 @@ psub - perform process substitution Synopsis -------- -COMMAND1 ( COMMAND2 | psub [-F | --fifo] [-f | --file] [-s SUFFIX]) +:: + COMMAND1 ( COMMAND2 | psub [-F | --fifo] [-f | --file] [-s SUFFIX]) Description ----------- diff --git a/sphinx_doc_src/cmds/pushd.rst b/sphinx_doc_src/cmds/pushd.rst index 727b11cf6..5467510b1 100644 --- a/sphinx_doc_src/cmds/pushd.rst +++ b/sphinx_doc_src/cmds/pushd.rst @@ -6,8 +6,9 @@ pushd - push directory to directory stack Synopsis -------- -pushd [DIRECTORY] +:: + pushd [DIRECTORY] Description ----------- diff --git a/sphinx_doc_src/cmds/pwd.rst b/sphinx_doc_src/cmds/pwd.rst index 1cf815a0f..4a16a7c05 100644 --- a/sphinx_doc_src/cmds/pwd.rst +++ b/sphinx_doc_src/cmds/pwd.rst @@ -6,7 +6,9 @@ pwd - output the current working directory Synopsis -------- -pwd +:: + + pwd Description diff --git a/sphinx_doc_src/cmds/random.rst b/sphinx_doc_src/cmds/random.rst index 916aae5d0..7b912af83 100644 --- a/sphinx_doc_src/cmds/random.rst +++ b/sphinx_doc_src/cmds/random.rst @@ -6,12 +6,13 @@ random - generate random number Synopsis -------- -random -random SEED -random START END -random START STEP END -random choice [ITEMS...] +:: + random + random SEED + random START END + random START STEP END + random choice [ITEMS...] Description ----------- diff --git a/sphinx_doc_src/cmds/read.rst b/sphinx_doc_src/cmds/read.rst index 1bed7993c..9ab622616 100644 --- a/sphinx_doc_src/cmds/read.rst +++ b/sphinx_doc_src/cmds/read.rst @@ -6,8 +6,9 @@ read - read line of input into variables Synopsis -------- -read [OPTIONS] [VARIABLE ...] +:: + read [OPTIONS] [VARIABLE ...] Description ----------- diff --git a/sphinx_doc_src/cmds/realpath.rst b/sphinx_doc_src/cmds/realpath.rst index 2fee264de..5d594e492 100644 --- a/sphinx_doc_src/cmds/realpath.rst +++ b/sphinx_doc_src/cmds/realpath.rst @@ -6,8 +6,9 @@ realpath - Convert a path to an absolute path without symlinks Synopsis -------- -realpath path +:: + realpath PATH Description ----------- diff --git a/sphinx_doc_src/cmds/return.rst b/sphinx_doc_src/cmds/return.rst index 86b1202de..22823ca61 100644 --- a/sphinx_doc_src/cmds/return.rst +++ b/sphinx_doc_src/cmds/return.rst @@ -6,8 +6,9 @@ return - stop the current inner function Synopsis -------- -function NAME; [COMMANDS...;] return [STATUS]; [COMMANDS...;] end +:: + function NAME; [COMMANDS...;] return [STATUS]; [COMMANDS...;] end Description ----------- diff --git a/sphinx_doc_src/cmds/set.rst b/sphinx_doc_src/cmds/set.rst index 068642ab5..f215ba0c9 100644 --- a/sphinx_doc_src/cmds/set.rst +++ b/sphinx_doc_src/cmds/set.rst @@ -6,14 +6,15 @@ set - display and change shell variables. Synopsis -------- -set [SCOPE_OPTIONS] -set [OPTIONS] VARIABLE_NAME VALUES... -set [OPTIONS] VARIABLE_NAME[INDICES]... VALUES... -set ( -q | --query ) [SCOPE_OPTIONS] VARIABLE_NAMES... -set ( -e | --erase ) [SCOPE_OPTIONS] VARIABLE_NAME -set ( -e | --erase ) [SCOPE_OPTIONS] VARIABLE_NAME[INDICES]... -set ( -S | --show ) [VARIABLE_NAME]... +:: + set [SCOPE_OPTIONS] + set [OPTIONS] VARIABLE_NAME VALUES... + set [OPTIONS] VARIABLE_NAME[INDICES]... VALUES... + set ( -q | --query ) [SCOPE_OPTIONS] VARIABLE_NAMES... + set ( -e | --erase ) [SCOPE_OPTIONS] VARIABLE_NAME + set ( -e | --erase ) [SCOPE_OPTIONS] VARIABLE_NAME[INDICES]... + set ( -S | --show ) [VARIABLE_NAME]... Description ----------- diff --git a/sphinx_doc_src/cmds/set_color.rst b/sphinx_doc_src/cmds/set_color.rst index 4be42f857..1653efb50 100644 --- a/sphinx_doc_src/cmds/set_color.rst +++ b/sphinx_doc_src/cmds/set_color.rst @@ -6,8 +6,9 @@ set_color - set the terminal color Synopsis -------- -set_color [OPTIONS] VALUE +:: + set_color [OPTIONS] VALUE Description ----------- diff --git a/sphinx_doc_src/cmds/source.rst b/sphinx_doc_src/cmds/source.rst index 4f0233a08..facd65d3e 100644 --- a/sphinx_doc_src/cmds/source.rst +++ b/sphinx_doc_src/cmds/source.rst @@ -6,8 +6,10 @@ source - evaluate contents of file. Synopsis -------- -source FILENAME [ARGUMENTS...] -somecommand | source +:: + + source FILENAME [ARGUMENTS...] + somecommand | source Description diff --git a/sphinx_doc_src/cmds/status.rst b/sphinx_doc_src/cmds/status.rst index e503babdf..25fb27382 100644 --- a/sphinx_doc_src/cmds/status.rst +++ b/sphinx_doc_src/cmds/status.rst @@ -6,42 +6,26 @@ status - query fish runtime information Synopsis -------- -``status`` - -``status is-login`` - -``status is-interactive`` - -``status is-block`` - -``status is-breakpoint`` - -``status is-command-substitution`` - -``status is-no-job-control`` - -``status is-full-job-control`` - -``status is-interactive-job-control`` - -``status current-command`` - -``status filename`` - -``status fish-path`` - -``status function`` - -``status line-number`` - -``status stack-trace`` - -``status job-control CONTROL-TYPE`` - -``status features`` - -``status test-feature FEATURE`` +:: + status + status is-login + status is-interactive + status is-block + status is-breakpoint + status is-command-substitution + status is-no-job-control + status is-full-job-control + status is-interactive-job-control + status current-command + status filename + status fish-path + status function + status line-number + status stack-trace + status job-control CONTROL-TYPE + status features + status test-feature FEATURE Description ----------- diff --git a/sphinx_doc_src/cmds/string.rst b/sphinx_doc_src/cmds/string.rst index 83df2e2b3..18484ca16 100644 --- a/sphinx_doc_src/cmds/string.rst +++ b/sphinx_doc_src/cmds/string.rst @@ -6,36 +6,23 @@ string - manipulate strings Synopsis -------- -``string collect [(-N | --no-trim-newlines)] [STRING...]`` - -``string escape [(-n | --no-quoted)] [--style=xxx] [STRING...]`` - -``string join [(-q | --quiet)] SEP [STRING...]`` - -``string join0 [(-q | --quiet)] [STRING...]`` - -``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...]`` - -``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 REPLACEMENT [STRING...]`` - -``string split [(-m | --max) MAX] [(-n | --no-empty)] [(-q | --quiet)] [(-r | --right)] SEP [STRING...]`` - -``string split0 [(-m | --max) MAX] [(-n | --no-empty)] [(-q | --quiet)] [(-r | --right)] [STRING...]`` - -``string sub [(-s | --start) START] [(-l | --length) LENGTH] [(-q | --quiet)] [STRING...]`` - -``string trim [(-l | --left)] [(-r | --right)] [(-c | --chars CHARS)] [(-q | --quiet)] [STRING...]`` - -``string unescape [--style=xxx] [STRING...]`` - -``string upper [(-q | --quiet)] [STRING...]`` +:: + string collect [(-N | --no-trim-newlines)] [STRING...] + string escape [(-n | --no-quoted)] [--style=xxx] [STRING...] + string join [(-q | --quiet)] SEP [STRING...] + string join0 [(-q | --quiet)] [STRING...] + 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...] + 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 REPLACEMENT [STRING...] + string split [(-m | --max) MAX] [(-n | --no-empty)] [(-q | --quiet)] [(-r | --right)] SEP [STRING...] + string split0 [(-m | --max) MAX] [(-n | --no-empty)] [(-q | --quiet)] [(-r | --right)] [STRING...] + string sub [(-s | --start) START] [(-l | --length) LENGTH] [(-q | --quiet)] [STRING...] + string trim [(-l | --left)] [(-r | --right)] [(-c | --chars CHARS)] [(-q | --quiet)] [STRING...] + string unescape [--style=xxx] [STRING...] + string upper [(-q | --quiet)] [STRING...] Description ----------- diff --git a/sphinx_doc_src/cmds/suspend.rst b/sphinx_doc_src/cmds/suspend.rst index c43c9d3c2..b82ce5940 100644 --- a/sphinx_doc_src/cmds/suspend.rst +++ b/sphinx_doc_src/cmds/suspend.rst @@ -6,8 +6,9 @@ suspend - suspend the current shell Synopsis -------- -suspend [--force] +:: + suspend [--force] Description ----------- diff --git a/sphinx_doc_src/cmds/switch.rst b/sphinx_doc_src/cmds/switch.rst index 3613d68e8..ca42f7519 100644 --- a/sphinx_doc_src/cmds/switch.rst +++ b/sphinx_doc_src/cmds/switch.rst @@ -6,8 +6,9 @@ switch - conditionally execute a block of commands Synopsis -------- -switch VALUE; [case [WILDCARD...]; [COMMANDS...]; ...] end +:: + switch VALUE; [case [WILDCARD...]; [COMMANDS...]; ...] end Description ----------- diff --git a/sphinx_doc_src/cmds/test.rst b/sphinx_doc_src/cmds/test.rst index cbdd6e65d..a1f406276 100644 --- a/sphinx_doc_src/cmds/test.rst +++ b/sphinx_doc_src/cmds/test.rst @@ -6,8 +6,10 @@ test - perform tests on files and text Synopsis -------- -test [EXPRESSION] -[ [EXPRESSION] ] +:: + + test [EXPRESSION] + [ [EXPRESSION] ] Description diff --git a/sphinx_doc_src/cmds/trap.rst b/sphinx_doc_src/cmds/trap.rst index c63dfbc60..37898497f 100644 --- a/sphinx_doc_src/cmds/trap.rst +++ b/sphinx_doc_src/cmds/trap.rst @@ -6,8 +6,9 @@ trap - perform an action when the shell receives a signal Synopsis -------- -trap [OPTIONS] [[ARG] REASON ... ] +:: + trap [OPTIONS] [[ARG] REASON ... ] Description ----------- diff --git a/sphinx_doc_src/cmds/true.rst b/sphinx_doc_src/cmds/true.rst index c6aa4d889..750d18cfe 100644 --- a/sphinx_doc_src/cmds/true.rst +++ b/sphinx_doc_src/cmds/true.rst @@ -6,7 +6,9 @@ true - return a successful result Synopsis -------- -true +:: + + true Description diff --git a/sphinx_doc_src/cmds/type.rst b/sphinx_doc_src/cmds/type.rst index 7c6b1ae68..6a8627790 100644 --- a/sphinx_doc_src/cmds/type.rst +++ b/sphinx_doc_src/cmds/type.rst @@ -6,7 +6,9 @@ type - indicate how a command would be interpreted Synopsis -------- -type [OPTIONS] NAME [NAME ...] +:: + + type [OPTIONS] NAME [NAME ...] Description diff --git a/sphinx_doc_src/cmds/ulimit.rst b/sphinx_doc_src/cmds/ulimit.rst index 9b4297626..e99e02e6d 100644 --- a/sphinx_doc_src/cmds/ulimit.rst +++ b/sphinx_doc_src/cmds/ulimit.rst @@ -6,7 +6,9 @@ ulimit - set or get resource usage limits Synopsis -------- -ulimit [OPTIONS] [LIMIT] +:: + + ulimit [OPTIONS] [LIMIT] Description diff --git a/sphinx_doc_src/cmds/umask.rst b/sphinx_doc_src/cmds/umask.rst index bafbca7aa..4c374440d 100644 --- a/sphinx_doc_src/cmds/umask.rst +++ b/sphinx_doc_src/cmds/umask.rst @@ -6,7 +6,9 @@ umask - set or get the file creation mode mask Synopsis -------- -umask [OPTIONS] [MASK] +:: + + umask [OPTIONS] [MASK] Description diff --git a/sphinx_doc_src/cmds/vared.rst b/sphinx_doc_src/cmds/vared.rst index b5caca6d0..c77599492 100644 --- a/sphinx_doc_src/cmds/vared.rst +++ b/sphinx_doc_src/cmds/vared.rst @@ -6,8 +6,9 @@ vared - interactively edit the value of an environment variable Synopsis -------- -vared VARIABLE_NAME +:: + vared VARIABLE_NAME Description ----------- diff --git a/sphinx_doc_src/cmds/wait.rst b/sphinx_doc_src/cmds/wait.rst index 6268d616b..12f37469a 100644 --- a/sphinx_doc_src/cmds/wait.rst +++ b/sphinx_doc_src/cmds/wait.rst @@ -6,8 +6,9 @@ wait - wait for jobs to complete Synopsis -------- -wait [-n | --any] [PID | PROCESS_NAME] ... +:: + wait [-n | --any] [PID | PROCESS_NAME] ... Description ----------- diff --git a/sphinx_doc_src/cmds/while.rst b/sphinx_doc_src/cmds/while.rst index 78d3c77d5..de0c0d370 100644 --- a/sphinx_doc_src/cmds/while.rst +++ b/sphinx_doc_src/cmds/while.rst @@ -6,7 +6,9 @@ while - perform a command multiple times Synopsis -------- -while CONDITION; COMMANDS...; end +:: + + while CONDITION; COMMANDS...; end Description