man: Fix several whitespace formatting issues

Fix the following whitespace formatting issues: - Indentation in scdoc source files should be done with tabs. - Lines where there (clearly) should be a line break, need to have '++' at the end, but several were missing them. - The scdoc manual (clearly) states that lines should be hard wrapped at 80 columns, but when line(s) are indented, that causes rendering issues. So lines where a line break was not clearly intended or clearly not intended, have been put onto 1 line to circumvent the rendering issue. Link: https://lists.sr.ht/~sircmpwn/public-inbox/%3C8251560.T7Z3S40VBb%40bagend%3E
2023-12-21 10:22:59 +01:00 · 2023-07-30 17:33:02 +02:00 · 2023-07-30 17:33:02 +02:00 · a3904ff039
commit a3904ff039
parent 88828265c0
36 changed files with 421 additions and 430 deletions
--- a/man/waybar-battery.5.scd
+++ b/man/waybar-battery.5.scd
@ -132,8 +132,8 @@ The *battery* module allows one to define custom formats based on up to two fact
 # STATES

 - 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.	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>*. For more information see *custom-formats*.
+- 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>*. For more information see *custom-formats*.



--- a/man/waybar-cava.5.scd
+++ b/man/waybar-cava.5.scd
@ -158,10 +158,10 @@ In case when cava releases new version and you're wanna get it, it should be rai

 ```
 "cava": {
-//        "cava_config": "$XDG_CONFIG_HOME/cava/cava.conf",
+	//"cava_config": "$XDG_CONFIG_HOME/cava/cava.conf",
 	"framerate": 30,
 	"autosens": 1,
-//        "sensitivity": 100,
+	//"sensitivity": 100,
 	"bars": 14,
 	"lower_cutoff_freq": 50,
 	"higher_cutoff_freq": 10000,
@ -178,5 +178,5 @@ In case when cava releases new version and you're wanna get it, it should be rai
 	"actions": {
 		"on-click-right": "mode"
 	}
-    },
+},
 ```
--- a/man/waybar-clock.5.scd
+++ b/man/waybar-clock.5.scd
@ -262,7 +262,7 @@ Example of working config
 		"on-scroll-up": "shift_up",
 		"on-scroll-down": "shift_down"
 	}
