open class PlaintextHelpFormatter : HelpFormatter
PlaintextHelpFormatter(indent: String = " ", width: Int? = null, maxWidth: Int = 78, maxColWidth: Int? = null, usageTitle: String = "Usage:", optionsTitle: String = "Options:", argumentsTitle: String = "Arguments:", commandsTitle: String = "Commands:", optionsMetavar: String = "[OPTIONS]", commandMetavar: String = "COMMAND [ARGS]...", colSpacing: Int = 2) |
val argumentsTitle: String |
|
val colSpacing: Int |
|
val commandMetavar: String |
|
val commandsTitle: String |
|
val indent: String |
|
val maxColWidth: Int |
|
val optionsMetavar: String |
|
val optionsTitle: String |
|
val usageTitle: String |
|
val width: Int |
open fun StringBuilder.addArguments(parameters: List<ParameterHelp>): Unit |
|
open fun StringBuilder.addCommands(parameters: List<ParameterHelp>): Unit |
|
open fun StringBuilder.addEpilog(epilog: String): Unit |
|
open fun StringBuilder.addOptions(parameters: List<ParameterHelp>): Unit |
|
open fun StringBuilder.addProlog(prolog: String): Unit |
|
open fun StringBuilder.addUsage(parameters: List<ParameterHelp>, programName: String): Unit |
|
fun StringBuilder.appendDefinitionList(rows: List<Pair<String, String>>): Unit |
|
open fun formatHelp(prolog: String, epilog: String, parameters: List<ParameterHelp>, programName: String): String
Create the full help string. |
|
open fun formatUsage(parameters: List<ParameterHelp>, programName: String): String
Create the one-line usage information for a command. |
|
open fun joinOptionNames(names: Set<String>): String |
|
open fun optionMetavar(option: Option): String |