Page 2 of 23
cfg_check
Aborts if the given parameter is not a valid one
Arguments
$1 | Parameter |
Returns
Only if parameter is validDisplays
If parameter is invalid, aborts with error messagecfg_display
Display the parameters along with their default and actual values
Arguments
None
Returns
0Displays
Parameterscfg_dump
Display parameters with actual value in raw format
Format of each line : <parameter><space><value>
The output of this function does not allow to say if a value is the default one or not.
Arguments
None
Returns
0Displays
List of '<parameter><space><value>' linescfg_exists
Check that the given parameter is a valid one
Actually, parameter is valid if a default value is registered for this param.
Arguments
$1 | Parameter |
Returns
0 if parameter exists, =!0 if notDisplays
nothingcfg_get
Get parameter value
If parameter is set, returns set value. Else, returns default value.
Arguments
$1 | Parameter |
Returns
Only if parameter is validDisplays
Parameter valuecfg_get_default
Get parameter default value
Arguments
$1 | Parameter |
Returns
Only if parameter is validDisplays
Parameter default valuecfg_info
Display parameter information
Arguments
$* | Optional. List of parameters. If empty, display every defined parameters |
Returns
0Displays
Parameters and related informationcfg_isset
Check if a parameter is explicitely set (not default)
Arguments
$1 | Parameter |
Returns
0 if parameter is set (not default value), 1 if not setDisplays
nothingcfg_list
List defined configuration parameters
Arguments
None
Returns
0Displays
Defined parameters, one by linecfg_set
Set an explicit parameter value
To reset a parameter to its default value, see cfg_unset
Arguments
$1 | Parameter |
$2 | Value |
Returns
Only if parameter is validDisplays
Nothingcfg_unset
Reset a parameter to its default value
Arguments
$1 | Parameter |