.\" Generated by scdoc 1.11.0
.\" 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-cpu" "5" "2021-01-30"
.P
.SH NAME
.P
waybar - cpu module
.P
.SH DESCRIPTION
.P
The \fBcpu\fR module displays the current cpu utilization.
.P
.SH CONFIGURATION
.P
\fBinterval\fR: 
.br
	typeof: integer 
.br
	default: 10 
.br
	The interval in which the information gets polled.
.P
\fBformat\fR: 
.br
	typeof: string  
.br
	default: {usage}% 
.br
	The format, how information should be displayed. On {} data gets inserted.
.P
\fBmax-length\fR: 
.br
	typeof: integer 
.br
	The maximum length in character the module should display.
.P
\fBrotate\fR: 
.br
	typeof: integer 
.br
	Positive value to rotate the text label.
.P
\fBstates\fR: 
.br
	typeof: array 
.br
	A number of cpu usage states which get activated on certain usage levels. See \fBwaybar-states(5)\fR.
.P
\fBon-click\fR: 
.br
	typeof: string  
.br
	Command to execute when clicked on the module.
.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
\fBtooltip\fR: 
.br
	typeof: bool 
.br
	default: true 
.br
	Option to disable tooltip on hover.
.P
.SH FORMAT REPLACEMENTS
.P
\fB{load}\fR: Current cpu load.
.P
\fB{usage}\fR: Current cpu usage.
.P
.SH EXAMPLE
.P
.nf
.RS 4
"cpu": {
	"interval": 10,
	"format": "{}% ",
	"max-length": 10
}
.fi
.RE
.P
.SH STYLE
.P
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fB#cpu\fR
.RE