root/lm-sensors/branches/lm-sensors-3.0.0/doc/progs @ 4460

Revision 4460, 6.0 KB (checked in by khali, 7 years ago)

Drop description of deleted doc scripts.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
Line 
1This is a list of additional programs, that may or may not be installed by
2`make install', and that can be found in the `prog' directory of
3this package.
4
5These programs are generally small utilities used for debugging,
6and installation of the lm_sensors package, and for demonstrating
7the use of the drivers and libraries in this package.
8For more elaborate programs (for example, GUI sensor displays),
9see useful_addresses.html.
10
11
12* prog/config/grab_busses.sh (written in bash and awk, not installed)
13  This program helps you generate the `bus' statements for your configuration
14  file. It read /proc/bus/i2c (or the file specified on the command-line),
15  and prints to stdout `bus' statements reflecting the currently detected
16  adapters.
17
18* prog/daemon/healthd.sh (written in bash, not installed)
19  An example of a very simple hardware health monitoring daemon.
20
21* prog/detect/i2cdetect (written in C, installed by 'make install')
22  This program scans your complete I2C or SMBus adapter for connected devices.
23  Syntax:
24    i2cdetect 0
25  Here the '0' stands for the bus number (run "i2cdetect -l"
26  to list all installed busses).
27
28* prog/detect/sensors-detect (written in Perl, installed by 'make install')
29  This program tries to detect the available SMBus adapters and the chips
30  connected to them, as well as Super-I/O and misc chips. It also generates
31  modprobe lines and module options. This program is interactive.
32
33* prog/dump/i2cdump (written in C, installed by 'make install')
34  This program dumps the registers of an I2C device.
35  Usual syntax:
36    i2cdump 0 0x4c b
37  Here the '0' stands for the bus number (run i2cdump with no arguments
38  to list all installed busses).
39  '0x49' is the device address, and 'b' or 'w' stands for byte
40  or word data.
41
42* prog/dump/i2cset (written in C, installed by 'make install')
43  prog/dump/i2cget (written in C, installed by 'make install')
44  These programs are used to write to or read from a register of an
45  I2C device. Usual syntax:
46    i2cset bus device address data
47    i2cget bus device address
48
49* prog/dump/isadump (written in C, installed by 'make install')
50  This program dumps the registers of ISA or Super-I/O chips.
51  Usual syntax:
52     isadump 0x295 0x296
53     isadump -k 0x55 0x2e 0x2f
54
55* prog/eeprom/decode-dimms.pl (perl script, installed by 'make install')
56  This program decodes the information found in a memory module SPD EEPROM.
57
58* prog/eeprom/decode-vaio.pl (perl script, installed by 'make install')
59  This program decodes the information in a Sony Vaio laptop
60  identification eeprom at 0x57.
61
62* prog/eeprom/ddcmon (perl script, installed by 'make install')
63  prog/eeprom/decode-edid.pl (perl script, installed by 'make install')
64  These programs decode the information found in a display EEPROM. They
65  require a bus driver for your video adapter, for DDC access to the display.
66
67* prog/eepromer/eepromer (written in C, not installed)
68  This program reads and writes eeproms.
69  Danger: Do not use this to write your DRAM DIMM eeproms.
70
71* prog/hotplug/m7101.o (kernel module, not installed)
72  An experimental kernel module to enable the Acer Labs 7101 PCI device.
73  See prog/hotplug/README for details.
74
75* prog/hotplug/p4b_smbus.o (kernel module, not installed)
76  An experimental kernel module to enable the i801 2443 PCI device
77  on Asus P4B boards.
78  See prog/hotplug/README.p4b for details.
79
80* prog/hotplug/unhide_ICH_SMBus (shell script, not installed)
81  It unhides the ICH Intel SMBus for 2.6 kernels
82
83* prog/init/lm_sensors.init (shell script, not installed)
84  A SysV init script to be installed in /etc/rc.d/init.d/
85  It inserts the bus and chip modules.
86
87* prog/init/sensord.init (shell script, not installed)
88  A SysV init script to be installed in /etc/rc.d/init.d/
89  It inserts the bus and chip modules and starts the sensord daemon.
90
91* prog/matorb/displayit.pl (written in Perl, not installed)
92  A simple Perl script to display a 'screen' on a Matrix Orbital Display.
93
94* prog/maxilife/sysinfo.sh (written in shell, not installed)
95  Write system information to the HP Maxilife LCD display using writelcd.sh.
96
97* prog/maxilife/writelcd.sh (written in shell, not installed)
98  Write a string to the HP Maxilife LCD display.
99
100* prog/mkdev/mkdev.sh (written in bash, not installed)
101  This script creates the /dev/i2c-* files. Please check the source before
102  you run it, as you may need to set some variables first.
103
104* prog/pwm/pwmconfig (shell script, installed by 'make install')
105  Formerly pwmtest, tests the pwm (pulse width modulation) outputs of sensors
106  for their effect on the fans and helps to setup the configfile for fancontrol.
107
108* prog/pwm/fancontrol (shell script, installed by 'make install')
109  Controls fanspeeds responding to changes on temperature sensors.
110  Configuration through pwmconfig.
111
112* prog/pwm/fancontrol.pl (perl script, installed by 'make install')
113  Reimplementation of fancontrol in perl, with self-daemonizing.
114
115* prog/rrd/sens_update_rrd (written in bash, not installed)
116  This script gathers sensors data and adds it to a round robin database
117  (RRD). RRD is then used to display the graphed data in web pages.
118  See prog/rrd/README for more information.
119
120* prog/sensord/sensord (written in C, installed by `make install-prog-sensord')
121  This daemon can be used to periodically log sensor readings from
122  the sensors hardware to syslog, and to alert (using syslog level ALERT)
123  when a sensor alarm is signalled; for example, if a fan fails, a temperature
124  limit is exceeded, etc.
125
126* prog/sensors/sensors (written in C, installed by `make install')
127  This pretty-prints the information provided by the modules. It is a normal
128  console application, using stdout. It is essential, because
129  unlike the raw /proc/sys/dev/sensors/*/* files, it takes your configuration
130  file into account.
131
132* prog/tellerstats/gather.sh, tellerstats.sh (written in bash, not installed)
133  These scripts gather sensors data and graph the data for web pages.
134  See prog/tellerstats/README for more information.
135
136* prog/xeon/decode-xeon.pl (written in Perl, installed by 'make install')
137  ID ROM data decoding for Xeon processors.
Note: See TracBrowser for help on using the browser.