.\" 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-idle-inhibitor" "5" "2023-02-28"
.P
.SH NAME
.P
waybar - idle_inhibitor module
.P
.SH DESCRIPTION
.P
The \fBidle_inhibitor\fR module can inhibiting the idle behavior such as screen blanking, locking, and
screensaving, also known as "presentation mode".\&
.P
.SH CONFIGURATION
.P
\fBformat\fR: 
.br
	typeof: string 
.br
	The format, how the state should be displayed.\&
.P
\fBformat-icons\fR: 
.br
	typeof: array 
.br
	Based on the current state, the corresponding icon gets selected.\&
.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
\fBon-click\fR: 
.br
	typeof: string 
.br
	Command to execute when clicked on the module.\& A click also toggles the state
.P
\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.\&
.P
\fBon-scroll-down\fR: 
.br
	typeof: string 
.br
	Command to execute when scrolling down on the module.\&
.P
\fBsmooth-scrolling-threshold\fR: 
.br
	typeof: double 
.br
	Threshold to be used when scrolling.\&
.P
\fBstart-activated\fR: 
.br
  typeof: bool 
.br
  default: \fBfalse\fR 
.br
  Whether the inhibit should be activated when starting waybar.\&
.P
\fBtimeout\fR: 
.br
	typeof: double 
.br
	The number of minutes the inhibit should last.\&
.P
\fBtooltip\fR: 
.br
	typeof: bool 
.br
	default: true 
.br
	Option to disable tooltip on hover.\&
.P
\fBtooltip-format-activated\fR: 
.br
	typeof: string 
.br
	This format is used when the inhibit is activated.\&
.P
\fBtooltip-format-deactivated\fR: 
.br
	typeof: string 
.br
	This format is used when the inhibit is deactivated.\&
.P
.SH FORMAT REPLACEMENTS
.P
\fB{status}\fR: status (\fBactivated\fR or \fBdeactivated\fR)
.P
\fB{icon}\fR: Icon, as defined in \fBformat-icons\fR
.P
.SH EXAMPLES
.P
.nf
.RS 4
"idle_inhibitor": {
	"format": "{icon}",
	"format-icons": {
	    "activated": "",
	    "deactivated": ""
	},
	"timeout": 30\&.5
}
.fi
.RE