Package: glib

Function glib:option-context-help

Lambda List

glib:option-context-help (context main &optional group)

Arguments

context -- a g:option-context instance
main -- if true, only include the main group
group -- an optional g:option-group instance to create help for

Return Value

The newly allocated string containing the help text.

Details

Returns a formatted, translated help text for the given option context. To obtain the text produced by the --help output, call
(g:option-context-help context t)  
To obtain the text produced by --help-all, call
(g:option-context-help context nil)  
To obtain the help text for an option group, call
(g:option-context-help context nil group)  
 

See also

#2024-11-19