tyler.durden/bottom
1
0
Fork 0
mirror of https://github.com/ClementTsang/bottom.git synced 2025-05-02 21:51:29 +02:00
Code Issues Packages Projects Releases Wiki Activity
bottom/docs/content/configuration/config-file/flags.md
Twan Stok 1b1e80ec3c
feature: add buffer and cache memory (#1063) 
* First implementation of cache memory data collection, mostly copied from RAM and swap implementations

* First implementation of cache memory display, copied from RAM and swap implementations. placed cache as second in the list as it is more similar to the RAM than any other item in the list

* expanded comment to explain method.

* rustfmt

* all cache-related code excluded on windows, in the process refactored src/data_conversion.rs convert_mem_label() to convert a single label instead of all at once

* better factoring-out of cache memory logic to allow individual disabling

* added --enable_cache_memory flag, disabled cache memory collection by default

* renamed CCH to CHE
not sure how i messed that up

* changelog updated

* Added command line flag documentation

* updated config file documentation

* specified that buffer and cache memory display does not work on windows

* resolved merge conflicts

* added documentation to cache memory data collection

* capitalized Windows

* implemented missing canvas styling logic

* fixed misplaced no-windows flag

* reduced colour collisions, as cache colour was the same as the first GPU colour

* made FIFTH_COLOUR constant windows-only

* Revert "made FIFTH_COLOUR constant windows-only"

This reverts commit 72698f1dd7e2de7dbda843708ece6a3dba66f94f.

* made FIFTH_COLOUR constant non-windows-only

* minor fix for basic mode row count

* Update src/app/data_harvester/memory/sysinfo.rs

Co-authored-by: Clement Tsang <34804052+ClementTsang@users.noreply.github.com>

* Update src/canvas/widgets/mem_basic.rs

Co-authored-by: Clement Tsang <34804052+ClementTsang@users.noreply.github.com>

* updated default_config.toml

* formatting

---------

Co-authored-by: ClementTsang <34804052+ClementTsang@users.noreply.github.com>
2023-04-12 22:51:41 -04:00

7.6 KiB
Raw Blame History

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.
enable_cache_memory Boolean Enable collecting and displaying cache and buffer memory (not available on Windows).
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.
enable_gpu_memory Boolean Shows the GPU memory widget.
retention String (human readable time, such as "10m", "1h", etc.) How much data is stored at once in terms of time.
unnormalized_cpu Boolean Show process CPU% without normalizing over the number of cores.
expanded_on_startup Boolean Expand the default widget upon starting the app.