waybar/man/waybar-cpu.5.scd

83 lines
1.5 KiB
Plaintext
Raw Normal View History

2019-08-26 14:23:11 +02:00
waybar-cpu(5)
# NAME
waybar - cpu module
# DESCRIPTION
The *cpu* module displays the current cpu utilization.
# CONFIGURATION
*interval*: ++
2019-08-26 14:31:57 +02:00
typeof: integer ++
default: 10 ++
The interval in which the information gets polled.
2019-08-26 14:23:11 +02:00
*format*: ++
2019-08-26 14:31:57 +02:00
typeof: string ++
default: {usage}% ++
The format, how information should be displayed. On {} data gets inserted.
2019-08-26 14:23:11 +02:00
*max-length*: ++
2019-08-26 14:31:57 +02:00
typeof: integer ++
The maximum length in character the module should display.
2019-08-26 14:23:11 +02:00
*rotate*: ++
2019-08-26 14:31:57 +02:00
typeof: integer ++
Positive value to rotate the text label.
2019-08-26 14:23:11 +02:00
*states*: ++
2019-08-26 14:31:57 +02:00
typeof: array ++
A number of cpu usage states which get activated on certain usage levels. See *waybar-states(5)*.
2019-08-26 14:23:11 +02:00
*on-click*: ++
2019-08-26 14:31:57 +02:00
typeof: string ++
Command to execute when clicked on the module.
2019-08-26 14:23:11 +02:00
2019-12-29 05:20:29 +01:00
*on-click-middle*: ++
typeof: string ++
Command to execute when middle-clicked on the module using mousewheel.
2019-08-26 14:23:11 +02:00
*on-click-right*: ++
2019-08-26 14:31:57 +02:00
typeof: string ++
Command to execute when you right clicked on the module.
2019-08-26 14:23:11 +02:00
*on-scroll-up*: ++
2019-08-26 14:31:57 +02:00
typeof: string ++
Command to execute when scrolling up on the module.
2019-08-26 14:23:11 +02:00
*on-scroll-down*: ++
2019-08-26 14:31:57 +02:00
typeof: string ++
Command to execute when scrolling down on the module.
2019-08-26 14:23:11 +02:00
*smooth-scrolling-threshold*: ++
2019-08-26 14:31:57 +02:00
typeof: double ++
Threshold to be used when scrolling.
2019-08-26 14:23:11 +02:00
*tooltip*: ++
2019-08-26 14:31:57 +02:00
typeof: bool ++
default: true ++
Option to disable tooltip on hover.
2019-08-26 14:23:11 +02:00
# FORMAT REPLACEMENTS
*{load}*: Current cpu load.
*{usage}*: Current cpu usage.
# EXAMPLE
```
"cpu": {
2019-08-26 14:31:57 +02:00
"interval": 10,
"format": "{}% ",
"max-length": 10
2019-08-26 14:23:11 +02:00
}
```
# STYLE
- *#cpu*