mirror of
https://github.com/house-of-vanity/tmux-helper.git
synced 2026-02-04 01:37:57 +00:00
Update readme
This commit is contained in:
36
README.md
36
README.md
@@ -3,14 +3,36 @@ Small app that perform system check and print TMUX friendly output.
|
||||
|
||||

|
||||
|
||||
### Features:
|
||||
1. `tmux-helper -cb` print cpu load with bar.
|
||||
2. `tmux-helper -mb` print memory usage with bar.
|
||||
3. `tmux-helper -p` show current player status using d-bus.
|
||||
|
||||
### Building
|
||||
`cargo build --release`
|
||||
or get binary on release page
|
||||
|
||||
### Customization
|
||||
Colours are hardcoded but it's easy to change it. It defined as CONST in very beginning of main.rs file.
|
||||
### Fetures
|
||||
```shell
|
||||
tmux-helper 0.3.2
|
||||
Ultra Desu <ultradesu@hexor.ru>
|
||||
Utility for printing system info for tmux status line.
|
||||
|
||||
USAGE:
|
||||
tmux-helper [FLAGS] [OPTIONS]
|
||||
|
||||
FLAGS:
|
||||
-c, --cpu Print cpu load bar.
|
||||
-h, --help Prints help information
|
||||
-m, --mem Print mem usage bar.
|
||||
-d, --mpd Show mpd player using MPD native protocol.
|
||||
-p, --mpris Show player info using MPRIS2 interface.
|
||||
-V, --version Prints version information
|
||||
|
||||
OPTIONS:
|
||||
--COLOR_END <COLOR_END> Default color using to terminate others.
|
||||
--COLOR_HIGH <COLOR_HIGH> CPU and MEM bar color while high usage.
|
||||
--COLOR_LOW <COLOR_LOW> CPU and MEM bar color while low usage.
|
||||
--COLOR_MID <COLOR_MID> CPU and MEM bar color while mid usage.
|
||||
--COLOR_TRACK_ARTIST <COLOR_TRACK_ARTIST> Color of artist name filed.
|
||||
--COLOR_TRACK_NAME <COLOR_TRACK_NAME> Color of track name filed.
|
||||
--COLOR_TRACK_TIME <COLOR_TRACK_TIME> Color of playing time field.
|
||||
-l, --localtime <localtime> Local time
|
||||
-a, --mpd-address <mpd_address> <ADDR>:<PORT> of MPD server.
|
||||
-u, --utctime <utctime> UTC time
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user