tobias/waybar
1
0
Fork 0
mirror of https://github.com/rad4day/Waybar.git synced 2023-12-21 10:22:59 +01:00
Code Issues Packages Projects Releases Wiki Activity

Fix states documentation

Browse Source
This commit is contained in:
Kelsey Judson 2022-11-07 20:30:01 +13:00
parent af1668dfd0
commit 51e6fc6250
7 changed files with 13 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
man/waybar-backlight.5.scd
View File

@ -37,8 +37,8 @@ The *backlight* module displays the current backlight level.
Positive value to rotate the text label. Positive value to rotate the text label.
*states*: ++ *states*: ++
typeof: array ++ typeof: object ++
A number of backlight states which get activated on certain brightness levels. A number of backlight states which get activated on certain brightness levels. See *waybar-states(5)*.
*on-click*: ++ *on-click*: ++
typeof: string ++ typeof: string ++

2
man/waybar-battery.5.scd
View File

@ -33,7 +33,7 @@ The *battery* module displays the current capacity and state (eg. charging) of y
The interval in which the information gets polled. The interval in which the information gets polled.
*states*: ++ *states*: ++
typeof: array ++ typeof: object ++
A number of battery states which get activated on certain capacity levels. See *waybar-states(5)*. A number of battery states which get activated on certain capacity levels. See *waybar-states(5)*.
*format*: ++ *format*: ++

2
man/waybar-cpu.5.scd
View File

@ -42,7 +42,7 @@ The *cpu* module displays the current cpu utilization.
Positive value to rotate the text label. Positive value to rotate the text label.
*states*: ++ *states*: ++
typeof: array ++ typeof: object ++
A number of cpu usage states which get activated on certain usage levels. See *waybar-states(5)*. A number of cpu usage states which get activated on certain usage levels. See *waybar-states(5)*.
*on-click*: ++ *on-click*: ++

2
man/waybar-disk.5.scd
View File

@ -32,7 +32,7 @@ Addressed by *disk*
Positive value to rotate the text label. Positive value to rotate the text label.
*states*: ++ *states*: ++
typeof: array ++ typeof: object ++
A number of disk utilization states which get activated on certain percentage thresholds (percentage_used). See *waybar-states(5)*. A number of disk utilization states which get activated on certain percentage thresholds (percentage_used). See *waybar-states(5)*.
*max-length*: ++ *max-length*: ++

2
man/waybar-memory.5.scd
View File

@ -32,7 +32,7 @@ Addressed by *memory*
Positive value to rotate the text label. Positive value to rotate the text label.
*states*: ++ *states*: ++
typeof: array ++ typeof: object ++
A number of memory utilization states which get activated on certain percentage thresholds. See *waybar-states(5)*. A number of memory utilization states which get activated on certain percentage thresholds. See *waybar-states(5)*.
*max-length*: ++ *max-length*: ++

4
man/waybar-pulseaudio.5.scd
View File

@ -43,8 +43,8 @@ Additionally you can control the volume by scrolling *up* or *down* while the cu
Positive value to rotate the text label. Positive value to rotate the text label.
*states*: ++ *states*: ++
typeof: array ++ typeof: object ++
A number of volume states which get activated on certain volume levels. See *waybar-states(5)* A number of volume states which get activated on certain volume levels. See *waybar-states(5)*.
*max-length*: ++ *max-length*: ++
typeof: integer ++ typeof: integer ++

11
man/waybar-states.5.scd
View File

@ -7,14 +7,13 @@ apply a class when the value matches the declared state value.
# STATES # STATES
- Every entry (*state*) consists of a *<name>* (typeof: *string*) and a *<value>* (typeof: *integer*). Every entry (*state*) consists 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. - 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>*. Each class gets activated when the current value is equal to or less than the configured *<value>* for the *battery* module, or equal to or greater than the configured *<value>* for all other modules.
- Also each state can have its own *format*. - Also, each state can have its own *format*.
Those can be configured via *format-<name>*. Those can be configured via *format-<name>*, or if you want to differentiate a bit more, as *format-<status>-<state>*.
Or if you want to differentiate a bit more even as *format-<status>-<state>*.
# EXAMPLE # EXAMPLE