Waybar/man/waybar-temperature.5.scd

131 lines
3.2 KiB
Plaintext
Raw Normal View History

2019-08-26 17:13:48 +00:00
waybar-temperature(5)
# NAME
waybar - temperature module
# DESCRIPTION
The *temperature* module displays the current temperature from a thermal zone.
# CONFIGURATION
Addressed by *temperature*
*thermal-zone*: ++
2019-12-29 04:24:33 +00:00
typeof: integer ++
The thermal zone, as in */sys/class/thermal/*.
2019-08-26 17:13:48 +00:00
*hwmon-path*: ++
2019-12-29 04:24:33 +00:00
typeof: string ++
The temperature path to use, e.g. */sys/class/hwmon/hwmon2/temp1_input* instead of one in */sys/class/thermal/*.
2019-08-26 17:13:48 +00:00
*hwmon-path-abs*: ++
typeof: string ++
The path of the hwmon-directory of the device, e.g. */sys/devices/pci0000:00/0000:00:18.3/hwmon*. (Note that the subdirectory *hwmon/hwmon#*, where *#* is a number is not part of the path!) Has to be used together with *input-filename*.
*input-filename*: ++
typeof: string ++
The temperature filename of your *hwmon-path-abs*, e.g. *temp1_input*
2019-08-26 17:13:48 +00:00
*critical-threshold*: ++
2019-12-29 04:24:33 +00:00
typeof: integer ++
2020-02-03 09:40:26 +00:00
The threshold before it is considered critical (Celsius).
2019-08-26 17:13:48 +00:00
*interval*: ++
2019-12-29 04:24:33 +00:00
typeof: integer ++
default: 10 ++
The interval in which the information gets polled.
2019-08-26 17:13:48 +00:00
*format-critical*: ++
2019-12-29 04:24:33 +00:00
typeof: string ++
The format to use when temperature is considered critical
2019-08-26 17:13:48 +00:00
*format*: ++
2019-12-29 04:24:33 +00:00
typeof: string ++
default: {temperatureC}°C ++
2020-04-25 16:57:56 +00:00
The format (Celsius/Fahrenheit/Kelvin) in which the temperature should be displayed.
2019-08-26 17:13:48 +00:00
*format-icons*: ++
2019-12-29 04:24:33 +00:00
typeof: array ++
2020-02-03 09:40:26 +00:00
Based on the current temperature (Celsius) and *critical-threshold* if available, the corresponding icon gets selected. The order is *low* to *high*.
2019-08-26 17:13:48 +00:00
*tooltip-format*: ++
typeof: string ++
default: {temperatureC}°C ++
The format for the tooltip
2019-08-26 17:13:48 +00:00
*rotate*: ++
2019-12-29 04:24:33 +00:00
typeof: integer ++
Positive value to rotate the text label.
2019-08-26 17:13:48 +00:00
*max-length*: ++
2019-12-29 04:24:33 +00:00
typeof: integer ++
The maximum length in characters the module should display.
2019-08-26 17:13:48 +00:00
2021-02-01 16:34:51 +00:00
*min-length*: ++
typeof: integer ++
The minimum length in characters the module should take up.
*align*: ++
typeof: float ++
The alignment of the text, where 0 is left-aligned and 1 is right-aligned. If the module is rotated, it will follow the flow of the text.
2019-08-26 17:13:48 +00:00
*on-click*: ++
2019-12-29 04:24:33 +00:00
typeof: string ++
Command to execute when you clicked on the module.
*on-click-middle*: ++
typeof: string ++
Command to execute when middle-clicked on the module using mousewheel.
2019-08-26 17:13:48 +00:00
*on-click-right*: ++
2019-12-29 04:24:33 +00:00
typeof: string ++
Command to execute when you right clicked on the module.
2019-08-26 17:13:48 +00:00
2020-04-12 16:35:41 +00:00
*on-update*: ++
typeof: string ++
Command to execute when the module is updated.
2019-08-26 17:13:48 +00:00
*on-scroll-up*: ++
2019-12-29 04:24:33 +00:00
typeof: string ++
Command to execute when scrolling up on the module.
2019-08-26 17:13:48 +00:00
*on-scroll-down*: ++
2019-12-29 04:24:33 +00:00
typeof: string ++
Command to execute when scrolling down on the module.
2019-08-26 17:13:48 +00:00
*smooth-scrolling-threshold*: ++
2019-12-29 04:24:33 +00:00
typeof: double ++
Threshold to be used when scrolling.
2019-08-26 17:13:48 +00:00
*tooltip*: ++
2019-12-29 04:24:33 +00:00
typeof: bool ++
default: true ++
Option to disable tooltip on hover.
2019-08-26 17:13:48 +00:00
# FORMAT REPLACEMENTS
2020-02-03 09:40:26 +00:00
*{temperatureC}*: Temperature in Celsius.
2019-08-26 17:13:48 +00:00
*{temperatureF}*: Temperature in Fahrenheit.
2020-04-25 16:57:56 +00:00
*{temperatureK}*: Temperature in Kelvin.
2019-08-26 17:13:48 +00:00
# EXAMPLES
```
"temperature": {
// "thermal-zone": 2,
// "hwmon-path": "/sys/class/hwmon/hwmon2/temp1_input",
// "critical-threshold": 80,
// "format-critical": "{temperatureC}°C ",
"format": "{temperatureC}°C "
}
```
# STYLE
- *#temperature*
- *#temperature.critical*