.\" 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-cpu" "5" "2024-05-09"
.PP
.SH NAME
.PP
waybar - cpu module
.PP
.SH DESCRIPTION
.PP
The \fBcpu\fR module displays the current CPU utilization.\&
.PP
.SH CONFIGURATION
.PP
\fBinterval\fR: 
.br
	typeof: integer 
.br
	default: 10 
.br
	The interval in which the information gets polled.\&
.PP
\fBformat\fR: 
.br
	typeof: string  
.br
	default: {usage}% 
.br
	The format, how information should be displayed.\& On {} data gets inserted.\&
.PP
\fBformat-icons\fR: 
.br
	typeof: array/object 
.br
	Based on the current usage, the corresponding icon gets selected.\& 
.br
	The order is \fBlow\fR to \fBhigh\fR.\& Or by the state if it is an object.\&
.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
\fBrotate\fR: 
.br
	typeof: integer 
.br
	Positive value to rotate the text label.\&
.PP
\fBstates\fR: 
.br
	typeof: object 
.br
	A number of CPU usage states which get activated on certain usage levels.\& See \fBwaybar-states(5)\fR.\&
.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
\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
.SH FORMAT REPLACEMENTS
.PP
\fB{load}\fR: Current CPU load.\&
.PP
\fB{usage}\fR: Current overall CPU usage.\&
.PP
\fB{usage\fR{n}\fB}\fR: Current CPU core n usage.\& Cores are numbered from zero, so first core will be {usage0} and 4th will be {usage3}.\&
.PP
\fB{avg_frequency}\fR: Current CPU average frequency (based on all cores) in GHz.\&
.PP
\fB{max_frequency}\fR: Current CPU max frequency (based on the core with the highest frequency) in GHz.\&
.PP
\fB{min_frequency}\fR: Current CPU min frequency (based on the core with the lowest frequency) in GHz.\&
.PP
\fB{icon}\fR: Icon for overall CPU usage.\&
.PP
\fB{icon\fR{n}\fB}\fR: Icon for CPU core n usage.\& Use like {icon0}.\&
.PP
.SH EXAMPLES
.PP
Basic configuration:
.PP
.nf
.RS 4
"cpu": {
	"interval": 10,
	"format": "{}% ",
	"max-length": 10
}
.fi
.RE
.PP
CPU usage per core rendered as icons:
.PP
.nf
.RS 4
"cpu": {
	"interval": 1,
	"format": "{icon0}{icon1}{icon2}{icon3} {usage:>2}% ",
	"format-icons": ["▁", "▂", "▃", "▄", "▅", "▆", "▇", "█"],
},
.fi
.RE
.PP
.SH STYLE
.PP
.PD 0
.IP \(bu 4
\fB#cpu\fR