usr.sbin/sensorsd/sensorsd.8

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