Function g-option-context-description

Package: glib

Lambda List

g-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 function g-option-context-description returns the description. The function (setf g-option-context-description) 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 function g-option-context-set-translate-func.

Example

(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.
"