Args module

help_text

procedure · 1 overloadSource

The help text of the whole program (what --help prints), for tools that show it themselves.

help_text :: ($T: Type, $help: Help(T), program := "", color := false) -> string

The help text of the whole program (what --help prints), for tools that show it themselves.

Parameters

$T: Type
the struct whose fields are the options.
$help: Help(T)
the help strings for T.
program := ""
the name shown in the usage line; "" uses argv[0]'s basename.
color := false
whether to include ANSI colour codes.

Returns

string

See also