Home > freetb4matlab > help > lookfor.m

lookfor

PURPOSE ^

% Search for the string @var{str} in all functions found in the current

SYNOPSIS ^

function [out_fun, out_help_text] = lookfor (str, extra)

DESCRIPTION ^

% -*- texinfo -*-
% @deftypefn {Command} lookfor @var{str}
% @deftypefnx {Command} lookfor -all @var{str}
% @deftypefnx {Function} {[@var{func}, @var{helpstring}] =} lookfor (@var{str})
% @deftypefnx {Function} {[@var{func}, @var{helpstring}] =} lookfor ('-all', @var{str})
% Search for the string @var{str} in all functions found in the current 
% function search path.  By default, @code{lookfor} searches for @var{str}
% in the first sentence of the help string of each function found.  The entire
% help text of each function can be searched if the '-all' argument is 
% supplied.  All searches are case insensitive.
% 
% Called with no output arguments, @code{lookfor} prints the list of 
% matching functions to the terminal.  Otherwise, the output arguments 
% @var{func} and @var{helpstring} define the matching functions and the 
% first sentence of each of their help strings.
% 
% The ability of @code{lookfor} to correctly identify the first
% sentence of the help text is dependent on the format of the
% function's help.  All Octave core functions are correctly
% formatted, but the same can not be guaranteed for external packages and
% user-supplied functions.  Therefore, the use of the '-all' argument may 
% be necessary to find related functions that are not a part of Octave.
% @seealso{help, doc, which}
% @end deftypefn

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:
Generated on Fri 22-May-2009 15:13:00 by m2html © 2003