Navigation

Operators and Keywords

Function List:

C++ API

help.m File Reference


Functions

function help (name) if(nargin
 elseif (nargin==1 &&ischar(name))[text
 switch (lower(format)) case"plain text"status=0
case not documented error ("help: `%s' is not documented\n", name)
endif which (name)
 printf ("\n%s\n%s", text, __additional_help_message__())
else error ("help: invalid input\n")
 if (!isempty(d)) p
endswitch unwind_protect_cleanup path (p)

Variables

 format = get_help_text (name)
case texinfo [text, status] = __makeinfo__ (text, "plain text")
case html [text, status] = strip_html_tags (text)
case not found [text, status] = do_contents (name)
if(status!=0) error("help raw
Texinfo source of help text
follows 
n
endif endfunction function [text, status]
 status = 1
 d = find_dir_in_path (name)
unwind_protect path (d)

Function Documentation

elseif ( nargin  = = 1 && ischar (name)  ) 

else error ( "help: invalid input\n"   ) 

case not documented error ( "help: `%s' is not documented\n"  ,
name   
)

function help ( name   ) 

if ( isemptyd  ) 

endswitch unwind_protect_cleanup path (  ) 

printf ( "\n%s\n%s"  ,
text  ,
__additional_help_message__()   
)

switch ( lower(format  )  [pure virtual]

endif which ( name   ) 


Variable Documentation

d = find_dir_in_path (name)

format = get_help_text (name)

case not found[text, status] = do_contents (name)

Initial value:

 do_contents (name)
  text = ""

case html[text, status] = strip_html_tags (text)

if (status != 0) error ("help raw Texinfo source of help text follows n

endif endif endfor w path

status = 1

case texinfo[text, status] = __makeinfo__ (text, "plain text")