Navigation

Operators and Keywords

Function List:

C++ API

: val = texi_macros_file ()
: old_val = texi_macros_file (new_val)
: texi_macros_file (new_val, "local")

Query or set the internal variable that specifies the name of the file containing Texinfo macros that are prepended to documentation strings before they are passed to makeinfo.

The default value is octave-home/share/octave/version/etc/macros.texi, in which octave-home is the root directory of the Octave installation, and version is the Octave version number. The default value may be overridden by the environment variable OCTAVE_TEXI_MACROS_FILE, or the command line argument --texi-macros-file FNAME.

When called from inside a function with the "local" option, the variable is changed locally for the function and any subroutines it calls. The original variable value is restored when exiting the function.

See also: makeinfo_program.

Package: octave