Merge branch 'master' into output-exclusion

man/waybar-backlight.5.scd

@@ -10,29 +10,29 @@ The *backlight* module displays the current backlight level.
 
 # CONFIGURATION
 
-*interval* ++
+*interval*: ++
 	typeof: integer ++
 	default: 2 ++
 	The interval in which information gets polled.
 
-*format* ++
+*format*: ++
 	typeof: string ++
 	default: {percent}% ++
 	The format, how information should be displayed. On {} data gets inserted.
 
-*max-length* ++
+*max-length*: ++
 	typeof: integer ++
 	The maximum length in characters the module should display.
 
-*rotate* ++
+*rotate*: ++
 	typeof: integer ++
 	Positive value to rotate the text label.
 
-*states* ++
+*states*: ++
 	typeof: array ++
 	A number of backlight states which get activated on certain brightness levels.
 
-*on-click* ++
+*on-click*: ++
 	typeof: string ++
 	Command to execute when the module is clicked.
 
@@ -40,19 +40,23 @@ The *backlight* module displays the current backlight level.
 	typeof: string ++
 	Command to execute when middle-clicked on the module using mousewheel.
 
-*on-click-right* ++
+*on-click-right*: ++
 	typeof: string ++
 	Command to execute when the module is right clicked.
 
-*on-scroll-up* ++
+*on-update*: ++
+	typeof: string ++
+	Command to execute when the module is updated.
+
+*on-scroll-up*: ++
 	typeof: string ++
 	Command to execute when performing a scroll up on the module.
 
-*on-scroll-down* ++
+*on-scroll-down*: ++
 	typeof: string
 	Command to execute when performing a scroll down on the module.
 
-*smooth-scrolling-threshold* ++
+*smooth-scrolling-threshold*: ++
 	typeof: double
 	Threshold to be used when scrolling.
 

man/waybar-battery.5.scd

@@ -10,29 +10,33 @@ The *battery* module displays the current capacity and state (eg. charging) of y
 
 # CONFIGURATION
 
-*bat* ++
+*bat*: ++
 	typeof: string ++
 	The battery to monitor, as in /sys/class/power_supply/ instead of auto detect.
 
-*adapter* ++
+*adapter*: ++
 	typeof: string ++
 	The adapter to monitor, as in /sys/class/power_supply/ instead of auto detect.
 
-*interval* ++
+*full-at*: ++
+	typeof: integer ++
+	Define the max percentage of the battery, usefull for an old battery, e.g. 96
+
+*interval*: ++
 	typeof: integer ++
 	default: 60 ++
 	The interval in which the information gets polled.
 
-*states* ++
+*states*: ++
 	typeof: array ++
 	A number of battery states which get activated on certain capacity levels. See *waybar-states(5)*.
 
-*format* ++
+*format*: ++
 	typeof: string ++
 	default: {capacity}% ++
 	The format, how the time should be displayed.
 
-*format-time* ++
+*format-time*: ++
 	typeof: string ++
 	default: {H} h {M} min ++
 	The format, how the time should be displayed.
@@ -58,10 +62,14 @@ The *battery* module displays the current capacity and state (eg. charging) of y
 	typeof: string ++
 	Command to execute when middle-clicked on the module using mousewheel.
 
-*on-click-right* ++
+*on-click-right*: ++
 	typeof: string ++
 	Command to execute when you right clicked on the module.
 
+*on-update*: ++
+	typeof: string ++
+	Command to execute when the module is updated.
+
 *on-scroll-up*: ++
 	typeof: string ++
 	Command to execute when scrolling up on the module.
@@ -70,11 +78,11 @@ The *battery* module displays the current capacity and state (eg. charging) of y
 	typeof: string ++
 	Command to execute when scrolling down on the module.
 
-*smooth-scrolling-threshold* ++
+*smooth-scrolling-threshold*: ++
 	typeof: double ++
 	Threshold to be used when scrolling.
 
-*tooltip* ++
+*tooltip*: ++
 	typeof: bool ++
 	default: true ++
 	Option to disable tooltip on hover.

man/waybar-bluetooth.5.scd

