xref: /openbsd-src/usr.sbin/sensorsd/sensorsd.8 (revision aaeccf361df1072faadf2a1fead1655dd480730e)
1*aaeccf36Sderaadt.\"	$OpenBSD: sensorsd.8,v 1.25 2018/01/12 04:36:45 deraadt Exp $
200a49680Shenning.\"
300a49680Shenning.\" Copyright (c) 2003 Henning Brauer <henning@openbsd.org>
4ee263a2cShshoexer.\" Copyright (c) 2005 Matthew Gream <matthew.gream@pobox.com>
5cf62077dScnst.\" Copyright (c) 2007 Constantine A. Murenin <cnst@openbsd.org>
600a49680Shenning.\"
700a49680Shenning.\" Permission to use, copy, modify, and distribute this software for any
800a49680Shenning.\" purpose with or without fee is hereby granted, provided that the above
900a49680Shenning.\" copyright notice and this permission notice appear in all copies.
1000a49680Shenning.\"
1100a49680Shenning.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
1200a49680Shenning.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1300a49680Shenning.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
1400a49680Shenning.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
1500a49680Shenning.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
1600a49680Shenning.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
1700a49680Shenning.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1800a49680Shenning.\"
19*aaeccf36Sderaadt.Dd $Mdocdate: January 12 2018 $
2000a49680Shenning.Dt SENSORSD 8
2100a49680Shenning.Os
2200a49680Shenning.Sh NAME
2300a49680Shenning.Nm sensorsd
244b25f8e2Scnst.Nd hardware sensors monitor
2500a49680Shenning.Sh SYNOPSIS
2600a49680Shenning.Nm sensorsd
27750333acSjmc.Op Fl d
28ecae9564Stedu.Op Fl c Ar check
29017ace1eSbluhm.Op Fl f Ar file
3000a49680Shenning.Sh DESCRIPTION
3100a49680ShenningThe
3200a49680Shenning.Nm
33cf62077dScnstutility retrieves sensor monitoring data like fan speed,
342069f8e0Sschwarzetemperature, voltage and RAID logical disk status from the
35*aaeccf36Sderaadt.Xr sysctl 2
362069f8e0Sschwarze.Va hw.sensors
372069f8e0Sschwarzesubtree.
382069f8e0SschwarzeWhen the state of any monitored sensor changes, an alert is triggered.
392069f8e0SschwarzeEvery alert logs a message to
4000a49680Shenning.Xr syslog 3
412069f8e0Sschwarzeusing the
422069f8e0Sschwarze.Cm daemon
432069f8e0Sschwarzefacility.
442069f8e0SschwarzeOptionally, an alert can be configured to execute a command.
4500a49680Shenning.Pp
46d62c2f6dScnstBy default,
47d62c2f6dScnst.Nm
48cf62077dScnstmonitors status changes on all sensors that keep their state,
49cf62077dScnstthus sensors that automatically provide status do not require
50cf62077dScnstany additional configuration.
51cf62077dScnstIn addition, for every sensor,
52cf62077dScnstno matter whether it automatically provides its state or not,
53cf62077dScnstcustom low and high limits may be set,
54cf62077dScnstso that a local notion of sensor status can be computed by
55cf62077dScnst.Nm ,
56cf62077dScnstindicating whether the sensor is within or is exceeding its limits.
57d62c2f6dScnst.Pp
58ee263a2cShshoexerLimit and command values for a particular sensor may be specified in the
5900a49680Shenning.Xr sensorsd.conf 5
6000a49680Shenningconfiguration file.
6181a42750SjmcThis file is reloaded upon receiving
6281a42750Sjmc.Dv SIGHUP .
63200615eeSrobert.Pp
64200615eeSrobertThe options are as follows:
65200615eeSrobert.Bl -tag -width Ds
66230e9c37Sjmc.It Fl c Ar check
67230e9c37SjmcCheck sensors every
68230e9c37Sjmc.Ar check
69230e9c37Sjmcseconds.
704f20a19dScnstThe default is 20.
712069f8e0SschwarzeThe state of a sensor is not yet regarded as changed when a check
722069f8e0Sschwarzereturns a new state for the first time, but only when the two
732069f8e0Sschwarzesubsequent checks both confirm the new state.
74200615eeSrobert.It Fl d
75200615eeSrobertDo not daemonize.
76200615eeSrobertIf this option is specified,
77200615eeSrobert.Nm
78200615eeSrobertwill run in the foreground.
79017ace1eSbluhm.It Fl f Ar file
80017ace1eSbluhmRead configuration from
81017ace1eSbluhm.Ar file
82017ace1eSbluhminstead of the default configuration file
83017ace1eSbluhm.Pa /etc/sensorsd.conf .
84200615eeSrobert.El
85e0b5b43cShenning.Sh FILES
86e0b5b43cShenning.Bl -tag -width "/etc/sensorsd.conf"
87b9170857Ssobrado.It Pa /etc/sensorsd.conf
88e0b5b43cShenningConfiguration file for
89e0b5b43cShenning.Nm .
90e0b5b43cShenning.El
9100a49680Shenning.Sh SEE ALSO
92*aaeccf36Sderaadt.Xr sysctl 2 ,
9300a49680Shenning.Xr sensorsd.conf 5 ,
942069f8e0Sschwarze.Xr syslog.conf 5 ,
952069f8e0Sschwarze.Xr sysctl 8
9600a49680Shenning.Sh HISTORY
9700a49680ShenningThe
9800a49680Shenning.Nm
9900a49680Shenningprogram first appeared in
10000a49680Shenning.Ox 3.5 .
101987cc61eScnst.Sh CAVEATS
1022069f8e0SschwarzeCertain sensors may erratically flip status from time to time.
103987cc61eScnstTo guard against false reports,
104987cc61eScnst.Nm
1052069f8e0Sschwarzerequires two confirmations before reporting a state change.
106987cc61eScnstHowever, this inevitably introduces
107987cc61eScnstan additional delay in status reporting and command execution,
108987cc61eScnste.g. one may notice that
109987cc61eScnst.Nm
110987cc61eScnstmakes its initial report about the state of monitored sensors
1112069f8e0Sschwarzenot immediately, but by default about 60 seconds after it is started.
112