1waybar-cpu(5)                 File Formats Manual                waybar-cpu(5)
2
3
4

NAME

6       waybar - cpu module
7

DESCRIPTION

9       The cpu module displays the current cpu utilization.
10

CONFIGURATION

12       interval:
13            typeof: integer
14            default: 10
15            The interval in which the information gets polled.
16
17       format:
18            typeof: string
19            default: {usage}%
20            The format, how information should be displayed. On {} data gets
21       inserted.
22
23       format-icons:
24            typeof: array/object
25            Based on the current usage, the corresponding icon gets selected.
26            The order is low to high. Or by the state if it is an object.
27
28       max-length:
29            typeof: integer
30            The maximum length in character the module should display.
31
32       min-length:
33            typeof: integer
34            The minimum length in characters the module should take up.
35
36       align:
37            typeof: float
38            The alignment of the text, where 0 is left-aligned and 1 is right-
39       aligned. If the module is rotated, it will follow the flow of the text.
40
41       rotate:
42            typeof: integer
43            Positive value to rotate the text label.
44
45       states:
46            typeof: object
47            A number of cpu usage states which get activated on certain usage
48       levels. See waybar-states(5).
49
50       on-click:
51            typeof: string
52            Command to execute when clicked on the module.
53
54       on-click-middle:
55            typeof: string
56            Command to execute when middle-clicked on the module using mouse‐
57       wheel.
58
59       on-click-right:
60            typeof: string
61            Command to execute when you right clicked on the module.
62
63       on-update:
64            typeof: string
65            Command to execute when the module is updated.
66
67       on-scroll-up:
68            typeof: string
69            Command to execute when scrolling up on the module.
70
71       on-scroll-down:
72            typeof: string
73            Command to execute when scrolling down on the module.
74
75       smooth-scrolling-threshold:
76            typeof: double
77            Threshold to be used when scrolling.
78
79       tooltip:
80            typeof: bool
81            default: true
82            Option to disable tooltip on hover.
83

FORMAT REPLACEMENTS

85       {load}: Current cpu load.
86
87       {usage}: Current overall cpu usage.
88
89       {usage{n}}: Current cpu core n usage. Cores are numbered from zero, so
90       first core will be {usage0} and 4th will be {usage3}.
91
92       {avg_frequency}: Current cpu average frequency (based on all cores) in
93       GHz.
94
95       {max_frequency}: Current cpu max frequency (based on the core with the
96       highest frequency) in GHz.
97
98       {min_frequency}: Current cpu min frequency (based on the core with the
99       lowest frequency) in GHz.
100
101       {icon}: Icon for overall cpu usage.
102
103       {icon{n}}: Icon for cpu core n usage. Use like {icon0}.
104

EXAMPLES

106       Basic configuration:
107
108           "cpu": {
109                "interval": 10,
110                "format": "{}% ",
111                "max-length": 10
112           }
113
114       Cpu usage per core rendered as icons:
115
116           "cpu": {
117                "interval": 1,
118                "format": "{icon0}{icon1}{icon2}{icon3} {usage:>2}% ",
119                "format-icons": ["▁", "▂", "▃", "▄", "▅", "▆", "▇", "█"],
120           },
121

STYLE

123       •   #cpu
124
125
126
127                                  2023-08-16                     waybar-cpu(5)