fish-shell/doc_src/cmds/help.rst

.. _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 :ref:`fg <cmd-fg>` builtin.
docs: Add labels to all commands This allows us to use :ref: references, which don't require hardcoding it as html [ci skip] 2019-03-31 09:05:09 +00:00			`.. _cmd-help:`

Switch command docs from \section to reStructuredText 2018-12-17 01:39:33 +00:00			`help - display fish documentation`
Fix command section separator line lengths 2019-01-03 04:10:47 +00:00			`=================================`
Switch command docs from \section to reStructuredText 2018-12-17 01:39:33 +00:00
Migrate the 'synopsis' sections to .rst format 2018-12-18 01:58:24 +00:00			`Synopsis`
			`--------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
docs: update all command synopsis formatting Adds synopses for those commands missing them. Moves all synopsis sections to code blocks. This improves the appearance, although highlighting as fish code may not be the ideal appearance. 2019-09-17 09:59:04 +00:00			`::`
Migrate the 'synopsis' sections to .rst format 2018-12-18 01:58:24 +00:00
docs: update all command synopsis formatting Adds synopses for those commands missing them. Moves all synopsis sections to code blocks. This improves the appearance, although highlighting as fish code may not be the ideal appearance. 2019-09-17 09:59:04 +00:00			`help [SECTION]`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Convert \\subsection sections into rst format 2018-12-19 02:44:30 +00:00			`Description`
Fix command section separator line lengths 2019-01-03 04:10:47 +00:00			`-----------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Switch backticks to double backticks for rst compatibility 2018-12-19 20:02:45 +00:00			``help`` displays the fish help documentation.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Switch backticks to double backticks for rst compatibility 2018-12-19 20:02:45 +00:00			If a ``SECTION`` is specified, the help for that command is shown.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
			`If the BROWSER environment variable is set, it will be used to display the documentation. Otherwise, fish will search for a suitable browser.`

docs: Call "arrays" "lists" We were flip-flopping between the two terms, so we now use one. We still mention "array" in the chapter, and it's still `read --array`, though. Fixes #5846. [ci skip] 2019-05-05 12:01:07 +00:00			`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.`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Switch backticks to double backticks for rst compatibility 2018-12-19 20:02:45 +00:00			Note that most builtin commands display their help in the terminal when given the ``--help`` option.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00

Convert \\subsection sections into rst format 2018-12-19 02:44:30 +00:00			`Example`
Fix command section separator line lengths 2019-01-03 04:10:47 +00:00			`-------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
docs: Link builtins When we say "the XYZ command/builtin", we should typically include a link. The exceptions are - In the documentation for that command - no need to link to ulimit in the ulimit page - When we've already linked before - not every thing needs to be clickable, or clicking it will cause the browser to mark fifty words as visited. This is roughly what wikipedia does for crosslinks. [ci skip] 2020-03-21 14:31:25 +00:00			``help fg`` shows the documentation for the :ref:`fg <cmd-fg>` builtin.