tyler.durden/bottom
1
0
Fork 0
mirror of https://github.com/ClementTsang/bottom.git synced 2025-07-22 21:24:49 +02:00
Code Issues Packages Projects Releases Wiki Activity

[skip travis] Updated documentation.

Browse Source
This commit is contained in:
ClementTsang 2020-02-13 21:36:49 -05:00
parent fe5f911ad3
commit debee7d9cb
1 changed files with 28 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -98,13 +98,19 @@ Run using `btm`.
- `-R`, `--regex` will default to using regex.
- `--cpu_default`, `--memory_default`, `--disk_default`, `--temperature_default`, `--network_default`, `--process_default` will default the selected widget on startup to that option. By default the process widget is selected.
- `-C`, `--config` takes in a file path leading to a TOML file.
### Config Files
One use of a config file is to set flags to execute by default.
- This is set under the `[flags]` section.
- These options are generally the same as the long names as other flags (ex: `case_sensitive = true`).
- For temperature type, use `temperature_type = "<kelvin|k|celsius|c|fahrenheit|f>"`.
- Note that if a flag and an option conflict, the flag has higher precedence (ex: if the `-c` and `temperature_type = kelvin` both exist, the Celsius temperature type is ultimately chosen).
- For temperature type, use `temperature_type = "kelvin|k|celsius|c|fahrenheit|f"`.
- For default widgets, use `default_widget = "cpu_default|memory_default|disk_default|temperature_default|network_default|process_default"`.
Another use is to set colours, under the `[colors]`. The following labels are customizable with hex colour code strings: