Add waybar-states(5)

This commit is contained in:
Michael Aquilina 2019-08-26 22:49:04 +01:00
parent 2a3f40bc02
commit ba5592c86a
No known key found for this signature in database
GPG Key ID: 636066730B056BD1
2 changed files with 44 additions and 0 deletions

43
man/waybar-states.5.scd Normal file
View File

@ -0,0 +1,43 @@
waybar-states(5)
# OVERVIEW
Some modules support 'states' which allows percentage values to be used as styling triggers to
apply a class when the value matches the declared state value.
# STATES
- Every entry (*state*) consits of a *<name>* (typeof: *string*) and a *<value>* (typeof: *integer*).
- The state can be addressed as a CSS class in the *style.css*. The name of the CSS class is the *<name>* of the state.
Each class gets activated when the current capacity is equal or below the configured *<value>*.
- Also each state can have its own *format*.
Those con be configured via *format-<name>*.
Or if you want to differentiate a bit more even as *format-<status>-<state>*.
# EXAMPLE
```
"battery": {
"bat": "BAT2",
"interval": 60,
"states": {
"warning": 30,
"critical": 15
},
"format": "{capacity}% {icon}",
"format-icons": ["", "", "", "", ""],
"max-length": 25
}
```
# STYLING STATES
- *#battery.<state>*
- *<state>* can be defined in the *config*.
# EXAMPLE:
- *#battery.warning: { background: orange; }*
- *#battery.critical: { background: red; }*

View File

@ -176,6 +176,7 @@ if scdoc.found()
'waybar-sway-workspaces.5.scd', 'waybar-sway-workspaces.5.scd',
'waybar-temperature.5.scd', 'waybar-temperature.5.scd',
'waybar-tray.5.scd', 'waybar-tray.5.scd',
'waybar-states.5.scd',
] ]
foreach filename : man_files foreach filename : man_files