.\" Generated by scdoc 1.11.2
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "waybar-sndio" "5" "2023-02-28"
.P
.SH NAME
.P
waybar - sndio module
.P
.SH DESCRIPTION
.P
The \fBsndio\fR module displays the current volume reported by sndio(7).\&
.P
Additionally, you can control the volume by scrolling \fBup\fR or \fBdown\fR while the
cursor is over the module, and clicking on the module toggles mute.\&
.P
.SH CONFIGURATION
.P
\fBformat\fR: 
.br
	typeof: string  
.br
	default: {volume}% 
.br
	The format for how information should be displayed.\&
.P
\fBrotate\fR: 
.br
	typeof: integer 
.br
	Positive value to rotate the text label.\&
.P
\fBmax-length\fR: 
.br
	typeof: integer 
.br
	The maximum length in character the module should display.\&
.P
\fBmin-length\fR: 
.br
    typeof: integer 
.br
    The minimum length in characters the module should take up.\&
.P
\fBalign\fR: 
.br
    typeof: float 
.br
    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.\&
.P
\fBscroll-step\fR: 
.br
	typeof: int 
.br
	default: 5 
.br
	The speed in which to change the volume when scrolling.\&
.P
\fBon-click\fR: 
.br
	typeof: string 
.br
	Command to execute when clicked on the module.\&
.RS 4
This replaces the default behaviour of toggling mute.\&
.P
.RE
\fBon-click-middle\fR: 
.br
	typeof: string 
.br
	Command to execute when middle-clicked on the module using mousewheel.\&
.P
\fBon-click-right\fR: 
.br
	typeof: string 
.br
	Command to execute when you right clicked on the module.\&
.P
\fBon-update\fR: 
.br
	typeof: string 
.br
	Command to execute when the module is updated.\&
.P
\fBon-scroll-up\fR: 
.br
	typeof: string 
.br
	Command to execute when scrolling up on the module.\&
.RS 4
This replaces the default behaviour of volume control.\&
.P
.RE
\fBon-scroll-down\fR: 
.br
	typeof: string 
.br
	Command to execute when scrolling down on the module.\&
.RS 4
This replaces the default behaviour of volume control.\&
.P
.RE
\fBsmooth-scrolling-threshold\fR: 
.br
	typeof: double 
.br
	Threshold to be used when scrolling.\&
.P
.SH FORMAT REPLACEMENTS
.P
\fB{volume}\fR: Volume in percentage.\&
.P
\fB{raw_value}\fR: Volume as value reported by sndio.\&
.P
.SH EXAMPLES
.P
.nf
.RS 4
"sndio": {
    "format": "{raw_value} 🎜",
    "scroll-step": 3
}
.fi
.RE
.P
.SH STYLE
.P
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fB#sndio\fR
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fB#sndio.\&muted\fR
.RE