Deployed 4d507d1 to nightly with MkDocs 1.3.0 and mike 1.1.2

8 files changed, 109 insertions, 28 deletions

diff --git a/nightly/assets/screenshots/troubleshooting/cmd_prompt_font.webp b/nightly/assets/screenshots/troubleshooting/cmd_prompt_font.webp
new file mode 100644
index 00000000..6cffdccd
--- /dev/null
+++ b/nightly/assets/screenshots/troubleshooting/cmd_prompt_font.webp
diff --git a/nightly/assets/screenshots/troubleshooting/cmd_prompt_props.webp b/nightly/assets/screenshots/troubleshooting/cmd_prompt_props.webp
new file mode 100644
index 00000000..445d0749
--- /dev/null
+++ b/nightly/assets/screenshots/troubleshooting/cmd_prompt_props.webp
diff --git a/nightly/assets/screenshots/troubleshooting/regedit_fonts.webp b/nightly/assets/screenshots/troubleshooting/regedit_fonts.webp
new file mode 100644
index 00000000..e3e6322e
--- /dev/null
+++ b/nightly/assets/screenshots/troubleshooting/regedit_fonts.webp
diff --git a/nightly/search/search_index.json b/nightly/search/search_index.json
index fe198fa2..77cc275f 100644
--- a/nightly/search/search_index.json
+++ b/nightly/search/search_index.json
@@ -1 +1 @@
-{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"bottom This site serves as extended documentation for bottom alongside the README.md . Warning Some areas of this site are still in progress and may be missing details. Feel free to suggest/contribute changes! Installation Tip It is a good idea to first check out the Support page to see if your system is officially supported! Tip If you're facing some issues during/after installation, check out the Troubleshooting page for some common problems and solutions. To install bottom, refer to the installation section of the README.md , which contains a list of all the installation methods. Contribution New contributors are always welcome! See the contribution section for how to contribute to bottom, whether it be filing issues, writing documentation, creating pull requests, etc.","title":"Home"},{"location":"#bottom","text":"This site serves as extended documentation for bottom alongside the README.md . Warning Some areas of this site are still in progress and may be missing details. Feel free to suggest/contribute changes!","title":"bottom"},{"location":"#installation","text":"Tip It is a good idea to first check out the Support page to see if your system is officially supported! Tip If you're facing some issues during/after installation, check out the Troubleshooting page for some common problems and solutions. To install bottom, refer to the installation section of the README.md , which contains a list of all the installation methods.","title":"Installation"},{"location":"#contribution","text":"New contributors are always welcome! See the contribution section for how to contribute to bottom, whether it be filing issues, writing documentation, creating pull requests, etc.","title":"Contribution"},{"location":"troubleshooting/","text":"Troubleshooting The graph points look broken/strange It's possible that your graphs won't look great out of the box due to the reliance on braille fonts. One example of this is seeing a bunch of missing font characters, caused when the terminal isn't configured properly to render braille fonts. Powershell shown missing braille fonts Another example is when braille is rendered as a block of dots, with the non-coloured dots also appearing. This may look strange for some users, and it is also caused by misconfiguration or missing fonts. Braille fonts rendering as a block of dots In either case, you may need to install a specific font and configure your terminal to use it. For example, installing UBraille and ensuring your terminal uses it should work. Another alternative is to use the --dot_marker option to render graph charts using dots instead of the braille characters, which generally seems better supported out of the box, at the expense of looking less intricate: Example using btm --dot_marker Why can't I see all my processes/process usage on macOS? You may have to run the program with elevated privileges - for example: sudo btm Please note that you should be certain that you trust any software you grant root privileges. There are measures taken to try to maximize the amount of information obtained without elevated privileges, but there may still be some limitations. My configuration file isn't working If your configuration files aren't working, here are a few things to try: Check the formatting It may be handy to refer to the automatically generated config files or the sample configuration files . The config files also follow the TOML format. Also make sure your config options are under the right table - for example, to set your temperature type, you must set it under the [flags] table: [flags] temperature_type = \"f\" Meanwhile, if you want to set a custom color scheme, it would be under the [colors] table: [colors] table_header_color = \"LightBlue\" Check the configuration file location Make sure bottom is reading the right configuration file. By default, bottom looks for config files at these locations: OS Default Config Location macOS $HOME/Library/Application Support/bottom/bottom.toml ~/.config/bottom/bottom.toml $XDG_CONFIG_HOME/bottom/bottom.toml Linux ~/.config/bottom/bottom.toml $XDG_CONFIG_HOME/bottom/bottom.toml Windows C:\\Users\\<USER>\\AppData\\Roaming\\bottom\\bottom.toml If you want to use a config file in another location, use the --config or -C flags along with the path to the configuration file, like so: btm -C path_to_config My installation through snap has some widgets that are blank/show no data Make sure bottom is given the correct permissions. Snapcraft explains how to do so.","title":"Troubleshooting"},{"location":"troubleshooting/#troubleshooting","text":"","title":"Troubleshooting"},{"location":"troubleshooting/#the-graph-points-look-brokenstrange","text":"It's possible that your graphs won't look great out of the box due to the reliance on braille fonts. One example of this is seeing a bunch of missing font characters, caused when the terminal isn't configured properly to render braille fonts. Powershell shown missing braille fonts Another example is when braille is rendered as a block of dots, with the non-coloured dots also appearing. This may look strange for some users, and it is also caused by misconfiguration or missing fonts. Braille fonts rendering as a block of dots In either case, you may need to install a specific font and configure your terminal to use it. For example, installing UBraille and ensuring your terminal uses it should work. Another alternative is to use the --dot_marker option to render graph charts using dots instead of the braille characters, which generally seems better supported out of the box, at the expense of looking less intricate: Example using btm --dot_marker","title":"The graph points look broken/strange"},{"location":"troubleshooting/#why-cant-i-see-all-my-processesprocess-usage-on-macos","text":"You may have to run the program with elevated privileges - for example: sudo btm Please note that you should be certain that you trust any software you grant root privileges. There are measures taken to try to maximize the amount of information obtained without elevated privileges, but there may still be some limitations.","title":"Why can't I see all my processes/process usage on macOS?"},{"location":"troubleshooting/#my-configuration-file-isnt-working","text":"If your configuration files aren't working, here are a few things to try:","title":"My configuration file isn't working"},{"location":"troubleshooting/#check-the-formatting","text":"It may be handy to refer to the automatically generated config files or the sample configuration files . The config files also follow the TOML format. Also make sure your config options are under the right table - for example, to set your temperature type, you must set it under the [flags] table: [flags] temperature_type = \"f\" Meanwhile, if you want to set a custom color scheme, it would be under the [colors] table: [colors] table_header_color = \"LightBlue\"","title":"Check the formatting"},{"location":"troubleshooting/#check-the-configuration-file-location","text":"Make sure bottom is reading the right configuration file. By default, bottom looks for config files at these locations: OS Default Config Location macOS $HOME/Library/Application Support/bottom/bottom.toml ~/.config/bottom/bottom.toml $XDG_CONFIG_HOME/bottom/bottom.toml Linux ~/.config/bottom/bottom.toml $XDG_CONFIG_HOME/bottom/bottom.toml Windows C:\\Users\\<USER>\\AppData\\Roaming\\bottom\\bottom.toml If you want to use a config file in another location, use the --config or -C flags along with the path to the configuration file, like so: btm -C path_to_config","title":"Check the configuration file location"},{"location":"troubleshooting/#my-installation-through-snap-has-some-widgets-that-are-blankshow-no-data","text":"Make sure bottom is given the correct permissions. Snapcraft explains how to do so.","title":"My installation through snap has some widgets that are blank/show no data"},{"location":"configuration/command-line-flags/","text":"Command-line Flags Warning This section is in progress, and is just copied from the old documentation. The following flags can be provided to bottom in the command line to change the behaviour of the program (run btm --help for more information on each flag): Flag Behaviour --autohide_time Temporarily shows the time scale in graphs. -b, --basic Hides graphs and uses a more basic look. --battery Shows the battery widget. -S, --case_sensitive Enables case sensitivity by default. -c, --celsius Sets the temperature type to Celsius. --color <COLOR SCHEME> Use a color scheme, use --help for supported values. -C, --config <CONFIG PATH> Sets the location of the config file. -u, --current_usage Sets process CPU% to be based on current CPU%. -t, --default_time_value <MS> Default time value for graphs in ms. --default_widget_count <INT> Sets the n'th selected widget type as the default. --default_widget_type <WIDGET TYPE> Sets the default widget type, use --help for more info. --disable_advanced_kill Hides advanced options to stop a process on Unix-like systems. --disable_click Disables mouse clicks. -m, --dot_marker Uses a dot marker for graphs. -f, --fahrenheit Sets the temperature type to Fahrenheit. -g, --group Groups processes with the same name by default. -h, --help Prints help information. Use --help for more info. -a, --hide_avg_cpu Hides the average CPU usage. --hide_table_gap Hides the spacing between table headers and entries. --hide_time Hides the time scale. -k, --kelvin Sets the temperature type to Kelvin. -l, --left_legend Puts the CPU chart legend to the left side. --mem_as_value Defaults to showing process memory usage by value. --network_use_binary_prefix Displays the network widget with binary prefixes. --network_use_bytes Displays the network widget using bytes. --network_use_log Displays the network widget with a log scale. --process_command Show processes as their commands by default. -r, --rate <MS> Sets a refresh rate in ms. -R, --regex Enables regex by default. --show_table_scroll_position Shows the scroll position tracker in table widgets. -d, --time_delta <MS> The amount in ms changed upon zooming. -T, --tree Defaults to showing the process widget in tree mode. --use_old_network_legend DEPRECATED - uses the older network legend. -V, --version Prints version information. -W, --whole_word Enables whole-word matching by default.","title":"Command-line Flags"},{"location":"configuration/command-line-flags/#command-line-flags","text":"Warning This section is in progress, and is just copied from the old documentation. The following flags can be provided to bottom in the command line to change the behaviour of the program (run btm --help for more information on each flag): Flag Behaviour --autohide_time Temporarily shows the time scale in graphs. -b, --basic Hides graphs and uses a more basic look. --battery Shows the battery widget. -S, --case_sensitive Enables case sensitivity by default. -c, --celsius Sets the temperature type to Celsius. --color <COLOR SCHEME> Use a color scheme, use --help for supported values. -C, --config <CONFIG PATH> Sets the location of the config file. -u, --current_usage Sets process CPU% to be based on current CPU%. -t, --default_time_value <MS> Default time value for graphs in ms. --default_widget_count <INT> Sets the n'th selected widget type as the default. --default_widget_type <WIDGET TYPE> Sets the default widget type, use --help for more info. --disable_advanced_kill Hides advanced options to stop a process on Unix-like systems. --disable_click Disables mouse clicks. -m, --dot_marker Uses a dot marker for graphs. -f, --fahrenheit Sets the temperature type to Fahrenheit. -g, --group Groups processes with the same name by default. -h, --help Prints help information. Use --help for more info. -a, --hide_avg_cpu Hides the average CPU usage. --hide_table_gap Hides the spacing between table headers and entries. --hide_time Hides the time scale. -k, --kelvin Sets the temperature type to Kelvin. -l, --left_legend Puts the CPU chart legend to the left side. --mem_as_value Defaults to showing process memory usage by value. --network_use_binary_prefix Displays the network widget with binary prefixes. --network_use_bytes Displays the network widget using bytes. --network_use_log Displays the network widget with a log scale. --process_command Show processes as their commands by default. -r, --rate <MS> Sets a refresh rate in ms. -R, --regex Enables regex by default. --show_table_scroll_position Shows the scroll position tracker in table widgets. -d, --time_delta <MS> The amount in ms changed upon zooming. -T, --tree Defaults to showing the process widget in tree mode. --use_old_network_legend DEPRECATED - uses the older network legend. -V, --version Prints version information. -W, --whole_word Enables whole-word matching by default.","title":"Command-line Flags"},{"location":"configuration/config-file/data-filtering/","text":"Data Filtering Warning This section is in progress, and is just copied from the old documentation. You can hide specific disks, temperature sensors, and networks by name in the config file via disk_filter and mount_filter , temp_filter , and net_filter respectively. Regex ( regex = true ), case-sensitivity ( case_sensitive = true ), and matching only if the entire word matches ( whole_word = true ) are supported, but are off by default. Filters default to denying entries that match and can be toggled by setting is_list_ignored to false in the config file. For example, here's the disk widget with no filter: The following in the config file would filter out some entries by disk name: [disk_filter] is_list_ignored = true list = [ \"/dev/sda\" ] regex = true case_sensitive = false whole_word = false If there are two potentially conflicting filters (i.e. when you are using both a disk and mount filter), the filter that explicitly allows an entry takes precedence over a filter that explicitly denies one. So for example, let's say we set a disk filter accepting anything with /dev/sda , but deny anything with /mnt/.* or / . So to do so, we write in the config file: [disk_filter] is_list_ignored = false list = [ \"/dev/sda\" ] regex = true case_sensitive = false whole_word = false [mount_filter] is_list_ignored = true list = [ \"/mnt/.*\" , \"/\" ] regex = true case_sensitive = false whole_word = true This gives us:","title":"Data Filtering"},{"location":"configuration/config-file/data-filtering/#data-filtering","text":"Warning This section is in progress, and is just copied from the old documentation. You can hide specific disks, temperature sensors, and networks by name in the config file via disk_filter and mount_filter , temp_filter , and net_filter respectively. Regex ( regex = true ), case-sensitivity ( case_sensitive = true ), and matching only if the entire word matches ( whole_word = true ) are supported, but are off by default. Filters default to denying entries that match and can be toggled by setting is_list_ignored to false in the config file. For example, here's the disk widget with no filter: The following in the config file would filter out some entries by disk name: [disk_filter] is_list_ignored = true list = [ \"/dev/sda\" ] regex = true case_sensitive = false whole_word = false If there are two potentially conflicting filters (i.e. when you are using both a disk and mount filter), the filter that explicitly allows an entry takes precedence over a filter that explicitly denies one. So for example, let's say we set a disk filter accepting anything with /dev/sda , but deny anything with /mnt/.* or / . So to do so, we write in the config file: [disk_filter] is_list_ignored = false list = [ \"/dev/sda\" ] regex = true case_sensitive = false whole_word = false [mount_filter] is_list_ignored = true list = [ \"/mnt/.*\" , \"/\" ] regex = true case_sensitive = false whole_word = true This gives us:","title":"Data Filtering"},{"location":"configuration/config-file/default-config/","text":"Default Config A default config file is automatically generated at the following locations that bottom checks by default: OS Default Config Location macOS $HOME/Library/Application Support/bottom/bottom.toml ~/.config/bottom/bottom.toml $XDG_CONFIG_HOME/bottom/bottom.toml Linux ~/.config/bottom/bottom.toml $XDG_CONFIG_HOME/bottom/bottom.toml Windows C:\\Users\\<USER>\\AppData\\Roaming\\bottom\\bottom.toml Furthermore, if a custom config path that does not exist is given (using -C or --config ), bottom will attempt to create a default config file at that location.","title":"Default Config"},{"location":"configuration/config-file/default-config/#default-config","text":"A default config file is automatically generated at the following locations that bottom checks by default: OS Default Config Location macOS $HOME/Library/Application Support/bottom/bottom.toml ~/.config/bottom/bottom.toml $XDG_CONFIG_HOME/bottom/bottom.toml Linux ~/.config/bottom/bottom.toml $XDG_CONFIG_HOME/bottom/bottom.toml Windows C:\\Users\\<USER>\\AppData\\Roaming\\bottom\\bottom.toml Furthermore, if a custom config path that does not exist is given (using -C or --config ), bottom will attempt to create a default config file at that location.","title":"Default Config"},{"location":"configuration/config-file/flags/","text":"Flags Warning This section is in progress, and is just copied from the old documentation. Most of the command line flags have config file equivalents to avoid having to type them out each time: Field Type Functionality hide_avg_cpu Boolean Hides the average CPU usage. dot_marker Boolean Uses a dot marker for graphs. left_legend Boolean Puts the CPU chart legend to the left side. current_usage Boolean Sets process CPU% to be based on current CPU%. group_processes Boolean Groups processes with the same name by default. case_sensitive Boolean Enables case sensitivity by default. whole_word Boolean Enables whole-word matching by default. regex Boolean Enables regex by default. basic Boolean Hides graphs and uses a more basic look. use_old_network_legend Boolean DEPRECATED - uses the older network legend. battery Boolean Shows the battery widget. rate Unsigned Int (represents milliseconds) Sets a refresh rate in ms. default_time_value Unsigned Int (represents milliseconds) Default time value for graphs in ms. time_delta Unsigned Int (represents milliseconds) The amount in ms changed upon zooming. hide_time Boolean Hides the time scale. temperature_type String (one of [\"k\", \"f\", \"c\", \"kelvin\", \"fahrenheit\", \"celsius\"]) Sets the temperature unit type. default_widget_type String (one of [\"cpu\", \"proc\", \"net\", \"temp\", \"mem\", \"disk\"], same as layout options) Sets the default widget type, use --help for more info. default_widget_count Unsigned Int (represents which default_widget_type ) Sets the n'th selected widget type as the default. disable_click Boolean Disables mouse clicks. color String (one of [\"default\", \"default-light\", \"gruvbox\", \"gruvbox-light\", \"nord\", \"nord-light\"]) Use a color scheme, use --help for supported values. mem_as_value Boolean Defaults to showing process memory usage by value. tree Boolean Defaults to showing the process widget in tree mode. show_table_scroll_position Boolean Shows the scroll position tracker in table widgets. process_command Boolean Show processes as their commands by default. disable_advanced_kill Boolean Hides advanced options to stop a process on Unix-like systems. network_use_binary_prefix Boolean Displays the network widget with binary prefixes. network_use_bytes Boolean Displays the network widget using bytes. network_use_log Boolean Displays the network widget with a log scale.","title":"Flags"},{"location":"configuration/config-file/flags/#flags","text":"Warning This section is in progress, and is just copied from the old documentation. Most of the command line flags have config file equivalents to avoid having to type them out each time: Field Type Functionality hide_avg_cpu Boolean Hides the average CPU usage. dot_marker Boolean Uses a dot marker for graphs. left_legend Boolean Puts the CPU chart legend to the left side. current_usage Boolean Sets process CPU% to be based on current CPU%. group_processes Boolean Groups processes with the same name by default. case_sensitive Boolean Enables case sensitivity by default. whole_word Boolean Enables whole-word matching by default. regex Boolean Enables regex by default. basic Boolean Hides graphs and uses a more basic look. use_old_network_legend Boolean DEPRECATED - uses the older network legend. battery Boolean Shows the battery widget. rate Unsigned Int (represents milliseconds) Sets a refresh rate in ms. default_time_value Unsigned Int (represents milliseconds) Default time value for graphs in ms. time_delta Unsigned Int (represents milliseconds) The amount in ms changed upon zooming. hide_time Boolean Hides the time scale. temperature_type String (one of [\"k\", \"f\", \"c\", \"kelvin\", \"fahrenheit\", \"celsius\"]) Sets the temperature unit type. default_widget_type String (one of [\"cpu\", \"proc\", \"net\", \"temp\", \"mem\", \"disk\"], same as layout options) Sets the default widget type, use --help for more info. default_widget_count Unsigned Int (represents which default_widget_type ) Sets the n'th selected widget type as the default. disable_click Boolean Disables mouse clicks. color String (one of [\"default\", \"default-light\", \"gruvbox\", \"gruvbox-light\", \"nord\", \"nord-light\"]) Use a color scheme, use --help for supported values. mem_as_value Boolean Defaults to showing process memory usage by value. tree Boolean Defaults to showing the process widget in tree mode. show_table_scroll_position Boolean Shows the scroll position tracker in table widgets. process_command Boolean Show processes as their commands by default. disable_advanced_kill Boolean Hides advanced options to stop a process on Unix-like systems. network_use_binary_prefix Boolean Displays the network widget with binary prefixes. network_use_bytes Boolean Displays the network widget using bytes. network_use_log Boolean Displays the network widget with a log scale.","title":"Flags"},{"location":"configuration/config-file/layout/","text":"Layout Warning This section is in progress, and is just copied from the old documentation. bottom supports customizable layouts via the config file. Currently, layouts are controlled by using TOML objects and arrays. For example, given the sample layout: [[row]] [[row.child]] type = \"cpu\" [[row]] ratio = 2 [[row.child]] ratio = 4 type = \"mem\" [[row.child]] ratio = 3 [[row.child.child]] type = \"temp\" [[row.child.child]] type = \"disk\" This would give a layout that has two rows, with a 1:2 ratio. The first row has only the CPU widget. The second row is split into two columns with a 4:3 ratio. The first column contains the memory widget. The second column is split into two rows with a 1:1 ratio. The first is the temperature widget, the second is the disk widget. This is what the layout would look like when run: Each [[row]] represents a row in the layout. A row can have any number of child values. Each [[row.child]] represents either a column or a widget . A column can have any number of child values as well. Each [[row.child.child]] represents a widget . A widget is represented by having a type field set to a string. The following type values are supported: \"cpu\" CPU chart and legend \"mem\", \"memory\" Memory chart \"net\", \"network\" Network chart and legend \"proc\", \"process\", \"processes\" Process table and search \"temp\", \"temperature\" Temperature table \"disk\" Disk table \"empty\" An empty space \"batt\", \"battery\" Battery statistics Each component of the layout accepts a ratio value. If this is not set, it defaults to 1. Furthermore, you can have duplicate widgets. For an example, look at the default config , which contains the default layout.","title":"Layout"},{"location":"configuration/config-file/layout/#layout","text":"Warning This section is in progress, and is just copied from the old documentation. bottom supports customizable layouts via the config file. Currently, layouts are controlled by using TOML objects and arrays. For example, given the sample layout: [[row]] [[row.child]] type = \"cpu\" [[row]] ratio = 2 [[row.child]] ratio = 4 type = \"mem\" [[row.child]] ratio = 3 [[row.child.child]] type = \"temp\" [[row.child.child]] type = \"disk\" This would give a layout that has two rows, with a 1:2 ratio. The first row has only the CPU widget. The second row is split into two columns with a 4:3 ratio. The first column contains the memory widget. The second column is split into two rows with a 1:1 ratio. The first is the temperature widget, the second is the disk widget. This is what the layout would look like when run: Each [[row]] represents a row in the layout. A row can have any number of child values. Each [[row.child]] represents either a column or a widget . A column can have any number of child values as well. Each [[row.child.child]] represents a widget . A widget is represented by having a type field set to a string. The following type values are supported: \"cpu\" CPU chart and legend \"mem\", \"memory\" Memory chart \"net\", \"network\" Network chart and legend \"proc\", \"process\", \"processes\" Process table and search \"temp\", \"temperature\" Temperature table \"disk\" Disk table \"empty\" An empty space \"batt\", \"battery\" Battery statistics Each component of the layout accepts a ratio value. If this is not set, it defaults to 1. Furthermore, you can have duplicate widgets. For an example, look at the default config , which contains the default layout.","title":"Layout"},{"location":"configuration/config-file/theming/","text":"Theming Warning This section is in progress, and is just copied from the old documentation. The config file can be used to set custom colours for parts of the application under the [colors] object. The following labels are customizable with strings that are hex colours, RGB colours, or specific named colours. Supported named colours are one of the following strings: Reset, Black, Red, Green, Yellow, Blue, Magenta, Cyan, Gray, DarkGray, LightRed, LightGreen, LightYellow, LightBlue, LightMagenta, LightCyan, White . Labels Details Example Table header colours Colour of table headers table_header_color=\"255, 255, 255\" CPU colour per core Colour of each core. Read in order. cpu_core_colors=[\"#ffffff\", \"white\", \"255, 255, 255\"] Average CPU colour The average CPU color avg_cpu_color=\"White\" All CPUs colour The colour for the \"All\" CPU label all_cpu_color=\"White\" RAM The colour RAM will use ram_color=\"#ffffff\" SWAP The colour SWAP will use swap_color=\"#ffffff\" RX The colour rx will use rx_color=\"#ffffff\" TX The colour tx will use tx_color=\"#ffffff\" Widget title colour The colour of the label each widget has widget_title_color=\"#ffffff\" Border colour The colour of the border of unselected widgets border_color=\"#ffffff\" Selected border colour The colour of the border of selected widgets highlighted_border_color=\"#ffffff\" Text colour The colour of most text text_color=\"#ffffff\" Graph colour The colour of the lines and text of the graph graph_color=\"#ffffff\" Cursor colour The cursor's colour cursor_color=\"#ffffff\" Selected text colour The colour of text that is selected scroll_entry_text_color=\"#ffffff\" Selected text background colour The background colour of text that is selected scroll_entry_bg_color=\"#ffffff\" High battery level colour The colour used for a high battery level (100% to 50%) high_battery_color=\"green\" Medium battery level colour The colour used for a medium battery level (50% to 10%) medium_battery_color=\"yellow\" Low battery level colour The colour used for a low battery level (10% to 0%) low_battery_color=\"red\"","title":"Theming"},{"location":"configuration/config-file/theming/#theming","text":"Warning This section is in progress, and is just copied from the old documentation. The config file can be used to set custom colours for parts of the application under the [colors] object. The following labels are customizable with strings that are hex colours, RGB colours, or specific named colours. Supported named colours are one of the following strings: Reset, Black, Red, Green, Yellow, Blue, Magenta, Cyan, Gray, DarkGray, LightRed, LightGreen, LightYellow, LightBlue, LightMagenta, LightCyan, White . Labels Details Example Table header colours Colour of table headers table_header_color=\"255, 255, 255\" CPU colour per core Colour of each core. Read in order. cpu_core_colors=[\"#ffffff\", \"white\", \"255, 255, 255\"] Average CPU colour The average CPU color avg_cpu_color=\"White\" All CPUs colour The colour for the \"All\" CPU label all_cpu_color=\"White\" RAM The colour RAM will use ram_color=\"#ffffff\" SWAP The colour SWAP will use swap_color=\"#ffffff\" RX The colour rx will use rx_color=\"#ffffff\" TX The colour tx will use tx_color=\"#ffffff\" Widget title colour The colour of the label each widget has widget_title_color=\"#ffffff\" Border colour The colour of the border of unselected widgets border_color=\"#ffffff\" Selected border colour The colour of the border of selected widgets highlighted_border_color=\"#ffffff\" Text colour The colour of most text text_color=\"#ffffff\" Graph colour The colour of the lines and text of the graph graph_color=\"#ffffff\" Cursor colour The cursor's colour cursor_color=\"#ffffff\" Selected text colour The colour of text that is selected scroll_entry_text_color=\"#ffffff\" Selected text background colour The background colour of text that is selected scroll_entry_bg_color=\"#ffffff\" High battery level colour The colour used for a high battery level (100% to 50%) high_battery_color=\"green\" Medium battery level colour The colour used for a medium battery level (50% to 10%) medium_battery_color=\"yellow\" Low battery level colour The colour used for a low battery level (10% to 0%) low_battery_color=\"red\"","title":"Theming"},{"location":"contribution/development/","text":"Development Warning This section is currently WIP. Dev Environment Logging Testing","title":"Development"},{"location":"contribution/development/#development","text":"Warning This section is currently WIP.","title":"Development"},{"location":"contribution/development/#dev-environment","text":"","title":"Dev Environment"},{"location":"contribution/development/#logging","text":"","title":"Logging"},{"location":"contribution/development/#testing","text":"","title":"Testing"},{"location":"contribution/documentation/","text":"Documentation When should documentation changes be done? Whenever a new feature is added, a bug is fixed, or a breaking change is made, it should be documented where appropriate (ex: README.md , changelog, etc.) New methods of installation are always appreciated and should be documented What pages need documentation? There are a few areas where documentation changes are often needed: The extended documentation (AKA here) The README.md The help menu inside of the application (located here ) The CHANGELOG.md How should I add documentation? Fork the repository first and make changes there. Where you're adding documentation will probably affect what you need to do: For changes to README.md and CHANGELOG.md , just follow the formatting provided and use any editor. For changes to the help menu, try to refer to the existing code within src/constants.rs on how the help menu is generated. For changes to the extended documentation, you'll want MkDocs , Material for MkDocs , and mdx_truly_sane_lists installed to provide live reloading and preview for your changes. You can do so through pip or your system's package managers. While you don't need these, it'll probably help in making and validating changes. You may also want Mike , but it isn't really needed. Once you have your documentation changes done, submit it as a pull request. For more information regarding that, refer to Issues, Pull Requests, and Discussions .","title":"Documentation"},{"location":"contribution/documentation/#documentation","text":"","title":"Documentation"},{"location":"contribution/documentation/#when-should-documentation-changes-be-done","text":"Whenever a new feature is added, a bug is fixed, or a breaking change is made, it should be documented where appropriate (ex: README.md , changelog, etc.) New methods of installation are always appreciated and should be documented","title":"When should documentation changes be done?"},{"location":"contribution/documentation/#what-pages-need-documentation","text":"There are a few areas where documentation changes are often needed: The extended documentation (AKA here) The README.md The help menu inside of the application (located here ) The CHANGELOG.md","title":"What pages need documentation?"},{"location":"contribution/documentation/#how-should-i-add-documentation","text":"Fork the repository first and make changes there. Where you're adding documentation will probably affect what you need to do: For changes to README.md and CHANGELOG.md , just follow the formatting provided and use any editor. For changes to the help menu, try to refer to the existing code within src/constants.rs on how the help menu is generated. For changes to the extended documentation, you'll want MkDocs , Material for MkDocs , and mdx_truly_sane_lists installed to provide live reloading and preview for your changes. You can do so through pip or your system's package managers. While you don't need these, it'll probably help in making and validating changes. You may also want Mike , but it isn't really needed. Once you have your documentation changes done, submit it as a pull request. For more information regarding that, refer to Issues, Pull Requests, and Discussions .","title":"How should I add documentation?"},{"location":"contribution/issues-and-pull-requests/","text":"Issues, Pull Requests, and Discussions Contribution in any way is appreciated, whether it is reporting problems, fixing bugs, implementing features, improving the documentation, etc. Discussions Discussions are open in the repo . As for the difference between discussions and issues: Open an issue if what you have enough information to properly fill out any details needed for a report or request. Open a discussion otherwise (e.g. asking a question). Opening an issue Bug reports When filing a bug report, please use the bug report template and fill in as much as you can. It is incredibly difficult for a maintainer to fix a bug when it cannot be reproduced, and giving as much detail as possible generally helps to make it easier to reproduce the problem! Feature requests Please use the feature request template and fill it out. Remember to give details about what the feature is along with why you think this suggestion will be useful. Also please check whether or not an existing issue has covered your specific feature request! Pull requests The expected workflow for a pull request is: Fork the project. Make your changes. Make any documentation changes if necessary - if you add a new feature, it'll probably need documentation changes. See here for tips on documentation. Commit and create a pull request to merge into the master branch. Please follow the pull request template . Wait for the tests to pass. These consist of clippy lints, rustfmt checks, and basic tests. If you are a first time contributor, you may need to skip this step for now, as GitHub Actions requires approval to run. Ask a maintainer to review your pull request. If changes are suggested or any comments are made, they should probably be addressed. Once it looks good, it'll be merged!","title":"Issues, Pull Requests, and Discussions"},{"location":"contribution/issues-and-pull-requests/#issues-pull-requests-and-discussions","text":"Contribution in any way is appreciated, whether it is reporting problems, fixing bugs, implementing features, improving the documentation, etc.","title":"Issues, Pull Requests, and Discussions"},{"location":"contribution/issues-and-pull-requests/#discussions","text":"Discussions are open in the repo . As for the difference between discussions and issues: Open an issue if what you have enough information to properly fill out any details needed for a report or request. Open a discussion otherwise (e.g. asking a question).","title":"Discussions"},{"location":"contribution/issues-and-pull-requests/#opening-an-issue","text":"","title":"Opening an issue"},{"location":"contribution/issues-and-pull-requests/#bug-reports","text":"When filing a bug report, please use the bug report template and fill in as much as you can. It is incredibly difficult for a maintainer to fix a bug when it cannot be reproduced, and giving as much detail as possible generally helps to make it easier to reproduce the problem!","title":"Bug reports"},{"location":"contribution/issues-and-pull-requests/#feature-requests","text":"Please use the feature request template and fill it out. Remember to give details about what the feature is along with why you think this suggestion will be useful. Also please check whether or not an existing issue has covered your specific feature request!","title":"Feature requests"},{"location":"contribution/issues-and-pull-requests/#pull-requests","text":"The expected workflow for a pull request is: Fork the project. Make your changes. Make any documentation changes if necessary - if you add a new feature, it'll probably need documentation changes. See here for tips on documentation. Commit and create a pull request to merge into the master branch. Please follow the pull request template . Wait for the tests to pass. These consist of clippy lints, rustfmt checks, and basic tests. If you are a first time contributor, you may need to skip this step for now, as GitHub Actions requires approval to run. Ask a maintainer to review your pull request. If changes are suggested or any comments are made, they should probably be addressed. Once it looks good, it'll be merged!","title":"Pull requests"},{"location":"contribution/packaging-and-distribution/","text":"Packaging and Distribution Package maintainers are always welcome and appreciated! Here's some info on how one can help with package distribution and bottom. Pre-built binaries The latest stable release can be found here , where you can find pre-built binaries in either a tar.gz or zip format. Binaries here also include automatically generated shell completion files for zsh, bash, fish, and Powershell, which you may want to also install during the packaging process. You can also find a nightly build in the releases page , built every day at 00:00 UTC off of the master branch. Building manually If you want to manually build bottom rather than distributing a pre-built binary, you'll need the most recent version of stable Rust, which you can get with: rustup update stable You'll then want to build with: cargo build --release --locked Completion files are automatically generated during this process, and are located in the directory target/release/build/bottom-<gibberish>/out . Note there may be multiple folders that look like target/release/build/bottom-<gibberish> . To programmatically determine which is the right folder, you might want to use something like: $( ls target/release/build/bottom-*/out/btm.bash | head -n1 | xargs dirname ) You may find the Arch package install script template useful as a reference. Adding an installation source Once you've finished your installation source, if you want to mention it in the main bottom repo, fork the repo and add the installation method and any details to the README.md file under the Installation section. Once that's done, open a pull request - these will usually be approved of very quickly. You can find more info on the contribution process here .","title":"Packaging and Distribution"},{"location":"contribution/packaging-and-distribution/#packaging-and-distribution","text":"Package maintainers are always welcome and appreciated! Here's some info on how one can help with package distribution and bottom.","title":"Packaging and Distribution"},{"location":"contribution/packaging-and-distribution/#pre-built-binaries","text":"The latest stable release can be found here , where you can find pre-built binaries in either a tar.gz or zip format. Binaries here also include automatically generated shell completion files for zsh, bash, fish, and Powershell, which you may want to also install during the packaging process. You can also find a nightly build in the releases page , built every day at 00:00 UTC off of the master branch.","title":"Pre-built binaries"},{"location":"contribution/packaging-and-distribution/#building-manually","text":"If you want to manually build bottom rather than distributing a pre-built binary, you'll need the most recent version of stable Rust, which you can get with: rustup update stable You'll then want to build with: cargo build --release --locked Completion files are automatically generated during this process, and are located in the directory target/release/build/bottom-<gibberish>/out . Note there may be multiple folders that look like target/release/build/bottom-<gibberish> . To programmatically determine which is the right folder, you might want to use something like: $( ls target/release/build/bottom-*/out/btm.bash | head -n1 | xargs dirname ) You may find the Arch package install script template useful as a reference.","title":"Building manually"},{"location":"contribution/packaging-and-distribution/#adding-an-installation-source","text":"Once you've finished your installation source, if you want to mention it in the main bottom repo, fork the repo and add the installation method and any details to the README.md file under the Installation section. Once that's done, open a pull request - these will usually be approved of very quickly. You can find more info on the contribution process here .","title":"Adding an installation source"},{"location":"support/official/","text":"Official support bottom officially supports the following operating systems and corresponding architectures: macOS ( x86_64 ) Linux ( x86_64 , i686 , aarch64 ) Windows ( x86_64 , i686 ) These platforms are tested to work (with caveats, see below) and issues on these platforms will be fixed if possible. Furthermore, binaries are expected to be built and tested using the most recent version of stable Rust - if you are manually building bottom from the repo/source, then please try that as well. Known problems Linux If you're using Linux via WSL or WSL2: You may have issues with getting memory data. Temperature sensors may not be correctly reported. WSL2 will not match Windows' own Task Manager in terms of data. Windows The temperature widget seems to require elevated access in some cases to get data. The battery widget seems to have issues with dual battery systems, like some Thinkpads. If you are using WSL or WSL2: You may have issues with getting memory data. Temperature sensors may not be correctly reported. WSL2 will not match Windows' own Task Manager in terms of data. macOS The process widget may require elevated access (ex: sudo btm ) to gather all data in some cases. Please note that you should be certain that you trust any software you grant root privileges.","title":"Official Support"},{"location":"support/official/#official-support","text":"bottom officially supports the following operating systems and corresponding architectures: macOS ( x86_64 ) Linux ( x86_64 , i686 , aarch64 ) Windows ( x86_64 , i686 ) These platforms are tested to work (with caveats, see below) and issues on these platforms will be fixed if possible. Furthermore, binaries are expected to be built and tested using the most recent version of stable Rust - if you are manually building bottom from the repo/source, then please try that as well.","title":"Official support"},{"location":"support/official/#known-problems","text":"","title":"Known problems"},{"location":"support/official/#linux","text":"If you're using Linux via WSL or WSL2: You may have issues with getting memory data. Temperature sensors may not be correctly reported. WSL2 will not match Windows' own Task Manager in terms of data.","title":"Linux"},{"location":"support/official/#windows","text":"The temperature widget seems to require elevated access in some cases to get data. The battery widget seems to have issues with dual battery systems, like some Thinkpads. If you are using WSL or WSL2: You may have issues with getting memory data. Temperature sensors may not be correctly reported. WSL2 will not match Windows' own Task Manager in terms of data.","title":"Windows"},{"location":"support/official/#macos","text":"The process widget may require elevated access (ex: sudo btm ) to gather all data in some cases. Please note that you should be certain that you trust any software you grant root privileges.","title":"macOS"},{"location":"support/unofficial/","text":"Unofficial support Systems and architectures that aren't officially supported may still work, but there are no guarantees on how much will work. For example, it might only compile, or it might run with bugs/broken features. Furthermore, while it will depend on the problem at the end of the day, issues on unsupported platforms are likely to go unfixed . Unofficially supported platforms known to compile/work: Linux on ARMv7 and ARMv6 (tested to compile in CI ) macOS on AArch64 (tested to compile in CI ) Linux on PowerPC 64 LE (tested to compile in CI ) Linux on an RISC-V (tested to compile in CI , tested to run on an Allwinner D1 Nezha ) Known problems M1-based macOS devices may have issues with temperature sensors not returning anything.","title":"Unofficial Support"},{"location":"support/unofficial/#unofficial-support","text":"Systems and architectures that aren't officially supported may still work, but there are no guarantees on how much will work. For example, it might only compile, or it might run with bugs/broken features. Furthermore, while it will depend on the problem at the end of the day, issues on unsupported platforms are likely to go unfixed . Unofficially supported platforms known to compile/work: Linux on ARMv7 and ARMv6 (tested to compile in CI ) macOS on AArch64 (tested to compile in CI ) Linux on PowerPC 64 LE (tested to compile in CI ) Linux on an RISC-V (tested to compile in CI , tested to run on an Allwinner D1 Nezha )","title":"Unofficial support"},{"location":"support/unofficial/#known-problems","text":"M1-based macOS devices may have issues with temperature sensors not returning anything.","title":"Known problems"},{"location":"usage/basic-mode/","text":"Basic Mode Basic mode is a special layout that removes all of the graphs and provides an interface that resembles (a very stripped-down version of) htop. Basic mode can be enabled either through a command line flag: btm -b # or btm --basic or through the config: [flags] basic = true Notes In this mode, widgets that use tables (temperatures, processes, disks, and batteries) are only shown one at a time. One can switch between these widgets either by clicking the arrow buttons or by using the general widget selection shortcuts (for example, Ctrl + Left or H ) to switch which widget is shown. Also note that in this mode, widget expansion and custom layouts are disabled. Key bindings Basic mode follows the same key bindings as normal, barring widget expansion being disabled, and that the % key while selecting the memory widget toggles between total usage and percentage.","title":"Basic Mode"},{"location":"usage/basic-mode/#basic-mode","text":"Basic mode is a special layout that removes all of the graphs and provides an interface that resembles (a very stripped-down version of) htop. Basic mode can be enabled either through a command line flag: btm -b # or btm --basic or through the config: [flags] basic = true","title":"Basic Mode"},{"location":"usage/basic-mode/#notes","text":"In this mode, widgets that use tables (temperatures, processes, disks, and batteries) are only shown one at a time. One can switch between these widgets either by clicking the arrow buttons or by using the general widget selection shortcuts (for example, Ctrl + Left or H ) to switch which widget is shown. Also note that in this mode, widget expansion and custom layouts are disabled.","title":"Notes"},{"location":"usage/basic-mode/#key-bindings","text":"Basic mode follows the same key bindings as normal, barring widget expansion being disabled, and that the % key while selecting the memory widget toggles between total usage and percentage.","title":"Key bindings"},{"location":"usage/general-usage/","text":"General Usage You can run bottom with: btm For help regarding the command-line flags, use: # For a simple overview of flags btm -h # For more details btm --help Features Expansion By default, bottom is somewhat like a dashboard - a bunch of different widgets, all showing different things, and they all cram together to fit into one terminal. If you instead just want to see one widget - maybe you want to look at a graph in more detail, for example - you can \"expand\" the currently selected widget using the e key, which will hide all other widgets and make that widget take up all available terminal space. You can leave this state by either pressing e again or pressing Esc . Widget selection To allow for widget-specific keybindings and expansion, there is the idea of widget selection in bottom, where you can focus on a specific widget to work with it. This can be done with the mouse (just click on the widget of interest) or keyboard (ex: Ctrl + Direction , see Key bindings for alternatives). Key bindings These are global or common keyboard shortcuts for the application, which you can see in-app through the ? shortcut. Note that key bindings are generally case-sensitive. Binding Action q , Ctrl + c Quit Esc Close dialog windows, search, widgets, or exit expanded mode Ctrl + r Reset display and any collected data f Freeze/unfreeze updating with new data ? Open help menu e Toggle expanding the currently selected widget Ctrl + Up Shift + Up K W Select the widget above Ctrl + Down Shift + Down J S Select the widget below Ctrl + Left Shift + Left H A Select the widget on the left Ctrl + Right Shift + Right L D Select the widget on the right Up , k Move up within a widget Down , j Move down within a widget Left h Alt + h Move left within a widget Right l Alt + l Move right within a widget g + g , Home Jump to the first entry G , End Jump to the last entry Page Up , Page Down Scroll up/down a table by a page Mouse bindings Binding Action Left Button Selects the widget","title":"General Usage"},{"location":"usage/general-usage/#general-usage","text":"You can run bottom with: btm For help regarding the command-line flags, use: # For a simple overview of flags btm -h # For more details btm --help","title":"General Usage"},{"location":"usage/general-usage/#features","text":"","title":"Features"},{"location":"usage/general-usage/#expansion","text":"By default, bottom is somewhat like a dashboard - a bunch of different widgets, all showing different things, and they all cram together to fit into one terminal. If you instead just want to see one widget - maybe you want to look at a graph in more detail, for example - you can \"expand\" the currently selected widget using the e key, which will hide all other widgets and make that widget take up all available terminal space. You can leave this state by either pressing e again or pressing Esc .","title":"Expansion"},{"location":"usage/general-usage/#widget-selection","text":"To allow for widget-specific keybindings and expansion, there is the idea of widget selection in bottom, where you can focus on a specific widget to work with it. This can be done with the mouse (just click on the widget of interest) or keyboard (ex: Ctrl + Direction , see Key bindings for alternatives).","title":"Widget selection"},{"location":"usage/general-usage/#key-bindings","text":"These are global or common keyboard shortcuts for the application, which you can see in-app through the ? shortcut. Note that key bindings are generally case-sensitive. Binding Action q , Ctrl + c Quit Esc Close dialog windows, search, widgets, or exit expanded mode Ctrl + r Reset display and any collected data f Freeze/unfreeze updating with new data ? Open help menu e Toggle expanding the currently selected widget Ctrl + Up Shift + Up K W Select the widget above Ctrl + Down Shift + Down J S Select the widget below Ctrl + Left Shift + Left H A Select the widget on the left Ctrl + Right Shift + Right L D Select the widget on the right Up , k Move up within a widget Down , j Move down within a widget Left h Alt + h Move left within a widget Right l Alt + l Move right within a widget g + g , Home Jump to the first entry G , End Jump to the last entry Page Up , Page Down Scroll up/down a table by a page","title":"Key bindings"},{"location":"usage/general-usage/#mouse-