@@ -0,0 +1,94 @@
+waybar-bluetooth(5)
+
+# NAME
+
+waybar - bluetooth module
+
+# DESCRIPTION
+
+The *bluetooth* module displays information about the status of the device's bluetooth device.
+
+# CONFIGURATION
+
+Addressed by *bluetooth*
+
+*interval*: ++
+	typeof: integer ++
+	default: 60 ++
+	The interval in which the bluetooth state gets updated.
+
+*format*: ++
+	typeof: string  ++
+	default: *{icon}* ++
+	The format, how information should be displayed. This format is used when other formats aren't specified.
+
+*format-icons*: ++
+	typeof: array/object ++
+	Based on the device status, 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.
+
+*max-length*: ++
+	typeof: integer ++
+	The maximum length in character the module should display.
+
+*on-click*: ++
+	typeof: string ++
+	Command to execute when clicked on the module.
+
+*on-click-middle*: ++
+	typeof: string ++
+	Command to execute when middle-clicked on the module using mousewheel.
+
+*on-click-right*: ++
+	typeof: string ++
+	Command to execute when you right clicked on the module.
+
+*on-scroll-up*: ++
+	typeof: string ++
+	Command to execute when scrolling up on the module.
+
+*on-scroll-down*: ++
+	typeof: string ++
+	Command to execute when scrolling down on the module.
+
+*smooth-scrolling-threshold*: ++
+	typeof: double ++
+	Threshold to be used when scrolling.
+
+*tooltip*: ++
+	typeof: bool ++
+	default: *true* ++
+	Option to disable tooltip on hover.
+
+*tooltip-format*: ++
+	typeof: string ++
+	The format, how information should be displayed in the tooltip. This format is used when other formats aren't specified.
+
+# FORMAT REPLACEMENTS
+
+*{status}*: Status of the bluetooth device.
+
+*{icon}*: Icon, as defined in *format-icons*.
+
+# EXAMPLES
+
+```
+"bluetooth": {
+	"format": "{icon}",
+	"format-alt": "bluetooth: {status}",
+	"interval": 30,
+	"format-icons": {
+		"enabled": "",
+		"disabled": ""
+	}
+	"tooltip-format": "{status}"
+}
+```
+
+# STYLE
+
+- *#bluetooth*

man/waybar-clock.5.scd

@@ -51,6 +51,10 @@ The *clock* module displays the current date and time.
 	typeof: string ++
 	Command to execute when you right clicked on the module.
 
+*on-update*: ++
+	typeof: string ++
+	Command to execute when the module is updated.
+
 *on-scroll-up*: ++
 	typeof: string ++
 	Command to execute when scrolling up on the module.

man/waybar-cpu.5.scd

@@ -44,6 +44,10 @@ The *cpu* module displays the current cpu utilization.
 	typeof: string ++
 	Command to execute when you right clicked on the module.
 
+*on-update*: ++
+	typeof: string ++
+	Command to execute when the module is updated.
+
 *on-scroll-up*: ++
 	typeof: string ++
 	Command to execute when scrolling up on the module.

man/waybar-custom.5.scd

@@ -33,6 +33,12 @@ Addressed by *custom/<name>*
 	You can update it manually with a signal. If no *interval* is defined,
 	it is assumed that the out script loops it self.
 
+*restart-interval*: ++
+	typeof: integer ++
+	The restart interval (in seconds).
+	Can't be used with the *interval* option, so only with continuous scripts.
+	Once the script exit, it'll be re-executed after the *restart-interval*.
+
 *signal*: ++
 	typeof: integer ++
 	The signal number used to update the module.
@@ -67,6 +73,10 @@ Addressed by *custom/<name>*
 	typeof: string ++
 	Command to execute when you right clicked on the module.
 
+*on-update*: ++
+	typeof: string ++
+	Command to execute when the module is updated.
+
 *on-scroll-up*: ++
 	typeof: string ++
 	Command to execute when scrolling up on the module.

man/waybar-disk.5.scd

@@ -47,6 +47,10 @@ Addressed by *disk*
 	typeof: string ++
 	Command to execute when you right clicked on the module.
 
+*on-update*: ++
+	typeof: string ++
+	Command to execute when the module is updated.
+
 *on-scroll-up*: ++
 	typeof: string ++
 	Command to execute when scrolling up on the module.

man/waybar-idle-inhibitor.5.scd

@@ -39,6 +39,10 @@ screensaving, also known as "presentation mode".
 	typeof: string ++
 	Command to execute when you right clicked on the module.
 
+*on-update*: ++
+	typeof: string ++
+	Command to execute when the module is updated.
+
 *on-scroll-up*: ++
 	typeof: string ++
 	Command to execute when scrolling up on the module.

man/waybar-memory.5.scd

@@ -46,6 +46,10 @@ Addressed by *memory*
 	typeof: string ++
 	Command to execute when you right clicked on the module.
 
+*on-update*: ++
+	typeof: string ++
+	Command to execute when the module is updated.
+
 *on-scroll-up*: ++
 	typeof: string ++
 	Command to execute when scrolling up on the module.

man/waybar-mpd.5.scd

@@ -89,6 +89,10 @@ Addressed by *mpd*
 	typeof: string ++
 	Command to execute when you right clicked on the module.
 
+*on-update*: ++
+	typeof: string ++
+	Command to execute when the module is updated.
+
 *on-scroll-up*: ++
 	typeof: string ++
 	Command to execute when scrolling up on the module.

man/waybar-network.5.scd

@@ -47,6 +47,10 @@ Addressed by *network*
 	typeof: string ++
 	This format is used when the displayed interface is disconnected.
 
+*format-disabled*: ++
+	typeof: string ++
+	This format is used when the displayed interface is disabled.
+
 *format-icons*: ++
 	typeof: array/object ++
 	Based on the current signal strength, the corresponding icon gets selected. ++
@@ -72,6 +76,10 @@ Addressed by *network*
 	typeof: string ++
 	Command to execute when you right clicked on the module.
 
