Mercurial > hg > octave-lyh

comparison src/help.cc @ 7001:8b0cfeb06365

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[project @ 2007-10-10 18:02:59 by jwe]
author jwe
date Wed, 10 Oct 2007 18:03:02 +0000
parents bf4bdc21dc8d
children 93c65f2a5668
comparison
equal deleted inserted replaced
7000:e87f860624cc 7001:8b0cfeb06365
1742 @deffn {Command} lookfor @var{str}\n\ 1742 @deffn {Command} lookfor @var{str}\n\
1743 @deffnx {Command} lookfor -all @var{str}\n\ 1743 @deffnx {Command} lookfor -all @var{str}\n\
1744 @deffnx {Function} {[@var{fun}, @var{helpstring}] = } lookfor (@var{str})\n\ 1744 @deffnx {Function} {[@var{fun}, @var{helpstring}] = } lookfor (@var{str})\n\
1745 @deffnx {Function} {[@var{fun}, @var{helpstring}] = } lookfor ('-all', @var{str})\n\ 1745 @deffnx {Function} {[@var{fun}, @var{helpstring}] = } lookfor ('-all', @var{str})\n\
1746 Search for the string @var{str} in all of the functions found in the\n\ 1746 Search for the string @var{str} in all of the functions found in the\n\
1747 function search path. By default @code{lookfor} searchs for @var{str}\n\ 1747 function search path. By default @code{lookfor} searches for @var{str}\n\
1748 in the first sentence of the help string of each function found. The entire\n\ 1748 in the first sentence of the help string of each function found. The entire\n\
1749 help string of each function found in the path can be search if\n\ 1749 help string of each function found in the path can be searched if\n\
1750 the '-all' argument is supplied. All searches are case insensitive.\n\ 1750 the '-all' argument is supplied. All searches are case insensitive.\n\
1751 \n\ 1751 \n\
1752 Called with no output arguments, @code{lookfor} prints the list of matching\n\ 1752 Called with no output arguments, @code{lookfor} prints the list of matching\n\
1753 functions to the terminal. Otherwise the output arguments @var{fun} and\n\ 1753 functions to the terminal. Otherwise the output arguments @var{fun} and\n\
1754 @var{helpstring} define the matching functions and the first sentence of\n\ 1754 @var{helpstring} define the matching functions and the first sentence of\n\
2159 2159
2160 DEFUN (suppress_verbose_help_message, args, nargout, 2160 DEFUN (suppress_verbose_help_message, args, nargout,
2161 "-*- texinfo -*-\n\ 2161 "-*- texinfo -*-\n\
2162 @deftypefn {Built-in Function} {@var{val} =} suppress_verbose_help_message ()\n\ 2162 @deftypefn {Built-in Function} {@var{val} =} suppress_verbose_help_message ()\n\
2163 @deftypefnx {Built-in Function} {@var{old_val} =} suppress_verbose_help_message (@var{new_val})\n\ 2163 @deftypefnx {Built-in Function} {@var{old_val} =} suppress_verbose_help_message (@var{new_val})\n\
2164 Query or set the internal vaiable that controls whether Octave\n\ 2164 Query or set the internal variable that controls whether Octave\n\
2165 will add additional help information to the end of the output from\n\ 2165 will add additional help information to the end of the output from\n\
2166 the @code{help} command and usage messages for built-in commands.\n\ 2166 the @code{help} command and usage messages for built-in commands.\n\
2167 @end deftypefn") 2167 @end deftypefn")
2168 { 2168 {
2169 return SET_INTERNAL_VARIABLE (suppress_verbose_help_message); 2169 return SET_INTERNAL_VARIABLE (suppress_verbose_help_message);