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