Man page - waybar-sndio(5)

Packages contains this manual

Manual

waybar-sndio

NAME
DESCRIPTION
CONFIGURATION
FORMAT REPLACEMENTS
EXAMPLES
STYLE

NAME

waybar - sndio module

DESCRIPTION

The sndio module displays the current volume reported by sndio(7).

Additionally, you can control the volume by scrolling up or down while the cursor is over the module, and clicking on the module toggles mute.

CONFIGURATION

format :

typeof: string

default: {volume}%

The format for how information should be displayed.

rotate :

typeof: integer

Positive value to rotate the text label (in 90 degree increments).

max-length :

typeof: integer

The maximum length in character the module should display.

min-length :

typeof: integer

The minimum length in characters the module should accept.

align :

typeof: float

The alignment of the label within the module, where 0 is left-aligned and 1 is right-aligned. If the module is rotated, it will follow the flow of the text.

justify :

typeof: string

The alignment of the text within the module’s label, allowing options ’left’, ’right’, or ’center’ to define the positioning.

scroll-step :

typeof: int

default: 5

The speed at which to change the volume when scrolling.

on-click :

typeof: string

Command to execute when clicked on the module.

This replaces the default behaviour of toggling mute.

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-click 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.

on-scroll-down :

typeof: string

Command to execute when scrolling down on the module.

This replaces the default behaviour of volume control.

smooth-scrolling-threshold :

typeof: double

Threshold to be used when scrolling.

menu :

typeof: string

Action that popups the menu.

menu-file :

typeof: string

Location of the menu descriptor file. There need to be an element of type

GtkMenu with id menu

menu-actions :

typeof: array

The actions corresponding to the buttons of the menu.

expand :

typeof: bool

default: false

Enables this module to consume all left over space dynamically.

FORMAT REPLACEMENTS

{volume} : Volume in percentage.

{raw_value} : Volume as value reported by sndio.

EXAMPLES

"sndio": {

"format": "{raw_value} 🎜",

"scroll-step": 3

}

STYLE

#sndio

#sndio.muted