.\" Generated by scdoc 1.11.3
.\" 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-jack" "5" "2024-05-06"
.PP
.SH NAME
.PP
waybar - JACK module
.PP
.SH DESCRIPTION
.PP
The \fBjack\fR module displays the current state of the JACK server.\&
.PP
.SH CONFIGURATION
.PP
Addressed by \fBjack\fR
.PP
\fBformat\fR: 
.br
	typeof: string 
.br
	default: \fB{load}%\fR 
.br
	The format, how information should be displayed.\& This format is used when other formats aren'\&t specified.\&
.PP
\fBformat-connected\fR: 
.br
	typeof: string 
.br
	This format is used when the module is connected to the JACK server.\&
.PP
\fBformat-disconnected\fR: 
.br
	typeof: string 
.br
	This format is used when the module is not connected to the JACK server.\&
.PP
\fBformat-xrun\fR: 
.br
	typeof: string 
.br
	This format is used for one polling interval when the JACK server reports an xrun.\&
.PP
\fBrealtime\fR: 
.br
	typeof: bool 
.br
	default: \fBtrue\fR 
.br
	Option to drop real-time privileges for the JACK client opened by Waybar.\&
.PP
\fBtooltip\fR: 
.br
	typeof: bool 
.br
	default: \fBtrue\fR 
.br
	Option to disable tooltip on hover.\&
.PP
\fBtooltip-format\fR: 
.br
	typeof: string 
.br
	default: \fB{bufsize}/{samplerate} {latency}ms\fR 
.br
	The format of information displayed in the tooltip.\&
.PP
\fBinterval\fR: 
.br
	typeof: integer 
.br
	default: 1 
.br
	The interval in which the information gets polled.\&
.PP
\fBrotate\fR: 
.br
	typeof: integer 
.br
	Positive value to rotate the text label.\&
.PP
\fBmax-length\fR: 
.br
	typeof: integer 
.br
	The maximum length in character the module should display.\&
.PP
\fBmin-length\fR: 
.br
	typeof: integer 
.br
	The minimum length in characters the module should accept.\&
.PP
\fBalign\fR: 
.br
	typeof: float 
.br
	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.\&
.PP
\fBjustify\fR: 
.br
	typeof: string 
.br
	The alignment of the text within the module'\&s label, allowing options '\&left'\&, '\&right'\&, or '\&center'\& to define the positioning.\&
.PP
\fBon-click\fR: 
.br
	typeof: string 
.br
	Command to execute when clicked on the module.\&
.PP
\fBon-click-middle\fR: 
.br
	typeof: string 
.br
	Command to execute when middle-clicked on the module using mousewheel.\&
.PP
\fBon-click-right\fR: 
.br
	typeof: string 
.br
	Command to execute when you right-click on the module.\&
.PP
\fBon-update\fR: 
.br
	typeof: string 
.br
	Command to execute when the module is updated.\&
.PP
.SH FORMAT REPLACEMENTS
.PP
\fB{load}\fR: The current CPU load estimated by JACK.\&
.PP
\fB{bufsize}\fR: The size of the JACK buffer.\&
.PP
\fB{samplerate}\fR: The sample rate at which the JACK server is running.\&
.PP
\fB{latency}\fR: The duration, in ms, of the current buffer size.\&
.PP
\fB{xruns}\fR: The number of xruns reported by the JACK server since starting Waybar.\&
.PP
.SH EXAMPLES
.PP
.nf
.RS 4
"jack": {
	"format": "DSP {}%",
	"format-xrun": "{xruns} xruns",
	"format-disconnected": "DSP off",
	"realtime": true
}
.fi
.RE
.PP
.SH STYLE
.PP
.PD 0
.IP \(bu 4
\fB#jack\fR
.IP \(bu 4
\fB#jack.\&connected\fR
.IP \(bu 4
\fB#jack.\&disconnected\fR
.IP \(bu 4
\fB#jack.\&xrun\fR