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/type.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/type.txt')
| -rw-r--r-- | doc_src/type.txt | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/doc_src/type.txt b/doc_src/type.txt index 8945102c..7a2c882b 100644 --- a/doc_src/type.txt +++ b/doc_src/type.txt @@ -1,11 +1,13 @@ \section type type - indicate how a command would be interpreted \subsection type-synopsis Synopsis - <tt>type [OPTIONS] NAME [NAME ...]</tt> +\fish{syn} +type [OPTIONS] NAME [NAME ...] +\endfish \subsection type-description Description -With no options, \c type indicates how each \c NAME would be interpreted if used as a command name. +With no options, `type` indicates how each `NAME` would be interpreted if used as a command name. The following options are available: @@ -17,9 +19,9 @@ The following options are available: - \c -P or \c --force-path returns the name of the disk file that would be executed, or nothing if no file with the specified name could be found in the <tt>$PATH</tt>. - \c -q or \c --quiet suppresses all output; this is useful when testing the exit status. -\c type sets the exit status to 0 if the specified command was found, +`type` sets the exit status to 0 if the specified command was found, and 1 if it could not be found. \subsection type-example Example -<tt>type fg</tt> outputs the string 'fg is a shell builtin'. +`type fg` outputs the string '`fg is a shell builtin`'. |