mirror of
https://github.com/fish-shell/fish-shell.git
synced 2026-05-16 15:21:14 -03:00
We no longer have two doc systems, move sphinx_doc_src back to doc_src
This commit is contained in:
30
doc_src/cmds/help.rst
Normal file
30
doc_src/cmds/help.rst
Normal file
@@ -0,0 +1,30 @@
|
||||
.. _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 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.
|
||||
|
||||
|
||||
Example
|
||||
-------
|
||||
|
||||
``help fg`` shows the documentation for the ``fg`` builtin.
|
||||
Reference in New Issue
Block a user