Go to the first, previous, next, last section, table of contents.
When calling argp_help
(see section The argp_help
Function), or
argp_state_help
(see section Functions For Use in Argp Parsers), exactly what is
output is determined by the flags argument, which should consist
of any of the following flags, or'd together:
ARGP_HELP_USAGE
-
A unix `Usage:' message that explicitly lists all options.
ARGP_HELP_SHORT_USAGE
-
A unix `Usage:' message that displays only an appropriate
placeholder to indicate where the options go; useful for showing
the non-option argument syntax.
ARGP_HELP_SEE
-
A `Try ... for more help' message; `...' contains the
program name and `--help'.
ARGP_HELP_LONG
-
A verbose option help message that gives each option understood along
with its documentation string.
ARGP_HELP_PRE_DOC
-
The part of the argp parser doc string that precedes the verbose option help.
ARGP_HELP_POST_DOC
-
The part of the argp parser doc string that follows the verbose option help.
ARGP_HELP_DOC
-
(ARGP_HELP_PRE_DOC | ARGP_HELP_POST_DOC)
ARGP_HELP_BUG_ADDR
-
A message saying where to report bugs for this program, if the
argp_program_bug_address
variable contains one.
ARGP_HELP_LONG_ONLY
-
Modify any output appropriately to reflect
ARGP_LONG_ONLY
mode.
The following flags are only understood when used with
argp_state_help
, and control whether the function returns after
printing its output, or terminates the program:
ARGP_HELP_EXIT_ERR
-
Terminate the program with
exit (argp_err_exit_status)
.
ARGP_HELP_EXIT_OK
-
Terminate the program with
exit (0)
.
The following flags are combinations of the basic ones for printing
standard messages:
ARGP_HELP_STD_ERR
-
Assuming an error message for a parsing error has already printed,
prints a note on how to get help, and terminates the program with an
error.
ARGP_HELP_STD_USAGE
-
Prints a standard usage message and terminates the program with an
error. This is used when no more specific error message is appropriate.
ARGP_HELP_STD_HELP
-
Prints the standard response for a `--help' option, and terminates
the program successfully.
Go to the first, previous, next, last section, table of contents.