diff --git a/doc_src/cmds/breakpoint.rst b/doc_src/cmds/breakpoint.rst index f491c40a6..a076f760f 100644 --- a/doc_src/cmds/breakpoint.rst +++ b/doc_src/cmds/breakpoint.rst @@ -8,7 +8,6 @@ Synopsis ``breakpoint`` - Description ----------- diff --git a/doc_src/cmds/complete.rst b/doc_src/cmds/complete.rst index 190a8b0f9..8bb0cb77d 100644 --- a/doc_src/cmds/complete.rst +++ b/doc_src/cmds/complete.rst @@ -6,7 +6,7 @@ complete - edit command specific tab-completions Synopsis -------- -``complete`` **-c** | **--command** | **-p** | **--path** [*OPTIONS*] *COMMAND* +``complete`` **-c** | **--command** | **-p** | **--path** [*options*] *COMMAND* ``complete`` **-C** *STRING* | **--do-complete** *STRING* Description diff --git a/doc_src/cmds/contains.rst b/doc_src/cmds/contains.rst index 71db0f9fc..e50a1abb5 100644 --- a/doc_src/cmds/contains.rst +++ b/doc_src/cmds/contains.rst @@ -6,9 +6,7 @@ contains - test if a word is present in a list Synopsis -------- -:: - - contains [OPTIONS] KEY [VALUES...] +``contains`` [**options**] *KEY* [*VALUE* ...] Description ----------- diff --git a/doc_src/cmds/continue.rst b/doc_src/cmds/continue.rst index 532f6b866..6466e8447 100644 --- a/doc_src/cmds/continue.rst +++ b/doc_src/cmds/continue.rst @@ -6,9 +6,7 @@ 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/doc_src/cmds/count.rst b/doc_src/cmds/count.rst index 44a1c644c..b6257399a 100644 --- a/doc_src/cmds/count.rst +++ b/doc_src/cmds/count.rst @@ -6,11 +6,9 @@ count - count the number of elements of a list Synopsis -------- -:: - - count $VARIABLE - COMMAND | count - count < FILE +| ``count`` string1 string2... +| *command* | ``count`` +| ``count`` [...] < *FILE* Description ----------- diff --git a/doc_src/cmds/dirh.rst b/doc_src/cmds/dirh.rst index f60c43d6a..d55a6de85 100644 --- a/doc_src/cmds/dirh.rst +++ b/doc_src/cmds/dirh.rst @@ -6,9 +6,7 @@ dirh - print directory history Synopsis -------- -:: - - dirh +``dirh`` Description ----------- diff --git a/doc_src/cmds/dirs.rst b/doc_src/cmds/dirs.rst index 0b6541e29..837f892ca 100644 --- a/doc_src/cmds/dirs.rst +++ b/doc_src/cmds/dirs.rst @@ -6,10 +6,7 @@ dirs - print directory stack Synopsis -------- -:: - - dirs - dirs -c +``dirs`` [*-c*] Description ----------- diff --git a/doc_src/cmds/disown.rst b/doc_src/cmds/disown.rst index ac7d1a104..b47780926 100644 --- a/doc_src/cmds/disown.rst +++ b/doc_src/cmds/disown.rst @@ -6,9 +6,7 @@ disown - remove a process from the list of jobs Synopsis -------- -:: - - disown [ PID ... ] +disown [ **PID** ... ] Description ----------- diff --git a/doc_src/cmds/echo.rst b/doc_src/cmds/echo.rst index b76d9db5c..5cf5de3e7 100644 --- a/doc_src/cmds/echo.rst +++ b/doc_src/cmds/echo.rst @@ -6,14 +6,12 @@ echo - display a line of text Synopsis -------- -:: - - echo [OPTIONS] [STRING] +``echo`` [*options*] [*STRING*] Description ----------- -``echo`` displays a string of text. +``echo`` displays *STRING* of text. The following options are available: diff --git a/doc_src/cmds/else.rst b/doc_src/cmds/else.rst index 2355dafd4..17e498ecd 100644 --- a/doc_src/cmds/else.rst +++ b/doc_src/cmds/else.rst @@ -6,22 +6,20 @@ 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 ----------- -:ref:`if ` will execute the command ``CONDITION``. If the condition's exit status is 0, the commands ``COMMANDS_TRUE`` will execute. If it is not 0 and ``else`` is given, ``COMMANDS_FALSE`` will be executed. +:ref:`if ` will execute the command **CONDITION**. +If the condition's exit status is 0, the commands *COMMANDS_TRUE* will execute. +If it is not 0 and ``else`` is given, *COMMANDS_FALSE* will be executed. Example ------- -The following code tests whether a file ``foo.txt`` exists as a regular file. - - +The following code tests whether a file *foo.txt* exists as a regular file. :: diff --git a/doc_src/cmds/emit.rst b/doc_src/cmds/emit.rst index 7a8c13c75..5eaf0ae2f 100644 --- a/doc_src/cmds/emit.rst +++ b/doc_src/cmds/emit.rst @@ -6,9 +6,7 @@ emit - emit a generic event Synopsis -------- -:: - - emit EVENT_NAME [ARGUMENTS...] +``emit`` *EVENT_NAME* [*ARGUMENTS*...] Description ----------- diff --git a/doc_src/cmds/end.rst b/doc_src/cmds/end.rst index 697c437ee..f2d5c40f5 100644 --- a/doc_src/cmds/end.rst +++ b/doc_src/cmds/end.rst @@ -6,23 +6,25 @@ end - end a block of commands Synopsis -------- -:: +| **begin** +| [*COMMANDS*...] +| **end** - begin; [COMMANDS...] end - function NAME [OPTIONS]; COMMANDS...; end - if CONDITION; COMMANDS_TRUE...; [else; COMMANDS_FALSE...;] end - switch VALUE; [case [WILDCARD...]; [COMMANDS...]; ...] end - while CONDITION; COMMANDS...; end - for VARNAME in [VALUES...]; COMMANDS...; end +| **function** *NAME* [*OPTIONS*]; *COMMANDS*...; **end** +| **if** *CONDITION*; *COMMANDS_TRUE*...; [**else**; *COMMANDS_FALSE*...;] **end** +| **switch** *VALUE*; [**case** [*WILDCARD*...]; [*COMMANDS*...]; ...] **end** +| **while** *CONDITION*; *COMMANDS*...; **end** +| **for** *VARNAME* in [*VALUES*...]; **COMMANDS**...; **end** Description ----------- -``end`` ends a block of commands started by one of the following commands: +The **end** keyword ends a block of commands started by one of the following commands: - :ref:`begin ` to start a block of commands - :ref:`function ` to define a function - :ref:`if `, :ref:`switch ` to conditionally execute commands - :ref:`while `, :ref:`for ` to perform commands multiple times -The ``end`` command does not change the current exit status. Instead, the status after it will be the status returned by the most recent command. +The **end** keyword does not change the current exit status. +Instead, the status after it will be the status returned by the most recent command. diff --git a/doc_src/cmds/eval.rst b/doc_src/cmds/eval.rst index ddd8254c6..0f30ddeaf 100644 --- a/doc_src/cmds/eval.rst +++ b/doc_src/cmds/eval.rst @@ -6,20 +6,18 @@ eval - evaluate the specified commands Synopsis -------- -:: - - eval [COMMANDS...] +**eval** [*COMMANDS*...] 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. +**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. -If your command does not need access to stdin, consider using :ref:`source ` instead. +If the command does not need access to stdin, consider using :ref:`source ` instead. If no piping or other compound shell constructs are required, variable-expansion-as-command, as in ``set cmd ls -la; $cmd``, is also an option. - Example ------- @@ -30,4 +28,3 @@ The following code will call the ls command and truncate each filename to the fi set cmd ls \| cut -c 1-12 eval $cmd - diff --git a/doc_src/cmds/exec.rst b/doc_src/cmds/exec.rst index 37b7d9298..25987acf9 100644 --- a/doc_src/cmds/exec.rst +++ b/doc_src/cmds/exec.rst @@ -6,9 +6,7 @@ exec - execute command in current process Synopsis -------- -:: - - exec COMMAND [OPTIONS...] +**exec** *COMMAND* Description ----------- diff --git a/doc_src/cmds/fg.rst b/doc_src/cmds/fg.rst index 26b9b81db..98605a63c 100644 --- a/doc_src/cmds/fg.rst +++ b/doc_src/cmds/fg.rst @@ -6,16 +6,18 @@ fg - bring job to foreground Synopsis -------- -:: - - fg [PID] +**fg** [*PID*] Description ----------- -``fg`` brings the specified :ref:`job ` to the foreground, resuming it if it is stopped. While a foreground job is executed, fish is suspended. If no job is specified, the last job to be used is put in the foreground. If ``PID`` is specified, the job containing a process with the specified process ID is put in the foreground. +The **fg** builtin brings the specified :ref:`job ` to the foreground, resuming it if it is stopped. +While a foreground job is executed, fish is suspended. +If no job is specified, the last job to be used is put in the foreground. +If ``PID`` is specified, the job containing a process with the specified process ID is put in the foreground. -For compatibility with other shells, job expansion syntax is supported for ``fg``. A ``PID`` of the format ``%1`` will foreground job 1. Job numbers can be seen in the output of :ref:`jobs `. +For compatibility with other shells, job expansion syntax is supported for ``fg``. A ``PID`` of the format ``%1`` will foreground job 1. +Job numbers can be seen in the output of :ref:`jobs `. Example ------- diff --git a/doc_src/cmds/fish.rst b/doc_src/cmds/fish.rst index 7cc2b55da..e1f8fe82b 100644 --- a/doc_src/cmds/fish.rst +++ b/doc_src/cmds/fish.rst @@ -8,7 +8,6 @@ Synopsis -------- **fish** [*OPTIONS*] [*FILE* [*ARGS* ...]] - **fish** [*OPTIONS*] [**-c** *COMMAND* [*ARGS* ...]] Description diff --git a/doc_src/cmds/fish_add_path.rst b/doc_src/cmds/fish_add_path.rst index 28b482d0c..9dd367ebf 100644 --- a/doc_src/cmds/fish_add_path.rst +++ b/doc_src/cmds/fish_add_path.rst @@ -7,9 +7,9 @@ fish_add_path - add to the path Synopsis -------- -**fish_add_path** *path*... +``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_breakpoint_prompt.rst b/doc_src/cmds/fish_breakpoint_prompt.rst index 784add5a0..e6e2381c4 100644 --- a/doc_src/cmds/fish_breakpoint_prompt.rst +++ b/doc_src/cmds/fish_breakpoint_prompt.rst @@ -6,11 +6,9 @@ fish_breakpoint_prompt - define the prompt when stopped at a breakpoint Synopsis -------- -:: - - function fish_breakpoint_prompt - ... - end +| **function** *fish_breakpoint_prompt* +| ... +| end Description