root/lm-sensors/trunk/doc/progs @ 1683

Revision 1683, 6.5 KB (checked in by mds, 11 years ago)

add pwmtest

  • 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 usually 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* doc/developers/editticket (written in shell, not installed)
13  Calls netscape to edit a specific support ticket.
14
15* doc/developers/readticket (written in shell, not installed)
16  Calls netscape to read a specific support ticket.
17
18* prog/config/grab_busses.sh (written in bash and awk, not installed)
19  This program helps you generate the `bus' statements for your configuration
20  file. It read /proc/bus/i2c (or the file specified on the command-line),
21  and prints to stdout `bus' statements reflecting the currently detected
22  adapters.
23
24* prog/daemon/healthd.sh (written in bash, not installed)
25  An example of a very simple hardware health monitoring daemon.
26
27* prog/detect/dmidecode (written in C, installed by 'make install')
28  This program scans the DMI (Desktop Management Interface) information
29  in the BIOS and prints out the useful information.
30
31* prog/detect/i2cdetect (written in C, installed by 'make install')
32  This program scans your complete I2C or SMBus adapter for connected devices.
33  Not all devices can be detected in this way, though; and it may hang your
34  bus. Syntax:
35    ./i2cdetect 0
36  Here the '0' stands for the bus number (run i2cdetect with no arguments
37  to list all installed busses).
38
39* prog/detect/sensors-detect (written in Perl, installed by 'make install')
40  This program tries to detect the available SMBus adapters and the chips
41  connected to them and/or the ISA bus. It also generates modprobe lines
42  and module options. This program is interactive and will ask you about
43  all information it needs.
44
45* prog/doc/doc-features.pl (written in Perl, not installed)
46  This program is used to help us generate driver documentation; it scans
47  some C source programs to do this. Syntax:
48    ./doc-features.pl BASE [PREFIX...]
49  BASE is the path to the base directory of the lm_sensors tree
50  PREFIX is one of more prefixes of chips you want documented; if left out,
51  all chips are documented.
52
53* prog/doc/doc-insmod.pl (written in Perl, not installed)
54  This program is used to help us generate driver documentation; it reads
55  all module information and outputs insmod parameter information. Syntax:
56    ./doc-insmod.pl DRIVER
57
58* prog/dump/i2cdump (written in C, installed by 'make install')
59  This program dumps the registers of a I2C device that understands
60  the 'byte data' or 'word data' and block read SMBus protocols.
61  Usual syntax:
62    ./i2cdump 0 0x49 b
63  Here the '0' stands for the bus number (run i2cdump with no arguments
64  to list all installed busses).
65  '0x49' is the device address, and 'b' or 'w' stands for byte
66  or word data.
67
68* prog/dump/i2cset (written in C, installed by 'make install')
69  This program is used to write the register of a I2C device.
70  Usual syntax:
71    ./i2cset bus device address data
72
73* prog/dump/isadump (written in C, installed by 'make install')
74  This program dumps the registers of LM78-like chips, or more
75  exactly, chips which use one I/O-port for its address and one as its
76  data register. Usual syntax:
77     ./isadump 0x295 0x296
78
79* prog/eeprom/decode-dimms.pl (written in Perl 5, not installed)
80  This program decodes the information generated by the `eeprom.o' module.
81  It will only work for the installed eeprom module from the src/ directory,
82  not for the old one in the i2c/drivers/ directory.
83
84* prog/eeprom/decode-vaio.pl (written in Perl 5, not installed)
85  This program decodes the information in a Sony Vaio laptop
86  identification eeprom at 0x57.
87
88* prog/eepromer/eepromer (written in C, not installed)
89  This program reads and writes eeproms.
90  Danger: Do not use this to write your DRAM DIMM eeproms.
91
92* prog/hotplug/m7101.o (kernel module, not installed)
93  An experimental kernel module to enable the Acer Labs 7101 PCI device.
94  See prog/hotplug/README for details.
95
96* prog/hotplug/p4b_smbus.o (kernel module, not installed)
97  An experimental kernel module to enable the i801 2443 PCI device
98  on Asus P4B boards.
99  See prog/hotplug/README.p4b for details.
100
101* prog/init/lm_sensors.init (shell script, not installed)
102  A SysV init script to be installed in /etc/rc.d/init.d/
103  It inserts the bus and chip modules.
104
105* prog/init/sensord.init (shell script, not installed)
106  A SysV init script to be installed in /etc/rc.d/init.d/
107  It inserts the bus and chip modules and starts the sensord daemon.
108
109* prog/matorb/displayit.pl (written in Perl, not installed)
110  A simple Perl script to display a 'screen' on a Matrix Orbital Display.
111
112* prog/maxilife/sysinfo.sh (written in shell, not installed)
113  Write system information to the HP Maxilife LCD display using writelcd.sh.
114
115* prog/maxilife/writelcd.sh (written in shell, not installed)
116  Write a string to the HP Maxilife LCD display.
117
118* prog/mkdev/mkdev.sh (written in bash, not installed)
119  This script creates the /dev/i2c-* files. Please check the source before
120  you run it, as you may need to set some variables first.
121
122* prog/pwm/pwmtest (shell script, not installed)
123  This script tests the pwm (pulse width modulation) outputs of sensors
124  for their effect on the fans.
125
126* prog/rrd/sens_update_rrd (written in bash, not installed)
127  This script gathers sensors data and adds it to a round robin database
128  (RRD). RRD is then used to display the graphed data in web pages.
129  See prog/rrd/README for more information.
130
131* prog/sensord/sensord (written in C, installed by `make install-prog-sensord')
132  This daemon can be used to periodically log sensor readings from
133  the sensors hardware to syslog, and to alert (using syslog level ALERT)
134  when a sensor alarm is signalled; for example, if a fan fails, a temperature
135  limit is exceeded, etc.
136
137* prog/sensors/sensors (written in C, installed by `make install')
138  This pretty-prints the information provided by the modules. It is a normal
139  console application, using stdout. It is essential, because
140  unlike the raw /proc/sys/dev/sensors/*/* files, it takes your configuration
141  file into account.
142
143* prog/tellerstats/gather.sh, tellerstats.sh (written in bash, not installed)
144  These scripts gather sensors data and graph the data for web pages.
145  See prog/tellerstats/README for more information.
146
147* prog/xeon/decode-xeon.pl (written in Perl, not installed)
148  ID ROM data decoding for Xeon processors.
Note: See TracBrowser for help on using the browser.