deblan/i3-blocks-go
deblan/i3-blocks-go
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases 6 Wiki Activity

update readme
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
Details

Browse source
This commit is contained in:
Simon Vieille 2022-08-30 16:29:53 +02:00
parent 7ff5b31ce8
commit 84fd3269cc
Signed by: deblan
GPG key ID: 579388D585F70417
1 changed files with 52 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

73
README.md
View file

@ -5,7 +5,7 @@ Blocks compatible with [i3blocks](https://github.com/vivien/i3blocks).
## Requirements
* `go` for compilation
* `sudo` for `wireguard` block
* `sudo` and `wg-quick` for `wireguard` block
* `tmux` for `app` and `date` blocks
* `df` for `du` block
* `xdg-open` for `du` block
@ -27,81 +27,112 @@ make
## Usage
Each binary has a help, eg `./app -h`.
### App
Add the shortcut `<name>` and run `<command>` when clicked.
```
app -block=<block_name> -name=<name> -cmd=<command> -bg-color=<background_color> -fg-color<foreground_color>
command=/path/to/app -block=<block_name> -name=<name> -cmd=<command> -bg-color=<background_color> -fg-color<foreground_color>
```
### Date
Show the time using given format and run `gnome-calendar` when clicked.
```
date -format="%H:%M:%S %d/%m/%Y"
command=/path/to/date -format="%H:%M:%S %d/%m/%Y"
```
### Disk usage
Show mount point usage and warns with limits and colors.
```
du -block=<block_name> -name=<name> -mount-point=<mount_point> -limit-warning=<limit_warning> -limit-danger=<limit_danger>
command=/path/to/du -block=<block_name> -name=<name> -mount-point=<mount_point> -limit-warning=<limit_warning> -limit-danger=<limit_danger>
```
### IP
Show the IP of the given iface.
```
ip -iface=<iface> -version=<ip4|ip6> -name=<name>
command=/path/to/ip -iface=<iface> -version=<ip4|ip6> -name=<name>
```
### IP (wan)
Show the public IP.
```
ip_wan
command=/path/to/ip_wan
```
### Prusa telemetry
Show the telemetry using Prusa Printer API.
```
prusa_telemetry -api=http://1.2.3.4/api/telemetry
command=/path/to/prusa_telemetry -api=http://1.2.3.4/api/telemetry
```
### Process
Show a message when the given process is running (use `preg -f`).
```
ps -process=<process> -message=<message>
command=/path/to/ps -process=<process> -message=<message>
```
### Feed indicator
Show indicator of RSS.
```
rss -block=<block_name> -feed=<feed_url> -website=<feed_reader_url> -empty-color=<color> -non-empty-color=<color>
command=/path/to/rss -block=<block_name> -feed=<feed_url> -website=<feed_reader_url> -empty-color=<color> -non-empty-color=<color>
```
### Spotify status
Show current song played (spotify).
```
spotify
command=/path/to/spotify
```
### Volume
Show volume.
```
volume -channel=<channel>
command=/path/to/volume -channel=<channel>
```
### Wireguard toggler
Toggler for wireguard.
```
wireguard -iface=<iface> -name=<name>
command=/path/to/wireguard -iface=<iface> -name=<name>
```
Add a blocks that represent opened apps to create a task bar.
### Task bar
Add blocks that represent opened apps and create a task bar.
```
workspace_apps 0 $BLOCK_BUTTON
workspace_apps 1 $BLOCK_BUTTON
workspace_apps 2 $BLOCK_BUTTON
workspace_apps 3 $BLOCK_BUTTON
workspace_apps 4 $BLOCK_BUTTON
workspace_apps 5 $BLOCK_BUTTON
workspace_apps 6 $BLOCK_BUTTON
workspace_apps 7 $BLOCK_BUTTON
[workspace_apps_0]
command=/path/to/workspace_apps 0 $BLOCK_BUTTON
format=json
markup=pango
interval=1
[workspace_apps_1]
command=/path/to/workspace_apps 1 $BLOCK_BUTTON
format=json
markup=pango
interval=1
...
```