ESO Recipe Execution Tool
3.13
|
Functions | |
void | er_help_display (const char *plugin_name, cpl_parameterlist *param_list, int flag_show_all) |
Provides help information on EsoRex. More... | |
void | er_help_manpage (cpl_recipe *recipe, int flag_show_all) |
Prints a simulated man page for a plugin. More... | |
void | er_help_create_config (int def_flag, const char *context_name, const char *file_name, cpl_parameterlist *caller_parlist, cpl_parameterlist *config_parlist) |
Generates a default configuration file. More... | |
Generates help information for EsoRex functionality.
void er_help_create_config | ( | int | def_flag, |
const char * | context_name, | ||
const char * | file_name, | ||
cpl_parameterlist * | caller_parlist, | ||
cpl_parameterlist * | config_parlist | ||
) |
Generates a default configuration file.
def_flag | = 1 for default , = 11 for specific config file |
context_name | Name of the application context |
file_name | Name of the file to be created (without extension) |
caller_parlist | List of Parameters from the caller, which will govern the behaviour of this function. |
config_parlist | List of the parameters that shall be written into the configuration file. |
Generates a configuration file containing all the parameters from the specified list, along with relevant comments and the default values.
void er_help_display | ( | const char * | plugin_name, |
cpl_parameterlist * | param_list, | ||
int | flag_show_all | ||
) |
Provides help information on EsoRex.
plugin_name | The name of the plugin |
param_list | List of the plugin parameters |
flag_show_all | Flag to force displaying disabled parameters. |
Prints the help information for EsoRex (but not the plugin, if any).
void er_help_manpage | ( | cpl_recipe * | recipe, |
int | flag_show_all | ||
) |
Prints a simulated man page for a plugin.
recipe | The recipe plugin for which the page should be generated. |
flag_show_all | Flag to force displaying disabled parameters. |
Prints a "man page" for a plugin.