Node:Argp Help Flags, Up:Argp Help
argp_help
Function
When calling argp_help
(see Argp Help), or
argp_state_help
(see Argp Helper Functions), 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
Usage:
message that explicitly lists all options.
ARGP_HELP_SHORT_USAGE
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
Try ... for more help
message; ...
contains the
program name and --help
.
ARGP_HELP_LONG
ARGP_HELP_PRE_DOC
ARGP_HELP_POST_DOC
ARGP_HELP_DOC
(ARGP_HELP_PRE_DOC | ARGP_HELP_POST_DOC)
ARGP_HELP_BUG_ADDR
argp_program_bug_address
variable contains one.
ARGP_HELP_LONG_ONLY
ARGP_LONG_ONLY
mode.
argp_state_help
, and control whether the function returns after
printing its output, or terminates the program:
ARGP_HELP_EXIT_ERR
exit (argp_err_exit_status)
.
ARGP_HELP_EXIT_OK
exit (0)
.
ARGP_HELP_STD_ERR
ARGP_HELP_STD_USAGE
ARGP_HELP_STD_HELP
--help
option, and terminates
the program successfully.