Package: glib

Function glib:option-context-description

Lambda List

glib:option-context-description (context)

Syntax

(g:option-context-description context) => description
(setf (g:option-context-descripton context) description)

Arguments

context -- a g:option-context instance
description -- a string to be shown in --help output after the list of options, or nil

Details

The g:option-context-description function returns the description. The (setf g:option-context-description) function adds a string to be displayed in --help output after the list of options. This text often includes a bug reporting address.

Note that the summary is translated. See the g:option-context-set-translate-func function.

Examples

(setq context (g:option-context-new "A short description"))
=> #.(SB-SYS:INT-SAP #X55637A1CF6D0)
(setf (g:option-context-description context) "More descriptions.")
=> "More descriptions."
(g:option-context-help context nil)
"Aufruf:
  sbcl [OPTION …] A short description

Hilfeoptionen: -h, --help Hilfeoptionen anzeigen

More descriptions. "
 

See also

2024-11-19