From 9fead046b567e6928e5d179a813eb8680e79262c Mon Sep 17 00:00:00 2001 From: Fabian Homborg Date: Sun, 31 Jan 2021 11:41:46 +0100 Subject: [PATCH] docs: Explain the man/help split in the help section --- doc_src/index.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc_src/index.rst b/doc_src/index.rst index 0c6068ab6..22c24a0b0 100644 --- a/doc_src/index.rst +++ b/doc_src/index.rst @@ -1484,10 +1484,12 @@ Help Fish has an extensive help system. Use the :ref:`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 ` 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 ---------------