GNU Info

(libc.info)Argp Help

---

Next: Argp Examples Prev: Argp Flags Up: Argp

---

Enter node , (file) or (file)node

The `argp_help' Function
------------------------

   Normally programs using argp need not be written with particular
printing argument-usage-type help messages in mind as the standard
`--help' option is handled automatically by argp.  Typical error cases
can be handled using `argp_usage' and `argp_error'.  Note: Argp Helper
Functions.  However, if it's desirable to print a help message in
some context other than parsing the program options, argp offers the
`argp_help' interface.

 - Function: void argp_help (const struct argp *ARGP, FILE *STREAM,
          unsigned FLAGS, char *NAME)
     This outputs a help message for the argp parser ARGP to STREAM.
     The type of messages printed will be 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 best to use `argp_state_help' if calling from within
     an argp parser function.  Note: Argp Helper Functions.

Flags

Argp Help Flags. Specifying what sort of help message to print.