Documentation clean-up.
19
README.md
|
@ -9,8 +9,8 @@ Another terminal based graphical activity monitor, inspired by [gtop](https://gi
|
||||||
|
|
||||||
The original author of gotop has re-implemented the application in Rust, as [ytop](https://github.com/cjbassi/ytop). This is a fork of original gotop project with a new maintainer.
|
The original author of gotop has re-implemented the application in Rust, as [ytop](https://github.com/cjbassi/ytop). This is a fork of original gotop project with a new maintainer.
|
||||||
|
|
||||||
<img src="./assets/demos/demo.gif" />
|
<img src="./assets/screenshots/demo.gif" />
|
||||||
<img src="./assets/screenshots/minimal.png" width="96%" />
|
<img src="./assets/screenshots/kitchensink.gif" />
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
@ -166,21 +166,30 @@ build massive edifices, you're in for disappointment.
|
||||||
### CLI Options
|
### CLI Options
|
||||||
|
|
||||||
`-c`, `--color=NAME` Set a colorscheme.
|
`-c`, `--color=NAME` Set a colorscheme.
|
||||||
`-m`, `--minimal` Only show CPU, Mem and Process widgets. (DEPRECATED for `-l minimal`)
|
`-m`, `--minimal` Only show CPU, Mem and Process widgets. (DEPRECATED, use `-l minimal`)
|
||||||
`-r`, `--rate=RATE` Number of times per second to update CPU and Mem widgets [default: 1].
|
`-r`, `--rate=RATE` Number of times per second to update CPU and Mem widgets [default: 1].
|
||||||
`-V`, `--version` Print version and exit.
|
`-V`, `--version` Print version and exit.
|
||||||
`-p`, `--percpu` Show each CPU in the CPU widget.
|
`-p`, `--percpu` Show each CPU in the CPU widget.
|
||||||
`-a`, `--averagecpu` Show average CPU in the CPU widget.
|
`-a`, `--averagecpu` Show average CPU in the CPU widget.
|
||||||
`-f`, `--fahrenheit` Show temperatures in fahrenheit.
|
`-f`, `--fahrenheit` Show temperatures in fahrenheit.
|
||||||
`-s`, `--statusbar` Show a statusbar with the time.
|
`-s`, `--statusbar` Show a statusbar with the time.
|
||||||
`-b`, `--battery` Show battery level widget (`minimal` turns off). [preview](./assets/screenshots/battery.png) (DEPRECATED for `-l battery`)
|
`-b`, `--battery` Show battery level widget (`minimal` turns off). (DEPRECATED, use `-l battery`)
|
||||||
`-i`, `--interface=NAME` Select network interface [default: all].
|
`-i`, `--interface=NAME` Select network interface [default: all].
|
||||||
`-l`, `--layout=NAME` Choose a layout. gotop searches for a file by NAME in \$XDG_CONFIG_HOME/gotop, then relative to the current path. "-" reads a layout from stdin, allowing for simple, one-off layouts such as `echo net | gotop -l -`
|
`-l`, `--layout=NAME` Choose a layout. gotop searches for a file by NAME in \$XDG_CONFIG_HOME/gotop, then relative to the current path. "-" reads a layout from stdin, allowing for simple, one-off layouts such as `echo net | gotop -l -`
|
||||||
|
|
||||||
Several interfaces can be defined using comma separated values.
|
Several interfaces can be defined using comma separated values.
|
||||||
|
|
||||||
Interfaces can also be ignored using `!`
|
Interfaces can also be ignored using `!`
|
||||||
|
|
||||||
|
## More screen shots
|
||||||
|
|
||||||
|
#### "-l battery"
|
||||||
|
<img src="./assets/screenshots/battery.png" />
|
||||||
|
#### "-l minimal"
|
||||||
|
<img src="./assets/screenshots/minimal.png" />
|
||||||
|
#### Custom (layouts/procs)
|
||||||
|
<img src="./assets/screenshots/procs.png" />
|
||||||
|
|
||||||
## Built With
|
## Built With
|
||||||
|
|
||||||
- [gizak/termui](https://github.com/gizak/termui)
|
- [gizak/termui](https://github.com/gizak/termui)
|
||||||
|
|
Before Width: | Height: | Size: 93 KiB After Width: | Height: | Size: 122 KiB |
Before Width: | Height: | Size: 146 KiB After Width: | Height: | Size: 146 KiB |
BIN
assets/screenshots/kitchensink.gif
Normal file
After Width: | Height: | Size: 230 KiB |
Before Width: | Height: | Size: 43 KiB After Width: | Height: | Size: 87 KiB |
BIN
assets/screenshots/procs.png
Normal file
After Width: | Height: | Size: 160 KiB |
|
@ -236,6 +236,7 @@ func countMaxHeight(rs [][]widgetRule) int {
|
||||||
// deepFindProc looks in the UI widget tree for the ProcWidget,
|
// deepFindProc looks in the UI widget tree for the ProcWidget,
|
||||||
// and returns it if found or nil if not.
|
// and returns it if found or nil if not.
|
||||||
func deepFindProc(gs interface{}) *widgets.ProcWidget {
|
func deepFindProc(gs interface{}) *widgets.ProcWidget {
|
||||||
|
// FIXME: `procs` layout isn't passing down keystrokes
|
||||||
// Recursive function #1. Recursion is OK here because the number
|
// Recursive function #1. Recursion is OK here because the number
|
||||||
// of UI elements, even in a very complex UI, is going to be
|
// of UI elements, even in a very complex UI, is going to be
|
||||||
// relatively small.
|
// relatively small.
|
||||||
|
|