The Bash Argsparse Library 1.8
An high level argument parsing library for bash.
Loading...
Searching...
No Matches
Setting options values.

Functions

 argsparse_set_alias (option)
 "alias" property specific option-setting hook.
 
 argsparse_set_cumulative_option (option, value)
 "cumulative" property specific option-setting hook.
 
 argsparse_set_cumulativeset_option (option, value)
 "cumulativeset" property specific option-setting hook.
 
 argsparse_set_option (option, value)
 Default option-setting hook.
 
 argsparse_set_option_with_value (option, value)
 "value" property specific option-setting hook.
 
 argsparse_set_option_without_value (option)
 The option-setting hook for options not accepting values.
 

Detailed Description

Function Documentation

◆ argsparse_set_alias()

argsparse_set_alias ( option )

"alias" property specific option-setting hook.

Parameters
optionan option name.

When an option is an alias for other option(s), then set the aliases options.

◆ argsparse_set_cumulative_option()

argsparse_set_cumulative_option ( option ,
value  )

"cumulative" property specific option-setting hook.

Default action to take for cumulative options. Store value into an array whose name is generated using argsparse_get_cumulative_array_name().

Parameters
optionan option name.
valuethe value put on command line for given option.

◆ argsparse_set_cumulativeset_option()

argsparse_set_cumulativeset_option ( option ,
value  )

"cumulativeset" property specific option-setting hook.

Parameters
optionan option name.
valuea new value for the option.

Default action to take for cumulativeset options. Act exactly like argsparse_set_cumulative_option() except that values are not duplicated in the cumulated values array.

◆ argsparse_set_option()

argsparse_set_option ( option ,
value  )

Default option-setting hook.

Parameters
optionThe option being set.
valuethe value of the option (optional).

This function will be called by argsparse_parse_options() whenever an option is being and no custom setting hook is define for this option. Depending of the properties of the option a more specific setting hook will be called.

◆ argsparse_set_option_with_value()

argsparse_set_option_with_value ( option ,
value  )

"value" property specific option-setting hook.

Parameters
optionan option name.
valuethe value put on command line for given option.

◆ argsparse_set_option_without_value()

argsparse_set_option_without_value ( option )

The option-setting hook for options not accepting values.

Parameters
optionan option name.
Return values
0