diff options
| author |  Mark Griffiths <mark@thebespokepixel.com> | 2014-08-01 03:37:32 +0100 |
|---|---|---|
| committer | Mark Griffiths <mark@thebespokepixel.com> | 2014-09-03 14:43:24 +0100 |
| commit | d282bc462578a6e47747c78d2d42883530f0d11e (patch) | |
| tree | a6515e908d4fc1c400cb6cebaf79b1590b005804 /doc_src/help.txt | |
| parent | 1c4223889bd729ee83aa21a3450dc28f92ade641 (diff) | |
Documentation update
Rework for Doxygen >1.8. Moved large parts of the documentation to a
simplified format, making use of Markdown enhancements and fixing bad
long options.
Diffstat (limited to 'doc_src/help.txt')
| -rw-r--r-- | doc_src/help.txt | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/doc_src/help.txt b/doc_src/help.txt index c4c05382..a3375204 100644 --- a/doc_src/help.txt +++ b/doc_src/help.txt @@ -1,20 +1,22 @@ \section help help - display fish documentation \subsection help-synopsis Synopsis - <tt>help [SECTION]</tt> +\fish{syn} +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. Note that most builtin commands display their help in the terminal when -given the <tt>--help</tt> option. +given the `--help` 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. |