gretl_help: Libgretl Reference Manual

gretl_help

gretl_help

Functions

int	cli_help ()

Description

Functions

cli_help ()

int
cli_help (const char *hlpword,
          const char *param,
          gretlopt opt,
          PRN *prn);

Searches in the gretl helpfile for help on hlpword and, if help is found, prints it to prn . If hlpword is NULL, lists the valid commands.

Parameters

hlpword	the word (usually a command) on which help is wanted.
param	parameter usable when `hlpword` is "set".
opt	may include `OPT_F` to give priority to functions rather than commands.
prn	pointer to gretl printing struct.

Returns

0 on success, 1 if the helpfile was not found or the requested topic was not found.

Types and Values