h/fish-shell
1
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2026-05-03 20:11:15 -03:00
Code Issues Packages Projects Releases Wiki Activity

Documentation update

Browse Source 
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.
This commit is contained in:
Mark Griffiths
2014-08-01 03:37:32 +01:00
parent 1c4223889b
commit d282bc4625
86 changed files with 9212 additions and 4813 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
doc_src/help.txt
View File

@@ -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.