Module com.github.rvesse.airline.help.man

Package com.github.rvesse.airline.help.man

Class ManUsageHelper

java.lang.Object

com.github.rvesse.airline.help.common.AbstractUsageGenerator

com.github.rvesse.airline.help.man.ManUsageHelper

public class ManUsageHelper
extends AbstractUsageGenerator

Field Summary

Fields inherited from class com.github.rvesse.airline.help.common.AbstractUsageGenerator

DEFAULT_COLUMNS

Constructor Summary

Constructors

Constructor	Description
ManUsageHelper(java.util.Comparator<? super OptionMetadata> optionComparator, boolean includeHidden)

Method Summary

Modifier and Type	Method	Description
<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 option
void	outputArgumentsSynopsis(TroffPrinter printer, ArgumentsMetadata arguments)
void	outputArgumentsTitle(TroffPrinter printer, ArgumentsMetadata arguments)
void	outputHelpSection(TroffPrinter printer, HelpSection section)	Outputs a help section
protected void	outputHint(TroffPrinter printer, HelpHint hint)
protected void	outputOptionRestriction(TroffPrinter printer, OptionMetadata option, OptionRestriction restriction, HelpHint hint)	Outputs documentation about a restriction on an option
int	outputOptions(TroffPrinter printer, java.util.List<OptionMetadata> options, boolean endList)
void	outputOptionsSynopsis(TroffPrinter printer, java.util.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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ManUsageHelper

public ManUsageHelper(java.util.Comparator<? super OptionMetadata> optionComparator,
                      boolean includeHidden)

Method Detail

outputOptions

public int outputOptions(TroffPrinter printer,
                         java.util.List<OptionMetadata> options,
                         boolean endList)
                  throws java.io.IOException

Throws:

java.io.IOException

outputArguments

public <T> void outputArguments(TroffPrinter printer,
                                ArgumentsMetadata arguments,
                                boolean startList,
                                ParserMetadata<T> parserConfig)
                         throws java.io.IOException

Throws:

java.io.IOException

outputOptionRestriction

protected void outputOptionRestriction(TroffPrinter printer,
                                       OptionMetadata option,
                                       OptionRestriction restriction,
                                       HelpHint hint)
                                throws java.io.IOException

Outputs documentation about a restriction on an option

Parameters:

printer - Troff printer

option - Option meta-data

restriction - Restriction

hint - Help hint

Throws:

java.io.IOException - Thrown if there is a problem generating usage output

outputArgumentsRestriction

protected void outputArgumentsRestriction(TroffPrinter printer,
                                          ArgumentsMetadata arguments,
                                          ArgumentsRestriction restriction,
                                          HelpHint hint)
                                   throws java.io.IOException

Outputs documentation about a restriction on an option

Parameters:

printer - Troff Printer

arguments - Arguments meta-data

restriction - Restriction

hint - Help hint

Throws:

java.io.IOException - Thrown if there is a problem generating usage output

outputHelpSection

public void outputHelpSection(TroffPrinter printer,
                              HelpSection section)
                       throws java.io.IOException

Outputs a help section

Parameters:

printer - Troff printer

section - Help section

Throws:

java.io.IOException - Thrown if there is a problem generating usage output

outputHint

protected void outputHint(TroffPrinter printer,
                          HelpHint hint)

outputOptionsSynopsis

public void outputOptionsSynopsis(TroffPrinter printer,
                                  java.util.List<OptionMetadata> options)

outputOptionSynopsis

public void outputOptionSynopsis(TroffPrinter printer,
                                 OptionMetadata option)

outputArgumentsSynopsis

public void outputArgumentsSynopsis(TroffPrinter printer,
                                    ArgumentsMetadata arguments)

outputOptionTitle

public void outputOptionTitle(TroffPrinter printer,
                              OptionMetadata option)

outputArgumentsTitle

public void outputArgumentsTitle(TroffPrinter printer,
                                 ArgumentsMetadata arguments)