.\" Generated by scdoc 1.11.2
.\" 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 "waybar-temperature" "5" "2023-02-28"
.P
.SH NAME
.P
waybar - temperature module
.P
.SH DESCRIPTION
.P
The \fBtemperature\fR module displays the current temperature from a thermal zone.\&
.P
.SH CONFIGURATION
.P
Addressed by \fBtemperature\fR
.P
\fBthermal-zone\fR: 
.br
	typeof: integer 
.br
	The thermal zone, as in \fB/sys/class/thermal/\fR.\&
.P
\fBhwmon-path\fR: 
.br
	typeof: string 
.br
	The temperature path to use, e.\&g.\& \fB/sys/class/hwmon/hwmon2/temp1_input\fR instead of one in \fB/sys/class/thermal/\fR.\&
.P
\fBhwmon-path-abs\fR: 
.br
	typeof: string 
.br
	The path of the hwmon-directory of the device, e.\&g.\& \fB/sys/devices/pci0000:00/0000:00:18.\&3/hwmon\fR.\& (Note that the subdirectory \fBhwmon/hwmon#\fR, where \fB#\fR is a number is not part of the path!\&) Has to be used together with \fBinput-filename\fR.\&
.P
\fBinput-filename\fR: 
.br
	typeof: string 
.br
	The temperature filename of your \fBhwmon-path-abs\fR, e.\&g.\& \fBtemp1_input\fR
.P
\fBcritical-threshold\fR: 
.br
	typeof: integer 
.br
	The threshold before it is considered critical (Celsius).\&
.P
\fBinterval\fR: 
.br
	typeof: integer 
.br
	default: 10 
.br
	The interval in which the information gets polled.\&
.P
\fBformat-critical\fR: 
.br
	typeof: string 
.br
	The format to use when temperature is considered critical
.P
\fBformat\fR: 
.br
	typeof: string  
.br
	default: {temperatureC}°C 
.br
	The format (Celsius/Fahrenheit/Kelvin) in which the temperature should be displayed.\&
.P
\fBformat-icons\fR: 
.br
	typeof: array 
.br
	Based on the current temperature (Celsius) and \fBcritical-threshold\fR if available, the corresponding icon gets selected.\& The order is \fBlow\fR to \fBhigh\fR.\&
.P
\fBtooltip-format\fR: 
.br
	typeof: string  
.br
	default: {temperatureC}°C 
.br
	The format for the tooltip
.P
\fBrotate\fR: 
.br
	typeof: integer 
.br
	Positive value to rotate the text label.\&
.P
\fBmax-length\fR: 
.br
	typeof: integer 
.br
	The maximum length in characters the module should display.\&
.P
\fBmin-length\fR: 
.br
    typeof: integer 
.br
    The minimum length in characters the module should take up.\&
.P
\fBalign\fR: 
.br
    typeof: float 
.br
    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.\&
.P
\fBon-click\fR: 
.br
	typeof: string 
.br
	Command to execute when you clicked on the module.\&
.P
\fBon-click-middle\fR: 
.br
	typeof: string 
.br
	Command to execute when middle-clicked on the module using mousewheel.\&
.P
\fBon-click-right\fR: 
.br
	typeof: string 
.br
	Command to execute when you right clicked on the module.\&
.P
\fBon-update\fR: 
.br
	typeof: string 
.br
	Command to execute when the module is updated.\&
.P
\fBon-scroll-up\fR: 
.br
	typeof: string 
.br
	Command to execute when scrolling up on the module.\&
.P
\fBon-scroll-down\fR: 
.br
	typeof: string 
.br
	Command to execute when scrolling down on the module.\&
.P
\fBsmooth-scrolling-threshold\fR: 
.br
	typeof: double 
.br
	Threshold to be used when scrolling.\&
.P
\fBtooltip\fR: 
.br
	typeof: bool 
.br
	default: true 
.br
	Option to disable tooltip on hover.\&
.P
.SH FORMAT REPLACEMENTS
.P
\fB{temperatureC}\fR: Temperature in Celsius.\&
.P
\fB{temperatureF}\fR: Temperature in Fahrenheit.\&
.P
\fB{temperatureK}\fR: Temperature in Kelvin.\&
.P
.SH EXAMPLES
.P
.nf
.RS 4
 "temperature": {
	// "thermal-zone": 2,
	// "hwmon-path": "/sys/class/hwmon/hwmon2/temp1_input",
	// "critical-threshold": 80,
	// "format-critical": "{temperatureC}°C ",
	"format": "{temperatureC}°C "
}
.fi
.RE
.P
.SH STYLE
.P
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fB#temperature\fR
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fB#temperature.\&critical\fR
.RE