From 2f6a70f34e9984b32b4ac9d9362b7031827215fb Mon Sep 17 00:00:00 2001 From: Moritz Jordan Date: Fri, 3 Jan 2020 15:46:59 +0100 Subject: [PATCH 1/5] man: document gtk-layer-shell configuration option --- man/waybar.5.scd | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/man/waybar.5.scd b/man/waybar.5.scd index 3278c636..72146359 100644 --- a/man/waybar.5.scd +++ b/man/waybar.5.scd @@ -66,6 +66,12 @@ Also a minimal example configuration can be found on the at the bottom of this m typeof: string ++ Optional name added as a CSS class, for styling multiple waybars. +*gtk-layer-shell* ++ + typeof: bool ++ + default: true ++ + Option to disable the use of gtk-layer-shell for popups. + Only functional if compiled with gtk-layer-shell support. + # MODULE FORMAT You can use PangoMarkupFormat (See https://developer.gnome.org/pango/stable/PangoMarkupFormat.html#PangoMarkupFormat). From f01ddb9ab39ced295aa5b612702537c83b6c5998 Mon Sep 17 00:00:00 2001 From: Moritz Jordan Date: Fri, 3 Jan 2020 15:50:05 +0100 Subject: [PATCH 2/5] man: clarify options for layer configuration --- man/waybar.5.scd | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/man/waybar.5.scd b/man/waybar.5.scd index 72146359..758d90a9 100644 --- a/man/waybar.5.scd +++ b/man/waybar.5.scd @@ -23,7 +23,8 @@ Also a minimal example configuration can be found on the at the bottom of this m *layer* ++ typeof: string ++ default: bottom ++ - Decide if the bar is displayed in front of the windows or behind them. + Decide if the bar is displayed in front (*top*) of the windows or behind (*bottom*) + them. *output* ++ typeof: string|array ++ From 4836333bffdaab998ace77730301e909de852ad4 Mon Sep 17 00:00:00 2001 From: Moritz Jordan Date: Sat, 4 Jan 2020 03:26:06 +0100 Subject: [PATCH 3/5] man: document family configuration option in network module --- man/waybar-network.5.scd | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/man/waybar-network.5.scd b/man/waybar-network.5.scd index ed8451f4..248b8b33 100644 --- a/man/waybar-network.5.scd +++ b/man/waybar-network.5.scd @@ -21,6 +21,11 @@ Addressed by *network* default: 60 ++ The interval in which the network information gets polled (e.g. signal strength). +*family*: ++ + typeof: string ++ + default: *ipv4* ++ + The address family that is used for the format replacement {ipaddr} and to determine if a network connection is present. + *format*: ++ typeof: string ++ default: *{ifname}* ++ From 173a7bb8cdd32e6e3d4d662d5bf7293ab24490f7 Mon Sep 17 00:00:00 2001 From: Moritz Jordan Date: Sat, 4 Jan 2020 04:31:24 +0100 Subject: [PATCH 4/5] man: fix layout in battery module --- man/waybar-battery.5.scd | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/man/waybar-battery.5.scd b/man/waybar-battery.5.scd index 94a99e4f..81ee22dd 100644 --- a/man/waybar-battery.5.scd +++ b/man/waybar-battery.5.scd @@ -37,32 +37,32 @@ The *battery* module displays the current capacity and state (eg. charging) of y default: {H} h {M} min ++ The format, how the time should be displayed. -*format-icons* - typeof: array/object +*format-icons*: ++ + typeof: array/object ++ Based on the current capacity, the corresponding icon gets selected. ++ The order is *low* to *high*. Or by the state if it is an object. -*max-length* ++ +*max-length*: ++ typeof: integer++ The maximum length in character the module should display. -*rotate* ++ +*rotate*: ++ typeof: integer++ Positive value to rotate the text label. -*on-click* ++ +*on-click*: ++ typeof: string ++ Command to execute when clicked on the module. -*on-click-right* ++ +*on-click-right*: ++ typeof: string ++ Command to execute when you right clicked on the module. -*on-scroll-up* ++ +*on-scroll-up*: ++ typeof: string ++ Command to execute when scrolling up on the module. -*on-scroll-down* ++ +*on-scroll-down*: ++ typeof: string ++ Command to execute when scrolling down on the module. From 1125119dc695d5daf1864f7fd5213bde5332997b Mon Sep 17 00:00:00 2001 From: Moritz Jordan Date: Sat, 4 Jan 2020 04:33:04 +0100 Subject: [PATCH 5/5] man: add icon and format-icon to network module --- man/waybar-network.5.scd | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/man/waybar-network.5.scd b/man/waybar-network.5.scd index 248b8b33..b06cbaed 100644 --- a/man/waybar-network.5.scd +++ b/man/waybar-network.5.scd @@ -47,6 +47,11 @@ Addressed by *network* typeof: string ++ This format is used when the displayed interface is disconnected. +*format-icons*: ++ + typeof: array/object ++ + Based on the current signal strength, the corresponding icon gets selected. ++ + The order is *low* to *high*. Or by the state if it is an object. + *rotate*: ++ typeof: integer ++ Positive value to rotate the text label. @@ -122,6 +127,8 @@ Addressed by *network* *{bandwidthDownOctets}*: Instant down speed in octets/seconds. +*{icon}*: Icon, as defined in *format-icons*. + # EXAMPLES ```