Functions
	argsparse_describe_parameters (param...)
	Describe non-option positionnal parameters.
	argsparse_usage ()
	A generic help message generated from the options and their descriptions.
	argsparse_usage_long ()
	Fully describe the program syntax and options to the end-user.
	argsparse_usage_short ()
	Print a short description of the program syntax.
	set_option_help ()
	Default trigger for –help option.
	usage ()
	Default usage function.

Variables
String Array	__argsparse_parameters_description
	Internal use only.
String	argsparse_usage_description
	Usage description additionnal string.

Detailed Description

Function Documentation

◆ argsparse_describe_parameters()

argsparse_describe_parameters ( param... )

Describe non-option positionnal parameters.

This function has currently 2 purposes:

enhance the "short" usage program description (see argsparse_usage_short())
compute the minimum and maximum numbers of non-option positionnal parameters and will overwrite previous settings using argsparse_minimum_parameters() and argsparse_maximum_parameters().

Parameters

param...

a list of label describing positionnal parameters. These labels can have special forms such as:

"label?" a single optional non-repeatable parameter
"label+" a non-empty list of parameters
"label*" a potentially-empty list of parameters
"label" a single non-optional non-repeatable parameter

Return values

0

◆ argsparse_usage()

argsparse_usage ( )

A generic help message generated from the options and their descriptions.

Will print both a rather-short and a quite long description of the program and its options. Just provided to be wrapped in your own usage().

◆ argsparse_usage_long()

argsparse_usage_long ( )

Fully describe the program syntax and options to the end-user.

This function generates and prints the "long" description of the program usage. Print all options along with their descriptions provided to argsparse_use_option().

◆ argsparse_usage_short()

argsparse_usage_short ( )

Print a short description of the program syntax.

Generate and print the "short" description of the program usage.

◆ set_option_help()

set_option_help ( )

Default trigger for –help option.

Will actually only call usage().

Returns: Whatever usage() returns.

◆ usage()

usage ( )

Default usage function.

The default usage function. By default, it will be called by argsparse_parse_options() on error or if –help option provided by user on the command line. It can easily be overwritten if it does not suits your needs.

Returns: This function makes an exit with code 1

Variable Documentation

◆ argsparse_usage_description

String argsparse_usage_description

Usage description additionnal string.

The content of this variable will be appended to the argsparse_usage() output.

Functions

Variables