ESO Recipe Execution Tool 3.13.10
Functions
EsoRex help functions.

Functions

void er_help_display (const char *plugin_name, cpl_parameterlist *param_list, int flag_show_all)
 Provides help information on EsoRex.
 
void er_help_manpage (cpl_recipe *recipe, int flag_show_all)
 Prints a simulated man page for a plugin.
 
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.
 

Detailed Description

Generates help information for EsoRex functionality.

Function Documentation

◆ er_help_create_config()

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.

Parameters
def_flag= 1 for default , = 11 for specific config file
context_nameName of the application context
file_nameName of the file to be created (without extension)
caller_parlistList of Parameters from the caller, which will govern the behaviour of this function.
config_parlistList 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.

◆ er_help_display()

void er_help_display ( const char * plugin_name,
cpl_parameterlist * param_list,
int flag_show_all )

Provides help information on EsoRex.

Parameters
plugin_nameThe name of the plugin
param_listList of the plugin parameters
flag_show_allFlag to force displaying disabled parameters.

Prints the help information for EsoRex (but not the plugin, if any).

◆ er_help_manpage()

void er_help_manpage ( cpl_recipe * recipe,
int flag_show_all )

Prints a simulated man page for a plugin.

Parameters
recipeThe recipe plugin for which the page should be generated.
flag_show_allFlag to force displaying disabled parameters.

Prints a "man page" for a plugin.