xref: /openbsd-src/usr.sbin/sensorsd/sensorsd.8 (revision 0b7734b3d77bb9b21afec6f4621cae6c805dbd45)
1.\"	$OpenBSD: sensorsd.8,v 1.22 2015/07/27 17:28:40 sobrado 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: July 27 2015 $
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.Sh DESCRIPTION
30The
31.Nm
32utility retrieves sensor monitoring data like fan speed,
33temperature, voltage and RAID logical disk status via
34.Xr sysctl 3 .
35When the state of any monitored sensor changes, an alert is sent using
36.Xr syslog 3
37and a command, if specified, is executed.
38.Pp
39By default,
40.Nm
41monitors status changes on all sensors that keep their state,
42thus sensors that automatically provide status do not require
43any additional configuration.
44In addition, for every sensor,
45no matter whether it automatically provides its state or not,
46custom low and high limits may be set,
47so that a local notion of sensor status can be computed by
48.Nm ,
49indicating whether the sensor is within or is exceeding its limits.
50.Pp
51Limit and command values for a particular sensor may be specified in the
52.Xr sensorsd.conf 5
53configuration file.
54This file is reloaded upon receiving
55.Dv SIGHUP .
56.Pp
57The options are as follows:
58.Bl -tag -width Ds
59.It Fl c Ar check
60Check sensors every
61.Ar check
62seconds.
63The shortest reporting period for state changes
64will be three times this value.
65The default is 20.
66.It Fl d
67Do not daemonize.
68If this option is specified,
69.Nm
70will run in the foreground.
71.El
72.Sh FILES
73.Bl -tag -width "/etc/sensorsd.conf"
74.It Pa /etc/sensorsd.conf
75Configuration file for
76.Nm .
77.El
78.Sh SEE ALSO
79.Xr sysctl 3 ,
80.Xr syslog 3 ,
81.Xr sensorsd.conf 5 ,
82.Xr syslogd 8
83.Sh HISTORY
84The
85.Nm
86program first appeared in
87.Ox 3.5 .
88.Sh CAVEATS
89Certain sensors may flip status from time to time.
90To guard against false reports,
91.Nm
92implements a state dumping mechanism.
93However, this inevitably introduces
94an additional delay in status reporting and command execution,
95e.g. one may notice that
96.Nm
97makes its initial report about the state of monitored sensors
98not immediately, but about 60 seconds after it is started.
99