moritz/simple-i3blocks
Archived
1
0
Fork 0
Code Issues Pull Requests Releases Activity

tidy up readme

Browse Source
This commit is contained in:
koksnuss 2018-08-08 21:47:31 +02:00
parent 83d2abae92
commit d7529b2356
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -6,12 +6,13 @@
This is a simple collection of i3blocks-modules accompagnied by a config file with the aim to display only important information in favor of not spilling lots of numbers into the status bar.
# Usage
- module *datetime*: A left click will toggle long and short displays. The short version is displayed in the format `HH:MM`. The long version also shows the day of the week, weeknumber, date and seconds.
- module *audio*: `instance=mic` will show the microphone level instead. With a left mouse click the device is muted/unmuted.
- module *ram*: by default free ram and swap are shown in the format `a+b G` where `a` is ram and `b` is swap. If you want to show ram and swap seperatly, use `instance=ram` or `instance=swap`. If you left click on the block, `top` will be openend.
- *cpu*: by default total idle cpu time of all cores together is displayed using a vertical block symbol. Use `instance=long` to show the percentage instead. If you left click on the block, `top` will be openend.
- module *battery*: By default the total energy left of all batteries is shown using a vertical block symbol. Use `instance=x` to show the status of `BATx` in case you have more than one battery in `/sys/class/powersupply`. On Left click, the long percentage is shown.
- module *backlight*: By default the brightness level is shown in the default font color (depending on your i3 config). Use `instance=long` to show the brightness percentage. Use `instance="color"` to print the brightness level colored which is nice when using a device in battery mode. On left click the brightness in percent will be shown.
- *datetime* -- A left click will toggle long and short displays. The short version is displayed in the format `HH:MM`. The long version also shows the day of the week, weeknumber, date and seconds.
- *audio* -- Current audio output level. `instance=mic` will show the microphone input level instead.
- *ram* -- Free ram and swap are shown in the format `a+b G` where `a` is ram and `b` is swap. If you want to show ram and swap seperatly, use `instance=ram` or `instance=swap`.
- *cpu* -- Total idle cpu time of all cores together. Use `instance=long` to show the percentage instead.
- *temp* -- Current temperature of the cpu.
- *battery* -- Total energy left of all batteries. Use `instance=x` to show the status of `BATx` in case you have more than one battery in `/sys/class/powersupply`.
- *backlight* -- Brightness level. Use `instance=long` to show the brightness percentage. Use `instance="color"` to print the brightness level colored which is nice when using a device in battery mode.
# Requirements
Install [i3 window manager](https://i3wm.org) alongside with [i3blocks](https://github.com/vivien/i3blocks) and `git`. The following shows the requirements for each module: