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

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

Class ManCommandUsageGenerator

java.lang.Object

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

com.github.rvesse.airline.help.common.AbstractCommandUsageGenerator

com.github.rvesse.airline.help.man.ManCommandUsageGenerator

All Implemented Interfaces:

CommandUsageGenerator

public class ManCommandUsageGenerator
extends AbstractCommandUsageGenerator

A command usage generator which generates help in man page (Troff) format

Field Summary

Fields

Modifier and Type	Field	Description
private ManUsageHelper	helper
private int	manSection

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

DEFAULT_COLUMNS

Constructor Summary

Constructors

Constructor	Description
ManCommandUsageGenerator()
ManCommandUsageGenerator(int manSection, boolean includeHidden)	Creates a new man page usage generator

Method Summary

Modifier and Type	Method	Description
protected ManUsageHelper	createHelper(boolean includeHidden)
protected java.lang.String	getFullCommandName(java.lang.String programName, java.lang.String[] groupNames, java.lang.String commandName)	Gets the full command name in man page syntax
protected <T> void	outputOptions(TroffPrinter printer, CommandMetadata command, java.util.List<OptionMetadata> options, ParserMetadata<T> parserConfig)	Outputs a documentation section detailing the options and their usages
protected java.util.List<OptionMetadata>	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	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 java.lang.String	toDescription(OptionMetadata option)
<T> void	usage(java.lang.String programName, java.lang.String[] groupNames, java.lang.String commandName, CommandMetadata command, ParserMetadata<T> parserConfig, java.io.OutputStream output)	Generate the help and output it to the stream

Methods inherited from class com.github.rvesse.airline.help.common.AbstractCommandUsageGenerator

findHelpSections, sortExitCodes, usage, usage

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

getCommandComparator, getOptionComparator, htmlize, includeHidden, sortArgumentsRestrictions, sortCommands, sortOptionRestrictions, sortOptions, toDefaultCommand, toDescription, toSynopsisUsage, toUsage, toUsage

Methods inherited from class java.lang.Object

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

Field Detail

manSection

private final int manSection

helper

private final ManUsageHelper helper

Constructor Detail

ManCommandUsageGenerator

public ManCommandUsageGenerator()

ManCommandUsageGenerator

public ManCommandUsageGenerator(int manSection,
                                boolean includeHidden)

Creates a new man page usage generator

Parameters:

manSection - Man section to which this command belongs, use constants from ManSections

includeHidden - Whether to include hidden items in the help output

Method Detail

createHelper

protected ManUsageHelper createHelper(boolean includeHidden)

usage

public <T> void usage(java.lang.String programName,
                      java.lang.String[] groupNames,
                      java.lang.String commandName,
                      CommandMetadata command,
                      ParserMetadata<T> parserConfig,
                      java.io.OutputStream output)
               throws java.io.IOException

Description copied from interface: CommandUsageGenerator

Generate the help and output it to the stream

Type Parameters:

T - Command type

Parameters:

programName - Program Name

groupNames - Group Name(s)

commandName - Command Name

command - Command Metadata

parserConfig - Parser Configuration, if null is passed then the parser configuration is automatically determined based on the command class for which we are producing help

output - Stream to output to

Throws:

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

outputOptions

protected <T> void outputOptions(TroffPrinter printer,
                                 CommandMetadata command,
                                 java.util.List<OptionMetadata> options,
                                 ParserMetadata<T> parserConfig)
                          throws java.io.IOException

Outputs a documentation section detailing the options and their usages

Type Parameters:

T - Command type

Parameters:

printer - Troff Printer

command - Command

options - Option meta-data

parserConfig - Parser configuration

Throws:

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

outputSynopsis

protected java.util.List<OptionMetadata> outputSynopsis(TroffPrinter printer,
                                                        java.lang.String programName,
                                                        java.lang.String[] groupNames,
                                                        java.lang.String commandName,
                                                        CommandMetadata command)
                                                 throws java.io.IOException

Outputs a synopsis section for the documentation showing how to use a command

Parameters:

printer - Troff printer

programName - Program name

groupNames - Group name(s)

commandName - Command name

command - Command

Returns:

List of all the available options (global, group and command)

Throws:

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

outputTitle

protected void outputTitle(TroffPrinter printer,
                           java.lang.String programName,
                           java.lang.String[] groupNames,
                           java.lang.String commandName,
                           CommandMetadata command)
                    throws java.io.IOException

Outputs a title section for the document

Parameters:

printer - Troff Printer

programName - Program name

groupNames - Group name(s)

commandName - Command name

command - Command meta-data

Throws:

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

getFullCommandName

protected java.lang.String getFullCommandName(java.lang.String programName,
                                              java.lang.String[] groupNames,
                                              java.lang.String commandName)
                                       throws java.io.IOException

Gets the full command name in man page syntax

Parameters:

programName - Program name

groupNames - Group name(s)

commandName - Command name

Returns:

Full command name

Throws:

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

toDescription

protected java.lang.String toDescription(OptionMetadata option)

Overrides:

toDescription in class AbstractUsageGenerator