-    },
+},
 ```

 # AUTHOR
--- a/man/waybar-custom.5.scd
+++ b/man/waybar-custom.5.scd
@ -1,5 +1,4 @@
 waybar-custom(5)
-
 # NAME

 waybar - custom module
@ -19,14 +18,13 @@ Addressed by *custom/<name>*

 *exec-if*: ++
 	typeof: string ++
-	The path to a script, which determines if the script in *exec* should be executed.
+	The path to a script, which determines if the script in *exec* should be executed. ++
 	*exec* will be executed if the exit code of *exec-if* equals 0.

 *exec-on-event*: ++
 	typeof: bool ++
 	default: true ++
-	If an event command is set (e.g. *on-click* or *on-scroll-up*) then re-execute the script after
-	executing the event command.
+	If an event command is set (e.g. *on-click* or *on-scroll-up*) then re-execute the script after executing the event command.

 *return-type*: ++
 	typeof: string ++
@ -34,20 +32,19 @@ Addressed by *custom/<name>*

 *interval*: ++
 	typeof: integer ++
-	The interval (in seconds) in which the information gets polled.
-	Use *once* if you want to execute the module only on startup.
-	You can update it manually with a signal. If no *interval* is defined,
-	it is assumed that the out script loops it self.
+	The interval (in seconds) in which the information gets polled. ++
+	Use *once* if you want to execute the module only on startup. ++
+	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.
+	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.
+	The signal number used to update the module. ++
 	The number is valid between 1 and N, where *SIGRTMIN+N* = *SIGRTMAX*.

 *format*: ++
--- a/man/waybar-image.5.scd
+++ b/man/waybar-image.5.scd
@ -13,24 +13,26 @@ The *image* module displays an image from a path.
 *path*: ++
 	typeof: string ++
 	The path to the image.
+
 *exec*: ++
 	typeof: string ++
-	The path to the script, which should return image path file
-	it will only execute if the path is not set
+	The path to the script, which should return image path file. ++
+	It will only execute if the path is not set
+
 *size*: ++
 	typeof: integer ++
 	The width/height to render the image.

 *interval*: ++
 	typeof: integer ++
-	The interval (in seconds) to re-render the image.
-	This is useful if the contents of *path* changes.
+	The interval (in seconds) to re-render the image. ++
+	This is useful if the contents of *path* changes. ++
 	If no *interval* is defined, the image will only be rendered once.

 *signal*: ++
 	typeof: integer ++
-	The signal number used to update the module.
-	This can be used instead of *interval* if the file changes irregularly.
+	The signal number used to update the module. ++
+	This can be used instead of *interval* if the file changes irregularly. ++
 	The number is valid between 1 and N, where *SIGRTMIN+N* = *SIGRTMAX*.

 *on-click*: ++
--- a/man/waybar-mpris.5.scd
+++ b/man/waybar-mpris.5.scd
@ -13,8 +13,7 @@ The *mpris* module displays currently playing media via libplayerctl.
 *player*: ++
 	typeof: string ++
 	default: playerctld ++
-	Name of the MPRIS player to attach to. Using the default value always
-	follows the currenly active player.
+	Name of the MPRIS player to attach to. Using the default value always follows the currenly active player.

 *ignored-players*: ++
 	typeof: []string ++
@ -49,18 +48,15 @@ The *mpris* module displays currently playing media via libplayerctl.

 *artist-len*: ++
 	typeof: integer ++
-	Maximum length of the Artist tag (Wide/Fullwidth Unicode characters
-	count as two). Set to zero to hide the artist in `{dynamic}` tag.
+	Maximum length of the Artist tag (Wide/Fullwidth Unicode characters count as two). Set to zero to hide the artist in `{dynamic}` tag.

 *album-len*: ++
 	typeof: integer ++
-	Maximum length of the Album tag (Wide/Fullwidth Unicode characters count
-	as two). Set to zero to hide the album in `{dynamic}` tag.
+	Maximum length of the Album tag (Wide/Fullwidth Unicode characters count as two). Set to zero to hide the album in `{dynamic}` tag.

 *title-len*: ++
 	typeof: integer ++
-	Maximum length of the Title tag (Wide/Fullwidth Unicode characters count
-	as two). Set to zero to hide the title in `{dynamic}` tag.
+	Maximum length of the Title tag (Wide/Fullwidth Unicode characters count as two). Set to zero to hide the title in `{dynamic}` tag.

 *dynamic-len*: ++
 	typeof: integer ++
@ -101,14 +97,12 @@ The *mpris* module displays currently playing media via libplayerctl.
 *enable-tooltip-len-limits*: ++
 	typeof: bool ++
 	default: false ++
-	Option to enable the length limits for the tooltip as well. By default
-	the tooltip ignores all length limits.
+	Option to enable the length limits for the tooltip as well. By default the tooltip ignores all length limits.

 *ellipsis*: ++
 	typeof: string ++
 	default: "…" ++
-	This character will be used when any of the tags exceed their maximum
-	length. If you don't want to use an ellipsis, set this to empty string.
+	This character will be used when any of the tags exceed their maximum length. If you don't want to use an ellipsis, set this to empty string.

 *rotate*: ++
 	typeof: integer ++
@ -124,7 +118,7 @@ The *mpris* module displays currently playing media via libplayerctl.

 *align*: ++
 	typeof: float ++
-	The alignment of the text, where 0 is left-aligned and 1 is right-aligned.
+	The alignment of the text, where 0 is left-aligned and 1 is right-aligned. ++
 	If the module is rotated, it will follow the flow of the text.

 *on-click*: ++
@ -148,8 +142,7 @@ The *mpris* module displays currently playing media via libplayerctl.

 *status-icons*: ++
 	typeof: map[string]string ++
-	Allows setting _{status-icon}_ based on player status (playing, paused,
-	stopped).
+	Allows setting _{status-icon}_ based on player status (playing, paused, stopped).


 # FORMAT REPLACEMENTS
--- a/man/waybar-sndio.5.scd
+++ b/man/waybar-sndio.5.scd
@ -58,12 +58,12 @@ cursor is over the module, and clicking on the module toggles mute.

 *on-scroll-up*: ++
 	typeof: string ++
-	Command to execute when scrolling up on the module.
+	Command to execute when scrolling up on the module. ++
 	This replaces the default behaviour of volume control.

 *on-scroll-down*: ++
 	typeof: string ++
-	Command to execute when scrolling down on the module.
+	Command to execute when scrolling down on the module. ++
 	This replaces the default behaviour of volume control.

 *smooth-scrolling-threshold*: ++
--- a/man/waybar-tray.5.scd
+++ b/man/waybar-tray.5.scd
@ -6,7 +6,7 @@ waybar - tray module

 # DESCRIPTION

-_WARNING_ *tray* is still in beta. There may me bugs. Breaking changes may occur.
+_WARNING_ *tray* is still in beta. There may be bugs. Breaking changes may occur.

 # CONFIGURATION

--- a/man/waybar-wlr-workspaces.5.scd
+++ b/man/waybar-wlr-workspaces.5.scd
@ -29,9 +29,8 @@ Addressed by *wlr/workspaces*
 *sort-by-coordinates*: ++
 	typeof: bool ++
 	default: true ++
-	Should workspaces be sorted by coordinates.
-	Note that if both  *sort-by-name* and *sort-by-coordinates* are true sort by name will be first.
-	If both are false - sort by id will be performed.
+	Should workspaces be sorted by coordinates. ++
+	Note that if both  *sort-by-name* and *sort-by-coordinates* are true sort by name will be first. If both are false - sort by id will be performed.

 *sort-by-number*: ++
 	typeof: bool ++