<T> void |
ManUsageHelper.outputArguments(TroffPrinter printer,
ArgumentsMetadata arguments,
boolean startList,
ParserMetadata<T> parserConfig) |
|
protected void |
ManUsageHelper.outputArgumentsRestriction(TroffPrinter printer,
ArgumentsMetadata arguments,
ArgumentsRestriction restriction,
HelpHint hint) |
Outputs documentation about a restriction on an option
|
void |
ManUsageHelper.outputArgumentsSynopsis(TroffPrinter printer,
ArgumentsMetadata arguments) |
|
void |
ManUsageHelper.outputArgumentsTitle(TroffPrinter printer,
ArgumentsMetadata arguments) |
|
protected void |
ManGlobalUsageGenerator.outputCommandList(TroffPrinter printer,
GlobalMetadata<T> global) |
Outputs a documentation section that lists the available commands
|
protected void |
ManGlobalUsageGenerator.outputCommandUsages(java.io.OutputStream output,
TroffPrinter printer,
GlobalMetadata<T> global) |
Outputs the command usages for all groups
|
protected void |
ManMultiPageGlobalUsageGenerator.outputCommandUsages(java.io.OutputStream output,
TroffPrinter printer,
GlobalMetadata<T> global) |
|
protected void |
ManGlobalUsageGenerator.outputDefaultGroupCommandUsages(java.io.OutputStream output,
TroffPrinter printer,
GlobalMetadata<T> global) |
Outputs the command usages for the commands in the default group
|
protected void |
ManMultiPageGlobalUsageGenerator.outputDefaultGroupCommandUsages(java.io.OutputStream output,
TroffPrinter printer,
GlobalMetadata<T> global) |
|
protected void |
ManGlobalUsageGenerator.outputGroupCommandsList(TroffPrinter printer,
GlobalMetadata<T> global,
java.util.List<CommandGroupMetadata> groups) |
|
protected void |
ManGlobalUsageGenerator.outputGroupCommandUsages(java.io.OutputStream output,
TroffPrinter printer,
GlobalMetadata<T> global,
java.util.List<CommandGroupMetadata> groups) |
Outputs the command usages for the commands in the given group
|
protected void |
ManMultiPageGlobalUsageGenerator.outputGroupCommandUsages(java.io.OutputStream output,
TroffPrinter printer,
GlobalMetadata<T> global,
java.util.List<CommandGroupMetadata> groups) |
|
protected void |
ManGlobalUsageGenerator.outputGroupList(TroffPrinter printer,
GlobalMetadata<T> global) |
Outputs a documentation section that lists the available groups and the
commands they contain
|
void |
ManUsageHelper.outputHelpSection(TroffPrinter printer,
HelpSection section) |
Outputs a help section
|
protected void |
ManUsageHelper.outputHint(TroffPrinter printer,
HelpHint hint) |
|
protected void |
ManUsageHelper.outputOptionRestriction(TroffPrinter printer,
OptionMetadata option,
OptionRestriction restriction,
HelpHint hint) |
Outputs documentation about a restriction on an option
|
protected <T> void |
ManCommandUsageGenerator.outputOptions(TroffPrinter printer,
CommandMetadata command,
java.util.List<OptionMetadata> options,
ParserMetadata<T> parserConfig) |
Outputs a documentation section detailing the options and their usages
|
int |
ManUsageHelper.outputOptions(TroffPrinter printer,
java.util.List<OptionMetadata> options,
boolean endList) |
|
void |
ManUsageHelper.outputOptionsSynopsis(TroffPrinter printer,
java.util.List<OptionMetadata> options) |
|
void |
ManUsageHelper.outputOptionSynopsis(TroffPrinter printer,
OptionMetadata option) |
|
void |
ManUsageHelper.outputOptionTitle(TroffPrinter printer,
OptionMetadata option) |
|
protected void |
ManMultiPageGlobalUsageGenerator.outputReferenceToSuite(TroffPrinter printer,
GlobalMetadata<T> global) |
|
protected java.util.List<OptionMetadata> |
ManCommandUsageGenerator.outputSynopsis(TroffPrinter printer,
java.lang.String programName,
java.lang.String[] groupNames,
java.lang.String commandName,
CommandMetadata command) |
Outputs a synopsis section for the documentation showing how to use a
command
|
protected void |
ManGlobalUsageGenerator.outputSynopsis(TroffPrinter printer,
GlobalMetadata<T> global) |
Outputs a documentation section with a synopsis of how to use the CLI
|
protected void |
ManCommandUsageGenerator.outputTitle(TroffPrinter printer,
java.lang.String programName,
java.lang.String[] groupNames,
java.lang.String commandName,
CommandMetadata command) |
Outputs a title section for the document
|
protected void |
ManGlobalUsageGenerator.outputTitle(GlobalMetadata<T> global,
TroffPrinter printer) |
Outputs the title section for the documentation
|