mirror of
https://github.com/fish-shell/fish-shell
synced 2024-12-28 13:53:10 +00:00
38b24c2325
This makes it so we link to the very top of the document instead of a special anchor we manually include. So clicking e.g. :doc:`string <cmds/string>` will link you to cmds/string.html instead of cmds/string.html#cmd-string. I would love to have a way to say "this document from the root of the document path", but that doesn't appear to work, I tried `/cmds/string`. So we'll just have to use cmds/string in normal documents and plain `string` from other commands.
35 lines
938 B
ReStructuredText
35 lines
938 B
ReStructuredText
.. _cmd-help:
|
|
|
|
help - display fish documentation
|
|
=================================
|
|
|
|
Synopsis
|
|
--------
|
|
|
|
.. synopsis::
|
|
|
|
help [SECTION]
|
|
|
|
Description
|
|
-----------
|
|
|
|
``help`` displays the fish help documentation.
|
|
|
|
If a *SECTION* is specified, the help for that command is shown.
|
|
|
|
The **-h** or **--help** option displays help about using this command.
|
|
|
|
If the :envvar:`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 :doc:`fg <fg>` builtin.
|
|
|
|
Notes
|
|
-----
|
|
|
|
Most builtin commands, including this one, display their help in the terminal when given the **--help** option.
|