RPJosh
/
Waybar
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: fix typos and improve language coherence

pull/2593/head
Avishek Sen 2023-10-21 21:15:25 +05:30
parent dbb887b4a9
commit d0cab2a367
No known key found for this signature in database
GPG Key ID: 80311095B2F76EF0
37 changed files with 144 additions and 144 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
man/waybar-backlight-slider.5.scd
View File

@ -8,7 +8,7 @@ waybar - backlight slider module
The *backlight slider* module displays and controls the current brightness of the default or preferred device.
The brightness can be controlled by dragging the slider accross the bar, or clicking on a specific position.
The brightness can be controlled by dragging the slider across the bar or clicking on a specific position.
# CONFIGURATION

8
man/waybar-backlight.5.scd
View File

@ -26,7 +26,7 @@ The *backlight* module displays the current backlight level.
*min-length*: ++
typeof: integer ++
The minimum length in characters the module should take up.
The minimum length in characters the module should accept.
*align*: ++
typeof: float ++
@ -46,11 +46,11 @@ The *backlight* module displays the current backlight level.
*on-click-middle*: ++
typeof: string ++
Command to execute when middle-clicked on the module using mousewheel.
Command to execute when middle-clicked on the module using mouse scroll wheel.
*on-click-right*: ++
typeof: string ++
Command to execute when the module is right clicked.
Command to execute when the module is right-clicked.
*on-update*: ++
typeof: string ++
@ -75,7 +75,7 @@ The *backlight* module displays the current backlight level.
*scroll-step*: ++
typeof: float ++
default: 1.0 ++
The speed in which to change the brightness when scrolling.
The speed at which to change the brightness when scrolling.
# EXAMPLE:

12
man/waybar-battery.5.scd
View File

@ -25,7 +25,7 @@ The *battery* module displays the current capacity and state (eg. charging) of y
*design-capacity*: ++
typeof: bool ++
default: false ++
Option to use the battery design capacity instead of it's current maximal capacity.
Option to use the battery design capacity instead of its current maximal capacity.
*interval*: ++
typeof: integer ++
@ -57,7 +57,7 @@ The *battery* module displays the current capacity and state (eg. charging) of y
*min-length*: ++
typeof: integer ++
The minimum length in characters the module should take up.
The minimum length in characters the module should accept.
*align*: ++
typeof: float ++
@ -77,7 +77,7 @@ The *battery* module displays the current capacity and state (eg. charging) of y
*on-click-right*: ++
typeof: string ++
Command to execute when you right clicked on the module.
Command to execute when you right-click on the module.
*on-update*: ++
typeof: string ++
@ -126,7 +126,7 @@ The three arguments are:
# CUSTOM FORMATS
The *battery* module allows one to define custom formats based on up to two factors. The best fitting format will be selected.
The *battery* module allows one to define custom formats based on up to two factors. The best-fitting format will be selected.
*format-<state>*: With *states*, a custom format can be set depending on the capacity of your battery.
@ -137,8 +137,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 to or below the configured *<value>*.
- Also each state can have its own *format*. Those can 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*.

12
man/waybar-bluetooth.5.scd
View File

@ -14,7 +14,7 @@ Addressed by *bluetooth*
*controller*: ++
typeof: string ++
Use the controller with the defined alias. Otherwise a random controller is used. Recommended to define when there is more than 1 controller available to the system.
Use the controller with the defined alias. Otherwise, a random controller is used. Recommended to define when there is more than 1 controller available to the system.
*format-device-preference*: ++
typeof: array ++
@ -44,7 +44,7 @@ Addressed by *bluetooth*
*format-no-controller*: ++
typeof: string ++
This format is used when no bluetooth controller could be found
This format is used when no bluetooth controller can be found
*format-icons*: ++
typeof: array/object ++
@ -62,7 +62,7 @@ Addressed by *bluetooth*
*min-length*: ++
typeof: integer ++
The minimum length in characters the module should take up.
The minimum length in characters the module should accept.
*align*: ++
typeof: float ++
@ -78,7 +78,7 @@ Addressed by *bluetooth*
*on-click-right*: ++
typeof: string ++
Command to execute when you right clicked on the module.
Command to execute when you right-click on the module.
*on-scroll-up*: ++
typeof: string ++
@ -119,7 +119,7 @@ Addressed by *bluetooth*
*tooltip-format-no-controller*: ++
typeof: string ++
This format is used when no bluetooth controller could be found
This format is used when no bluetooth controller can be found
*tooltip-format-enumerate-connected*: ++
typeof: string ++
@ -146,7 +146,7 @@ Addressed by *bluetooth*
*{device_alias}*: Alias of the displayed device.
*{device_enumerate}*: Show a list of all connected devices, each on a separate line. Define the format of each device with the *tooltip-format-enumerate-connected* ++
and/or *tooltip-format-enumerate-connected-battery* config options. Can only be used in the tooltip related format options.
and/or *tooltip-format-enumerate-connected-battery* config options. Can only be used in the tooltip-related format options.
# EXPERIMENTAL BATTERY PERCENTAGE FEATURE

