g-option-context-new (&optional parameter)

parameter -- a string which is displayed in the first line of --help output

A newly created g-option-context instance, which must be freed with the function g-option-context-free after use.

Creates a new option context.

The argument parameter can serve multiple purposes. It can be used to add descriptions for "rest" arguments, which are not parsed by the g-option-context instance, typically something like "FILES" or "FILE1 FILE2...". If you are using G_OPTION_REMAINING for collecting "rest" arguments, GLib handles this automatically by using the arg-description of the corresponding option entry in the usage summary.

Another usage is to give a short summary of the program functionality, like " - frob the strings", which will be displayed in the same line as the usage. For a longer description of the program functionality that should be displayed as a paragraph below the usage line, use the function g-option-context-summary.

Note that the argument parameter is translated using the function set with the function g-option-context-set-translate-func, so it should normally be passed untranslated.

(g-option-context-new "This is an example for a description.")
=> #.(SB-SYS:INT-SAP #X0817EB48)
(g-option-context-help * nil)
=>
"Aufruf:
  sbcl [OPTION …] This is an example for a description.


Hilfeoptionen:
  -h, --help       Hilfeoptionen anzeigen
"