Previous: , Up: Command-Line Interfaces   [Contents][Index]

4.8.2 --help

The standard --help option should output brief documentation for how to invoke the program, on standard output, then exit successfully. Other options and arguments should be ignored once this is seen, and the program should not perform its normal function.

Near the end of the ‘--help’ option’s output, please place lines giving the email address for bug reports, the package’s home page (normally ‘’), and the general page for help using GNU programs. The format should be like this:

Report bugs to: mailing-address
pkg home page: <>
General help using GNU software: <>

It is ok to mention other appropriate mailing lists and web pages.