mirror of https://github.com/aristocratos/bpytop
Updated example config file and install instructions
parent
ccc3d0bcd0
commit
d4656b594b
40
README.md
40
README.md
|
@ -127,9 +127,9 @@ Options menu.
|
|||
|
||||
### PyPi (will always have latest version)
|
||||
|
||||
> Install python3 and pip
|
||||
> Install or update to latest version
|
||||
``` bash
|
||||
python3 -m pip install bpytop
|
||||
pip3 install bpytop --upgrade
|
||||
```
|
||||
|
||||
### Arch Linux
|
||||
|
@ -247,12 +247,15 @@ Config files stored in "$HOME/.config/bpytop" folder
|
|||
"/etc/bpytop.conf" will be used as default seed for config file creation if it exists.
|
||||
|
||||
```bash
|
||||
#? Config file for bpytop v. 1.0.0
|
||||
#? Config file for bpytop v. 1.0.18
|
||||
|
||||
#* Color theme, looks for a .theme file in "/usr/[local/]share/bpytop/themes" and "~/.config/bpytop/themes", "Default" for builtin default theme.
|
||||
#* Prefix name by a plus sign (+) for a theme located in user themes folder, i.e. color_theme="+monokai"
|
||||
color_theme="Default"
|
||||
|
||||
#* If the theme set background should be shown, set to False if you want terminal background transparency
|
||||
theme_background=True
|
||||
|
||||
#* Update time in milliseconds, increases automatically if set below internal loops processing time, recommended 2000 ms or above for better sample times for graphs.
|
||||
update_ms=2000
|
||||
|
||||
|
@ -273,9 +276,12 @@ proc_colors=True
|
|||
proc_gradient=True
|
||||
|
||||
#* If process cpu usage should be of the core it's running on or usage of the total available cpu power.
|
||||
proc_per_core=False
|
||||
proc_per_core=True
|
||||
|
||||
#* Check cpu temperature, needs "vcgencmd" on Raspberry Pi and "osx-cpu-temp" on MacOS X.
|
||||
#* Show process memory as bytes instead of percent
|
||||
proc_mem_bytes=True
|
||||
|
||||
#* Check cpu temperature, needs "osx-cpu-temp" on MacOS X.
|
||||
check_temp=True
|
||||
|
||||
#* Draw a clock at top of screen, formatting according to strftime, empty string to disable.
|
||||
|
@ -295,7 +301,7 @@ disks_filter=""
|
|||
mem_graphs=True
|
||||
|
||||
#* If swap memory should be shown in memory box.
|
||||
show_swap=False
|
||||
show_swap=True
|
||||
|
||||
#* Show swap as a disk, ignores show_swap value above, inserts itself after first disk.
|
||||
swap_disk=True
|
||||
|
@ -303,6 +309,16 @@ swap_disk=True
|
|||
#* If mem box should be split to also show disks info.
|
||||
show_disks=True
|
||||
|
||||
#* Set fixed values for network graphs, default "10M" = 10 Mibibytes, possible units "K", "M", "G", append with "bit" for bits instead of bytes, i.e "100mbit"
|
||||
net_download="100Mbit"
|
||||
net_upload="100Mbit"
|
||||
|
||||
#* Start in network graphs auto rescaling mode, ignores any values set above and rescales down to 10 Kibibytes at the lowest.
|
||||
net_auto=True
|
||||
|
||||
#* If the network graphs color gradient should scale to bandwith usage or auto scale, bandwith usage is based on "net_download" and "net_upload" values
|
||||
net_color_fixed=False
|
||||
|
||||
#* Show init screen at startup, the init screen is purely cosmetical
|
||||
show_init=True
|
||||
|
||||
|
@ -316,9 +332,10 @@ mini_mode=False
|
|||
#* The level set includes all lower levels, i.e. "DEBUG" will show all logging info.
|
||||
log_level=WARNING
|
||||
|
||||
|
||||
```
|
||||
|
||||
#### Command line options: (not yet implemented)
|
||||
#### Command line options:
|
||||
|
||||
``` text
|
||||
USAGE: bpytop [argument]
|
||||
|
@ -332,7 +349,14 @@ Arguments:
|
|||
|
||||
## TODO
|
||||
|
||||
- [ ] See TODOs from [Bashtop](https://github.com/aristocratos/bashtop#todo).
|
||||
- [ ] Add gpu temp and usage.
|
||||
- [ ] Add cpu and mem stats for docker containers. (If feasible)
|
||||
- [x] Change process list to line scroll instead of page change.
|
||||
- [ ] Add options for resizing all boxes.
|
||||
- [x] Add command line argument parsing.
|
||||
|
||||
- [ ] Miscellaneous optimizations and code cleanup.
|
||||
|
||||
|
||||
## LICENSE
|
||||
|
||||
|
|
Loading…
Reference in New Issue