From 51e6fc62507dc95d3844693adf9ffac4dedfe214 Mon Sep 17 00:00:00 2001 From: Kelsey Judson Date: Mon, 7 Nov 2022 20:30:01 +1300 Subject: [PATCH] Fix states documentation --- man/waybar-backlight.5.scd | 4 ++-- man/waybar-battery.5.scd | 2 +- man/waybar-cpu.5.scd | 2 +- man/waybar-disk.5.scd | 2 +- man/waybar-memory.5.scd | 2 +- man/waybar-pulseaudio.5.scd | 4 ++-- man/waybar-states.5.scd | 11 +++++------ 7 files changed, 13 insertions(+), 14 deletions(-) diff --git a/man/waybar-backlight.5.scd b/man/waybar-backlight.5.scd index d14e4f2..9c8ba79 100644 --- a/man/waybar-backlight.5.scd +++ b/man/waybar-backlight.5.scd @@ -37,8 +37,8 @@ The *backlight* module displays the current backlight level. Positive value to rotate the text label. *states*: ++ - typeof: array ++ - A number of backlight states which get activated on certain brightness levels. + typeof: object ++ + A number of backlight states which get activated on certain brightness levels. See *waybar-states(5)*. *on-click*: ++ typeof: string ++ diff --git a/man/waybar-battery.5.scd b/man/waybar-battery.5.scd index 1ddd4d6..fabde59 100644 --- a/man/waybar-battery.5.scd +++ b/man/waybar-battery.5.scd @@ -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. *states*: ++ - typeof: array ++ + typeof: object ++ A number of battery states which get activated on certain capacity levels. See *waybar-states(5)*. *format*: ++ diff --git a/man/waybar-cpu.5.scd b/man/waybar-cpu.5.scd index 2e0d6c7..e354553 100644 --- a/man/waybar-cpu.5.scd +++ b/man/waybar-cpu.5.scd @@ -42,7 +42,7 @@ The *cpu* module displays the current cpu utilization. Positive value to rotate the text label. *states*: ++ - typeof: array ++ + typeof: object ++ A number of cpu usage states which get activated on certain usage levels. See *waybar-states(5)*. *on-click*: ++ diff --git a/man/waybar-disk.5.scd b/man/waybar-disk.5.scd index 5879714..586c9db 100644 --- a/man/waybar-disk.5.scd +++ b/man/waybar-disk.5.scd @@ -32,7 +32,7 @@ Addressed by *disk* Positive value to rotate the text label. *states*: ++ - typeof: array ++ + typeof: object ++ A number of disk utilization states which get activated on certain percentage thresholds (percentage_used). See *waybar-states(5)*. *max-length*: ++ diff --git a/man/waybar-memory.5.scd b/man/waybar-memory.5.scd index d960ffd..34e342f 100644 --- a/man/waybar-memory.5.scd +++ b/man/waybar-memory.5.scd @@ -32,7 +32,7 @@ Addressed by *memory* Positive value to rotate the text label. *states*: ++ - typeof: array ++ + typeof: object ++ A number of memory utilization states which get activated on certain percentage thresholds. See *waybar-states(5)*. *max-length*: ++ diff --git a/man/waybar-pulseaudio.5.scd b/man/waybar-pulseaudio.5.scd index e3f9045..b941c22 100644 --- a/man/waybar-pulseaudio.5.scd +++ b/man/waybar-pulseaudio.5.scd @@ -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. *states*: ++ - typeof: array ++ - A number of volume states which get activated on certain volume levels. See *waybar-states(5)* + typeof: object ++ + A number of volume states which get activated on certain volume levels. See *waybar-states(5)*. *max-length*: ++ typeof: integer ++ diff --git a/man/waybar-states.5.scd b/man/waybar-states.5.scd index ae2df1b..c1b7839 100644 --- a/man/waybar-states.5.scd +++ b/man/waybar-states.5.scd @@ -7,14 +7,13 @@ apply a class when the value matches the declared state value. # STATES -- Every entry (*state*) consists of a ** (typeof: *string*) and a ** (typeof: *integer*). +Every entry (*state*) consists of a ** (typeof: *string*) and a ** (typeof: *integer*). - - The state can be addressed as a CSS class in the *style.css*. The name of the CSS class is the ** of the state. - Each class gets activated when the current capacity is equal or below the configured **. +- The state can be addressed as a CSS class in the *style.css*. The name of the CSS class is the ** of the state. + Each class gets activated when the current value is equal to or less than the configured ** for the *battery* module, or equal to or greater than the configured ** for all other modules. - - Also each state can have its own *format*. - Those can be configured via *format-*. - Or if you want to differentiate a bit more even as *format--*. +- Also, each state can have its own *format*. + Those can be configured via *format-*, or if you want to differentiate a bit more, as *format--*. # EXAMPLE