g-option-context-summary (context)

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

The function g-option-context-summary returns the summary. The function (setf g-option-context-summary) adds a string to be displayed in --help output before the list of options. This is typically a summary of the program functionality.

Note that the summary is translated. See the functions g-option-context-set-translate-func and g-option-context-set-translation-domain.

(setq context (g-option-context-new "A short description."))
=> #.(SB-SYS:INT-SAP #X561C3BDDC430)
(setf (g-option-context-summary context) "This is the summary.")
=> "This is the summary."
(g-option-context-help context nil)
=>
"Aufruf:
  sbcl [OPTION …] A short description.


This is the summary.


Hilfeoptionen:
  -h, --help       Hilfeoptionen anzeigen
"