Method

GLibOptionContextset_summary

since: 2.12

Declaration [src] 

void
g_option_context_set_summary (
  GOptionContext* context,
  const gchar* summary
)

Description [src]

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 g_option_context_set_translate_func() and g_option_context_set_translation_domain()).

Available since: 2.12

Parameters

summary

Type: const gchar*

A string to be shown in --help output before the list of options, or NULL.

The argument can be NULL.
The data is owned by the caller of the method.
The value is a NUL terminated UTF-8 string.