Blame doc/progs

Packit 53d5b6
This is a list of additional programs, that may or may not be installed by
Packit 53d5b6
`make install', and that can be found in the `prog' directory of
Packit 53d5b6
this package.
Packit 53d5b6
Packit 53d5b6
These programs are generally small utilities used for debugging,
Packit 53d5b6
and installation of the lm_sensors package, and for demonstrating
Packit 53d5b6
the use of the drivers and libraries in this package.
Packit 53d5b6
For more elaborate programs (for example, GUI sensor displays),
Packit Service 5377e5
see https://github.com/lm-sensors/lm-sensors/
Packit 53d5b6
    http://sensors-applet.sourceforge.net/
Packit 53d5b6
    https://01.org/powertop/
Packit 53d5b6
    https://wpitchoune.net/psensor/
Packit 53d5b6
    https://amanusk.github.io/s-tui/
Packit 53d5b6
Packit 53d5b6
* prog/daemon/healthd.sh (written in bash, not installed)
Packit 53d5b6
  An example of a very simple hardware health monitoring daemon.
Packit 53d5b6
Packit 53d5b6
* prog/detect/sensors-detect (written in Perl, installed by 'make install')
Packit 53d5b6
  This program tries to detect the available SMBus adapters and the chips
Packit 53d5b6
  connected to them, as well as Super-I/O and misc chips. It also generates
Packit 53d5b6
  modprobe lines and module options. This program is stand-alone (can be
Packit 53d5b6
  run without installing lm-sensors) and interactive.
Packit 53d5b6
Packit 53d5b6
* prog/dump/isadump (written in C, installed by 'make install')
Packit 53d5b6
  This program dumps the registers of ISA or Super-I/O chips.
Packit 53d5b6
  Usual syntax:
Packit 53d5b6
     isadump 0x295 0x296
Packit 53d5b6
     isadump -k 0x55 0x2e 0x2f
Packit 53d5b6
Packit 53d5b6
* prog/hotplug/unhide_ICH_SMBus (shell script, not installed)
Packit 53d5b6
  It unhides the ICH Intel SMBus for kernel 2.6.5 and later.
Packit 53d5b6
Packit 53d5b6
* prog/init/lm_sensors.init (shell script, not installed)
Packit 53d5b6
  A SysV init script to be installed in /etc/rc.d/init.d/
Packit 53d5b6
  It inserts the bus and chip modules.
Packit 53d5b6
Packit 53d5b6
* prog/init/sensord.init (shell script, not installed)
Packit 53d5b6
  A SysV init script to be installed in /etc/rc.d/init.d/
Packit 53d5b6
  It inserts the bus and chip modules and starts the sensord daemon.
Packit 53d5b6
Packit 53d5b6
* prog/pwm/pwmconfig (shell script, installed by 'make install')
Packit 53d5b6
  Formerly pwmtest, tests the pwm (pulse width modulation) outputs of sensors
Packit 53d5b6
  for their effect on the fans and helps to setup the configfile for fancontrol.
Packit 53d5b6
Packit 53d5b6
* prog/pwm/fancontrol (shell script, installed by 'make install')
Packit 53d5b6
  Controls fanspeeds responding to changes on temperature sensors.
Packit 53d5b6
  Configuration through pwmconfig.
Packit 53d5b6
Packit 53d5b6
* prog/rrd/sens_update_rrd (written in bash, not installed)
Packit 53d5b6
  This script gathers sensors data and adds it to a round robin database
Packit 53d5b6
  (RRD). RRD is then used to display the graphed data in web pages.
Packit 53d5b6
  See prog/rrd/README for more information.
Packit 53d5b6
Packit 53d5b6
* prog/sensord/sensord (written in C, installed by `make install-prog-sensord')
Packit 53d5b6
  This daemon can be used to periodically log sensor readings from
Packit 53d5b6
  the sensors hardware to syslog, and to alert (using syslog level ALERT)
Packit 53d5b6
  when a sensor alarm is signalled; for example, if a fan fails, a temperature
Packit 53d5b6
  limit is exceeded, etc.
Packit 53d5b6
Packit 53d5b6
* prog/sensors/sensors (written in C, installed by `make install')
Packit 53d5b6
  This pretty-prints the information provided by the modules. It is a normal
Packit 53d5b6
  console application, using stdout. It is essential, because
Packit 53d5b6
  unlike the raw sysfs files, it takes your configuration file into account.
Packit 53d5b6
Packit 53d5b6
* prog/tellerstats/gather.sh, tellerstats.sh (written in bash, not installed)
Packit 53d5b6
  These scripts gather sensors data and graph the data for web pages.
Packit 53d5b6
  See prog/tellerstats/README for more information.