github-mirror/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2024-11-23 06:05:39 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: Explain the man/help split in the help section

Browse Source
This commit is contained in:
Fabian Homborg 2021-01-31 11:41:46 +01:00
parent dd48fdc970
commit 9fead046b5
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc_src/index.rst
View File

@ -1484,10 +1484,12 @@ Help
Fish has an extensive help system. Use the :ref:`help <cmd-help>` command to obtain help on a specific subject or command. For instance, writing ``help syntax`` displays the `syntax section <#syntax>`_ of this documentation.
Fish also has man pages for its commands. For example, ``man set`` will show the documentation for ``set`` as a man page.
Fish also has man pages for its commands, and translates the help pages to man pages. For example, ``man set`` will show the documentation for ``set`` as a man page.
Help on a specific builtin can also be obtained with the ``-h`` parameter. For instance, to obtain help on the :ref:`fg <cmd-fg>` builtin, either type ``fg -h`` or ``help fg``.
This page can be viewed via ``help index`` (or just ``help``) or ``man fish-doc``. The tutorial can be viewed with ``help tutorial`` or ``man fish-tutorial``.
Autosuggestions
---------------