RcppOctave (version 0.18.1)

octave_config: Octave Utils: octave-config

Description

Retrieves Octave configuration variables using octave-config.

Usage

octave_config(varname, verbose = FALSE, warn = TRUE, mustWork = TRUE, exec = c("octave-config", "mkoctfile"), bindir = Octave.home("bin"))

Arguments

varname

Name (as a character string) of the Octave configuration variable to retrieve. It is used in following system call octave-config -p . This function is vectorised and returns a character vector of the same length as its argument.

verbose

logical that toggles verbose messages.

warn

logical that indicates if a warning should be thrown when a variable is returned empty, which generally means that x is not a valid config variable name.

mustWork

logical that indicates if an error should be thrown if failing to load Octave configuration.

exec

name of the executable to query

bindir

path to Octave bin/ sub-directory where to look for octave-config. If NULL or NA, then the system PATH is looked up.

Details

octave_config uses the octave-config utility binary shipped with Octave to query details about the local Octave installation. Failure to retrieve such information is generally due to the binary not being found. By default, it is looked up in the bin/ sub-directory of the path returned by Octave.home().

See Also

Other Octave.info: Octave.config, Octave.info, Octave.version; Octave.home; o_config_info

Examples

octave_config('VERSION')
octave_config('BINDIR')