Sets whether the synopsis line(s) should show an abbreviated synopsis without detailed option names.
Sets whether line breaks should take wide Chinese, Japanese and Korean characters into account, and returns this UsageMessageSpec.
CommandLine.Model.UsageMessageSpec.autoWidth(boolean detectTerminalSize)
Sets whether picocli should attempt to detect the terminal size and adjust the usage help message width
to take the full terminal width.
Sets the optional heading preceding the subcommand list.
Sets the optional custom synopsis lines to use instead of the auto-generated synopsis.
Sets the optional text lines to use as the description of the help message, displayed between the synopsis and the
options list.
Sets the heading preceding the description section.
Sets the values to be displayed in the exit codes section: keys are exit codes, values are descriptions.
Sets the optional heading preceding the exit codes section, may contain "%n"
line separators.
Sets the optional footer text lines displayed at the bottom of the help message.
Sets the optional heading preceding the footer section.
Sets the optional header lines displayed at the top of the help message.
Sets the heading preceding the header section.
Sets a new IHelpFactory
to customize the usage help message.
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.
Sets the maximum usage help long options column max width to the specified value.
Sets the Messages for this usageMessage specification, and returns this UsageMessageSpec.
Sets the heading preceding the options list.
Sets the optional heading preceding the parameter list.
Sets the character used to prefix required options in the options list.
Sets the section keys in the order that the usage help message should render the sections.
Sets the map of section keys and renderers used to construct the usage help message to a copy of the specified map.
Sets whether to show a [@<filename>...]
entry in the synopsis and parameter list of the usage help message.
Sets whether the options list in the usage help message should show default values for all non-boolean options.
Sets whether to show a [--]
(End of Options) entry in the synopsis and options list of the usage help message.
CommandLine.Model.UsageMessageSpec.sortOptions(boolean newValue)
Sets whether the options list in the usage help message should be sorted alphabetically.
CommandLine.Model.UsageMessageSpec.sortSynopsis(boolean newValue)
Sets whether the options in the synopsis should be sorted alphabetically.
Sets the fraction of the usage help
width()
that is the threshold up to which
the 2nd line and subsequent lines of a multi-line synopsis should be aligned to the end of the command name.
Sets the optional heading preceding the synopsis.
Sets the indentation to use on the 2nd line and subsequent lines of a multi-line synopsis
when the length of the synopsis heading and the fully qualified command name exceed the
synopsisAutoIndentThreshold()
fraction of the
width()
,
-1
by default.
Sets the String representing the subcommands in the synopsis.
Returns the usage help message specification for this command.
CommandLine.Model.UsageMessageSpec.width(int newValue)
Sets the maximum usage help message width to the specified value.