Index (Airline - Help - Man Page (Troff) 3.0.0 API)

C F G H M O S T U
All Classes All Packages

C

C_LIBRARY_FUNCTIONS - Static variable in class com.github.rvesse.airline.help.man.ManSections: C Library Functions
com.github.rvesse.airline.help.man - module com.github.rvesse.airline.help.man: Copyright (C) 2010-16 the original author or authors.
com.github.rvesse.airline.help.man - package com.github.rvesse.airline.help.man
commandUsageGenerator - Variable in class com.github.rvesse.airline.help.man.ManGlobalUsageGenerator
createCommandFile(GlobalMetadata<T>, String[], CommandMetadata) - Method in class com.github.rvesse.airline.help.man.ManMultiPageGlobalUsageGenerator
createHelper(boolean) - Method in class com.github.rvesse.airline.help.man.ManCommandUsageGenerator
createHelper(boolean) - Method in class com.github.rvesse.airline.help.man.ManGlobalUsageGenerator

F

FILE_FORMATS - Static variable in class com.github.rvesse.airline.help.man.ManSections: File formats

G

GAMES_AND_SCREENSAVERS - Static variable in class com.github.rvesse.airline.help.man.ManSections: Games and Screensavers
GENERAL_COMMANDS - Static variable in class com.github.rvesse.airline.help.man.ManSections: General Commands
getCommandName(GlobalMetadata<T>, String[], CommandMetadata) - Method in class com.github.rvesse.airline.help.man.ManGlobalUsageGenerator: Gets the display name for a command
getFullCommandName(String, String[], String) - Method in class com.github.rvesse.airline.help.man.ManCommandUsageGenerator: Gets the full command name in man page syntax

H

helper - Variable in class com.github.rvesse.airline.help.man.ManGlobalUsageGenerator

M

ManCommandUsageGenerator - Class in com.github.rvesse.airline.help.man: A command usage generator which generates help in man page (Troff) format
ManCommandUsageGenerator() - Constructor for class com.github.rvesse.airline.help.man.ManCommandUsageGenerator
ManCommandUsageGenerator(int, boolean) - Constructor for class com.github.rvesse.airline.help.man.ManCommandUsageGenerator: Creates a new man page usage generator
ManGlobalUsageGenerator<T> - Class in com.github.rvesse.airline.help.man: A global usage generator which generates Man pages in Troff format
ManGlobalUsageGenerator() - Constructor for class com.github.rvesse.airline.help.man.ManGlobalUsageGenerator
ManGlobalUsageGenerator(int) - Constructor for class com.github.rvesse.airline.help.man.ManGlobalUsageGenerator
ManGlobalUsageGenerator(int, boolean) - Constructor for class com.github.rvesse.airline.help.man.ManGlobalUsageGenerator
ManGlobalUsageGenerator(int, boolean, CommandUsageGenerator) - Constructor for class com.github.rvesse.airline.help.man.ManGlobalUsageGenerator
ManMultiPageGlobalUsageGenerator<T> - Class in com.github.rvesse.airline.help.man
ManMultiPageGlobalUsageGenerator() - Constructor for class com.github.rvesse.airline.help.man.ManMultiPageGlobalUsageGenerator
ManMultiPageGlobalUsageGenerator(int) - Constructor for class com.github.rvesse.airline.help.man.ManMultiPageGlobalUsageGenerator
ManMultiPageGlobalUsageGenerator(int, boolean) - Constructor for class com.github.rvesse.airline.help.man.ManMultiPageGlobalUsageGenerator
ManMultiPageGlobalUsageGenerator(int, boolean, CommandUsageGenerator, File) - Constructor for class com.github.rvesse.airline.help.man.ManMultiPageGlobalUsageGenerator
ManMultiPageGlobalUsageGenerator(int, boolean, File) - Constructor for class com.github.rvesse.airline.help.man.ManMultiPageGlobalUsageGenerator
manSection - Variable in class com.github.rvesse.airline.help.man.ManGlobalUsageGenerator
ManSections - Class in com.github.rvesse.airline.help.man: Standard man page section numbers
ManSections() - Constructor for class com.github.rvesse.airline.help.man.ManSections
ManUsageHelper - Class in com.github.rvesse.airline.help.man
ManUsageHelper(Comparator<? super OptionMetadata>, boolean) - Constructor for class com.github.rvesse.airline.help.man.ManUsageHelper
MISCELLANEOUS - Static variable in class com.github.rvesse.airline.help.man.ManSections: Miscellaneous

O

