mirror of
https://github.com/ClementTsang/bottom.git
synced 2026-05-03 21:40:32 +00:00
Clement Tsang
457 lines
15 KiB
Rust
457 lines
15 KiB
Rust
use clap::*;
|
|
|
|
const TEMPLATE: &str = "\
|
|
{bin} {version}
|
|
{author}
|
|
|
|
{about}
|
|
|
|
USAGE:{usage}
|
|
|
|
FLAGS:
|
|
{unified}";
|
|
|
|
const USAGE: &str = "
|
|
btm [FLAG]";
|
|
|
|
pub fn get_matches() -> clap::ArgMatches<'static> {
|
|
build_app().get_matches()
|
|
}
|
|
|
|
// TODO: Refactor this a bit, it's quite messy atm
|
|
pub fn build_app() -> App<'static, 'static> {
|
|
// Temps
|
|
let kelvin = Arg::with_name("kelvin")
|
|
.short("k")
|
|
.long("kelvin")
|
|
.help("Sets the temperature type to Kelvin.")
|
|
.long_help(
|
|
"\
|
|
Sets the temperature type to Kelvin.\n\n",
|
|
);
|
|
let fahrenheit = Arg::with_name("fahrenheit")
|
|
.short("f")
|
|
.long("fahrenheit")
|
|
.help("Sets the temperature type to Fahrenheit.")
|
|
.long_help(
|
|
"\
|
|
Sets the temperature type to Fahrenheit.\n\n",
|
|
);
|
|
let celsius = Arg::with_name("celsius")
|
|
.short("c")
|
|
.long("celsius")
|
|
.help("Sets the temperature type to Celsius.")
|
|
.long_help(
|
|
"\
|
|
Sets the temperature type to Celsius. This is the default
|
|
option.\n\n",
|
|
);
|
|
|
|
// All flags. These are in alphabetical order
|
|
let autohide_time = Arg::with_name("autohide_time")
|
|
.long("autohide_time")
|
|
.help("Temporarily shows the time scale in graphs.")
|
|
.long_help(
|
|
"\
|
|
Automatically hides the time scale in graphs after being
|
|
shown for a brief moment when zoomed in/out. If time is
|
|
disabled via --hide_time then this will have no effect.\n\n\n",
|
|
);
|
|
let basic = Arg::with_name("basic")
|
|
.short("b")
|
|
.long("basic")
|
|
.help("Hides graphs and uses a more basic look.")
|
|
.long_help(
|
|
"\
|
|
Hides graphs and uses a more basic look. Design is largely
|
|
inspired by htop's.\n\n",
|
|
);
|
|
let battery = Arg::with_name("battery")
|
|
.long("battery")
|
|
.help("Shows the battery widget.")
|
|
.long_help(
|
|
"\
|
|
Shows the battery widget in default or basic mode. No effect on
|
|
custom layouts.\n\n",
|
|
);
|
|
let case_sensitive = Arg::with_name("case_sensitive")
|
|
.short("S")
|
|
.long("case_sensitive")
|
|
.help("Enables case sensitivity by default.")
|
|
.long_help(
|
|
"\
|
|
When searching for a process, enables case sensitivity by default.\n\n",
|
|
);
|
|
let current_usage = Arg::with_name("current_usage")
|
|
.short("u")
|
|
.long("current_usage")
|
|
.help("Sets process CPU% to be based on current CPU%.")
|
|
.long_help(
|
|
"\
|
|
Sets process CPU% usage to be based on the current system CPU% usage
|
|
rather than total CPU usage.\n\n",
|
|
);
|
|
// TODO: [DEBUG] Add a proper debugging solution.
|
|
// let debug = Arg::with_name("debug")
|
|
// .long("debug")
|
|
// .help("Enables debug logging.")
|
|
// .long_help(
|
|
// "\
|
|
// Enables debug logging. The program will print where it logged to after running.",
|
|
// );
|
|
// TODO: [DIAGNOSE] Add a diagnose option to help with debugging.
|
|
let disable_click = Arg::with_name("disable_click")
|
|
.long("disable_click")
|
|
.help("Disables mouse clicks.")
|
|
.long_help(
|
|
"\
|
|
Disables mouse clicks from interacting with the program.\n\n",
|
|
);
|
|
|
|
let dot_marker = Arg::with_name("dot_marker")
|
|
.short("m")
|
|
.long("dot_marker")
|
|
.help("Uses a dot marker for graphs.")
|
|
.long_help(
|
|
"\
|
|
Uses a dot marker for graphs as opposed to the default braille
|
|
marker.\n\n",
|
|
);
|
|
|
|
let group = Arg::with_name("group") // FIXME: Rename this to something like "group_process", would be "breaking" though.
|
|
.short("g")
|
|
.long("group")
|
|
.help("Groups processes with the same name by default.")
|
|
.long_help(
|
|
"\
|
|
Groups processes with the same name by default.\n\n",
|
|
);
|
|
|
|
let hide_avg_cpu = Arg::with_name("hide_avg_cpu")
|
|
.short("a")
|
|
.long("hide_avg_cpu")
|
|
.help("Hides the average CPU usage.")
|
|
.long_help(
|
|
"\
|
|
Hides the average CPU usage from being shown.\n\n",
|
|
);
|
|
|
|
let hide_table_gap = Arg::with_name("hide_table_gap")
|
|
.long("hide_table_gap")
|
|
.help("Hides the spacing between table headers and entries.")
|
|
.long_help(
|
|
"\
|
|
Hides the spacing between table headers and entries.\n\n",
|
|
);
|
|
|
|
let hide_time = Arg::with_name("hide_time")
|
|
.long("hide_time")
|
|
.help("Hides the time scale.")
|
|
.long_help(
|
|
"\
|
|
Completely hides the time scale from being shown.\n\n",
|
|
);
|
|
|
|
let process_command = Arg::with_name("process_command")
|
|
.long("process_command")
|
|
.help("Show processes as their commands by default.")
|
|
.long_help(
|
|
"\
|
|
Show processes as their commands by default in the process widget.
|
|
",
|
|
);
|
|
|
|
let left_legend = Arg::with_name("left_legend")
|
|
.short("l")
|
|
.long("left_legend")
|
|
.help("Puts the CPU chart legend to the left side.")
|
|
.long_help(
|
|
"\
|
|
Puts the CPU chart legend to the left side rather than the right side.\n\n",
|
|
);
|
|
|
|
// let no_write = Arg::with_name("no_write")
|
|
// .long("no_write")
|
|
// .help("Disables writing to the config file.")
|
|
// .long_help(
|
|
// "\
|
|
// Disables config changes in-app from writing to the config file.",
|
|
// );
|
|
|
|
let regex = Arg::with_name("regex")
|
|
.short("R")
|
|
.long("regex")
|
|
.help("Enables regex by default.")
|
|
.long_help(
|
|
"\
|
|
When searching for a process, enables regex by default.\n\n",
|
|
);
|
|
|
|
let disable_advanced_kill = Arg::with_name("disable_advanced_kill")
|
|
.long("disable_advanced_kill")
|
|
.help("Hides advanced options to stop a process on Unix-like systems.")
|
|
.long_help(
|
|
"\
|
|
Hides advanced options to stop a process on Unix-like systems. The only option shown is -15.\n\n",
|
|
);
|
|
|
|
let show_table_scroll_position = Arg::with_name("show_table_scroll_position")
|
|
.long("show_table_scroll_position")
|
|
.help("Shows the scroll position tracker in table widgets.")
|
|
.long_help(
|
|
"\
|
|
Shows the list scroll position tracker in the widget title for table widgets.\n\n",
|
|
);
|
|
|
|
let use_old_network_legend = Arg::with_name("use_old_network_legend")
|
|
.long("use_old_network_legend")
|
|
.help("DEPRECATED - uses the older network legend.")
|
|
.long_help(
|
|
"\
|
|
DEPRECATED - uses the older (pre-0.4) network widget legend.
|
|
This display is not tested anymore and could be broken.\n\n\n",
|
|
);
|
|
|
|
let whole_word = Arg::with_name("whole_word")
|
|
.short("W")
|
|
.long("whole_word")
|
|
.help("Enables whole-word matching by default.")
|
|
.long_help(
|
|
"\
|
|
When searching for a process, return results that match the
|
|
entire query by default.\n\n",
|
|
);
|
|
|
|
// All options. Again, alphabetical order.
|
|
let config_location = Arg::with_name("config_location")
|
|
.short("C")
|
|
.long("config")
|
|
.takes_value(true)
|
|
.value_name("CONFIG PATH")
|
|
.help("Sets the location of the config file.")
|
|
.long_help(
|
|
"\
|
|
Sets the location of the config file. Expects a config
|
|
file in the TOML format. If it doesn't exist, one is created.\n\n\n",
|
|
);
|
|
let color = Arg::with_name("color")
|
|
.long("color")
|
|
.takes_value(true)
|
|
.value_name("COLOR SCHEME")
|
|
.help("Use a color scheme, use --help for supported values.")
|
|
.long_help(
|
|
"\
|
|
Use a pre-defined color scheme. Currently supported values are:
|
|
|
|
+------------------------------------------------------------+
|
|
| default |
|
|
+------------------------------------------------------------+
|
|
| default-light (default but for use with light backgrounds) |
|
|
+------------------------------------------------------------+
|
|
| gruvbox (a bright theme with 'retro groove' colors) |
|
|
+------------------------------------------------------------+
|
|
| gruvbox-light (gruvbox but for use with light backgrounds) |
|
|
+------------------------------------------------------------+
|
|
| nord (an arctic, north-bluish color palette) |
|
|
+------------------------------------------------------------+
|
|
| nord-light (nord but for use with light backgrounds) |
|
|
+------------------------------------------------------------+
|
|
|
|
Defaults to \"default\".
|
|
\n\n",
|
|
)
|
|
.possible_values(&[
|
|
"default",
|
|
"default-light",
|
|
"gruvbox",
|
|
"gruvbox-light",
|
|
"nord",
|
|
"nord-light",
|
|
])
|
|
.hide_possible_values(true);
|
|
let mem_as_value = Arg::with_name("mem_as_value")
|
|
.long("mem_as_value")
|
|
.help("Defaults to showing process memory usage by value.")
|
|
.long_help(
|
|
"\
|
|
Defaults to showing process memory usage by value. Otherwise,
|
|
it defaults to showing it by percentage.\n\n",
|
|
);
|
|
let default_time_value = Arg::with_name("default_time_value")
|
|
.short("t")
|
|
.long("default_time_value")
|
|
.takes_value(true)
|
|
.value_name("MS")
|
|
.help("Default time value for graphs in ms.")
|
|
.long_help(
|
|
"\
|
|
Default time value for graphs in milliseconds. The minimum
|
|
time is 30s (30000), and the default is 60s (60000).\n\n\n",
|
|
);
|
|
let default_widget_count = Arg::with_name("default_widget_count")
|
|
.long("default_widget_count")
|
|
.takes_value(true)
|
|
.requires_all(&["default_widget_type"])
|
|
.value_name("INT")
|
|
.help("Sets the n'th selected widget type as the default.")
|
|
.long_help(
|
|
"\
|
|
Sets the n'th selected widget type to use as the default widget.
|
|
Requires 'default_widget_type' to also be set, and defaults to 1.
|
|
|
|
This reads from left to right, top to bottom. For example, suppose
|
|
we have a layout that looks like:
|
|
+-------------------+-----------------------+
|
|
| CPU (1) | CPU (2) |
|
|
+---------+---------+-------------+---------+
|
|
| Process | CPU (3) | Temperature | CPU (4) |
|
|
+---------+---------+-------------+---------+
|
|
|
|
And we set our default widget type to 'CPU'. If we set
|
|
'--default_widget_count 1', then it would use the CPU (1) as
|
|
the default widget. If we set '--default_widget_count 3', it would
|
|
use CPU (3) as the default instead.
|
|
\n\n",
|
|
);
|
|
let default_widget_type = Arg::with_name("default_widget_type")
|
|
.long("default_widget_type")
|
|
.takes_value(true)
|
|
.value_name("WIDGET TYPE")
|
|
.help("Sets the default widget type, use --help for more info.")
|
|
.long_help(
|
|
"\
|
|
Sets which widget type to use as the default widget.
|
|
For the default layout, this defaults to the 'process' widget.
|
|
For a custom layout, it defaults to the first widget it sees.
|
|
|
|
For example, suppose we have a layout that looks like:
|
|
+-------------------+-----------------------+
|
|
| CPU (1) | CPU (2) |
|
|
+---------+---------+-------------+---------+
|
|
| Process | CPU (3) | Temperature | CPU (4) |
|
|
+---------+---------+-------------+---------+
|
|
|
|
Setting '--default_widget_type Temp' will make the Temperature
|
|
widget selected by default.
|
|
|
|
Supported widget names:
|
|
+--------------------------+
|
|
| cpu |
|
|
+--------------------------+
|
|
| mem, memory |
|
|
+--------------------------+
|
|
| net, network |
|
|
+--------------------------+
|
|
| proc, process, processes |
|
|
+--------------------------+
|
|
| temp, temperature |
|
|
+--------------------------+
|
|
| disk |
|
|
+--------------------------+
|
|
| batt, battery |
|
|
+--------------------------+
|
|
\n\n",
|
|
);
|
|
let rate = Arg::with_name("rate")
|
|
.short("r")
|
|
.long("rate")
|
|
.takes_value(true)
|
|
.value_name("MS")
|
|
.help("Sets a refresh rate in ms.")
|
|
.long_help(
|
|
"\
|
|
Sets a refresh rate in milliseconds. The minimum is 250ms,
|
|
and defaults to 1000ms. Smaller values may take more resources.\n\n\n",
|
|
);
|
|
let time_delta = Arg::with_name("time_delta")
|
|
.short("d")
|
|
.long("time_delta")
|
|
.takes_value(true)
|
|
.value_name("MS")
|
|
.help("The amount in ms changed upon zooming.")
|
|
.long_help(
|
|
"\
|
|
The amount of time in milliseconds changed when zooming in/out.
|
|
The minimum is 1s (1000), and defaults to 15s (15000).\n\n\n",
|
|
);
|
|
|
|
let tree = Arg::with_name("tree")
|
|
.short("T")
|
|
.long("tree")
|
|
.help("Defaults to showing the process widget in tree mode.")
|
|
.long_help(
|
|
"\
|
|
Defaults to showing the process widget in tree mode.\n\n",
|
|
);
|
|
|
|
let network_use_bytes = Arg::with_name("network_use_bytes")
|
|
.long("network_use_bytes")
|
|
.help("Displays the network widget using bytes.")
|
|
.long_help(
|
|
"\
|
|
Displays the network widget using bytes. Defaults to bits.\n\n",
|
|
);
|
|
|
|
let network_use_log = Arg::with_name("network_use_log")
|
|
.long("network_use_log")
|
|
.help("Displays the network widget with a log scale.")
|
|
.long_help(
|
|
"\
|
|
Displays the network widget with a log scale. Defaults to a non-log scale.\n\n",
|
|
);
|
|
|
|
let network_use_binary_prefix = Arg::with_name("network_use_binary_prefix")
|
|
.long("network_use_binary_prefix")
|
|
.help("Displays the network widget with binary prefixes.")
|
|
.long_help(
|
|
"\
|
|
Displays the network widget with binary prefixes (i.e. kibibits, mebibits) rather than a decimal prefix (i.e. kilobits, megabits). Defaults to decimal prefixes.\n\n\n",
|
|
);
|
|
|
|
App::new(crate_name!())
|
|
.setting(AppSettings::UnifiedHelpMessage)
|
|
.version(crate_version!())
|
|
.author(crate_authors!())
|
|
.about(crate_description!())
|
|
.template(TEMPLATE)
|
|
.usage(USAGE)
|
|
.help_message("Prints help information. Use --help for more info.")
|
|
.version_message("Prints version information.")
|
|
.arg(kelvin)
|
|
.arg(fahrenheit)
|
|
.arg(celsius)
|
|
.group(ArgGroup::with_name("TEMPERATURE_TYPE").args(&["kelvin", "fahrenheit", "celsius"]))
|
|
.arg(autohide_time)
|
|
.arg(basic)
|
|
.arg(battery)
|
|
.arg(case_sensitive)
|
|
.arg(process_command)
|
|
.arg(config_location)
|
|
.arg(color)
|
|
// .arg(debug)
|
|
.arg(mem_as_value)
|
|
.arg(default_time_value)
|
|
.arg(default_widget_count)
|
|
.arg(default_widget_type)
|
|
.arg(disable_click)
|
|
.arg(dot_marker)
|
|
.arg(group)
|
|
.arg(hide_avg_cpu)
|
|
.arg(hide_table_gap)
|
|
.arg(hide_time)
|
|
.arg(show_table_scroll_position)
|
|
.arg(left_legend)
|
|
.arg(disable_advanced_kill)
|
|
// .arg(no_write)
|
|
.arg(rate)
|
|
.arg(regex)
|
|
.arg(time_delta)
|
|
.arg(tree)
|
|
.arg(network_use_bytes)
|
|
.arg(network_use_log)
|
|
.arg(network_use_binary_prefix)
|
|
.arg(current_usage)
|
|
.arg(use_old_network_legend)
|
|
.arg(whole_word)
|
|
}
|