24
man/waybar-cava.5.scd
View File

@ -95,19 +95,19 @@ libcava lives in:
|[ *monstercat*
:[ bool
:[ false
:[ Disables or enables the so-called "Monstercat smoothing" with of without "waves"
:[ Disables or enables the so-called "Monstercat smoothing" with or without "waves"
|[ *waves*
:[ bool
:[ false
:[ Disables or enables the so-called "Monstercat smoothing" with of without "waves"
:[ Disables or enables the so-called "Monstercat smoothing" with or without "waves"
|[ *noise_reduction*
:[ double
:[ 0.77
:[ Range between 0 - 1. The raw visualization is very noisy, this factor adjust the integral and gravity filters to keep the signal smooth. 1 - will be very slow and smooth, 0 - will be fast but noisy
:[ Range between 0 - 1. The raw visualization is very noisy, this factor adjusts the integral and gravity filters to keep the signal smooth. 1 - will be very slow and smooth, 0 - will be fast but noisy
|[ *input_delay*
:[ integer
:[ 2
:[ Sets the delay before fetching audio source thread start working. On author machine Waybar starts much faster then pipewire audio server, and without a little delay cava module fails due to pipewire is not ready
:[ Sets the delay before fetching audio source thread start working. On author's machine, Waybar starts much faster than pipewire audio server, and without a little delay cava module fails because pipewire is not ready
|[ *ascii_max_range*
:[ integer
:[ 7
@ -124,14 +124,14 @@ libcava lives in:
Configuration can be provided as:
- The only cava configuration file which is provided through *cava_config*. The rest configuration can be skipped
- Without cava configuration file. In such case cava should be configured through provided list of the configuration option
- Mix. When provided both And cava configuration file And configuration options. In such case waybar applies configuration file first then overrides particular options by the provided list of configuration options
- Mix. When provided both And cava configuration file And configuration options. In such case, waybar applies configuration file first and then overrides particular options by the provided list of configuration options
# ACTIONS
[- *String*
:- *Action*
|[ *mode*
:< Switch main cava thread and fetching audio source thread from/to pause/resume
:< Switch main cava thread and fetch audio source thread from/to pause/resume
# DEPENDENCIES
@ -142,16 +142,16 @@ Configuration can be provided as:
. On start Waybar throws an exception "error while loading shared libraries: libcava.so: cannot open shared object file: No such file or directory".
It might happen when libcava for some reason hasn't been registered in the system. sudo ldconfig should help
. Waybar is starting but cava module doesn't react on the music
1. In such case for at first need to make sure usual cava application is working as well
. Waybar is starting but cava module doesn't react to the music
1. In such cases at first need to make sure usual cava application is working as well
2. If so, need to comment all configuration options. Uncomment cava_config and provide the path to the working cava config
3. You might set too huge or too small input_delay. Try to setup to 4 seconds, restart waybar and check again 4 seconds past. Usual even on weak machines it should be enough
4. You might accidentally switched action mode to pause mode
3. You might set too huge or too small input_delay. Try to setup to 4 seconds, restart waybar, and check again 4 seconds past. Usual even on weak machines it should be enough
4. You might accidentally switch action mode to pause mode
# RISING ISSUES
For clear understanding: this module is a cava API's consumer. So for any bugs related to cava engine you should contact to Cava upstream(https://github.com/karlstav/cava) ++
with the one Exception. Cava upstream doesn't provide cava as a shared library. For that this module author made a fork libcava(https://github.com/LukashonakV/cava). ++
For clear understanding: this module is a cava API's consumer. So for any bugs related to cava engine you should contact Cava upstream(https://github.com/karlstav/cava) ++
with the one Exception. Cava upstream doesn't provide cava as a shared library. For that, this module author made a fork libcava(https://github.com/LukashonakV/cava). ++
So the order is:
. cava upstream
. libcava upstream.

6
man/waybar-clock.5.scd
View File

@ -63,7 +63,7 @@ $XDG_CONFIG_HOME/waybar/config ++
|[ *on-click-right*
:[ string
:[
:[ Command to execute when you right clicked on the module
:[ Command to execute when you right-click on the module
|[ *on-scroll-up*
:[ string
:[
@ -147,7 +147,7 @@ View all valid format options in *strftime(3)* or have a look <https://fmt.dev/l
|[ *tz_up*
:[ Switch to the next provided time zone
|[ *tz_down*
:[ Switch to the previous provided time zone
:[ Switch to the previously provided time zone
|[ *shift_up*
:[ Switch to the next calendar month/year
|[ *shift_down*
@ -219,7 +219,7 @@ View all valid format options in *strftime(3)* or have a look <https://fmt.dev/l
# Troubleshooting
If clock module is disabled at startup with locale::facet::\_S\_create\_c\_locale ++
name not valid error message try one of the followings:
name not valid error message try one of the following:
- check if LC_TIME is set properly (glibc)
- set locale to C in the config file (musl)

26
man/waybar-cpu.5.scd
View File

@ -6,7 +6,7 @@ waybar - cpu module
# DESCRIPTION
The *cpu* module displays the current cpu utilization.
The *cpu* module displays the current CPU utilization.
# CONFIGURATION
@ -31,7 +31,7 @@ The *cpu* module displays the current cpu utilization.
*min-length*: ++
typeof: integer ++
The minimum length in characters the module should take up.
The minimum length in characters the module should accept.
*align*: ++
typeof: float ++
@ -43,7 +43,7 @@ The *cpu* module displays the current cpu utilization.
*states*: ++
typeof: object ++
A number of cpu usage states which get activated on certain usage levels. See *waybar-states(5)*.
A number of CPU usage states which get activated on certain usage levels. See *waybar-states(5)*.
*on-click*: ++
typeof: string ++
@ -55,7 +55,7 @@ The *cpu* module displays the current cpu utilization.
*on-click-right*: ++
typeof: string ++
Command to execute when you right clicked on the module.
Command to execute when you right-click on the module.
*on-update*: ++
typeof: string ++
@ -80,21 +80,21 @@ The *cpu* module displays the current cpu utilization.
# FORMAT REPLACEMENTS
*{load}*: Current cpu load.
*{load}*: Current CPU load.
*{usage}*: Current overall cpu usage.
*{usage}*: Current overall CPU usage.
*{usage*{n}*}*: Current cpu core n usage. Cores are numbered from zero, so first core will be {usage0} and 4th will be {usage3}.
*{usage*{n}*}*: Current CPU core n usage. Cores are numbered from zero, so first core will be {usage0} and 4th will be {usage3}.
*{avg_frequency}*: Current cpu average frequency (based on all cores) in GHz.
*{avg_frequency}*: Current CPU average frequency (based on all cores) in GHz.
*{max_frequency}*: Current cpu max frequency (based on the core with the highest frequency) in GHz.
*{max_frequency}*: Current CPU max frequency (based on the core with the highest frequency) in GHz.
*{min_frequency}*: Current cpu min frequency (based on the core with the lowest frequency) in GHz.
*{min_frequency}*: Current CPU min frequency (based on the core with the lowest frequency) in GHz.
*{icon}*: Icon for overall cpu usage.
*{icon}*: Icon for overall CPU usage.
*{icon*{n}*}*: Icon for cpu core n usage. Use like {icon0}.
*{icon*{n}*}*: Icon for CPU core n usage. Use like {icon0}.
# EXAMPLES
@ -108,7 +108,7 @@ Basic configuration:
}
```
Cpu usage per core rendered as icons:
CPU usage per core rendered as icons:
```
"cpu": {

10
man/waybar-custom.5.scd
View File

@ -35,13 +35,13 @@ Addressed by *custom/<name>*
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* or *signal* is defined, it is assumed that the out script loops itself. ++
If a *signal* is defined then the script will run once on startup and will will only update with a signal.
If a *signal* is defined then the script will run once on startup and will only update with a signal.
*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*.
Once the script exits, it'll be re-executed after the *restart-interval*.
*signal*: ++
typeof: integer ++
@ -68,7 +68,7 @@ Addressed by *custom/<name>*
*min-length*: ++
typeof: integer ++
The minimum length in characters the module should take up.
The minimum length in characters the module should accept.
*align*: ++
typeof: float ++
@ -84,7 +84,7 @@ Addressed by *custom/<name>*
*on-click-right*: ++
typeof: string ++
Command to execute when you right clicked on the module.
Command to execute when you right-click on the module.
*on-update*: ++
typeof: string ++
@ -136,7 +136,7 @@ $text\\n$tooltip\\n$class*
*{}*: Output of the script.
*{percentage}* Percentage which can be set via a json return-type.
*{percentage}* Percentage which can be set via a json return type.
*{icon}*: An icon from 'format-icons' according to percentage.

16
man/waybar-disk.5.scd
View File

@ -33,7 +33,7 @@ Addressed by *disk*
*states*: ++
typeof: object ++
A number of disk utilization states which get activated on certain percentage thresholds (percentage_used). See *waybar-states(5)*.
A number of disk utilization states that get activated on certain percentage thresholds (percentage_used). See *waybar-states(5)*.
*max-length*: ++
typeof: integer ++
@ -41,7 +41,7 @@ Addressed by *disk*
*min-length*: ++
typeof: integer ++
The minimum length in characters the module should take up.
The minimum length in characters the module should accept.
*align*: ++
typeof: float ++
@ -57,7 +57,7 @@ Addressed by *disk*
*on-click-right*: ++
typeof: string ++
Command to execute when you right clicked on the module.
Command to execute when you right-click on the module.
*on-update*: ++
typeof: string ++
@ -87,7 +87,7 @@ Addressed by *disk*
*unit*: ++
typeof: string ++
Use with specific_free, specific_used, and speciifc_total to force calculation to always be in a certain unit. Accepts kB, kiB, MB, Mib, GB, GiB, TB, TiB.
Use with specific_free, specific_used, and specific_total to force calculation to always be in a certain unit. Accepts kB, kiB, MB, Mib, GB, GiB, TB, TiB.
# FORMAT REPLACEMENTS
@ -95,7 +95,7 @@ Addressed by *disk*
*{percentage_free}*: Percentage of free disk space
*{total}*: Total amount of space on the disk, partition or mountpoint. Automatically selects unit based on size remaining.
*{total}*: Total amount of space on the disk, partition, or mountpoint. Automatically selects unit based on size remaining.
*{used}*: Amount of used disk space. Automatically selects unit based on size remaining.
@ -103,11 +103,11 @@ Addressed by *disk*
*{path}*: The path specified in the configuration.
*{specific_total}*: Total amount of space on the disk, partition or mountpoint in a specific unit. Deaults to bytes.
*{specific_total}*: Total amount of space on the disk, partition, or mountpoint in a specific unit. Defaults to bytes.
*{specific_used}*: Amount of used disk space in a specific unit. Deaults to bytes.
*{specific_used}*: Amount of used disk space in a specific unit. Defaults to bytes.
*{specific_free}*: Amount of available disk space for normal users in a specific unit. Deaults to bytes.
*{specific_free}*: Amount of available disk space for normal users in a specific unit. Defaults to bytes.
# EXAMPLES

2
man/waybar-dwl-tags.5.scd
View File

@ -24,7 +24,7 @@ Addressed by *dwl/tags*
*disable-click*: ++
typeof: bool ++
default: false ++
If set to false, you can left click to set focused tag. Right click to toggle tag focus. If set to true this behaviour is disabled.
If set to false, you can left-click to set focused tag. Right-click to toggle tag focus. If set to true this behaviour is disabled.
# EXAMPLE

4
man/waybar-gamemode.5.scd
View File

@ -65,11 +65,11 @@ Feral Gamemode optimizations.
*{glyph}*: The string icon glyph to use instead.
*{count}*: The amount of games running with gamemode optimizations.
*{count}*: The number of games running with gamemode optimizations.
# TOOLTIP FORMAT REPLACEMENTS
*{count}*: The amount of games running with gamemode optimizations.
*{count}*: The number of games running with gamemode optimizations.
# EXAMPLES

4
man/waybar-hyprland-submap.5.scd
View File

@ -27,7 +27,7 @@ Addressed by *hyprland/submap*
*min-length*: ++
typeof: integer ++
The minimum length in characters the module should take up.
The minimum length in characters the module should accept.
*align*: ++
typeof: float ++
@ -43,7 +43,7 @@ Addressed by *hyprland/submap*
*on-click-right*: ++
typeof: string ++
Command to execute when you right clicked on the module.
Command to execute when you right-click on the module.
*on-update*: ++
typeof: string ++

8
man/waybar-hyprland-workspaces.5.scd
View File

@ -19,13 +19,13 @@ Addressed by *hyprland/workspaces*
*format-icons*: ++
typeof: array ++
Based on the workspace id and state, the corresponding icon gets selected. See *icons*.
Based on the workspace ID and state, the corresponding icon gets selected. See *icons*.
*window-rewrite*: ++
typeof: object ++
Regex rules to map window class to an icon or preferred method of representation for a workspace's window.
Keys are the rules, while the values are the methods of representation.
Rules may specify `class<...>`, `title<...>` or both in order to fine-tune the matching.
Rules may specify `class<...>`, `title<...>`, or both in order to fine-tune the matching.
*window-rewrite-default*:
typeof: string ++
@ -45,7 +45,7 @@ Addressed by *hyprland/workspaces*
*all-outputs*: ++
typeof: bool ++
default: false ++
If set to false workspaces group will be shown only in assigned output. Otherwise all workspace groups are shown.
If set to false workspaces group will be shown only in assigned output. Otherwise, all workspace groups are shown.
*active-only*: ++
typeof: bool ++
@ -55,7 +55,7 @@ Addressed by *hyprland/workspaces*
*ignore-workspaces*: ++
typeof: array ++
default: [] ++
Regexes to match against workspaces names. If there's a match, the workspace will not be shown. This takes precedence over *show-special*, *all-outputs* and *active-only*.
Regexes to match against workspaces names. If there's a match, the workspace will not be shown. This takes precedence over *show-special*, *all-outputs*, and *active-only*.
*sort-by*: ++
typeof: string ++

10
man/waybar-idle-inhibitor.5.scd
View File

@ -6,8 +6,8 @@ waybar - idle_inhibitor module
# DESCRIPTION
The *idle_inhibitor* module can inhibiting the idle behavior such as screen blanking, locking, and
screensaving, also known as "presentation mode".
The *idle_inhibitor* module can inhibit the idle behavior such as screen blanking, locking, and
screensaver, also known as "presentation mode".
# CONFIGURATION
@ -29,7 +29,7 @@ screensaving, also known as "presentation mode".
*min-length*: ++
typeof: integer ++
The minimum length in characters the module should take up.
The minimum length in characters the module should accept.
*align*: ++
typeof: float ++
@ -45,7 +45,7 @@ screensaving, also known as "presentation mode".
*on-click-right*: ++
typeof: string ++
Command to execute when you right clicked on the module.
Command to execute when you right-click on the module.
*on-update*: ++
typeof: string ++
@ -70,7 +70,7 @@ screensaving, also known as "presentation mode".
*timeout*: ++
typeof: double ++
The number of minutes the inhibit should last.
The number of minutes the inhibition should last.
*tooltip*: ++
typeof: bool ++

2
man/waybar-image.5.scd
View File

@ -66,7 +66,7 @@ The *image* module displays an image from a path.
# SCRIPT OUTPUT
Similar to the *custom* module, output values of the script is *newline* separated.
Similar to the *custom* module, output values of the script are *newline* separated.
The following is the output format:
```

4
man/waybar-inhibitor.5.scd
View File

@ -33,7 +33,7 @@ See *systemd-inhibit*(1) for more information.
*min-length*: ++
typeof: integer ++
The minimum length in characters the module should take up.
The minimum length in characters the module should accept.
*align*: ++
typeof: float ++
@ -49,7 +49,7 @@ See *systemd-inhibit*(1) for more information.
*on-click-right*: ++
typeof: string ++
Command to execute when you right clicked on the module.
Command to execute when you right-click on the module.
*on-update*: ++
typeof: string ++

6
man/waybar-jack.5.scd
View File

@ -27,7 +27,7 @@ Addressed by *jack*
*format-xrun*: ++
typeof: string ++
This format is used for one polling interval, when the JACK server reports an xrun.
This format is used for one polling interval when the JACK server reports an xrun.
*realtime*: ++
typeof: bool ++
@ -59,7 +59,7 @@ Addressed by *jack*
*min-length*: ++
typeof: integer ++
The minimum length in characters the module should take up.
The minimum length in characters the module should accept.
*align*: ++
typeof: float ++
@ -75,7 +75,7 @@ Addressed by *jack*
*on-click-right*: ++
typeof: string ++
Command to execute when you right clicked on the module.
Command to execute when you right-click on the module.
*on-update*: ++
typeof: string ++

4
man/waybar-keyboard-state.5.scd
View File

@ -13,7 +13,7 @@ You must be a member of the input group to use this module.
# CONFIGURATION
*interval*: ++
Deprecated, this module use event loop now, the interval has no effect.
Deprecated, this module uses event loop now, the interval has no effect.
typeof: integer ++
default: 1 ++
The interval, in seconds, to poll the keyboard state.
@ -51,7 +51,7 @@ You must be a member of the input group to use this module.
*binding-keys*: ++
typeof: array ++
default: [58, 69, 70] ++
Customize the key to trigger this module, the key number can be find in /usr/include/linux/input-event-codes.h or running sudo libinput debug-events --show-keycodes.
Customize the key to trigger this module, the key number can be found in /usr/include/linux/input-event-codes.h or running sudo libinput debug-events --show-keycodes.
# FORMAT REPLACEMENTS

4
man/waybar-memory.5.scd
View File

@ -41,7 +41,7 @@ Addressed by *memory*
*min-length*: ++
typeof: integer ++
The minimum length in characters the module should take up.
The minimum length in characters the module should accept.
*align*: ++
typeof: float ++
@ -57,7 +57,7 @@ Addressed by *memory*
*on-click-right*: ++
typeof: string ++
Command to execute when you right clicked on the module.
Command to execute when you right-click on the module.
*on-update*: ++
typeof: string ++

6
man/waybar-mpd.5.scd
View File

@ -99,7 +99,7 @@ Addressed by *mpd*
*min-length*: ++
typeof: integer ++
The minimum length in characters the module should take up.
The minimum length in characters the module should accept.
*align*: ++
typeof: float ++
@ -115,7 +115,7 @@ Addressed by *mpd*
*on-click-right*: ++
typeof: string ++
Command to execute when you right clicked on the module.
Command to execute when you right-click on the module.
*on-update*: ++
typeof: string ++
@ -182,7 +182,7 @@ Addressed by *mpd*
*{queueLength}*: The length of the current queue.
*{stateIcon}*: The icon corresponding the playing or paused status of the player (see *state-icons* option)
*{stateIcon}*: The icon corresponding to the playing or paused status of the player (see *state-icons* option)
*{consumeIcon}*: The icon corresponding the "consume" option (see *consume-icons* option)

6
man/waybar-mpris.5.scd
View File

@ -13,7 +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 currently active player.
*ignored-players*: ++
typeof: []string ++
@ -97,7 +97,7 @@ 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 ++
@ -114,7 +114,7 @@ The *mpris* module displays currently playing media via libplayerctl.
*min-length*: ++
typeof: integer ++
The minimum length in characters the module should take up.
The minimum length in characters the module should accept.
*align*: ++
typeof: float ++

8
man/waybar-network.5.scd
View File

@ -14,7 +14,7 @@ Addressed by *network*
*interface*: ++
typeof: string ++
Use the defined interface instead of auto detection. Accepts wildcard.
Use the defined interface instead of auto-detection. Accepts wildcard.
*interval*: ++
typeof: integer ++
@ -41,7 +41,7 @@ Addressed by *network*
*format-linked*: ++
typeof: string ++
This format is used when a linked interface with no ip address is displayed.
This format is used when a linked interface with no IP address is displayed.
*format-disconnected*: ++
typeof: string ++
@ -66,7 +66,7 @@ Addressed by *network*
*min-length*: ++
typeof: integer ++
The minimum length in characters the module should take up.
The minimum length in characters the module should accept.
*align*: ++
typeof: float ++
@ -82,7 +82,7 @@ Addressed by *network*
*on-click-right*: ++
typeof: string ++
Command to execute when you right clicked on the module.
Command to execute when you right-click on the module.
*on-update*: ++
typeof: string ++

2
man/waybar-pulseaudio-slider.5.scd
View File

@ -8,7 +8,7 @@ waybar - pulseaudio slider module
The *pulseaudio slider* module displays and controls the current volume of the default sink or source as a bar.
The volume can be controlled by dragging the slider accross the bar, or clicking on a specific position.
The volume can be controlled by dragging the slider across the bar or clicking on a specific position.
# CONFIGURATION

12
man/waybar-pulseaudio.5.scd
View File

@ -8,7 +8,7 @@ waybar - pulseaudio module
The *pulseaudio* module displays the current volume reported by PulseAudio.
Additionally you can control the volume by scrolling *up* or *down* while the cursor is over the module.
Additionally, you can control the volume by scrolling *up* or *down* while the cursor is over the module.
# CONFIGURATION
@ -36,7 +36,7 @@ Additionally you can control the volume by scrolling *up* or *down* while the cu
*format-icons*: ++
typeof: array ++
Based on the current port-name and volume, the corresponding icon gets selected. The order is *low* to *high*. See *Icons*.
Based on the current port name and volume, the corresponding icon gets selected. The order is *low* to *high*. See *Icons*.
*rotate*: ++
typeof: integer ++
@ -52,7 +52,7 @@ Additionally you can control the volume by scrolling *up* or *down* while the cu
*min-length*: ++
typeof: integer ++
The minimum length in characters the module should take up.
The minimum length in characters the module should accept.
*align*: ++
typeof: float ++
@ -61,7 +61,7 @@ Additionally you can control the volume by scrolling *up* or *down* while the cu
*scroll-step*: ++
typeof: float ++
default: 1.0 ++
The speed in which to change the volume when scrolling.
The speed at which to change the volume when scrolling.
*on-click*: ++
typeof: string ++
@ -73,7 +73,7 @@ Additionally you can control the volume by scrolling *up* or *down* while the cu
*on-click-right*: ++
typeof: string ++
Command to execute when you right clicked on the module.
Command to execute when you right-click on the module.
*on-update*: ++
typeof: string ++
@ -107,7 +107,7 @@ Additionally you can control the volume by scrolling *up* or *down* while the cu
*ignored-sinks*: ++
typeof: array ++
Sinks in this list will not be shown as the active sink by Waybar. Entries should be the sink's description field.
Sinks in this list will not be shown as active sink by Waybar. Entries should be the sink's description field.
# FORMAT REPLACEMENTS

4
man/waybar-river-layout.5.scd
View File

@ -29,7 +29,7 @@ Addressed by *river/layout*
*min-length*: ++
typeof: integer ++
The minimum length in characters the module should take up.
The minimum length in characters the module should accept.
*align*: ++
typeof: float ++
@ -45,7 +45,7 @@ Addressed by *river/layout*
*on-click-right*: ++
typeof: string ++
Command to execute when you right clicked on the module.
Command to execute when you right-click on the module.
# EXAMPLE

4
man/waybar-river-mode.5.scd
View File

@ -27,7 +27,7 @@ Addressed by *river/mode*
*min-length*: ++
typeof: integer ++
The minimum length in characters the module should take up.
The minimum length in characters the module should accept.
*align*: ++
typeof: float ++
@ -43,7 +43,7 @@ Addressed by *river/mode*
*on-click-right*: ++
typeof: string ++
Command to execute when you right clicked on the module.
Command to execute when you right-click on the module.
*on-update*: ++
typeof: string ++

2
man/waybar-river-tags.5.scd
View File

@ -24,7 +24,7 @@ Addressed by *river/tags*
*disable-click*: ++
typeof: bool ++
default: false ++
If set to false, you can left click to set focused tag. Right click to toggle tag focus. If set to true this behaviour is disabled.
If set to false, you can left-click to set focused tag. Right-click to toggle tag focus. If set to true this behaviour is disabled.
# EXAMPLE

4
man/waybar-river-window.5.scd
View File

@ -27,7 +27,7 @@ Addressed by *river/window*
*min-length*: ++
typeof: integer ++
The minimum length in characters the module should take up.
The minimum length in characters the module should accept.
*align*: ++
typeof: float ++
@ -43,7 +43,7 @@ Addressed by *river/window*
*on-click-right*: ++
typeof: string ++
Command to execute when you right clicked on the module.
Command to execute when you right-click on the module.
# EXAMPLES

6
man/waybar-sndio.5.scd
View File

@ -28,7 +28,7 @@ cursor is over the module, and clicking on the module toggles mute.
*min-length*: ++
typeof: integer ++
The minimum length in characters the module should take up.
The minimum length in characters the module should accept.
*align*: ++
typeof: float ++
@ -37,7 +37,7 @@ cursor is over the module, and clicking on the module toggles mute.
*scroll-step*: ++
typeof: int ++
default: 5 ++
The speed in which to change the volume when scrolling.
The speed at which to change the volume when scrolling.
*on-click*: ++
typeof: string ++
@ -50,7 +50,7 @@ cursor is over the module, and clicking on the module toggles mute.
*on-click-right*: ++
typeof: string ++
Command to execute when you right clicked on the module.
Command to execute when you right-click on the module.
*on-update*: ++
typeof: string ++

4
man/waybar-sway-mode.5.scd
View File

@ -27,7 +27,7 @@ Addressed by *sway/mode*
*min-length*: ++
typeof: integer ++
The minimum length in characters the module should take up.
The minimum length in characters the module should accept.
*align*: ++
typeof: float ++
@ -43,7 +43,7 @@ Addressed by *sway/mode*
*on-click-right*: ++
typeof: string ++
Command to execute when you right clicked on the module.
Command to execute when you right-click on the module.
*on-update*: ++
typeof: string ++

8
man/waybar-sway-window.5.scd
View File

@ -27,7 +27,7 @@ Addressed by *sway/window*
*min-length*: ++
typeof: integer ++
The minimum length in characters the module should take up.
The minimum length in characters the module should accept.
*align*: ++
typeof: float ++
@ -43,7 +43,7 @@ Addressed by *sway/window*
*on-click-right*: ++
typeof: string ++
Command to execute when you right clicked on the module.
Command to execute when you right-click on the module.
*on-update*: ++
typeof: string ++
@ -78,7 +78,7 @@ Addressed by *sway/window*
*offscreen-css-text*: ++
typeof: string ++
Only effective when both all-outputs and offscreen-style are true. On screens currently not focused, show the given text along with that workspaces styles.
Only effective when both all-outputs and offscreen-style are true. On screens currently not focused, show the given text along with that workspace styles.
*show-focused-workspace-name*: ++
typeof: bool ++
@ -106,7 +106,7 @@ Addressed by *sway/window*
*{app_id}*: The app_id of the focused window.
*{shell}*: The shell of the focused window. It's 'xwayland' when the window is
running through xwayland, otherwise it's 'xdg-shell'.
running through xwayland, otherwise, it's 'xdg-shell'.
# REWRITE RULES

14
man/waybar-sway-workspaces.5.scd
View File

@ -63,7 +63,7 @@ Addressed by *sway/workspaces*
*persistent-workspaces*: ++
typeof: json (see below) ++
default: empty ++
Lists workspaces that should always be shown, even when non existent
Lists workspaces that should always be shown, even when non-existent
*on-update*: ++
typeof: string ++
@ -98,11 +98,11 @@ warp-on-scroll: ++
Additional to workspace name matching, the following *format-icons* can be set.
- *default*: Will be shown, when no string matches is found.
- *default*: Will be shown, when no string matches are 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.
- *high-priority-named*: Icons by names will be shown always for that workspaces, independent by state.
- *persistent*: Will be shown, when workspace is persistent.
- *high-priority-named*: Icons by names will be shown always for those workspaces, independent by state.
# PERSISTENT WORKSPACES
@ -113,9 +113,9 @@ an empty list denoting all outputs.
```
"sway/workspaces": {
"persistent-workspaces": {
"3": [], // Always show a workspace with name '3', on all outputs if it does not exists
"4": ["eDP-1"], // Always show a workspace with name '4', on output 'eDP-1' if it does not exists
"5": ["eDP-1", "DP-2"] // Always show a workspace with name '5', on outputs 'eDP-1' and 'DP-2' if it does not exists
"3": [], // Always show a workspace with name '3', on all outputs if it does not exist
"4": ["eDP-1"], // Always show a workspace with name '4', on output 'eDP-1' if it does not exist
"5": ["eDP-1", "DP-2"] // Always show a workspace with name '5', on outputs 'eDP-1' and 'DP-2' if it does not exist
}
}
```

6
man/waybar-temperature.5.scd
View File

@ -67,7 +67,7 @@ Addressed by *temperature*
*min-length*: ++
typeof: integer ++
The minimum length in characters the module should take up.
The minimum length in characters the module should accept.
*align*: ++
typeof: float ++
@ -75,7 +75,7 @@ Addressed by *temperature*
*on-click*: ++
typeof: string ++
Command to execute when you clicked on the module.
Command to execute when you click on the module.
*on-click-middle*: ++
typeof: string ++
@ -83,7 +83,7 @@ Addressed by *temperature*
*on-click-right*: ++
typeof: string ++
Command to execute when you right clicked on the module.
Command to execute when you right-click on the module.
*on-update*: ++
typeof: string ++

6
man/waybar-wireplumber.5.scd
View File

@ -43,7 +43,7 @@ The *wireplumber* module displays the current volume reported by WirePlumber.
*min-length*: ++
typeof: integer ++
The minimum length in characters the module should take up.
The minimum length in characters the module should accept.
*align*: ++
typeof: float ++
@ -52,7 +52,7 @@ The *wireplumber* module displays the current volume reported by WirePlumber.
*scroll-step*: ++
typeof: float ++
default: 1.0 ++
The speed in which to change the volume when scrolling.
The speed at which to change the volume when scrolling.
*on-click*: ++
typeof: string ++
@ -64,7 +64,7 @@ The *wireplumber* module displays the current volume reported by WirePlumber.
*on-click-right*: ++
typeof: string ++
Command to execute when you right clicked on the module.
Command to execute when you right-click on the module.
*on-update*: ++
typeof: string ++

4
man/waybar-wlr-taskbar.5.scd
View File

@ -16,7 +16,7 @@ Addressed by *wlr/taskbar*
*all-outputs*: ++
typeof: bool ++
default: false ++
If set to false applications on the waybar's current output will be shown. Otherwise all applications are shown.
If set to false applications on the waybar's current output will be shown. Otherwise, all applications are shown.
*format*: ++
typeof: string ++
@ -89,7 +89,7 @@ Addressed by *wlr/taskbar*
*{icon}*: The icon of the application.
*{name}*: The application name as in desktop file if appropriate desktop fils found, otherwise same as {app_id}
*{name}*: The application name as in desktop file if appropriate desktop files are found, otherwise same as {app_id}
*{title}*: The title of the application.

8
man/waybar-wlr-workspaces.5.scd
View File

@ -30,17 +30,17 @@ Addressed by *wlr/workspaces*
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.
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 ++
default: false ++
If set to true, workspace names will be sorted numerically. Takes presedence over any other sort-by option.
If set to true, workspace names will be sorted numerically. Takes precedence over any other sort-by option.
*all-outputs*: ++
typeof: bool ++
default: false ++
If set to false workspaces group will be shown only in assigned output. Otherwise all workspace groups are shown.
If set to false workspaces group will be shown only in assigned output. Otherwise, all workspace groups are shown.
*active-only*: ++
typeof: bool ++
@ -61,7 +61,7 @@ Addressed by *wlr/workspaces*
# ICONS
Additional to workspace name matching, the following *format-icons* can be set.
In addition to workspace name matching, the following *format-icons* can be set.
- *default*: Will be shown, when no string match is found.
- *active*: Will be shown, when workspace is active

12
man/waybar.5.scd.in
View File

@ -17,7 +17,7 @@ Valid locations for this file are:
- *@sysconfdir@/xdg/waybar/config*
A good starting point is the default configuration found at https://github.com/Alexays/Waybar/blob/master/resources/config
Also a minimal example configuration can be found on the at the bottom of this man page.
Also, a minimal example configuration can be found at the bottom of this man page.
# BAR CONFIGURATION
@ -30,7 +30,7 @@ Also a minimal example configuration can be found on the at the bottom of this m
*output* ++
typeof: string|array ++
Specifies on which screen this bar will be displayed. Exclamation mark(*!*) can be used to exclude specific output.
Output specification follows sway's and can either be the output port such as "HDMI-A-1" or a string consisting of the make, model and serial such as "Some Company ABC123 0x00000000". See *sway-output(5)* for details.
Output specification follows sway's and can either be the output port such as "HDMI-A-1" or a string consisting of the make, model, and serial such as "Some Company ABC123 0x00000000". See *sway-output(5)* for details.
In an array, star '*\**' can be used at the end to accept all outputs, in case all previous entries are exclusions.
*position* ++
@ -68,7 +68,7 @@ Also a minimal example configuration can be found on the at the bottom of this m
*spacing* ++
typeof: integer ++
Size of gaps in between of the different modules.
Size of gaps in between the different modules.
*name* ++
typeof: string ++
@ -89,7 +89,7 @@ Also a minimal example configuration can be found on the at the bottom of this m
default: *press*
Defines the timing of modifier key to reset the bar visibility.
To reset the visibility of the bar with the press of the modifier key use *press*.
Use *release* to reset the visibility upon the release of the modifier key and only if no other action happened while the key was pressed. This prevents hiding the bar when the modifier is used to switch a workspace, change binding mode or start a keybinding.
Use *release* to reset the visibility upon the release of the modifier key and only if no other action happened while the key was pressed. This prevents hiding the bar when the modifier is used to switch a workspace, change binding mode, or start a keybinding.
*exclusive* ++
typeof: bool ++
@ -142,7 +142,7 @@ e.g.
# MULTIPLE INSTANCES OF A MODULE
If you want to have a second instance of a module, you can suffix it by a '#' and a custom name.
For example if you want a second battery module, you can add *"battery#bat2"* to your modules.
For example, if you want a second battery module, you can add *"battery#bat2"* to your modules.
To configure the newly added module, you then also add a module configuration with the same name.
This could then look something like this *(this is an incomplete example)*:
@ -236,7 +236,7 @@ When positioning Waybar on the left or right side of the screen, sometimes it's
}
```
Valid options for the "rotate" property are: 0, 90, 180 and 270.
Valid options for the "rotate" property are: 0, 90, 180, and 270.
## Grouping modules