aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc_src/help.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc_src/help.txt')
-rw-r--r--doc_src/help.txt17
1 files changed, 9 insertions, 8 deletions
diff --git a/doc_src/help.txt b/doc_src/help.txt
index c4c05382..e279e62b 100644
--- a/doc_src/help.txt
+++ b/doc_src/help.txt
@@ -1,20 +1,21 @@
\section help help - display fish documentation
\subsection help-synopsis Synopsis
- <tt>help [SECTION]</tt>
+\fish{synopsis}
+help [SECTION]
+\endfish
\subsection help-description Description
-\c help displays the fish help documentation.
+`help` displays the fish help documentation.
-If a \c SECTION is specified, the help for that command is shown.
+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 the BROWSER environment variable is set, it will be used to display the documentation. Otherwise, fish will search for a suitable browser.
+
+Note that most builtin commands display their help in the terminal when given the `--help` option.
-Note that most builtin commands display their help in the terminal when
-given the <tt>--help</tt> option.
\subsection help-example Example
-<tt>help fg</tt> shows the documentation for the \c fg builtin.
+`help fg` shows the documentation for the `fg` builtin.