Node:Argp Help, Next:Argp Examples, Previous:Argp Flags, Up:Argp
argp_help
Function
Normally programs using argp need not worry too much about printing
argument-usage-type help messages, because the standard --help
option is handled automatically by argp, and the typical error cases can
be handled using argp_usage
and argp_error
(see Argp
Helper Functions).
However, if it's desirable to print a standard help message in some
context other than parsing the program options, argp offers the
argp_help
interface.
void argp_help (const struct argp *argp, FILE *stream, unsigned flags, char *name) | Function |
Output a help message for the argp parser argp to stream.
What sort of messages is printed is determined by flags.
Any options such as --help that are implemented automatically by
argp itself will not be present in the help output; for this
reason, it is better to use argp_state_help if calling from
within an argp parser function. See Argp Helper Functions.
|