Abstract base class for formatting option help. Horde_Argv_Parser instances should use one of the HelpFormatter subclasses for formatting help; by default IndentedHelpFormatter is used.
Located in /Argv/lib/Horde/Argv/HelpFormatter.php (line 58)
Class | Description |
---|---|
![]() |
Format help with indented section bodies. |
![]() |
Format help with underlined section headers. |
The help for each option consists of two parts:
* the opt strings and metavars eg. ("-x", or "-fFILENAME, --file=FILENAME") * the user-supplied help string eg. ("turn on expert mode", "read data from FILENAME")
If possible, we write both of these on the same line: -x turn on expert mode
But if the opt string list is too long, we put the help string on a second line, indented to the same column it would start in if it fit on the first line. -fFILENAME, --file=FILENAME read data from FILENAME
Return a comma-separated list of option strings & metavariables.
Format a paragraph of free-form text for inclusion in the help output at the current indentation level.
Documentation generated on Sun, 30 Jan 2011 05:17:58 +0000 by phpDocumentor 1.4.3