xref: /dragonfly/usr.sbin/sensorsd/sensorsd.8 (revision b7367ef6)
1.\" $OpenBSD: sensorsd.8,v 1.16 2007/08/11 20:45:35 cnst Exp $
2.\" $DragonFly: src/usr.sbin/sensorsd/sensorsd.8,v 1.2 2007/10/03 20:06:54 swildner Exp $
3.\"
4.\" Copyright (c) 2003 Henning Brauer <henning@openbsd.org>
5.\" Copyright (c) 2005 Matthew Gream <matthew.gream@pobox.com>
6.\" Copyright (c) 2007 Constantine A. Murenin <cnst@FreeBSD.org>
7.\"
8.\" Permission to use, copy, modify, and distribute this software for any
9.\" purpose with or without fee is hereby granted, provided that the above
10.\" copyright notice and this permission notice appear in all copies.
11.\"
12.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
13.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
14.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
15.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
16.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
17.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
18.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
19.\"
20.Dd August 11, 2007
21.Dt SENSORSD 8
22.Os
23.Sh NAME
24.Nm sensorsd
25.Nd hardware sensors monitor
26.Sh SYNOPSIS
27.Nm
28.Op Fl d
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 d
62Do not daemonize.
63If this option is specified,
64.Nm
65will run in the foreground.
66.El
67.Sh FILES
68.Bl -tag -width "/etc/sensorsd.conf"
69.It /etc/sensorsd.conf
70Configuration file for
71.Nm .
72.El
73.Sh SEE ALSO
74.Xr sysctl 3 ,
75.Xr syslog 3 ,
76.Xr sensorsd.conf 5 ,
77.Xr syslogd 8
78.Sh HISTORY
79The
80.Nm
81program first appeared in
82.Ox 3.5 .
83.Sh CAVEATS
84Certain sensors may flip status from time to time.
85To guard against false reports,
86.Nm
87implements a state dumping mechanism.
88However, this inevitably introduces
89an additional delay in status reporting and command execution,
90e.g. one may notice that
91.Nm
92makes its initial report about the state of monitored sensors
93not immediately, but either 1 or 2 minutes after it is being started up.
94