xref: /openbsd-src/usr.sbin/sensorsd/sensorsd.8 (revision aaeccf361df1072faadf2a1fead1655dd480730e)
1.\"	$OpenBSD: sensorsd.8,v 1.25 2018/01/12 04:36:45 deraadt Exp $
2.\"
3.\" Copyright (c) 2003 Henning Brauer <henning@openbsd.org>
4.\" Copyright (c) 2005 Matthew Gream <matthew.gream@pobox.com>
5.\" Copyright (c) 2007 Constantine A. Murenin <cnst@openbsd.org>
6.\"
7.\" Permission to use, copy, modify, and distribute this software for any
8.\" purpose with or without fee is hereby granted, provided that the above
9.\" copyright notice and this permission notice appear in all copies.
10.\"
11.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18.\"
19.Dd $Mdocdate: January 12 2018 $
20.Dt SENSORSD 8
21.Os
22.Sh NAME
23.Nm sensorsd
24.Nd hardware sensors monitor
25.Sh SYNOPSIS
26.Nm sensorsd
27.Op Fl d
28.Op Fl c Ar check
29.Op Fl f Ar file
30.Sh DESCRIPTION
31The
32.Nm
33utility retrieves sensor monitoring data like fan speed,
34temperature, voltage and RAID logical disk status from the
35.Xr sysctl 2
36.Va hw.sensors
37subtree.
38When the state of any monitored sensor changes, an alert is triggered.
39Every alert logs a message to
40.Xr syslog 3
41using the
42.Cm daemon
43facility.
44Optionally, an alert can be configured to execute a command.
45.Pp
46By default,
47.Nm
48monitors status changes on all sensors that keep their state,
49thus sensors that automatically provide status do not require
50any additional configuration.
51In addition, for every sensor,
52no matter whether it automatically provides its state or not,
53custom low and high limits may be set,
54so that a local notion of sensor status can be computed by
55.Nm ,
56indicating whether the sensor is within or is exceeding its limits.
57.Pp
58Limit and command values for a particular sensor may be specified in the
59.Xr sensorsd.conf 5
60configuration file.
61This file is reloaded upon receiving
62.Dv SIGHUP .
63.Pp
64The options are as follows:
65.Bl -tag -width Ds
66.It Fl c Ar check
67Check sensors every
68.Ar check
69seconds.
70The default is 20.
71The state of a sensor is not yet regarded as changed when a check
72returns a new state for the first time, but only when the two
73subsequent checks both confirm the new state.
74.It Fl d
75Do not daemonize.
76If this option is specified,
77.Nm
78will run in the foreground.
79.It Fl f Ar file
80Read configuration from
81.Ar file
82instead of the default configuration file
83.Pa /etc/sensorsd.conf .
84.El
85.Sh FILES
86.Bl -tag -width "/etc/sensorsd.conf"
87.It Pa /etc/sensorsd.conf
88Configuration file for
89.Nm .
90.El
91.Sh SEE ALSO
92.Xr sysctl 2 ,
93.Xr sensorsd.conf 5 ,
94.Xr syslog.conf 5 ,
95.Xr sysctl 8
96.Sh HISTORY
97The
98.Nm
99program first appeared in
100.Ox 3.5 .
101.Sh CAVEATS
102Certain sensors may erratically flip status from time to time.
103To guard against false reports,
104.Nm
105requires two confirmations before reporting a state change.
106However, this inevitably introduces
107an additional delay in status reporting and command execution,
108e.g. one may notice that
109.Nm
110makes its initial report about the state of monitored sensors
111not immediately, but by default about 60 seconds after it is started.
112