diff --git a/sphinx_doc_src/cmds/abbr.rst b/sphinx_doc_src/cmds/abbr.rst index da3d67f3a..5721cb6f1 100644 --- a/sphinx_doc_src/cmds/abbr.rst +++ b/sphinx_doc_src/cmds/abbr.rst @@ -1,15 +1,14 @@ abbr - manage fish abbreviations ========================================== +Synopsis +-------- -\subsection abbr-synopsis Synopsis -\fish{synopsis} abbr --add [SCOPE] WORD EXPANSION abbr --erase word abbr --rename [SCOPE] OLD_WORD NEW_WORD abbr --show abbr --list -\endfish \subsection abbr-description Description diff --git a/sphinx_doc_src/cmds/alias.rst b/sphinx_doc_src/cmds/alias.rst index e7c0ca543..0c5957cae 100644 --- a/sphinx_doc_src/cmds/alias.rst +++ b/sphinx_doc_src/cmds/alias.rst @@ -1,13 +1,13 @@ alias - create a function ========================================== +Synopsis +-------- -\subsection alias-synopsis Synopsis -\fish{synopsis} alias alias [OPTIONS] NAME DEFINITION alias [OPTIONS] NAME=DEFINITION -\endfish + \subsection alias-description Description diff --git a/sphinx_doc_src/cmds/and.rst b/sphinx_doc_src/cmds/and.rst index 7abca07dd..bf2088706 100644 --- a/sphinx_doc_src/cmds/and.rst +++ b/sphinx_doc_src/cmds/and.rst @@ -1,11 +1,11 @@ and - conditionally execute a command ========================================== +Synopsis +-------- -\subsection and-synopsis Synopsis -\fish{synopsis} COMMAND1; and COMMAND2 -\endfish + \subsection and-description Description diff --git a/sphinx_doc_src/cmds/argparse.rst b/sphinx_doc_src/cmds/argparse.rst index d54815d30..881d4df3b 100644 --- a/sphinx_doc_src/cmds/argparse.rst +++ b/sphinx_doc_src/cmds/argparse.rst @@ -1,11 +1,11 @@ argparse - parse options passed to a fish script or function ========================================== +Synopsis +-------- -\subsection argparse-synopsis Synopsis -\fish{synopsis} argparse [OPTIONS] OPTION_SPEC... -- [ARG...] -\endfish + \subsection argparse-description Description diff --git a/sphinx_doc_src/cmds/begin.rst b/sphinx_doc_src/cmds/begin.rst index cc63c36c4..8819a8a63 100644 --- a/sphinx_doc_src/cmds/begin.rst +++ b/sphinx_doc_src/cmds/begin.rst @@ -1,11 +1,11 @@ begin - start a new block of code ========================================== +Synopsis +-------- -\subsection begin-synopsis Synopsis -\fish{synopsis} begin; [COMMANDS...;] end -\endfish + \subsection begin-description Description diff --git a/sphinx_doc_src/cmds/bg.rst b/sphinx_doc_src/cmds/bg.rst index 10f40c89c..5e884c268 100644 --- a/sphinx_doc_src/cmds/bg.rst +++ b/sphinx_doc_src/cmds/bg.rst @@ -1,11 +1,11 @@ bg - send jobs to background ========================================== +Synopsis +-------- -\subsection bg-synopsis Synopsis -\fish{synopsis} bg [PID...] -\endfish + \subsection bg-description Description diff --git a/sphinx_doc_src/cmds/bind.rst b/sphinx_doc_src/cmds/bind.rst index db064b71a..86743a2fe 100644 --- a/sphinx_doc_src/cmds/bind.rst +++ b/sphinx_doc_src/cmds/bind.rst @@ -1,9 +1,9 @@ bind - handle fish key bindings ========================================== +Synopsis +-------- -\subsection bind-synopsis Synopsis -\fish{synopsis} bind [(-M | --mode) MODE] [(-m | --sets-mode) NEW_MODE] [--preset | --user] [(-s | --silent)] [(-k | --key)] SEQUENCE COMMAND [COMMAND...] @@ -14,7 +14,7 @@ bind (-L | --list-modes) bind (-e | --erase) [(-M | --mode) MODE] [--preset] [--user] (-a | --all | [(-k | --key)] SEQUENCE [SEQUENCE...]) -\endfish + \subsection bind-description Description diff --git a/sphinx_doc_src/cmds/block.rst b/sphinx_doc_src/cmds/block.rst index 5fe5dd3c9..24566083f 100644 --- a/sphinx_doc_src/cmds/block.rst +++ b/sphinx_doc_src/cmds/block.rst @@ -1,11 +1,11 @@ block - temporarily block delivery of events ========================================== +Synopsis +-------- -\subsection block-synopsis Synopsis -\fish{synopsis} block [OPTIONS...] -\endfish + \subsection block-description Description diff --git a/sphinx_doc_src/cmds/break.rst b/sphinx_doc_src/cmds/break.rst index 0b609955c..b20305e58 100644 --- a/sphinx_doc_src/cmds/break.rst +++ b/sphinx_doc_src/cmds/break.rst @@ -1,11 +1,11 @@ break - stop the current inner loop ========================================== +Synopsis +-------- -\subsection break-synopsis Synopsis -\fish{synopsis} LOOP_CONSTRUCT; [COMMANDS...] break; [COMMANDS...] end -\endfish + \subsection break-description Description diff --git a/sphinx_doc_src/cmds/breakpoint.rst b/sphinx_doc_src/cmds/breakpoint.rst index f0efffd85..4aa2852cc 100644 --- a/sphinx_doc_src/cmds/breakpoint.rst +++ b/sphinx_doc_src/cmds/breakpoint.rst @@ -1,11 +1,11 @@ breakpoint - Launch debug mode ========================================== +Synopsis +-------- -\subsection breakpoint-synopsis Synopsis -\fish{synopsis} breakpoint -\endfish + \subsection breakpoint-description Description diff --git a/sphinx_doc_src/cmds/builtin.rst b/sphinx_doc_src/cmds/builtin.rst index 90c512cec..6df15691d 100644 --- a/sphinx_doc_src/cmds/builtin.rst +++ b/sphinx_doc_src/cmds/builtin.rst @@ -1,11 +1,11 @@ builtin - run a builtin command ========================================== +Synopsis +-------- -\subsection builtin-synopsis Synopsis -\fish{synopsis} builtin BUILTINNAME [OPTIONS...] -\endfish + \subsection builtin-description Description diff --git a/sphinx_doc_src/cmds/case.rst b/sphinx_doc_src/cmds/case.rst index 8cfee4a76..2f06fb0a7 100644 --- a/sphinx_doc_src/cmds/case.rst +++ b/sphinx_doc_src/cmds/case.rst @@ -1,11 +1,11 @@ case - conditionally execute a block of commands ========================================== +Synopsis +-------- -\subsection case-synopsis Synopsis -\fish{synopsis} switch VALUE; [case [WILDCARD...]; [COMMANDS...]; ...] end -\endfish + \subsection case-description Description diff --git a/sphinx_doc_src/cmds/cd.rst b/sphinx_doc_src/cmds/cd.rst index 786f3c68b..2e0590759 100644 --- a/sphinx_doc_src/cmds/cd.rst +++ b/sphinx_doc_src/cmds/cd.rst @@ -1,11 +1,11 @@ cd - change directory ========================================== +Synopsis +-------- -\subsection cd-synopsis Synopsis -\fish{synopsis} cd [DIRECTORY] -\endfish + \subsection cd-description Description `cd` changes the current working directory. diff --git a/sphinx_doc_src/cmds/cdh.rst b/sphinx_doc_src/cmds/cdh.rst index 295ab4ea3..b122bd362 100644 --- a/sphinx_doc_src/cmds/cdh.rst +++ b/sphinx_doc_src/cmds/cdh.rst @@ -2,10 +2,11 @@ cdh - change to a recently visited directory ========================================== -\subsection cdh-synopsis Synopsis -\fish{synopsis} +Synopsis +-------- + cdh [ directory ] -\endfish + \subsection cdh-description Description diff --git a/sphinx_doc_src/cmds/command.rst b/sphinx_doc_src/cmds/command.rst index 0eafa8223..3e832d57c 100644 --- a/sphinx_doc_src/cmds/command.rst +++ b/sphinx_doc_src/cmds/command.rst @@ -1,11 +1,11 @@ command - run a program ========================================== +Synopsis +-------- -\subsection command-synopsis Synopsis -\fish{synopsis} command [OPTIONS] COMMANDNAME [ARGS...] -\endfish + \subsection command-description Description diff --git a/sphinx_doc_src/cmds/commandline.rst b/sphinx_doc_src/cmds/commandline.rst index ea2dad4f9..1241d3df7 100644 --- a/sphinx_doc_src/cmds/commandline.rst +++ b/sphinx_doc_src/cmds/commandline.rst @@ -1,11 +1,11 @@ commandline - set or get the current command line buffer ========================================== +Synopsis +-------- -\subsection commandline-synopsis Synopsis -\fish{synopsis} commandline [OPTIONS] [CMD] -\endfish + \subsection commandline-description Description diff --git a/sphinx_doc_src/cmds/complete.rst b/sphinx_doc_src/cmds/complete.rst index 1e9d42316..3691f7095 100644 --- a/sphinx_doc_src/cmds/complete.rst +++ b/sphinx_doc_src/cmds/complete.rst @@ -1,9 +1,9 @@ complete - edit command specific tab-completions ========================================== +Synopsis +-------- -\subsection complete-synopsis Synopsis -\fish{synopsis} complete ( -c | --command | -p | --path ) COMMAND [( -c | --command | -p | --path ) COMMAND]... [( -e | --erase )] @@ -18,7 +18,7 @@ complete ( -c | --command | -p | --path ) COMMAND [( -n | --condition ) CONDITION] [( -d | --description ) DESCRIPTION] complete ( -C[STRING] | --do-complete[=STRING] ) -\endfish + \subsection complete-description Description diff --git a/sphinx_doc_src/cmds/contains.rst b/sphinx_doc_src/cmds/contains.rst index cc3d8b1c3..8f69ba214 100644 --- a/sphinx_doc_src/cmds/contains.rst +++ b/sphinx_doc_src/cmds/contains.rst @@ -1,11 +1,11 @@ contains - test if a word is present in a list ========================================== +Synopsis +-------- -\subsection contains-synopsis Synopsis -\fish{synopsis} contains [OPTIONS] KEY [VALUES...] -\endfish + \subsection contains-description Description diff --git a/sphinx_doc_src/cmds/continue.rst b/sphinx_doc_src/cmds/continue.rst index 11c34bd10..1d7b7fd03 100644 --- a/sphinx_doc_src/cmds/continue.rst +++ b/sphinx_doc_src/cmds/continue.rst @@ -1,11 +1,11 @@ continue - skip the remainder of the current iteration of the current inner loop ========================================== +Synopsis +-------- -\subsection continue-synopsis Synopsis -\fish{synopsis} LOOP_CONSTRUCT; [COMMANDS...;] continue; [COMMANDS...;] end -\endfish + \subsection continue-description Description diff --git a/sphinx_doc_src/cmds/count.rst b/sphinx_doc_src/cmds/count.rst index 0b5659644..c84e7fe42 100644 --- a/sphinx_doc_src/cmds/count.rst +++ b/sphinx_doc_src/cmds/count.rst @@ -1,11 +1,11 @@ count - count the number of elements of an array ========================================== +Synopsis +-------- -\subsection count-synopsis Synopsis -\fish{synopsis} count $VARIABLE -\endfish + \subsection count-description Description diff --git a/sphinx_doc_src/cmds/dirh.rst b/sphinx_doc_src/cmds/dirh.rst index bf94537ba..451d44c17 100644 --- a/sphinx_doc_src/cmds/dirh.rst +++ b/sphinx_doc_src/cmds/dirh.rst @@ -1,11 +1,11 @@ dirh - print directory history ========================================== +Synopsis +-------- -\subsection dirh-synopsis Synopsis -\fish{synopsis} dirh -\endfish + \subsection dirh-description Description diff --git a/sphinx_doc_src/cmds/dirs.rst b/sphinx_doc_src/cmds/dirs.rst index 576d7de63..cd07b0f7a 100644 --- a/sphinx_doc_src/cmds/dirs.rst +++ b/sphinx_doc_src/cmds/dirs.rst @@ -1,12 +1,12 @@ dirs - print directory stack ========================================== +Synopsis +-------- -\subsection dirs-synopsis Synopsis -\fish{synopsis} dirs dirs -c -\endfish + \subsection dirs-description Description diff --git a/sphinx_doc_src/cmds/disown.rst b/sphinx_doc_src/cmds/disown.rst index 5047db5e5..c61ca0c03 100644 --- a/sphinx_doc_src/cmds/disown.rst +++ b/sphinx_doc_src/cmds/disown.rst @@ -1,11 +1,11 @@ disown - remove a process from the list of jobs ========================================== +Synopsis +-------- -\subsection disown-synopsis Synopsis -\fish{synopsis} disown [ PID ... ] -\endfish + \subsection disown-description Description diff --git a/sphinx_doc_src/cmds/echo.rst b/sphinx_doc_src/cmds/echo.rst index e01e9a63c..b38dbcbcf 100644 --- a/sphinx_doc_src/cmds/echo.rst +++ b/sphinx_doc_src/cmds/echo.rst @@ -1,11 +1,11 @@ echo - display a line of text ========================================== +Synopsis +-------- -\subsection echo-synopsis Synopsis -\fish{synopsis} echo [OPTIONS] [STRING] -\endfish + \subsection echo-description Description diff --git a/sphinx_doc_src/cmds/else.rst b/sphinx_doc_src/cmds/else.rst index d622d5750..42a4ac8c8 100644 --- a/sphinx_doc_src/cmds/else.rst +++ b/sphinx_doc_src/cmds/else.rst @@ -1,11 +1,11 @@ else - execute command if a condition is not met ========================================== +Synopsis +-------- -\subsection else-synopsis Synopsis -\fish{synopsis} if CONDITION; COMMANDS_TRUE...; [else; COMMANDS_FALSE...;] end -\endfish + \subsection else-description Description diff --git a/sphinx_doc_src/cmds/emit.rst b/sphinx_doc_src/cmds/emit.rst index 58bbde1fa..e66f3c7da 100644 --- a/sphinx_doc_src/cmds/emit.rst +++ b/sphinx_doc_src/cmds/emit.rst @@ -1,11 +1,11 @@ emit - Emit a generic event ========================================== +Synopsis +-------- -\subsection emit-synopsis Synopsis -\fish{synopsis} emit EVENT_NAME [ARGUMENTS...] -\endfish + \subsection emit-description Description diff --git a/sphinx_doc_src/cmds/end.rst b/sphinx_doc_src/cmds/end.rst index 24eba81a6..7ee68ef15 100644 --- a/sphinx_doc_src/cmds/end.rst +++ b/sphinx_doc_src/cmds/end.rst @@ -1,15 +1,15 @@ end - end a block of commands. ========================================== +Synopsis +-------- -\subsection end-synopsis Synopsis -\fish{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 -\endfish + \subsection end-description Description diff --git a/sphinx_doc_src/cmds/eval.rst b/sphinx_doc_src/cmds/eval.rst index a5dd592b1..5e1d09aaf 100644 --- a/sphinx_doc_src/cmds/eval.rst +++ b/sphinx_doc_src/cmds/eval.rst @@ -1,11 +1,11 @@ eval - evaluate the specified commands ========================================== +Synopsis +-------- -\subsection eval-synopsis Synopsis -\fish{synopsis} eval [COMMANDS...] -\endfish + \subsection eval-description Description `eval` evaluates the specified parameters as a command. If more than one parameter is specified, all parameters will be joined using a space character as a separator. diff --git a/sphinx_doc_src/cmds/exec.rst b/sphinx_doc_src/cmds/exec.rst index 9a2f228f6..7e0509397 100644 --- a/sphinx_doc_src/cmds/exec.rst +++ b/sphinx_doc_src/cmds/exec.rst @@ -1,11 +1,11 @@ exec - execute command in current process ========================================== +Synopsis +-------- -\subsection exec-synopsis Synopsis -\fish{synopsis} exec COMMAND [OPTIONS...] -\endfish + \subsection exec-description Description diff --git a/sphinx_doc_src/cmds/exit.rst b/sphinx_doc_src/cmds/exit.rst index 7baead27c..54467c09c 100644 --- a/sphinx_doc_src/cmds/exit.rst +++ b/sphinx_doc_src/cmds/exit.rst @@ -1,11 +1,11 @@ exit - exit the shell ========================================== +Synopsis +-------- -\subsection exit-synopsis Synopsis -\fish{synopsis} exit [STATUS] -\endfish + \subsection exit-description Description diff --git a/sphinx_doc_src/cmds/false.rst b/sphinx_doc_src/cmds/false.rst index cdf9b60d9..7e64aa757 100644 --- a/sphinx_doc_src/cmds/false.rst +++ b/sphinx_doc_src/cmds/false.rst @@ -1,11 +1,11 @@ false - return an unsuccessful result ========================================== +Synopsis +-------- -\subsection false-synopsis Synopsis -\fish{synopsis} false -\endfish + \subsection false-description Description diff --git a/sphinx_doc_src/cmds/fg.rst b/sphinx_doc_src/cmds/fg.rst index 518a2a5d8..df0263687 100644 --- a/sphinx_doc_src/cmds/fg.rst +++ b/sphinx_doc_src/cmds/fg.rst @@ -1,11 +1,11 @@ fg - bring job to foreground ========================================== +Synopsis +-------- -\subsection fg-synopsis Synopsis -\fish{synopsis} fg [PID] -\endfish + \subsection fg-description Description diff --git a/sphinx_doc_src/cmds/fish.rst b/sphinx_doc_src/cmds/fish.rst index 152c310ce..83183eaa8 100644 --- a/sphinx_doc_src/cmds/fish.rst +++ b/sphinx_doc_src/cmds/fish.rst @@ -1,11 +1,11 @@ fish - the friendly interactive shell ========================================== +Synopsis +-------- -\subsection fish-synopsis Synopsis -\fish{synopsis} fish [OPTIONS] [-c command] [FILE [ARGUMENTS...]] -\endfish + \subsection fish-description Description diff --git a/sphinx_doc_src/cmds/fish_breakpoint_prompt.rst b/sphinx_doc_src/cmds/fish_breakpoint_prompt.rst index 4a6b45ce5..2bef17f7c 100644 --- a/sphinx_doc_src/cmds/fish_breakpoint_prompt.rst +++ b/sphinx_doc_src/cmds/fish_breakpoint_prompt.rst @@ -1,13 +1,13 @@ fish_breakpoint_prompt - define the appearance of the command line prompt when in the context of a `breakpoint` command ========================================== +Synopsis +-------- -\subsection fish_breakpoint_prompt-synopsis Synopsis -\fish{synopsis} function fish_breakpoint_prompt ... end -\endfish + \subsection fish_breakpoint_prompt-description Description diff --git a/sphinx_doc_src/cmds/fish_indent.rst b/sphinx_doc_src/cmds/fish_indent.rst index 65eff46d8..7ee66eaaf 100644 --- a/sphinx_doc_src/cmds/fish_indent.rst +++ b/sphinx_doc_src/cmds/fish_indent.rst @@ -1,11 +1,11 @@ fish_indent - indenter and prettifier ========================================== +Synopsis +-------- -\subsection fish_indent-synopsis Synopsis -\fish{synopsis} fish_indent [OPTIONS] -\endfish + \subsection fish_indent-description Description diff --git a/sphinx_doc_src/cmds/fish_key_reader.rst b/sphinx_doc_src/cmds/fish_key_reader.rst index bba1fe1d1..818c4a59e 100644 --- a/sphinx_doc_src/cmds/fish_key_reader.rst +++ b/sphinx_doc_src/cmds/fish_key_reader.rst @@ -1,11 +1,11 @@ fish_key_reader - explore what characters keyboard keys send ========================================== +Synopsis +-------- -\subsection fish_key_reader-synopsis Synopsis -\fish{synopsis} fish_key_reader [OPTIONS] -\endfish + \subsection fish_key_reader-description Description diff --git a/sphinx_doc_src/cmds/fish_mode_prompt.rst b/sphinx_doc_src/cmds/fish_mode_prompt.rst index 9c9f15a82..2e7d7a4f7 100644 --- a/sphinx_doc_src/cmds/fish_mode_prompt.rst +++ b/sphinx_doc_src/cmds/fish_mode_prompt.rst @@ -2,7 +2,6 @@ fish_mode_prompt - define the appearance of the mode indicator ========================================== -\subsection fish_mode_prompt-synopsis Synopsis The fish_mode_prompt function will output the mode indicator for use in vi-mode. diff --git a/sphinx_doc_src/cmds/fish_opt.rst b/sphinx_doc_src/cmds/fish_opt.rst index c6a81415d..a76a42be2 100644 --- a/sphinx_doc_src/cmds/fish_opt.rst +++ b/sphinx_doc_src/cmds/fish_opt.rst @@ -1,13 +1,13 @@ fish_opt - create an option spec for the argparse command ========================================== +Synopsis +-------- -\subsection fish_opt-synopsis Synopsis -\fish{synopsis} fish_opt [ -h | --help ] fish_opt ( -s X | --short=X ) [ -l LONG | --long=LONG ] [ --long-only ] \ [ -o | --optional-val ] [ -r | --required-val ] [ --multiple-vals ] -\endfish + \subsection fish_opt-description Description diff --git a/sphinx_doc_src/cmds/fish_prompt.rst b/sphinx_doc_src/cmds/fish_prompt.rst index 0ee3ba550..6a8c7afde 100644 --- a/sphinx_doc_src/cmds/fish_prompt.rst +++ b/sphinx_doc_src/cmds/fish_prompt.rst @@ -1,13 +1,13 @@ fish_prompt - define the appearance of the command line prompt ========================================== +Synopsis +-------- -\subsection fish_prompt-synopsis Synopsis -\fish{synopsis} function fish_prompt ... end -\endfish + \subsection fish_prompt-description Description diff --git a/sphinx_doc_src/cmds/fish_right_prompt.rst b/sphinx_doc_src/cmds/fish_right_prompt.rst index a4fffa2af..0950691e1 100644 --- a/sphinx_doc_src/cmds/fish_right_prompt.rst +++ b/sphinx_doc_src/cmds/fish_right_prompt.rst @@ -1,13 +1,13 @@ fish_right_prompt - define the appearance of the right-side command line prompt ========================================== +Synopsis +-------- -\subsection fish_right_prompt-synopsis Synopsis -\fish{synopsis} function fish_right_prompt ... end -\endfish + \subsection fish_right_prompt-description Description diff --git a/sphinx_doc_src/cmds/fish_vi_mode.rst b/sphinx_doc_src/cmds/fish_vi_mode.rst index bed5657f3..40e288190 100644 --- a/sphinx_doc_src/cmds/fish_vi_mode.rst +++ b/sphinx_doc_src/cmds/fish_vi_mode.rst @@ -1,11 +1,11 @@ fish_vi_mode - Enable vi mode ========================================== +Synopsis +-------- -\subsection fish_vi_mode-synopsis Synopsis -\fish{synopsis} fish_vi_mode -\endfish + \subsection fish_vi_mode-description Description diff --git a/sphinx_doc_src/cmds/for.rst b/sphinx_doc_src/cmds/for.rst index 4c30846cd..1b7b20ff7 100644 --- a/sphinx_doc_src/cmds/for.rst +++ b/sphinx_doc_src/cmds/for.rst @@ -1,11 +1,11 @@ for - perform a set of commands multiple times. ========================================== +Synopsis +-------- -\subsection for-synopsis Synopsis -\fish{synopsis} for VARNAME in [VALUES...]; COMMANDS...; end -\endfish + \subsection for-description Description diff --git a/sphinx_doc_src/cmds/funced.rst b/sphinx_doc_src/cmds/funced.rst index 38709da6f..e53f4dadc 100644 --- a/sphinx_doc_src/cmds/funced.rst +++ b/sphinx_doc_src/cmds/funced.rst @@ -1,11 +1,11 @@ funced - edit a function interactively ========================================== +Synopsis +-------- -\subsection funced-synopsis Synopsis -\fish{synopsis} funced [OPTIONS] NAME -\endfish + \subsection funced-description Description diff --git a/sphinx_doc_src/cmds/funcsave.rst b/sphinx_doc_src/cmds/funcsave.rst index bd29e62f5..9a5d1405f 100644 --- a/sphinx_doc_src/cmds/funcsave.rst +++ b/sphinx_doc_src/cmds/funcsave.rst @@ -1,11 +1,11 @@ funcsave - save the definition of a function to the user's autoload directory ========================================== +Synopsis +-------- -\subsection funcsave-synopsis Synopsis -\fish{synopsis} funcsave FUNCTION_NAME -\endfish + \subsection funcsave-description Description diff --git a/sphinx_doc_src/cmds/function.rst b/sphinx_doc_src/cmds/function.rst index e892361c7..26defcc29 100644 --- a/sphinx_doc_src/cmds/function.rst +++ b/sphinx_doc_src/cmds/function.rst @@ -1,11 +1,11 @@ function - create a function ========================================== +Synopsis +-------- -\subsection function-synopsis Synopsis -\fish{synopsis} function NAME [OPTIONS]; BODY; end -\endfish + \subsection function-description Description diff --git a/sphinx_doc_src/cmds/functions.rst b/sphinx_doc_src/cmds/functions.rst index 5321fb3f5..3e52cb90f 100644 --- a/sphinx_doc_src/cmds/functions.rst +++ b/sphinx_doc_src/cmds/functions.rst @@ -1,15 +1,15 @@ functions - print or erase functions ========================================== +Synopsis +-------- -\subsection functions-synopsis Synopsis -\fish{synopsis} functions [ -a | --all ] [ -n | --names ] functions [ -D | --details ] [ -v ] FUNCTION functions -c OLDNAME NEWNAME functions -d DESCRIPTION FUNCTION functions [ -e | -q ] FUNCTIONS... -\endfish + \subsection functions-description Description diff --git a/sphinx_doc_src/cmds/help.rst b/sphinx_doc_src/cmds/help.rst index a033ed883..98ea11693 100644 --- a/sphinx_doc_src/cmds/help.rst +++ b/sphinx_doc_src/cmds/help.rst @@ -1,11 +1,11 @@ help - display fish documentation ========================================== +Synopsis +-------- -\subsection help-synopsis Synopsis -\fish{synopsis} help [SECTION] -\endfish + \subsection help-description Description diff --git a/sphinx_doc_src/cmds/history.rst b/sphinx_doc_src/cmds/history.rst index 06a45b031..739039393 100644 --- a/sphinx_doc_src/cmds/history.rst +++ b/sphinx_doc_src/cmds/history.rst @@ -1,16 +1,16 @@ history - Show and manipulate command history ========================================== +Synopsis +-------- -\subsection history-synopsis Synopsis -\fish{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 ) -\endfish + \subsection history-description Description diff --git a/sphinx_doc_src/cmds/if.rst b/sphinx_doc_src/cmds/if.rst index ded05f8c8..d684e53f4 100644 --- a/sphinx_doc_src/cmds/if.rst +++ b/sphinx_doc_src/cmds/if.rst @@ -1,14 +1,14 @@ if - conditionally execute a command ========================================== +Synopsis +-------- -\subsection if-synopsis Synopsis -\fish{synopsis} if CONDITION; COMMANDS_TRUE...; [else if CONDITION2; COMMANDS_TRUE2...;] [else; COMMANDS_FALSE...;] end -\endfish + \subsection if-description Description diff --git a/sphinx_doc_src/cmds/isatty.rst b/sphinx_doc_src/cmds/isatty.rst index 192197f63..bf73f06c1 100644 --- a/sphinx_doc_src/cmds/isatty.rst +++ b/sphinx_doc_src/cmds/isatty.rst @@ -1,11 +1,11 @@ isatty - test if a file descriptor is a tty. ========================================== +Synopsis +-------- -\subsection isatty-synopsis Synopsis -\fish{synopsis} isatty [FILE DESCRIPTOR] -\endfish + \subsection isatty-description Description diff --git a/sphinx_doc_src/cmds/jobs.rst b/sphinx_doc_src/cmds/jobs.rst index ae930e1eb..2d17d9f92 100644 --- a/sphinx_doc_src/cmds/jobs.rst +++ b/sphinx_doc_src/cmds/jobs.rst @@ -1,11 +1,11 @@ jobs - print currently running jobs ========================================== +Synopsis +-------- -\subsection jobs-synopsis Synopsis -\fish{synopsis} jobs [OPTIONS] [PID] -\endfish + \subsection jobs-description Description diff --git a/sphinx_doc_src/cmds/math.rst b/sphinx_doc_src/cmds/math.rst index 09d239153..b263746ae 100644 --- a/sphinx_doc_src/cmds/math.rst +++ b/sphinx_doc_src/cmds/math.rst @@ -1,11 +1,11 @@ math - Perform mathematics calculations ========================================== +Synopsis +-------- -\subsection math-synopsis Synopsis -\fish{synopsis} math [-sN | --scale=N] [--] EXPRESSION -\endfish + \subsection math-description Description diff --git a/sphinx_doc_src/cmds/nextd.rst b/sphinx_doc_src/cmds/nextd.rst index 4afb09687..8ce5ce915 100644 --- a/sphinx_doc_src/cmds/nextd.rst +++ b/sphinx_doc_src/cmds/nextd.rst @@ -1,11 +1,11 @@ nextd - move forward through directory history ========================================== +Synopsis +-------- -\subsection nextd-synopsis Synopsis -\fish{synopsis} nextd [ -l | --list ] [POS] -\endfish + \subsection nextd-description Description diff --git a/sphinx_doc_src/cmds/not.rst b/sphinx_doc_src/cmds/not.rst index 38a5eac83..7c572a251 100644 --- a/sphinx_doc_src/cmds/not.rst +++ b/sphinx_doc_src/cmds/not.rst @@ -1,11 +1,11 @@ not - negate the exit status of a job ========================================== +Synopsis +-------- -\subsection not-synopsis Synopsis -\fish{synopsis} not COMMAND [OPTIONS...] -\endfish + \subsection not-description Description diff --git a/sphinx_doc_src/cmds/open.rst b/sphinx_doc_src/cmds/open.rst index 4c63394f4..891d0589e 100644 --- a/sphinx_doc_src/cmds/open.rst +++ b/sphinx_doc_src/cmds/open.rst @@ -1,11 +1,11 @@ open - open file in its default application ========================================== +Synopsis +-------- -\subsection open-synopsis Synopsis -\fish{synopsis} open FILES... -\endfish + \subsection open-description Description diff --git a/sphinx_doc_src/cmds/or.rst b/sphinx_doc_src/cmds/or.rst index a7dd07967..1d507668c 100644 --- a/sphinx_doc_src/cmds/or.rst +++ b/sphinx_doc_src/cmds/or.rst @@ -1,11 +1,11 @@ or - conditionally execute a command ========================================== +Synopsis +-------- -\subsection or-synopsis Synopsis -\fish{synopsis} COMMAND1; or COMMAND2 -\endfish + \subsection or-description Description diff --git a/sphinx_doc_src/cmds/popd.rst b/sphinx_doc_src/cmds/popd.rst index f542a0acb..bd3ab1be6 100644 --- a/sphinx_doc_src/cmds/popd.rst +++ b/sphinx_doc_src/cmds/popd.rst @@ -1,11 +1,11 @@ popd - move through directory stack ========================================== +Synopsis +-------- -\subsection popd-synopsis Synopsis -\fish{synopsis} popd -\endfish + \subsection popd-description Description diff --git a/sphinx_doc_src/cmds/prevd.rst b/sphinx_doc_src/cmds/prevd.rst index e94e87c36..224f994ab 100644 --- a/sphinx_doc_src/cmds/prevd.rst +++ b/sphinx_doc_src/cmds/prevd.rst @@ -1,11 +1,11 @@ prevd - move backward through directory history ========================================== +Synopsis +-------- -\subsection prevd-synopsis Synopsis -\fish{synopsis} prevd [ -l | --list ] [POS] -\endfish + \subsection prevd-description Description diff --git a/sphinx_doc_src/cmds/printf.rst b/sphinx_doc_src/cmds/printf.rst index e943c92f4..ab8aaa95d 100644 --- a/sphinx_doc_src/cmds/printf.rst +++ b/sphinx_doc_src/cmds/printf.rst @@ -1,11 +1,11 @@ printf - display text according to a format string ========================================== +Synopsis +-------- -\subsection printf-synopsis Synopsis -\fish{synopsis} printf format [argument...] -\endfish + \subsection printf-description Description printf formats the string FORMAT with ARGUMENT, and displays the result. diff --git a/sphinx_doc_src/cmds/prompt_pwd.rst b/sphinx_doc_src/cmds/prompt_pwd.rst index f8587af3f..951daa7e5 100644 --- a/sphinx_doc_src/cmds/prompt_pwd.rst +++ b/sphinx_doc_src/cmds/prompt_pwd.rst @@ -1,11 +1,11 @@ prompt_pwd - Print pwd suitable for prompt ========================================== +Synopsis +-------- -\subsection prompt_pwd-synopsis Synopsis -\fish{synopsis} prompt_pwd -\endfish + \subsection prompt_pwd-description Description diff --git a/sphinx_doc_src/cmds/psub.rst b/sphinx_doc_src/cmds/psub.rst index 830f2f3ee..75060590f 100644 --- a/sphinx_doc_src/cmds/psub.rst +++ b/sphinx_doc_src/cmds/psub.rst @@ -1,11 +1,11 @@ psub - perform process substitution ========================================== +Synopsis +-------- -\subsection psub-synopsis Synopsis -\fish{synopsis} COMMAND1 ( COMMAND2 | psub [-F | --fifo] [-f | --file] [-s SUFFIX]) -\endfish + \subsection psub-description Description diff --git a/sphinx_doc_src/cmds/pushd.rst b/sphinx_doc_src/cmds/pushd.rst index a07606756..3d4a5a694 100644 --- a/sphinx_doc_src/cmds/pushd.rst +++ b/sphinx_doc_src/cmds/pushd.rst @@ -1,11 +1,11 @@ pushd - push directory to directory stack ========================================== +Synopsis +-------- -\subsection pushd-synopsis Synopsis -\fish{synopsis} pushd [DIRECTORY] -\endfish + \subsection pushd-description Description diff --git a/sphinx_doc_src/cmds/pwd.rst b/sphinx_doc_src/cmds/pwd.rst index 816f2f373..da99d575b 100644 --- a/sphinx_doc_src/cmds/pwd.rst +++ b/sphinx_doc_src/cmds/pwd.rst @@ -1,11 +1,11 @@ pwd - output the current working directory ========================================== +Synopsis +-------- -\subsection pwd-synopsis Synopsis -\fish{synopsis} pwd -\endfish + \subsection pwd-description Description diff --git a/sphinx_doc_src/cmds/random.rst b/sphinx_doc_src/cmds/random.rst index 6f6cc25d5..18df8b676 100644 --- a/sphinx_doc_src/cmds/random.rst +++ b/sphinx_doc_src/cmds/random.rst @@ -1,15 +1,15 @@ random - generate random number ========================================== +Synopsis +-------- -\subsection random-synopsis Synopsis -\fish{synopsis} random random SEED random START END random START STEP END random choice [ITEMS...] -\endfish + \subsection random-description Description diff --git a/sphinx_doc_src/cmds/read.rst b/sphinx_doc_src/cmds/read.rst index 9a848d28e..d16c7223e 100644 --- a/sphinx_doc_src/cmds/read.rst +++ b/sphinx_doc_src/cmds/read.rst @@ -1,11 +1,11 @@ read - read line of input into variables ========================================== +Synopsis +-------- -\subsection read-synopsis Synopsis -\fish{synopsis} read [OPTIONS] [VARIABLE ...] -\endfish + \subsection read-description Description diff --git a/sphinx_doc_src/cmds/realpath.rst b/sphinx_doc_src/cmds/realpath.rst index 9f2bb9bcc..a34c42198 100644 --- a/sphinx_doc_src/cmds/realpath.rst +++ b/sphinx_doc_src/cmds/realpath.rst @@ -1,11 +1,11 @@ realpath - Convert a path to an absolute path without symlinks ========================================== +Synopsis +-------- -\subsection realpath-synopsis Synopsis -\fish{synopsis} realpath path -\endfish + \subsection realpath-description Description diff --git a/sphinx_doc_src/cmds/return.rst b/sphinx_doc_src/cmds/return.rst index 328d397d2..c7b5ab432 100644 --- a/sphinx_doc_src/cmds/return.rst +++ b/sphinx_doc_src/cmds/return.rst @@ -1,11 +1,11 @@ return - stop the current inner function ========================================== +Synopsis +-------- -\subsection return-synopsis Synopsis -\fish{synopsis} function NAME; [COMMANDS...;] return [STATUS]; [COMMANDS...;] end -\endfish + \subsection return-description Description diff --git a/sphinx_doc_src/cmds/set.rst b/sphinx_doc_src/cmds/set.rst index 4a85f539a..ee0807a3e 100644 --- a/sphinx_doc_src/cmds/set.rst +++ b/sphinx_doc_src/cmds/set.rst @@ -1,9 +1,9 @@ set - display and change shell variables. ========================================== +Synopsis +-------- -\subsection set-synopsis Synopsis -\fish{synopsis} set [SCOPE_OPTIONS] set [OPTIONS] VARIABLE_NAME VALUES... set [OPTIONS] VARIABLE_NAME[INDICES]... VALUES... @@ -11,7 +11,7 @@ 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 ) [SCOPE_OPTIONS] [VARIABLE_NAME]... -\endfish + \subsection set-description Description diff --git a/sphinx_doc_src/cmds/set_color.rst b/sphinx_doc_src/cmds/set_color.rst index a5aede87b..84eb1d5b2 100644 --- a/sphinx_doc_src/cmds/set_color.rst +++ b/sphinx_doc_src/cmds/set_color.rst @@ -1,11 +1,11 @@ set_color - set the terminal color ========================================== +Synopsis +-------- -\subsection set_color-synopsis Synopsis -\fish{synopsis} set_color [OPTIONS] VALUE -\endfish + \subsection set_color-description Description diff --git a/sphinx_doc_src/cmds/source.rst b/sphinx_doc_src/cmds/source.rst index 8fc4c8f86..e23fbda25 100644 --- a/sphinx_doc_src/cmds/source.rst +++ b/sphinx_doc_src/cmds/source.rst @@ -1,12 +1,12 @@ source - evaluate contents of file. ========================================== +Synopsis +-------- -\subsection source-synopsis Synopsis -\fish{synopsis} source FILENAME [ARGUMENTS...] somecommand | source -\endfish + \subsection source-description Description diff --git a/sphinx_doc_src/cmds/status.rst b/sphinx_doc_src/cmds/status.rst index b3c6de020..8832855d1 100644 --- a/sphinx_doc_src/cmds/status.rst +++ b/sphinx_doc_src/cmds/status.rst @@ -1,9 +1,9 @@ status - query fish runtime information ========================================== +Synopsis +-------- -\subsection status-synopsis Synopsis -\fish{synopsis} status status is-login status is-interactive @@ -21,7 +21,7 @@ status stack-trace status job-control CONTROL-TYPE status features status test-feature FEATURE -\endfish + \subsection status-description Description diff --git a/sphinx_doc_src/cmds/string.rst b/sphinx_doc_src/cmds/string.rst index a798de5c5..e54784332 100644 --- a/sphinx_doc_src/cmds/string.rst +++ b/sphinx_doc_src/cmds/string.rst @@ -1,9 +1,9 @@ string - manipulate strings ========================================== +Synopsis +-------- -\subsection string-synopsis Synopsis -\fish{synopsis} string escape [(-n | --no-quoted)] [--style=xxx] [STRING...] string join [(-q | --quiet)] SEP [STRING...] string join0 [(-q | --quiet)] [STRING...] @@ -25,7 +25,7 @@ string trim [(-l | --left)] [(-r | --right)] [(-c | --chars CHARS)] [(-q | --quiet)] [STRING...] string unescape [--style=xxx] [STRING...] string upper [(-q | --quiet)] [STRING...] -\endfish + \subsection string-description Description diff --git a/sphinx_doc_src/cmds/suspend.rst b/sphinx_doc_src/cmds/suspend.rst index f96e47f9b..ef5932f3e 100644 --- a/sphinx_doc_src/cmds/suspend.rst +++ b/sphinx_doc_src/cmds/suspend.rst @@ -1,11 +1,11 @@ suspend - suspend the current shell ========================================== +Synopsis +-------- -\subsection suspend-synopsis Synopsis -\fish{synopsis} suspend [--force] -\endfish + \subsection suspend-description Description diff --git a/sphinx_doc_src/cmds/switch.rst b/sphinx_doc_src/cmds/switch.rst index 7ecf7b60b..7f16550ee 100644 --- a/sphinx_doc_src/cmds/switch.rst +++ b/sphinx_doc_src/cmds/switch.rst @@ -1,11 +1,11 @@ switch - conditionally execute a block of commands ========================================== +Synopsis +-------- -\subsection switch-synopsis Synopsis -\fish{synopsis} switch VALUE; [case [WILDCARD...]; [COMMANDS...]; ...] end -\endfish + \subsection switch-description Description diff --git a/sphinx_doc_src/cmds/test.rst b/sphinx_doc_src/cmds/test.rst index 4ea0f5caf..dbe8d07d4 100644 --- a/sphinx_doc_src/cmds/test.rst +++ b/sphinx_doc_src/cmds/test.rst @@ -1,12 +1,12 @@ test - perform tests on files and text ========================================== +Synopsis +-------- -\subsection test-synopsis Synopsis -\fish{synopsis} test [EXPRESSION] [ [EXPRESSION] ] -\endfish + \subsection test-description Description diff --git a/sphinx_doc_src/cmds/trap.rst b/sphinx_doc_src/cmds/trap.rst index 7aabf5ed0..a1e12bcbd 100644 --- a/sphinx_doc_src/cmds/trap.rst +++ b/sphinx_doc_src/cmds/trap.rst @@ -1,11 +1,11 @@ trap - perform an action when the shell receives a signal ========================================== +Synopsis +-------- -\subsection trap-synopsis Synopsis -\fish{synopsis} trap [OPTIONS] [[ARG] REASON ... ] -\endfish + \subsection trap-description Description diff --git a/sphinx_doc_src/cmds/true.rst b/sphinx_doc_src/cmds/true.rst index 00c06561f..2e986de4c 100644 --- a/sphinx_doc_src/cmds/true.rst +++ b/sphinx_doc_src/cmds/true.rst @@ -1,11 +1,11 @@ true - return a successful result ========================================== +Synopsis +-------- -\subsection true-synopsis Synopsis -\fish{synopsis} true -\endfish + \subsection true-description Description diff --git a/sphinx_doc_src/cmds/type.rst b/sphinx_doc_src/cmds/type.rst index fa4096243..26df7876a 100644 --- a/sphinx_doc_src/cmds/type.rst +++ b/sphinx_doc_src/cmds/type.rst @@ -1,11 +1,11 @@ type - indicate how a command would be interpreted ========================================== +Synopsis +-------- -\subsection type-synopsis Synopsis -\fish{synopsis} type [OPTIONS] NAME [NAME ...] -\endfish + \subsection type-description Description diff --git a/sphinx_doc_src/cmds/ulimit.rst b/sphinx_doc_src/cmds/ulimit.rst index ca822cb6d..7b6b60317 100644 --- a/sphinx_doc_src/cmds/ulimit.rst +++ b/sphinx_doc_src/cmds/ulimit.rst @@ -1,11 +1,11 @@ ulimit - set or get resource usage limits ========================================== +Synopsis +-------- -\subsection ulimit-synopsis Synopsis -\fish{synopsis} ulimit [OPTIONS] [LIMIT] -\endfish + \subsection ulimit-description Description diff --git a/sphinx_doc_src/cmds/umask.rst b/sphinx_doc_src/cmds/umask.rst index 23ff022a4..f884fb69f 100644 --- a/sphinx_doc_src/cmds/umask.rst +++ b/sphinx_doc_src/cmds/umask.rst @@ -1,11 +1,11 @@ umask - set or get the file creation mode mask ========================================== +Synopsis +-------- -\subsection umask-synopsis Synopsis -\fish{synopsis} umask [OPTIONS] [MASK] -\endfish + \subsection umask-description Description diff --git a/sphinx_doc_src/cmds/vared.rst b/sphinx_doc_src/cmds/vared.rst index 2687c1bf6..d37e1af0f 100644 --- a/sphinx_doc_src/cmds/vared.rst +++ b/sphinx_doc_src/cmds/vared.rst @@ -1,11 +1,11 @@ vared - interactively edit the value of an environment variable ========================================== +Synopsis +-------- -\subsection vared-synopsis Synopsis -\fish{synopsis} vared VARIABLE_NAME -\endfish + \subsection vared-description Description diff --git a/sphinx_doc_src/cmds/wait.rst b/sphinx_doc_src/cmds/wait.rst index 9d1565273..08ae375e7 100644 --- a/sphinx_doc_src/cmds/wait.rst +++ b/sphinx_doc_src/cmds/wait.rst @@ -1,11 +1,11 @@ wait - wait for jobs to complete ========================================== +Synopsis +-------- -\subsection wait-synopsis Synopsis -\fish{synopsis} wait [-n | --any] [PID | PROCESS_NAME] ... -\endfish + \subsection wait-description Description diff --git a/sphinx_doc_src/cmds/while.rst b/sphinx_doc_src/cmds/while.rst index a1511a43f..20cf3281b 100644 --- a/sphinx_doc_src/cmds/while.rst +++ b/sphinx_doc_src/cmds/while.rst @@ -1,11 +1,11 @@ while - perform a command multiple times ========================================== +Synopsis +-------- -\subsection while-synopsis Synopsis -\fish{synopsis} while CONDITION; COMMANDS...; end -\endfish + \subsection while-description Description