+*on-update*: ++
+	typeof: string ++
+	Command to execute when the module is updated.
+
 *on-scroll-up*: ++
 	typeof: string ++
 	Command to execute when scrolling up on the module.
@@ -105,6 +113,10 @@ Addressed by *network*
 	typeof: string ++
 	This format is used when the displayed interface is disconnected.
 
+*tooltip-format-disabled*: ++
+	typeof: string ++
+	This format is used when the displayed interface is disabled.
+
 # FORMAT REPLACEMENTS
 
 *{ifname}*: Name of the network interface.
@@ -142,6 +154,7 @@ Addressed by *network*
 	"format-wifi": "{essid} ({signalStrength}%) ",
 	"format-ethernet": "{ifname} ",
 	"format-disconnected": "", //An empty format will hide the module.
+	"format-disconnected": "",
 	"tooltip-format": "{ifname}",
 	"tooltip-format-wifi": "{essid} ({signalStrength}%) ",
 	"tooltip-format-ethernet": "{ifname} ",
@@ -154,6 +167,7 @@ Addressed by *network*
 
 - *#network*
 - *#network.disconnected*
+- *#network.disabled*
 - *#network.linked*
 - *#network.ethernet*
 - *#network.wifi*

man/waybar-pulseaudio.5.scd

@@ -67,6 +67,10 @@ Additionally you can control the volume by scrolling *up* or *down* while the cu
 	typeof: string ++
 	Command to execute when you right clicked on the module.
 
+*on-update*: ++
+	typeof: string ++
+	Command to execute when the module is updated.
+
 *on-scroll-up*: ++
 	typeof: string ++
 	Command to execute when scrolling up on the module. This replaces the default behaviour of volume control.

man/waybar-sway-mode.5.scd

@@ -37,6 +37,10 @@ Addressed by *sway/mode*
 	typeof: string ++
 	Command to execute when you right clicked on the module.
 
+*on-update*: ++
+	typeof: string ++
+	Command to execute when the module is updated.
+
 *on-scroll-up*: ++
 	typeof: string ++
 	Command to execute when scrolling up on the module.

man/waybar-sway-window.5.scd

@@ -37,6 +37,10 @@ Addressed by *sway/window*
 	typeof: string ++
 	Command to execute when you right clicked on the module.
 
+*on-update*: ++
+	typeof: string ++
+	Command to execute when the module is updated.
+
 *on-scroll-up*: ++
 	typeof: string ++
 	Command to execute when scrolling up on the module.

man/waybar-sway-workspaces.5.scd

@@ -19,7 +19,7 @@ Addressed by *sway/workspaces*
 
 *format*: ++
     typeof: string ++
-    default: {name} ++
+    default: {value} ++
     The format, how information should be displayed.
 
 *format-icons*: ++
@@ -60,9 +60,15 @@ Addressed by *sway/workspaces*
     default: empty ++
     Lists workspaces that should always be shown, even when non existent
 
+*on-update*: ++
+	typeof: string ++
+	Command to execute when the module is updated.
+
 # FORMAT REPLACEMENTS
 
-*{name}*: Name of the workspace, as defined by sway.
+*{value}*: Name of the workspace, as defined by sway.
+
+*{name}*: Number stripped from workspace value.
 
 *{icon}*: Icon, as defined in *format-icons*.
 
@@ -75,6 +81,7 @@ Additional to workspace name matching, the following *format-icons* can be set.
 - *default*: Will be shown, when no string matches is found.
 - *urgent*: Will be shown, when workspace is flagged as urgent
 - *focused*: Will be shown, when workspace is focused
+- *persistent*: Will be shown, when workspace is persistent one.
 
 # PERSISTENT WORKSPACES
 

man/waybar-temperature.5.scd

@@ -20,6 +20,14 @@ Addressed by *temperature*
 	typeof: string ++
 	The temperature path to use, e.g. */sys/class/hwmon/hwmon2/temp1_input* instead of one in */sys/class/thermal/*.
 
+*hwmon-path-abs*: ++
+	typeof: string ++
+	The path of the hwmon-directory of the device, e.g. */sys/devices/pci0000:00/0000:00:18.3/hwmon*. (Note that the subdirectory *hwmon/hwmon#*, where *#* is a number is not part of the path!) Has to be used together with *input-filename*.
+
+*input-filename*: ++
+	typeof: string ++
+	The temperature filename of your *hwmon-path-abs*, e.g. *temp1_input*
+
 *critical-threshold*: ++
 	typeof: integer ++
 	The threshold before it is considered critical (Celsius).
@@ -62,6 +70,10 @@ Addressed by *temperature*
 	typeof: string ++
 	Command to execute when you right clicked on the module.
 
+*on-update*: ++
+	typeof: string ++
+	Command to execute when the module is updated.
+
 *on-scroll-up*: ++
 	typeof: string ++
 	Command to execute when scrolling up on the module.

man/waybar-tray.5.scd

@@ -20,6 +20,10 @@ Addressed by *tray*
     typeof: integer ++
     Defines the spacing between the tray icons.
 
+*on-update*: ++
+	typeof: string ++
+	Command to execute when the module is updated.
+
 # EXAMPLES
 
 ```