help

Arguments

key

Scalar string naming the documentation page to display (usually a function name or the page identifier).

Description

The help function looks up the DocBook page referenced by key in the inline help index, applies the compact text stylesheet, and makes the resulting summary available in the current console.

If no output argument is requested, the formatted text is printed directly. When an output argument is provided, the same text is returned as a single string so that it can be inspected or post-processed programmatically.

Examples

// Display the inline summary of the "plot" page in the console
help("plot");

// Ask for the documentation page name before opening it with doc
fun = "fft";
help(fun);
doc(fun);

See also

• doc — queries and displays help pages in the Scilab help browser