Option Characterization
explain_cmdline_opt()
Public: Explains command-line option.
WARNING: This function is deprecated.
$1 - Option name.
$2 - Data type of option value.
$3 - Option description.
$4 - Option category (“GENERAL” category by default).
Examples:
explain_cmdline_opt "-s" "<string>" "String to be displayed"
The function does not return any value.
explain_opt()
Public: Explains option.
$1 - Option name.
$2 - Data type of option value.
$3 - Option description.
$4 - Option category (“GENERAL” category by default).
Examples:
explain_opt "-s" "<string>" "String to be displayed"
The function does not return any value.
explain_flag()
Public: Explains flag.
$1 - Flag name.
$2 - Flag description.
$3 - Flag category (“GENERAL” category by default).
Examples:
explain_flag "-m" "Show output in markdown format"
The function does not return any value.
explain_task_shaping_opt()
Public: Explains task shaping option.
$1 - Option name.
$2 - Data type of option value.
$3 - Option description.
$4 - Option category (“GENERAL” category by default).
Examples:
explain_task_shaping_opt "-w" "<int>" "Number of workers"
The function does not return any value.
opt_is_cmdline()
Public: Identify option/flag as a command-line option.
$1 - Option name.
Examples:
opt_is_cmdline "-s"
The function does not return any value.
opt_is_non_mandatory_cmdline()
Public: Identify option/flag as a non-mandatory command-line option.
$1 - Option name.
Examples:
opt_is_non_mandatory_cmdline "-s"
The function does not return any value.