info-taskspooler: update README.md

master
x70b1 2019-05-02 13:33:49 +02:00
parent e379d3c3f3
commit 1b308586f4
1 changed files with 7 additions and 18 deletions

View File

@ -1,39 +1,28 @@
# Script: info-taskspooler
Show queued/running count for one or more task spooler servers.
A small script that displays the number of queues/runtimes for one or more task spooler servers.
![info-taskspooler](screenshots/1.png)
## Dependencies
- `task-spooler`
* `task-spooler`
## Configuration
No arguments required, by default the script will output the count of the default task-spooler server.
By default the script will output the count of the default task-spooler server.
If desired, arguments can be passed to show custom task-spooler servers by using the TS_SOCKET variable. These custom servers will need to use a socket filename format like /tmp/ts-socket.SOCK_NAME or the script will be unable to find the server. Arguments are passed as name,sock_name with sock_name being optional, e.g. `default yt,youtube p,podcast`.
Arguments can be passed to show custom task-spooler servers by using the `TS_SOCKET variable`. These custom servers will need to use a socket filename format like /tmp/ts-socket.SOCK_NAME or the script will be unable to find the server. Arguments are passed as `name,sock_name` with sock_name being optional, e.g. `default yt,youtube p,podcast`.
## Module
```ini
[module/{ name }]
[module/info-taskspooler]
type = custom/script
exec = ~/polybar-scripts/info-task-spooler/info-task-spooler.sh
format-prefix = "tsp "
exec = ~/polybar-scripts/info-task-spooler/info-taskspooler.sh
# exec = ~/polybar-scripts/info-taskspooler/info-taskspooler.sh default yt,youtube p,podcast
interval = 5
...
```
or
```ini
[module/{ name }]
type = custom/script
exec = ~/polybar-scripts/info-task-spooler/info-task-spooler.sh default yt,youtube p,podcast
interval = 5
...
```