.\" Generated by scdoc 1.11.5
.\" 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 "yambar\-modules\-cpu" "5" "2026\-09\-18"
.PP
.SH NAME
cpu \- This module provides the CPU usage
.PP
.SH DESCRIPTION
.PP
This module reports CPU usage, in percent.\& The \fIcontent\fR particle is a
template that is instantiated once for each core, and once for the
total CPU usage.\&
.PP
.SH TAGS
.PP
.TS
allbox;l l lx
l l lx
l l lx.
T{
\fBName\fR
T}	T{
\fBType\fR
T}	T{
\fBDescription\fR
T}
T{
id
T}	T{
int
T}	T{
Core ID.\& 0.\&.\&n represents individual cores, and \-1 represents the total usage
T}
T{
cpu
T}	T{
range
T}	T{
Current usage of CPU core {id}, in percent
T}
.TE
.sp 1
.SH CONFIGURATION
.PP
.TS
allbox;l l l lx
l l l lx.
T{
\fBName\fR
T}	T{
\fBType\fR
T}	T{
\fBReq\fR
T}	T{
\fBDescription\fR
T}
T{
poll\-interval
T}	T{
int
T}	T{
no
T}	T{
Refresh interval of the CPU usage stats in milliseconds (default=500).\& Cannot be less then 250ms.\&
T}
.TE
.sp 1
.SH EXAMPLES
.PP
.SS Display total CPU usage as a number
.nf
.RS 4
bar:
  left:
    \- cpu:
        poll\-interval: 2500
        content:
          map:
            conditions:
              id < 0:
                \- string: {text: , font: Font Awesome 6 Free:style=solid}
                \- string: {text: "{cpu}%"}
.fi
.RE
.PP
.SS Display a vertical bar for each core
.nf
.RS 4
bar:
  left:
    \- cpu:
        poll\-interval: 2500
        content:
          map:
            conditions:
              id >= 0:
                \- ramp:
                    tag: cpu
                    items:
                      \- string: {text: ▁}
                      \- string: {text: ▂}
                      \- string: {text: ▃}
                      \- string: {text: ▄}
                      \- string: {text: ▅}
                      \- string: {text: ▆}
                      \- string: {text: ▇}
                      \- string: {text: █}
.fi
.RE
.PP
.PP
.SH SEE ALSO
.PP
\fByambar\-modules\fR(5), \fByambar\-particles\fR(5), \fByambar\-tags\fR(5), \fByambar\-decorations\fR(5)