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%3Epull/2367/head
parent
88828265c0
commit
a3904ff039
|
@ -1,5 +1,4 @@
|
||||||
waybar-custom(5)
|
waybar-custom(5)
|
||||||
|
|
||||||
# NAME
|
# NAME
|
||||||
|
|
||||||
waybar - custom module
|
waybar - custom module
|
||||||
|
@ -19,14 +18,13 @@ Addressed by *custom/<name>*
|
||||||
|
|
||||||
*exec-if*: ++
|
*exec-if*: ++
|
||||||
typeof: string ++
|
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* will be executed if the exit code of *exec-if* equals 0.
|
||||||
|
|
||||||
*exec-on-event*: ++
|
*exec-on-event*: ++
|
||||||
typeof: bool ++
|
typeof: bool ++
|
||||||
default: true ++
|
default: true ++
|
||||||
If an event command is set (e.g. *on-click* or *on-scroll-up*) then re-execute the script after
|
If an event command is set (e.g. *on-click* or *on-scroll-up*) then re-execute the script after executing the event command.
|
||||||
executing the event command.
|
|
||||||
|
|
||||||
*return-type*: ++
|
*return-type*: ++
|
||||||
typeof: string ++
|
typeof: string ++
|
||||||
|
@ -34,20 +32,19 @@ Addressed by *custom/<name>*
|
||||||
|
|
||||||
*interval*: ++
|
*interval*: ++
|
||||||
typeof: integer ++
|
typeof: integer ++
|
||||||
The interval (in seconds) in which the information gets polled.
|
The interval (in seconds) in which the information gets polled. ++
|
||||||
Use *once* if you want to execute the module only on startup.
|
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,
|
You can update it manually with a signal. If no *interval* is defined, it is assumed that the out script loops it self.
|
||||||
it is assumed that the out script loops it self.
|
|
||||||
|
|
||||||
*restart-interval*: ++
|
*restart-interval*: ++
|
||||||
typeof: integer ++
|
typeof: integer ++
|
||||||
The restart interval (in seconds).
|
The restart interval (in seconds). ++
|
||||||
Can't be used with the *interval* option, so only with continuous scripts.
|
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*.
|
Once the script exit, it'll be re-executed after the *restart-interval*.
|
||||||
|
|
||||||
*signal*: ++
|
*signal*: ++
|
||||||
typeof: integer ++
|
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*.
|
The number is valid between 1 and N, where *SIGRTMIN+N* = *SIGRTMAX*.
|
||||||
|
|
||||||
*format*: ++
|
*format*: ++
|
||||||
|
|
|
@ -13,24 +13,26 @@ The *image* module displays an image from a path.
|
||||||
*path*: ++
|
*path*: ++
|
||||||
typeof: string ++
|
typeof: string ++
|
||||||
The path to the image.
|
The path to the image.
|
||||||
|
|
||||||
*exec*: ++
|
*exec*: ++
|
||||||
typeof: string ++
|
typeof: string ++
|
||||||
The path to the script, which should return image path file
|
The path to the script, which should return image path file. ++
|
||||||
it will only execute if the path is not set
|
It will only execute if the path is not set
|
||||||
|
|
||||||
*size*: ++
|
*size*: ++
|
||||||
typeof: integer ++
|
typeof: integer ++
|
||||||
The width/height to render the image.
|
The width/height to render the image.
|
||||||
|
|
||||||
*interval*: ++
|
*interval*: ++
|
||||||
typeof: integer ++
|
typeof: integer ++
|
||||||
The interval (in seconds) to re-render the image.
|
The interval (in seconds) to re-render the image. ++
|
||||||
This is useful if the contents of *path* changes.
|
This is useful if the contents of *path* changes. ++
|
||||||
If no *interval* is defined, the image will only be rendered once.
|
If no *interval* is defined, the image will only be rendered once.
|
||||||
|
|
||||||
*signal*: ++
|
*signal*: ++
|
||||||
typeof: integer ++
|
typeof: integer ++
|
||||||
The signal number used to update the module.
|
The signal number used to update the module. ++
|
||||||
This can be used instead of *interval* if the file changes irregularly.
|
This can be used instead of *interval* if the file changes irregularly. ++
|
||||||
The number is valid between 1 and N, where *SIGRTMIN+N* = *SIGRTMAX*.
|
The number is valid between 1 and N, where *SIGRTMIN+N* = *SIGRTMAX*.
|
||||||
|
|
||||||
*on-click*: ++
|
*on-click*: ++
|
||||||
|
|
|
@ -13,8 +13,7 @@ The *mpris* module displays currently playing media via libplayerctl.
|
||||||
*player*: ++
|
*player*: ++
|
||||||
typeof: string ++
|
typeof: string ++
|
||||||
default: playerctld ++
|
default: playerctld ++
|
||||||
Name of the MPRIS player to attach to. Using the default value always
|
Name of the MPRIS player to attach to. Using the default value always follows the currenly active player.
|
||||||
follows the currenly active player.
|
|
||||||
|
|
||||||
*ignored-players*: ++
|
*ignored-players*: ++
|
||||||
typeof: []string ++
|
typeof: []string ++
|
||||||
|
@ -49,18 +48,15 @@ The *mpris* module displays currently playing media via libplayerctl.
|
||||||
|
|
||||||
*artist-len*: ++
|
*artist-len*: ++
|
||||||
typeof: integer ++
|
typeof: integer ++
|
||||||
Maximum length of the Artist tag (Wide/Fullwidth Unicode characters
|
Maximum length of the Artist tag (Wide/Fullwidth Unicode characters count as two). Set to zero to hide the artist in `{dynamic}` tag.
|
||||||
count as two). Set to zero to hide the artist in `{dynamic}` tag.
|
|
||||||
|
|
||||||
*album-len*: ++
|
*album-len*: ++
|
||||||
typeof: integer ++
|
typeof: integer ++
|
||||||
Maximum length of the Album tag (Wide/Fullwidth Unicode characters count
|
Maximum length of the Album tag (Wide/Fullwidth Unicode characters count as two). Set to zero to hide the album in `{dynamic}` tag.
|
||||||
as two). Set to zero to hide the album in `{dynamic}` tag.
|
|
||||||
|
|
||||||
*title-len*: ++
|
*title-len*: ++
|
||||||
typeof: integer ++
|
typeof: integer ++
|
||||||
Maximum length of the Title tag (Wide/Fullwidth Unicode characters count
|
Maximum length of the Title tag (Wide/Fullwidth Unicode characters count as two). Set to zero to hide the title in `{dynamic}` tag.
|
||||||
as two). Set to zero to hide the title in `{dynamic}` tag.
|
|
||||||
|
|
||||||
*dynamic-len*: ++
|
*dynamic-len*: ++
|
||||||
typeof: integer ++
|
typeof: integer ++
|
||||||
|
@ -101,14 +97,12 @@ The *mpris* module displays currently playing media via libplayerctl.
|
||||||
*enable-tooltip-len-limits*: ++
|
*enable-tooltip-len-limits*: ++
|
||||||
typeof: bool ++
|
typeof: bool ++
|
||||||
default: false ++
|
default: false ++
|
||||||
Option to enable the length limits for the tooltip as well. By default
|
Option to enable the length limits for the tooltip as well. By default the tooltip ignores all length limits.
|
||||||
the tooltip ignores all length limits.
|
|
||||||
|
|
||||||
*ellipsis*: ++
|
*ellipsis*: ++
|
||||||
typeof: string ++
|
typeof: string ++
|
||||||
default: "…" ++
|
default: "…" ++
|
||||||
This character will be used when any of the tags exceed their maximum
|
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.
|
||||||
length. If you don't want to use an ellipsis, set this to empty string.
|
|
||||||
|
|
||||||
*rotate*: ++
|
*rotate*: ++
|
||||||
typeof: integer ++
|
typeof: integer ++
|
||||||
|
@ -124,7 +118,7 @@ The *mpris* module displays currently playing media via libplayerctl.
|
||||||
|
|
||||||
*align*: ++
|
*align*: ++
|
||||||
typeof: float ++
|
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.
|
If the module is rotated, it will follow the flow of the text.
|
||||||
|
|
||||||
*on-click*: ++
|
*on-click*: ++
|
||||||
|
@ -148,8 +142,7 @@ The *mpris* module displays currently playing media via libplayerctl.
|
||||||
|
|
||||||
*status-icons*: ++
|
*status-icons*: ++
|
||||||
typeof: map[string]string ++
|
typeof: map[string]string ++
|
||||||
Allows setting _{status-icon}_ based on player status (playing, paused,
|
Allows setting _{status-icon}_ based on player status (playing, paused, stopped).
|
||||||
stopped).
|
|
||||||
|
|
||||||
|
|
||||||
# FORMAT REPLACEMENTS
|
# FORMAT REPLACEMENTS
|
||||||
|
|
|
@ -58,12 +58,12 @@ cursor is over the module, and clicking on the module toggles mute.
|
||||||
|
|
||||||
*on-scroll-up*: ++
|
*on-scroll-up*: ++
|
||||||
typeof: string ++
|
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.
|
This replaces the default behaviour of volume control.
|
||||||
|
|
||||||
*on-scroll-down*: ++
|
*on-scroll-down*: ++
|
||||||
typeof: string ++
|
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.
|
This replaces the default behaviour of volume control.
|
||||||
|
|
||||||
*smooth-scrolling-threshold*: ++
|
*smooth-scrolling-threshold*: ++
|
||||||
|
|
|
@ -6,7 +6,7 @@ waybar - tray module
|
||||||
|
|
||||||
# DESCRIPTION
|
# 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
|
# CONFIGURATION
|
||||||
|
|
||||||
|
|
|
@ -29,9 +29,8 @@ Addressed by *wlr/workspaces*
|
||||||
*sort-by-coordinates*: ++
|
*sort-by-coordinates*: ++
|
||||||
typeof: bool ++
|
typeof: bool ++
|
||||||
default: true ++
|
default: true ++
|
||||||
Should workspaces be sorted by coordinates.
|
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.
|
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.
|
||||||
If both are false - sort by id will be performed.
|
|
||||||
|
|
||||||
*sort-by-number*: ++
|
*sort-by-number*: ++
|
||||||
typeof: bool ++
|
typeof: bool ++
|
||||||
|
|
Loading…
Reference in New Issue