Class ManUsageHelper
java.lang.Object
com.github.rvesse.airline.help.common.AbstractUsageGenerator
com.github.rvesse.airline.help.man.ManUsageHelper
-
Field Summary
Fields inherited from class com.github.rvesse.airline.help.common.AbstractUsageGenerator
DEFAULT_COLUMNS
-
Constructor Summary
ConstructorsConstructorDescriptionManUsageHelper
(Comparator<? super OptionMetadata> optionComparator, boolean includeHidden) -
Method Summary
Modifier and TypeMethodDescription<T> void
outputArguments
(TroffPrinter printer, ArgumentsMetadata arguments, boolean startList, ParserMetadata<T> parserConfig) protected void
outputArgumentsRestriction
(TroffPrinter printer, ArgumentsMetadata arguments, ArgumentsRestriction restriction, HelpHint hint) Outputs documentation about a restriction on an optionvoid
outputArgumentsSynopsis
(TroffPrinter printer, ArgumentsMetadata arguments) void
outputArgumentsTitle
(TroffPrinter printer, ArgumentsMetadata arguments) void
outputHelpSection
(TroffPrinter printer, HelpSection section) Outputs a help sectionprotected void
outputHint
(TroffPrinter printer, HelpHint hint) protected void
outputOptionRestriction
(TroffPrinter printer, OptionMetadata option, OptionRestriction restriction, HelpHint hint) Outputs documentation about a restriction on an optionint
outputOptions
(TroffPrinter printer, List<OptionMetadata> options, boolean endList) void
outputOptionsSynopsis
(TroffPrinter printer, List<OptionMetadata> options) void
outputOptionSynopsis
(TroffPrinter printer, OptionMetadata option) void
outputOptionTitle
(TroffPrinter printer, OptionMetadata option) Methods inherited from class com.github.rvesse.airline.help.common.AbstractUsageGenerator
getCommandComparator, getOptionComparator, htmlize, includeHidden, sortArgumentsRestrictions, sortCommands, sortOptionRestrictions, sortOptions, toDefaultCommand, toDescription, toDescription, toSynopsisUsage, toUsage, toUsage
-
Constructor Details
-
ManUsageHelper
-
-
Method Details
-
outputOptions
public int outputOptions(TroffPrinter printer, List<OptionMetadata> options, boolean endList) throws IOException - Throws:
IOException
-
outputArguments
public <T> void outputArguments(TroffPrinter printer, ArgumentsMetadata arguments, boolean startList, ParserMetadata<T> parserConfig) throws IOException - Throws:
IOException
-
outputOptionRestriction
protected void outputOptionRestriction(TroffPrinter printer, OptionMetadata option, OptionRestriction restriction, HelpHint hint) throws IOException Outputs documentation about a restriction on an option- Parameters:
printer
- Troff printeroption
- Option meta-datarestriction
- Restrictionhint
- Help hint- Throws:
IOException
- Thrown if there is a problem generating usage output
-
outputArgumentsRestriction
protected void outputArgumentsRestriction(TroffPrinter printer, ArgumentsMetadata arguments, ArgumentsRestriction restriction, HelpHint hint) throws IOException Outputs documentation about a restriction on an option- Parameters:
printer
- Troff Printerarguments
- Arguments meta-datarestriction
- Restrictionhint
- Help hint- Throws:
IOException
- Thrown if there is a problem generating usage output
-
outputHelpSection
Outputs a help section- Parameters:
printer
- Troff printersection
- Help section- Throws:
IOException
- Thrown if there is a problem generating usage output
-
outputHint
-
outputOptionsSynopsis
-
outputOptionSynopsis
-
outputArgumentsSynopsis
-
outputOptionTitle
-
outputArgumentsTitle
-