outputArguments(TroffPrinter, ArgumentsMetadata, boolean, ParserMetadata<T>) - Method in class com.github.rvesse.airline.help.man.ManUsageHelper
outputArgumentsRestriction(TroffPrinter, ArgumentsMetadata, ArgumentsRestriction, HelpHint) - Method in class com.github.rvesse.airline.help.man.ManUsageHelper: Outputs documentation about a restriction on an option
outputArgumentsSynopsis(TroffPrinter, ArgumentsMetadata) - Method in class com.github.rvesse.airline.help.man.ManUsageHelper
outputArgumentsTitle(TroffPrinter, ArgumentsMetadata) - Method in class com.github.rvesse.airline.help.man.ManUsageHelper
outputCommandList(TroffPrinter, GlobalMetadata<T>) - Method in class com.github.rvesse.airline.help.man.ManGlobalUsageGenerator: Outputs a documentation section that lists the available commands
outputCommandUsages(OutputStream, TroffPrinter, GlobalMetadata<T>) - Method in class com.github.rvesse.airline.help.man.ManGlobalUsageGenerator: Outputs the command usages for all groups
outputCommandUsages(OutputStream, TroffPrinter, GlobalMetadata<T>) - Method in class com.github.rvesse.airline.help.man.ManMultiPageGlobalUsageGenerator
outputDefaultGroupCommandUsages(OutputStream, TroffPrinter, GlobalMetadata<T>) - Method in class com.github.rvesse.airline.help.man.ManGlobalUsageGenerator: Outputs the command usages for the commands in the default group
outputDefaultGroupCommandUsages(OutputStream, TroffPrinter, GlobalMetadata<T>) - Method in class com.github.rvesse.airline.help.man.ManMultiPageGlobalUsageGenerator
outputGroupCommandsList(TroffPrinter, GlobalMetadata<T>, List<CommandGroupMetadata>) - Method in class com.github.rvesse.airline.help.man.ManGlobalUsageGenerator
outputGroupCommandUsages(OutputStream, TroffPrinter, GlobalMetadata<T>, List<CommandGroupMetadata>) - Method in class com.github.rvesse.airline.help.man.ManGlobalUsageGenerator: Outputs the command usages for the commands in the given group
outputGroupCommandUsages(OutputStream, TroffPrinter, GlobalMetadata<T>, List<CommandGroupMetadata>) - Method in class com.github.rvesse.airline.help.man.ManMultiPageGlobalUsageGenerator
outputGroupList(TroffPrinter, GlobalMetadata<T>) - Method in class com.github.rvesse.airline.help.man.ManGlobalUsageGenerator: Outputs a documentation section that lists the available groups and the commands they contain
outputHelpSection(TroffPrinter, HelpSection) - Method in class com.github.rvesse.airline.help.man.ManUsageHelper: Outputs a help section
outputHint(TroffPrinter, HelpHint) - Method in class com.github.rvesse.airline.help.man.ManUsageHelper
outputOptionRestriction(TroffPrinter, OptionMetadata, OptionRestriction, HelpHint) - Method in class com.github.rvesse.airline.help.man.ManUsageHelper: Outputs documentation about a restriction on an option
outputOptions(TroffPrinter, CommandMetadata, List<OptionMetadata>, ParserMetadata<T>) - Method in class com.github.rvesse.airline.help.man.ManCommandUsageGenerator: Outputs a documentation section detailing the options and their usages
outputOptions(TroffPrinter, List<OptionMetadata>, boolean) - Method in class com.github.rvesse.airline.help.man.ManUsageHelper
outputOptionsSynopsis(TroffPrinter, List<OptionMetadata>) - Method in class com.github.rvesse.airline.help.man.ManUsageHelper
outputOptionSynopsis(TroffPrinter, OptionMetadata) - Method in class com.github.rvesse.airline.help.man.ManUsageHelper
outputOptionTitle(TroffPrinter, OptionMetadata) - Method in class com.github.rvesse.airline.help.man.ManUsageHelper
outputReferenceToSuite(TroffPrinter, GlobalMetadata<T>) - Method in class com.github.rvesse.airline.help.man.ManMultiPageGlobalUsageGenerator
outputSynopsis(TroffPrinter, GlobalMetadata<T>) - Method in class com.github.rvesse.airline.help.man.ManGlobalUsageGenerator: Outputs a documentation section with a synopsis of how to use the CLI
outputSynopsis(TroffPrinter, String, String[], String, CommandMetadata) - Method in class com.github.rvesse.airline.help.man.ManCommandUsageGenerator: Outputs a synopsis section for the documentation showing how to use a command
outputTitle(TroffPrinter, String, String[], String, CommandMetadata) - Method in class com.github.rvesse.airline.help.man.ManCommandUsageGenerator: Outputs a title section for the document
outputTitle(GlobalMetadata<T>, TroffPrinter) - Method in class com.github.rvesse.airline.help.man.ManGlobalUsageGenerator: Outputs the title section for the documentation

S

SPECIAL_FILES - Static variable in class com.github.rvesse.airline.help.man.ManSections: Special files
SYSTEM_ADMIN_AND_DAEMONS - Static variable in class com.github.rvesse.airline.help.man.ManSections: System administration and daemons
SYSTEM_CALLS - Static variable in class com.github.rvesse.airline.help.man.ManSections: System Calls

T

toDescription(OptionMetadata) - Method in class com.github.rvesse.airline.help.man.ManCommandUsageGenerator
toDescription(OptionMetadata) - Method in class com.github.rvesse.airline.help.man.ManGlobalUsageGenerator: Converts an option to its description form

U

usage(GlobalMetadata<T>, OutputStream) - Method in class com.github.rvesse.airline.help.man.ManGlobalUsageGenerator
usage(String, String[], String, CommandMetadata, ParserMetadata<T>, OutputStream) - Method in class com.github.rvesse.airline.help.man.ManCommandUsageGenerator

C F G H M O S T U
All Classes All Packages