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

Revision 1159, 5.4 KB (checked in by mds, 13 years ago)

add eepromer utility from Daniel Smolik <marvin@…>

  • 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/i2cdetect (written in C, not installed)
28  This program scans your complete I2C or SMBus adapter for connected devices.
29  Not all devices can be detected in this way, though; and it may hang your
30  bus. Syntax:
31    ./i2cdetect 0
32  Here the '0' stands for the bus number (run i2cdetect with no arguments
33  to list all installed busses).
34
35* prog/detect/sensors-detect (written in Perl, installed by 'make install')
36  This program tries to detect the available SMBus adapters and the chips
37  connected to them and/or the ISA bus. It also generates modprobe lines
38  and module options. This program is interactive and will ask you about
39  all information it needs.
40
41* prog/doc/doc-features.pl (written in Perl, not installed)
42  This program is used to help us generate driver documentation; it scans
43  some C source programs to do this. Syntax:
44    ./doc-features.pl BASE [PREFIX...]
45  BASE is the path to the base directory of the lm_sensors tree
46  PREFIX is one of more prefixes of chips you want documented; if left out,
47  all chips are documented.
48
49* prog/doc/doc-insmod.pl (written in Perl, not installed)
50  This program is used to help us generate driver documentation; it reads
51  all module information and outputs insmod parameter information. Syntax:
52    ./doc-insmod.pl DRIVER
53
54* prog/dump/i2cdump (written in C, not installed)
55  This program dumps the registers of a I2C device that understands
56  the 'byte data' or 'word data' and block read SMBus protocols.
57  Usual syntax:
58    ./i2cdump 0 0x49 b
59  Here the '0' stands for the bus number (run i2cdump with no arguments
60  to list all installed busses).
61  '0x49' is the device address, and 'b' or 'w' stands for byte
62  or word data.
63
64* prog/dump/i2cset (written in C, not installed)
65  This program is used to write the register of a I2C device.
66  Usual syntax:
67    ./i2cset bus device address data
68
69* prog/dump/isadump (written in C, not installed)
70  This program dumps the registers of LM78-like chips, or more
71  exactly, chips which use one I/O-port for its address and one as its
72  data register. Usual syntax:
73     ./isadump 0x295 0x296
74
75* prog/eeprom/decode-dimms.pl (written in Perl 5, not installed)
76  This program decodes the information generated by the `eeprom.o' module.
77  It will only work for the installed eeprom module from the src/ directory,
78  not for the old one in the i2c/drivers/ directory.
79
80* prog/eepromer/eepromer (written in C, not installed)
81  This program reads and writes eeproms.
82  Danger: Do not use this to write your DRAM DIMM eeproms.
83
84* prog/hotplug/m7101.o (kernel module, not installed)
85  An experimental kernel module to enable the Acer Labs 7101 PCI device.
86  See prog/hotplug/README for details.
87
88* prog/matorb/displayit.pl (written in Perl, not installed)
89  A simple Perl script to display a 'screen' on a Matrix Orbital Display.
90
91* prog/maxilife/sysinfo.sh (written in shell, not installed)
92  Write system information to the HP Maxilife LCD display using writelcd.sh.
93
94* prog/maxilife/writelcd.sh (written in shell, not installed)
95  Write a string to the HP Maxilife LCD display.
96
97* prog/mkdev/mkdev.sh (written in bash, not installed)
98  This script creates the /dev/i2c-* files. Please check the source before
99  you run it, as you may need to set some variables first.
100
101* prog/rrd/sens_update_rrd (written in bash, not installed)
102  This script gathers sensors data and adds it to a round robin database
103  (RRD). RRD is then used to display the graphed data in web pages.
104  See prog/rrd/README for more information.
105
106* prog/sensord/sensord (written in C, installed by `make install-prog-sensord')
107  This daemon can be used to periodically log sensor readings from
108  the sensors hardware to syslog, and to alert (using syslog level ALERT)
109  when a sensor alarm is signalled; for example, if a fan fails, a temperature
110  limit is exceeded, etc.
111
112* prog/sensors/sensors (written in C, installed by `make install')
113  This pretty-prints the information provided by the modules. It is a normal
114  console application, using stdout. It is essential, because
115  unlike the raw /proc/sys/dev/sensors/*/* files, it takes your configuration
116  file into account.
117
118* prog/tellerstats/gather.sh, tellerstats.sh (written in bash, not installed)
119  These scripts gather sensors data and graph the data for web pages.
120  See prog/tellerstats/README for more information.
121
122* prog/xeon/decode-xeon.pl (written in Perl, not installed)
123  ID ROM data decoding for Xeon processors.
Note: See TracBrowser for help on using the browser.