From 4f9c3d241383f5b4be1bc0ea8aa713a59cc33fa4 Mon Sep 17 00:00:00 2001 From: Michael Aquilina Date: Mon, 26 Aug 2019 18:13:48 +0100 Subject: [PATCH] Add waybar-temperature(5) --- man/waybar-temperature.5.scd | 99 ++++++++++++++++++++++++++++++++++++ meson.build | 1 + 2 files changed, 100 insertions(+) create mode 100644 man/waybar-temperature.5.scd diff --git a/man/waybar-temperature.5.scd b/man/waybar-temperature.5.scd new file mode 100644 index 0000000..8177969 --- /dev/null +++ b/man/waybar-temperature.5.scd @@ -0,0 +1,99 @@ +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*: ++ + typeof: integer ++ + The thermal zone, as in */sys/class/thermal/*. + +*hwmon-path*: ++ + typeof: string ++ + The temperature path to use, e.g. */sys/class/hwmon/hwmon2/temp1_input* instead of one in */sys/class/thermal/*. + +*critical-threshold*: ++ + typeof: integer ++ + The threshold before it is considered critical (Celcius). + +*interval*: ++ + typeof: integer ++ + default: 10 ++ + The interval in which the information gets polled. + +*format-critical*: ++ + typeof: string ++ + The format to use when temperature is considered critical + +*format*: ++ + typeof: string ++ + default: {temperatureC}°C ++ + The format (Celcius/Farenheit) in which the temperature should be displayed. + +*format-icons*: ++ + typeof: array ++ + Based on the current temperature (Celcius) and *critical-threshold* if available, the corresponding icon gets selected. The order is *low* to *high*. + +*rotate*: ++ + typeof: integer ++ + Positive value to rotate the text label. + +*max-length*: ++ + typeof: integer ++ + The maximum length in characters the module should display. + +*on-click*: ++ + typeof: string ++ + Command to execute when you clicked on the module. + +*on-click-right*: ++ + typeof: string ++ + Command to execute when you right clicked on the module. + +*on-scroll-up*: ++ + typeof: string ++ + Command to execute when scrolling up on the module. + +*on-scroll-down*: ++ + typeof: string ++ + Command to execute when scrolling down on the module. + +*smooth-scrolling-threshold*: ++ + typeof: double ++ + Threshold to be used when scrolling. + +*tooltip*: ++ + typeof: bool ++ + default: true ++ + Option to disable tooltip on hover. + +# FORMAT REPLACEMENTS + +*{temperatureC}*: Temperature in Celcius. + +*{temperatureF}*: Temperature in Fahrenheit. + +# 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* diff --git a/meson.build b/meson.build index 89b8994..5040b66 100644 --- a/meson.build +++ b/meson.build @@ -174,6 +174,7 @@ if scdoc.found() 'waybar-sway-mode.5.scd', 'waybar-sway-window.5.scd', 'waybar-sway-workspaces.5.scd', + 'waybar-temperature.5.scd', ] foreach filename : man_files