.\" 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-backlight" "5" "2023-02-28"
.P
.SH NAME
.P
waybar - backlight module
.P
.SH DESCRIPTION
.P
The \fBbacklight\fR module displays the current backlight level.\&
.P
.SH CONFIGURATION
.P
\fBinterval\fR: 
.br
	typeof: integer 
.br
	default: 2 
.br
	The interval in which information gets polled.\&
.P
\fBformat\fR: 
.br
	typeof: string 
.br
	default: {percent}% 
.br
	The format, how information should be displayed.\& On {} data gets inserted.\&
.P
\fBmax-length\fR: 
.br
	typeof: integer 
.br
	The maximum length in characters 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
\fBrotate\fR: 
.br
	typeof: integer 
.br
	Positive value to rotate the text label.\&
.P
\fBstates\fR: 
.br
	typeof: object 
.br
	A number of backlight states which get activated on certain brightness levels.\& See \fBwaybar-states(5)\fR.\&
.P
\fBon-click\fR: 
.br
	typeof: string 
.br
	Command to execute when the module is clicked.\&
.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 the module is right clicked.\&
.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 performing a scroll up on the module.\&
.P
\fBon-scroll-down\fR: 
.br
	typeof: string
.RS 4
Command to execute when performing a scroll down on the module.\&
.P
.RE
\fBsmooth-scrolling-threshold\fR: 
.br
	typeof: double
.RS 4
Threshold to be used when scrolling.\&
.P
.RE
.SH EXAMPLE:
.P
.nf
.RS 4
"backlight": {
    "device": "intel_backlight",
    "format": "{percent}% {icon}",
    "format-icons": ["", ""]
}
.fi
.RE
.P
.SH STYLE
.P
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fB#backlight\fR
.RE