h/fish-shell
1
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2026-06-09 03:51:20 -03:00
Code Issues Packages Projects Releases Wiki Activity

help: adjust synopsis. history manpage: indent long synopsis lines

Browse Source
This commit is contained in:
Aaron Gyes
2021-12-17 15:38:06 -08:00
parent 50d65ace34
commit 5ae7bc1443
2 changed files with 17 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
doc_src/cmds/help.rst
View File

@@ -6,25 +6,27 @@ help - display fish documentation
Synopsis
--------
::
help [SECTION]
``help`` [*SECTION*]
Description
-----------
``help`` displays the fish help documentation.
If a ``SECTION`` is specified, the help for that command is shown.
If a *SECTION* is specified, the help for that command is shown.
If the BROWSER environment variable is set, it will be used to display the documentation. Otherwise, fish will search for a suitable browser.
If you prefer to use a different browser (other than as described above) for fish help, you can set the fish_help_browser variable. This variable may be set as a list, where the first element is the browser command and the rest are browser options.
Note that most builtin commands display their help in the terminal when given the ``--help`` option.
If the BROWSER environment variable is set, it will be used to display the documentation.
Otherwise, fish will search for a suitable browser.
To use a different browser than as described above, one can set the :envvar:`fish_help_browser` variable.
This variable may be set as a list, where the first element is the browser command and the rest are browser options.
Example
-------
``help fg`` shows the documentation for the :ref:`fg <cmd-fg>` builtin.
Notes
-----
Most builtin commands display their help in the terminal when given the **--help** option.