Categories &

Functions List

Function Reference: doc_control

: doc_control fcn1 fcn2 ...
: st = doc_control (fcn1, fcn2, ...)

Open online documentation of the Control package in the system’s standard browser.

Note: Since Octave 11 and Control Package 4.2.0 the package documentation is automatically shown in the documentation browser of the Octave GUI as soon as the Control Package is loaded. Help to all package functions can then also be accessed by the comamnd doc .... However, this function is still useful when using Octave in the command line.

Inputs

fcn1, fcn2, ...

Function names for which the documentation should be displayed. If no function name is given, the index of the documentation is shown. If one of the function names is ’license’, copyright and license information are displayed.

Outputs

st

The return value st has one of the values:

  • 0’ Found and opened system browser successfully.
  • 1’ System browser not found.
  • 2’ System browser found, but an error occurred.

Source Code: doc_control