Mercurial > hg > octave-nkf

comparison scripts/help/help.m @ 11567:5c18da80e28a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc fixes
author John W. Eaton <jwe@octave.org>
date Wed, 19 Jan 2011 05:38:40 -0500
parents 21c3e1370b82
children c792872f8942
comparison
equal deleted inserted replaced
11566:8bb85ba7c9a6 11567:5c18da80e28a
16 ## along with Octave; see the file COPYING. If not, see 16 ## along with Octave; see the file COPYING. If not, see
17 ## <http://www.gnu.org/licenses/>. 17 ## <http://www.gnu.org/licenses/>.
18 18
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Command} {} help @var{name} 20 ## @deftypefn {Command} {} help @var{name}
21 ## @deftypefn {Command} {} help @code{--list} 21 ## @deftypefnx {Command} {} help @code{--list}
22 ## Display the help text for @var{name}. 22 ## Display the help text for @var{name}. For example, the command
23 ## If invoked without any arguments, @code{help} display instructions 23 ## @kbd{help help} prints a short message describing the @code{help}
24 ## on how to access help from the command line. 24 ## command.
25 ##
26 ## For example, the command @kbd{help help} prints a short message
27 ## describing the @code{help} command.
28 ## 25 ##
29 ## Given the single argument @code{--list}, list all operators, 26 ## Given the single argument @code{--list}, list all operators,
30 ## keywords, built-in functions, and loadable functions available 27 ## keywords, built-in functions, and loadable functions available
31 ## in the current session of Octave. 28 ## in the current session of Octave.
32 ## 29 ##
33 ## @deftypefnx {Function File} {@var{text} =} help (@var{name}) 30 ## If invoked without any arguments, @code{help} display instructions
34 ## Return the help text for the function, @var{name}. 31 ## on how to access help from the command line.
35 ## 32 ##
36 ## The help command can give you information about operators, but not the 33 ## The help command can give you information about operators, but not the
37 ## comma and semicolons that are used as command separators. To get help 34 ## comma and semicolons that are used as command separators. To get help
38 ## for those, you must type @kbd{help comma} or @kbd{help semicolon}. 35 ## for those, you must type @kbd{help comma} or @kbd{help semicolon}.
39 ## @seealso{doc, lookfor, which} 36 ## @seealso{doc, lookfor, which}