MirroredRepos/bat
1
0
Fork 0
mirror of https://github.com/sharkdp/bat.git synced 2025-01-31 10:11:07 +00:00
Code Issues Releases Wiki Activity

Simplify -h help text

Browse Source
This commit is contained in:
sharkdp 2018-10-07 10:43:39 +02:00
parent da09f3877b
commit f9fd5e4851
1 changed files with 36 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
src/clap_app.rs
View File

@ -17,12 +17,12 @@ pub fn build_app(interactive_output: bool) -> ClapApp<'static, 'static> {
.global_setting(clap_color_setting) .global_setting(clap_color_setting)
.global_setting(AppSettings::DeriveDisplayOrder) .global_setting(AppSettings::DeriveDisplayOrder)
.global_setting(AppSettings::UnifiedHelpMessage) .global_setting(AppSettings::UnifiedHelpMessage)
.global_setting(AppSettings::NextLineHelp) .global_setting(AppSettings::HidePossibleValuesInHelp)
.setting(AppSettings::InferSubcommands) .setting(AppSettings::InferSubcommands)
.setting(AppSettings::ArgsNegateSubcommands) .setting(AppSettings::ArgsNegateSubcommands)
.setting(AppSettings::DisableHelpSubcommand) .setting(AppSettings::DisableHelpSubcommand)
.setting(AppSettings::VersionlessSubcommands) .setting(AppSettings::VersionlessSubcommands)
.max_term_width(90) .max_term_width(100)
.about( .about(
"A cat(1) clone with wings.\n\n\ "A cat(1) clone with wings.\n\n\
Use '--help' instead of '-h' to see a more detailed version of the help text.", Use '--help' instead of '-h' to see a more detailed version of the help text.",
@ -87,14 +87,18 @@ pub fn build_app(interactive_output: bool) -> ClapApp<'static, 'static> {
.possible_values(&[ .possible_values(&[
"auto", "full", "plain", "changes", "header", "grid", "numbers", "auto", "full", "plain", "changes", "header", "grid", "numbers",
]) ])
.help("Comma-separated list of style elements to display.") .help(
"Comma-separated list of style elements to display \
(*auto*, full, plain, changes, header, grid, numbers).",
)
.long_help( .long_help(
"Configure which elements (line numbers, file headers, grid \ "Configure which elements (line numbers, file headers, grid \
borders, Git modifications, ..) to display in addition to the \ borders, Git modifications, ..) to display in addition to the \
file contents. The argument is a comma-separated list of \ file contents. The argument is a comma-separated list of \
components to display (e.g. 'numbers,changes,grid') or a \ components to display (e.g. 'numbers,changes,grid') or a \
pre-defined style ('full'). To set a default theme, export the \ pre-defined style ('full'). To set a default theme, export the \
BAT_STYLE environment variable (e.g.: export BAT_STYLE=\"numbers\").", BAT_STYLE environment variable (e.g.: export BAT_STYLE=\"numbers\"). \
Possible values: *auto*, full, plain, changes, header, grid, numbers.",
), ),
) )
.arg( .arg(
@ -144,11 +148,13 @@ pub fn build_app(interactive_output: bool) -> ClapApp<'static, 'static> {
.takes_value(true) .takes_value(true)
.value_name("when") .value_name("when")
.possible_values(&["auto", "never", "always"]) .possible_values(&["auto", "never", "always"])
.hide_default_value(true)
.default_value("auto") .default_value("auto")
.help("When to use colors.") .help("When to use colors (*auto*, never, always).")
.long_help( .long_help(
"Specify when to use colored output. The automatic mode \ "Specify when to use colored output. The automatic mode \
only enables colors if an interactive terminal is detected.", only enables colors if an interactive terminal is detected. \
Possible values: *auto*, never, always.",
), ),
) )
.arg( .arg(
@ -159,11 +165,12 @@ pub fn build_app(interactive_output: bool) -> ClapApp<'static, 'static> {
.value_name("when") .value_name("when")
.possible_values(&["auto", "never", "always"]) .possible_values(&["auto", "never", "always"])
.default_value("auto") .default_value("auto")
.help("When to show the decorations specified by '--style'.") .hide_default_value(true)
.help("When to show the decorations (*auto*, never, always).")
.long_help( .long_help(
"Specify when to use the decorations that have been specified \ "Specify when to use the decorations that have been specified \
via '--style'. The automatic mode only enables decorations if \ via '--style'. The automatic mode only enables decorations if \
an interactive terminal is detected.", an interactive terminal is detected. Possible values: *auto*, never, always.",
), ),
) )
.arg( .arg(
@ -174,13 +181,15 @@ pub fn build_app(interactive_output: bool) -> ClapApp<'static, 'static> {
.value_name("when") .value_name("when")
.possible_values(&["auto", "never", "always"]) .possible_values(&["auto", "never", "always"])
.default_value("auto") .default_value("auto")
.help("Specify when to use the pager.") .hide_default_value(true)
.help("Specify when to use the pager (*auto*, never, always).")
.long_help( .long_help(
"Specify when to use the pager. To control which pager \ "Specify when to use the pager. To control which pager \
is used, set the PAGER or BAT_PAGER environment \ is used, set the PAGER or BAT_PAGER environment \
variables (the latter takes precedence). The default \ variables (the latter takes precedence). The default \
pager is 'less'. To disable the pager permanently, set \ pager is 'less'. To disable the pager permanently, set \
BAT_PAGER to an empty string.", BAT_PAGER to an empty string. \
Possible values: *auto*, never, always.",
), ),
) )
.arg( .arg(
@ -191,24 +200,15 @@ pub fn build_app(interactive_output: bool) -> ClapApp<'static, 'static> {
.value_name("mode") .value_name("mode")
.possible_values(&["auto", "never", "character"]) .possible_values(&["auto", "never", "character"])
.default_value("auto") .default_value("auto")
.help("Specify the text-wrapping mode.") .hide_default_value(true)
.long_help("Specify the text-wrapping mode."), .help("Specify the text-wrapping mode (*auto*, never, character).")
) .long_help("Specify the text-wrapping mode (*auto*, never, character)."),
.arg(
Arg::with_name("unbuffered")
.short("u")
.hidden_short_help(true)
.long_help(
"This option exists for POSIX-compliance reasons ('u' is for \
'unbuffered'). The output is always unbuffered - this option \
is simply ignored.",
),
) )
.arg( .arg(
Arg::with_name("tabs") Arg::with_name("tabs")
.long("tabs") .long("tabs")
.takes_value(true) .takes_value(true)
.value_name("tabs") .value_name("T")
.validator( .validator(
|t| { |t| {
t.parse::<u32>() t.parse::<u32>()
@ -217,12 +217,23 @@ pub fn build_app(interactive_output: bool) -> ClapApp<'static, 'static> {
.map_err(|e| e.to_string()) .map_err(|e| e.to_string())
}, // Convert to Result<(), String> }, // Convert to Result<(), String>
) )
.help("Sets the tab width.") .help("Set the tab width to T spaces.")
.long_help( .long_help(
"Sets the tab width. Use a width of 0 to pass tabs through \ "Set the tab width to T spaces. Use a width of 0 to pass tabs through \
directly", directly",
), ),
) )
.arg(
Arg::with_name("unbuffered")
.short("u")
.long("unbuffered")
.hidden_short_help(true)
.long_help(
"This option exists for POSIX-compliance reasons ('u' is for \
'unbuffered'). The output is always unbuffered - this option \
is simply ignored.",
),
)
.arg( .arg(
Arg::with_name("terminal-width") Arg::with_name("terminal-width")
.long("terminal-width") .long("terminal-width")