## Uses of Class
picocli.CommandLine.Model.UsageMessageSpec

- Packages that use CommandLine.Model.UsageMessageSpec
  Package | Description
  --- | ---
  picocli | Provides classes and interfaces for the main picocli command line parsing and `autocompletion` functionality.

- - ### Uses of CommandLine.Model.UsageMessageSpec in picocli

    Methods in picocli that return CommandLine.Model.UsageMessageSpec
    Modifier and Type | Method and Description
    --- | ---
    `CommandLine.Model.UsageMessageSpec` | CommandLine.Model.UsageMessageSpec.`abbreviateSynopsis(boolean newValue)` Sets whether the synopsis line(s) should show an abbreviated synopsis without detailed option names.
    `CommandLine.Model.UsageMessageSpec` | CommandLine.Model.UsageMessageSpec.`commandListHeading(String newValue)` Sets the optional heading preceding the subcommand list.
    `CommandLine.Model.UsageMessageSpec` | CommandLine.Model.UsageMessageSpec.`customSynopsis(String... customSynopsis)` Sets the optional custom synopsis lines to use instead of the auto-generated synopsis.
    `CommandLine.Model.UsageMessageSpec` | CommandLine.Model.UsageMessageSpec.`description(String... description)` Sets the optional text lines to use as the description of the help message, displayed between the synopsis and the options list.
    `CommandLine.Model.UsageMessageSpec` | CommandLine.Model.UsageMessageSpec.`descriptionHeading(String newValue)` Sets the heading preceding the description section.
    `CommandLine.Model.UsageMessageSpec` | CommandLine.Model.UsageMessageSpec.`footer(String... footer)` Sets the optional footer text lines displayed at the bottom of the help message.
    `CommandLine.Model.UsageMessageSpec` | CommandLine.Model.UsageMessageSpec.`footerHeading(String newValue)` Sets the optional heading preceding the footer section.
    `CommandLine.Model.UsageMessageSpec` | CommandLine.Model.UsageMessageSpec.`header(String... header)` Sets the optional header lines displayed at the top of the help message.
    `CommandLine.Model.UsageMessageSpec` | CommandLine.Model.UsageMessageSpec.`headerHeading(String headerHeading)` Sets the heading preceding the header section.
    `CommandLine.Model.UsageMessageSpec` | CommandLine.Model.UsageMessageSpec.`helpFactory(CommandLine.IHelpFactory helpFactory)` Sets a new `IHelpFactory` to customize the usage help message.
    `CommandLine.Model.UsageMessageSpec` | CommandLine.Model.UsageMessageSpec.`hidden(boolean value)` Set the hidden flag on this command to control whether to show or hide it in the help usage text of the parent command.
    `CommandLine.Model.UsageMessageSpec` | CommandLine.Model.UsageMessageSpec.`messages(CommandLine.Model.Messages msgs)` Sets the Messages for this usageMessage specification, and returns this UsageMessageSpec.
    `CommandLine.Model.UsageMessageSpec` | CommandLine.Model.UsageMessageSpec.`optionListHeading(String newValue)` Sets the heading preceding the options list.
    `CommandLine.Model.UsageMessageSpec` | CommandLine.Model.UsageMessageSpec.`parameterListHeading(String newValue)` Sets the optional heading preceding the parameter list.
    `CommandLine.Model.UsageMessageSpec` | CommandLine.Model.UsageMessageSpec.`requiredOptionMarker(char newValue)` Sets the character used to prefix required options in the options list.
    `CommandLine.Model.UsageMessageSpec` | CommandLine.Model.UsageMessageSpec.`sectionKeys(List<String> keys)` Sets the section keys in the order that the usage help message should render the sections.
    `CommandLine.Model.UsageMessageSpec` | CommandLine.Model.UsageMessageSpec.`sectionMap(Map<String,CommandLine.IHelpSectionRenderer> map)` Sets the map of section keys and renderers used to construct the usage help message to a copy of the specified map.
    `CommandLine.Model.UsageMessageSpec` | CommandLine.Model.UsageMessageSpec.`showDefaultValues(boolean newValue)` Sets whether the options list in the usage help message should show default values for all non-boolean options.
    `CommandLine.Model.UsageMessageSpec` | CommandLine.Model.UsageMessageSpec.`sortOptions(boolean newValue)` Sets whether the options list in the usage help message should be sorted alphabetically.
    `CommandLine.Model.UsageMessageSpec` | CommandLine.Model.UsageMessageSpec.`synopsisHeading(String newValue)` Sets the optional heading preceding the synopsis.
    `CommandLine.Model.UsageMessageSpec` | CommandLine.Model.CommandSpec.`usageMessage()` Returns the usage help message specification for this command.
    `CommandLine.Model.UsageMessageSpec` | CommandLine.Model.UsageMessageSpec.`width(int newValue)` Sets the maximum usage help message width to the specified value.

    Methods in picocli with parameters of type CommandLine.Model.UsageMessageSpec
    Modifier and Type | Method and Description
    --- | ---
    `CommandLine.Model.CommandSpec` | CommandLine.Model.CommandSpec.`usageMessage(CommandLine.Model.UsageMessageSpec settings)` Initializes the usageMessage specification for this command from the specified settings and returns this commandSpec.

Copyright © 2019. All rights reserved.