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

update readme
ci/woodpecker/push/woodpecker Pipeline was successful Details

This commit is contained in:
Simon Vieille 2022-08-30 19:47:54 +02:00
parent b3d57a5f94
commit 42b76dd78d
Signed by: deblan
GPG Key ID: 579388D585F70417
1 changed files with 96 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

104
README.md
View File

@ -34,7 +34,23 @@ Each binary has a help, eg `./app -h`.
Add the shortcut `<name>` and run `<command>` when clicked.
```
command=/path/to/app -block=<block_name> -name=<name> -cmd=<command> -bg-color=<background_color> -fg-color<foreground_color>
[app_otp]
command=/path/to/app -block=app_otp -name=🔐 -bg-color='#363636' -fg-color='#ffc337' -cmd=otpclient
format=json
markup=pango
interval=1000
[app_flameshot]
command=/path/to/app -block=app_flameshot -name=F -bg-color='#bf007e' -fg-color='#fff' -cmd="flameshot gui --delay 500"
format=json
markup=pango
interval=1000
[app_ksnip]
command=/path/to/app -block=app_youtube -name=Y -bg-color='#c74a42' -fg-color='#fff' -cmd="xdg-open https://www.youtube.com/"
format=json
markup=pango
interval=1000
```
### Date
@ -42,7 +58,11 @@ command=/path/to/app -block=<block_name> -name=<name> -cmd=<command> -bg-color=<
Show the time using given format and run `gnome-calendar` when clicked.
```
command=/path/to/date -format="%H:%M:%S %d/%m/%Y"
[time]
command=/home/simon/www/repo/i3-blocks-go/build/date -format="%H:%M:%S %d/%m/%Y"
format=json
markup=pango
interval=persist
```
### Disk usage
@ -50,7 +70,17 @@ command=/path/to/date -format="%H:%M:%S %d/%m/%Y"
Show mount point usage and warns with limits and colors.
```
command=/path/to/du -block=<block_name> -name=<name> -mount-point=<mount_point> -limit-warning=<limit_warning> -limit-danger=<limit_danger>
[du_root]
command=/path/to/du -block=du_root -mount-point=/ -name=root -limit-warning=70 -limit-danger=90
format=json
markup=pango
interval=30
[du_home]
command=/path/to/du -block=du_home -mount-point=/home -name=home -limit-warning=90 -limit-danger=95
format=json
markup=pango
interval=30
```
### IP
@ -58,7 +88,23 @@ command=/path/to/du -block=<block_name> -name=<name> -mount-point=<mount_point>
Show the IP of the given iface.
```
command=/path/to/ip -iface=<iface> -version=<ip4|ip6> -name=<name>
[ip_wg0_ip4]
command=/path/to/ip -iface=wg0 -version=ip4 -name=VPN
format=json
markup=pango
interval=3
[ip_eth0_ip4]
command=/path/to/ip -iface=eth0 -version=ip4 -name=Foo
format=json
markup=pango
interval=3
[ip_eth0_ip6]
command=/path/to/ip -iface=eth0 -version=ip4 -name=Bar
format=json
markup=pango
interval=3
```
### IP (wan)
@ -66,7 +112,11 @@ command=/path/to/ip -iface=<iface> -version=<ip4|ip6> -name=<name>
Show the public IP.
```
[ip_wan]
command=/path/to/ip_wan
format=json
markup=pango
interval=100
```
### Prusa telemetry
@ -74,7 +124,11 @@ command=/path/to/ip_wan
Show the telemetry using Prusa Printer API.
```
[prusa]
command=/path/to/prusa_telemetry -api=http://1.2.3.4/api/telemetry
format=json
markup=pango
interval=60
```
### Process
@ -82,7 +136,11 @@ command=/path/to/prusa_telemetry -api=http://1.2.3.4/api/telemetry
Show a message when the given process is running (use `preg -f`).
```
command=/path/to/ps -process=<process> -message=<message>
[ps]
command=/path/to/ps -process=foo -message="Foo is running"
format=json
markup=pango
interval=3
```
### Feed indicator
@ -90,7 +148,19 @@ command=/path/to/ps -process=<process> -message=<message>
Show indicator of RSS.
```
command=/path/to/rss -block=<block_name> -feed=<feed_url> -website=<feed_reader_url> -empty-color=<color> -non-empty-color=<color>
[rss_foo]
command=/path/to/rss -block=rss_foo -feed="https://foo.example.com/feed.xml" -website="https://foo.example.com/" -empty-color="#CCCCCC" -non-empty-color="#B3FF6C"
align=left
interval=30
format=json
markup=pango
[rss_bar]
command=/path/to/rss -block=rss_bar -feed="https://bar.example.com/atom.xml" -website="https://bar.example.com/" -empty-color="#aabfc1" -non-empty-color="#00d8f0"
align=left
interval=30
format=json
markup=pango
```
### Spotify status
@ -98,7 +168,11 @@ command=/path/to/rss -block=<block_name> -feed=<feed_url> -website=<feed_reader_
Show current song played (spotify).
```
[spotify]
command=/path/to/spotify
format=json
markup=pango
interval=3
```
### Volume
@ -106,7 +180,11 @@ command=/path/to/spotify
Show volume.
```
command=/path/to/volume -channel=<channel>
[volume]
command=/path/to/volume -channel=Master
format=json
markup=pango
interval=1
```
### Wireguard toggler
@ -114,7 +192,17 @@ command=/path/to/volume -channel=<channel>
Toggler for wireguard.
```
command=/path/to/wireguard -iface=<iface> -name=<name>
[wireguard_wg0]
command=/path/to/wireguard -iface=wg0 -name=Foo
format=json
markup=pango
interval=2
[wireguard_wg1]
command=/path/to/wireguard -iface=wg1 -name=Bar
format=json
markup=pango
interval=2
```
### Task bar