usr.sbin/sensorsd/sensorsd.8

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