diff options
author | ClementTsang <cjhtsang@uwaterloo.ca> | 2020-04-02 21:23:11 -0400 |
---|---|---|
committer | ClementTsang <cjhtsang@uwaterloo.ca> | 2020-04-03 00:50:56 -0400 |
commit | 572d665a8a73fc21f4815c71d22f42a05581d23c (patch) | |
tree | 92b79dae1fd24948d078a3202e22a8fc143d89a3 /sample_configs | |
parent | ebceed123dbd1ab3e588cc157282e324d048bd3b (diff) |
(docs): Update README to be a bit nicer
Diffstat (limited to 'sample_configs')
-rw-r--r-- | sample_configs/bottom.toml | 92 | ||||
-rw-r--r-- | sample_configs/default_config.toml | 143 | ||||
-rw-r--r-- | sample_configs/demo_config.toml | 13 |
3 files changed, 146 insertions, 102 deletions
diff --git a/sample_configs/bottom.toml b/sample_configs/bottom.toml deleted file mode 100644 index 1dd183af..00000000 --- a/sample_configs/bottom.toml +++ /dev/null @@ -1,92 +0,0 @@ -# This is a default config file for bottom. All of the settings are commented -# out by default; if you wish to change them uncomment and modify as you see -# fit. - -# This group of options represents a command-line flag/option. Flags explicitly -# added when running (ie: btm -a) will override this config file if an option -# is also set here. -[flags] - -#avg_cpu = true -#dot_marker = false -#rate = 1000 -#left_legend = false -#current_usage = false -#group_processes = false -#case_sensitive = false -#whole_word = true -#regex = true -#show_disabled_data = true - -# Defaults to Celsius. Temperature is one of: -#temperature_type = "k" -#temperature_type = "f" -#temperature_type = "c" -#temperature_type = "kelvin" -#temperature_type = "fahrenheit" -#temperature_type = "celsius" - -# Defaults to processes. Default widget is one of: -#default_widget = "cpu_default" -#default_widget = "memory_default" -#default_widget = "disk_default" -#default_widget = "temperature_default" -#default_widget = "network_default" -#default_widget = "process_default" - -# Basic mode -#basic = true - - -# These are all the components that support custom theming. Currently, it only -# supports taking in a string representing a hex colour. Note that colour support -# will, at the end of the day, depend on terminal support - for example, the -# macOS default Terminal does NOT like custom colours and it will glitch out. -# -# The default options here are based on gruvbox: https://github.com/morhetz/gruvbox -[colors] - -# Represents the colour of table headers (processes, CPU, disks, temperature). -#table_header_color="#458588" - -# Represents the colour of the label each widget has. -#widget_title_color="#cc241d" - -# Represents the average CPU color -#avg_cpu_color="#d3869b" - -# Represents the colour the core will use in the CPU legend and graph. -#cpu_core_colors=["#cc241d", "#98971a"] - -# Represents the colour RAM will use in the memory legend and graph. -#ram_color="#fb4934" - -# Represents the colour SWAP will use in the memory legend and graph. -#swap_color="#fabd2f" - -# Represents the colour rx will use in the network legend and graph. -#rx_color="#458588" - -# Represents the colour tx will use in the network legend and graph. -#tx_color="#689d6a" - -# Represents the colour of the border of unselected widgets. -#border_color="#ebdbb2" - -# Represents the colour of the border of selected widgets. -#highlighted_border_color="#fe8019" - -# Represents the colour of most text. -#text_color="#ebdbb2" - -# Represents the colour of text that is selected. -#selected_text_color="#282828" - -# Represents the background colour of text that is selected. -#selected_bg_color="#458588" - -# Represents the colour of the lines and text of the graph. -#graph_color="#ebdbb2" - -# Represents the cursor's colour. -#cursor_color="#458588"
\ No newline at end of file diff --git a/sample_configs/default_config.toml b/sample_configs/default_config.toml new file mode 100644 index 00000000..fb692df7 --- /dev/null +++ b/sample_configs/default_config.toml @@ -0,0 +1,143 @@ + +# This is a default config file for bottom. All of the settings are commented +# out by default; if you wish to change them uncomment and modify as you see +# fit. + +# This group of options represents a command-line flag/option. Flags explicitly +# added when running (ie: btm -a) will override this config file if an option +# is also set here. +[flags] + +# Whether to display an average cpu entry. +#avg_cpu = false + +# Whether to use dot markers rather than braille. +#dot_marker = false + +# The update rate of the application. +#rate = 1000 + +# Whether to put the CPU legend to the left. +#left_legend = false + +# Whether to set CPU% on a process to be based on the total CPU or just current usage. +#current_usage = false + +# Whether to group processes with the same name together by default. +#group_processes = false + +# Whether to make process searching case sensitive by default. +#case_sensitive = false + +# Whether to make process searching look for matching the entire word by default. +#whole_word = false + +# Whether to make process searching use regex by default. +#regex = false + +# Whether to show CPU entries in the legend when they are hidden. +#show_disabled_data = false + +# Defaults to Celsius. Temperature is one of: +#temperature_type = "k" +#temperature_type = "f" +#temperature_type = "c" +#temperature_type = "kelvin" +#temperature_type = "fahrenheit" +#temperature_type = "celsius" + +# The default time interval (in milliseconds). +#default_time_value = 60000 + +# The time delta on each zoom in/out action (in milliseconds). +#time_delta = 15000 + +# Override layout default widget +#default_widget_type = "proc" +#default_widget_count = 1 + +# Use basic mode +#basic = false + +########################################################## + +# These are all the components that support custom theming. Note that colour support +# will, at the end of the day, depend on terminal support - for example, the +# macOS default Terminal does NOT like custom colours and it will glitch out. +[colors] + +# Represents the colour of table headers (processes, CPU, disks, temperature). +#table_header_color="LightBlue" + +# Represents the colour of the label each widget has. +#widget_title_color="Gray" + +# Represents the average CPU color. +#avg_cpu_color="Red" + +# Represents the colour the core will use in the CPU legend and graph. +#cpu_core_colors=["LightMagenta", "LightYellow", "LightCyan", "LightGreen", "LightBlue", "LightRed", "Cyan", "Green", "Blue", "Red"] + +# Represents the colour RAM will use in the memory legend and graph. +#ram_color="LightMagenta" + +# Represents the colour SWAP will use in the memory legend and graph. +#swap_color="LightYellow" + +# Represents the colour rx will use in the network legend and graph. +#rx_color="LightCyan" + +# Represents the colour tx will use in the network legend and graph. +#tx_color="LightGreen" + +# Represents the colour of the border of unselected widgets. +#border_color="Gray" + +# Represents the colour of the border of selected widgets. +#highlighted_border_color="LightBlue" + +# Represents the colour of most text. +#text_color="Gray" + +# Represents the colour of text that is selected. +#selected_text_color="Black" + +# Represents the background colour of text that is selected. +#selected_bg_color="Cyan" + +# Represents the colour of the lines and text of the graph. +#graph_color="Gray" + +########################################################## + +# Layout - layouts follow a pattern like this: +# [[row]] represents a row in the application. +# [[row.child]] represents either a widget or a column. +# [[row.child.child]] represents a widget. +# +# All widgets must have the type value set to one of ["cpu", "mem", "proc", "net", "temp", "disk", "empty"]. +# All layout components have a ratio value - if this is not set, then it defaults to 1. + +# The default widget layout: +#[[row]] +# ratio=30 +# [[row.child]] +# type="cpu" +#[[row]] +# ratio=40 +# [[row.child]] +# ratio=4 +# type="mem" +# [[row.child]] +# ratio=3 +# [[row.child.child]] +# type="temp" +# [[row.child.child]] +# type="disk" +#[[row]] +# ratio=30 +# [[row.child]] +# type="net" +# [[row.child]] +# type="proc" +# default=true diff --git a/sample_configs/demo_config.toml b/sample_configs/demo_config.toml index 36b63728..fa3ce588 100644 --- a/sample_configs/demo_config.toml +++ b/sample_configs/demo_config.toml @@ -12,18 +12,11 @@ left_legend = false current_usage = false group_processes = false case_sensitive = false -whole_word = true +whole_word = false regex = true - -# Default widget is one of: -default_widget = "cpu_default" -#default_widget = "memory_default" -#default_widget = "disk_default" -#default_widget = "temperature_default" -#default_widget = "network_default" -#default_widget = "process_default" - show_disabled_data = true +default_widget_type = "cpu" +default_widget_count = 1 [colors] # Based on gruvbox: https://github.com/morhetz/gruvbox |