.\" 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-inhibitor" "5" "2024-09-15"
.PP
.SH NAME
.PP
waybar - inhibitor module
.PP
.SH DESCRIPTION
.PP
The \fBinhibitor\fR module allows one to take an inhibitor lock that logind provides.\&
See \fBsystemd-inhibit\fR(1) for more information.\&
.PP
.SH CONFIGURATION
.PP
\fBwhat\fR: 
.br
	typeof: string or array 
.br
	The inhibitor lock or locks that should be taken when active.\& The available inhibitor locks are \fBidle\fR, \fBshutdown\fR, \fBsleep\fR, \fBhandle-power-key\fR, \fBhandle-suspend-key\fR, \fBhandle-hibernate-key\fR and \fBhandle-lid-switch\fR.\&
.PP
\fBformat\fR: 
.br
	typeof: string 
.br
	The format, how the state should be displayed.\&
.PP
\fBformat-icons\fR: 
.br
	typeof: array 
.br
	Based on the current state, the corresponding icon gets selected.\&
.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.\& A click also toggles the state
.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
\fBon-scroll-up\fR: 
.br
	typeof: string 
.br
	Command to execute when scrolling up on the module.\&
.PP
\fBon-scroll-down\fR: 
.br
	typeof: string 
.br
	Command to execute when scrolling down on the module.\&
.PP
\fBsmooth-scrolling-threshold\fR: 
.br
	typeof: double 
.br
	Threshold to be used when scrolling.\&
.PP
\fBtooltip\fR: 
.br
	typeof: bool 
.br
	default: true 
.br
	Option to disable tooltip on hover.\&
.PP
\fBmenu\fR: 
.br
	typeof: string 
.br
	Action that popups the menu.\& Cannot be "on-click".\&
.PP
\fBmenu-file\fR: 
.br
	typeof: string 
.br
	Location of the menu descriptor file.\& There need to be an element of type
.RS 4
GtkMenu with id \fBmenu\fR
.PP
.RE
\fBmenu-actions\fR: 
.br
	typeof: array 
.br
	The actions corresponding to the buttons of the menu.\&
.PP
.SH FORMAT REPLACEMENTS
.PP
\fB{status}\fR: status (\fBactivated\fR or \fBdeactivated\fR)
.PP
\fB{icon}\fR: Icon, as defined in \fBformat-icons\fR
.PP
.SH EXAMPLES
.PP
.nf
.RS 4
"inhibitor": {
	"what": "handle-lid-switch",
	"format": "{icon}",
	"format-icons": {
		"activated": "",
		"deactivated": ""
	}
}
.fi
.RE