mirror of
https://github.com/fish-shell/fish-shell.git
synced 2024-11-27 19:53:36 +08:00
cf9b8fa3fa
This allows us to use :ref: references, which don't require hardcoding it as html [ci skip]
30 lines
836 B
ReStructuredText
30 lines
836 B
ReStructuredText
.. _cmd-help:
|
|
|
|
help - display fish documentation
|
|
=================================
|
|
|
|
Synopsis
|
|
--------
|
|
|
|
help [SECTION]
|
|
|
|
|
|
Description
|
|
-----------
|
|
|
|
``help`` displays the fish help documentation.
|
|
|
|
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 an array, 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.
|
|
|
|
|
|
Example
|
|
-------
|
|
|
|
``help fg`` shows the documentation for the ``fg`` builtin.
|