Changeset 988

Show
Ignore:
Timestamp:
01/13/01 18:24:42 (14 years ago)
Author:
mds
Message:

add documentation entries for editticket, readticket, maxilife,

and matorb display programs.

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • lm-sensors/trunk/doc/progs

    r837 r988  
    22`make install', and that usually can be found in the `prog' directory of 
    33this package. 
     4 
     5 
     6* doc/developers/editticket (written in shell, not installed) 
     7  Calls netscape to edit a specific support ticket. 
     8 
     9* doc/developers/readticket (written in shell, not installed) 
     10  Calls netscape to read a specific support ticket. 
    411 
    512* prog/config/grab_busses.sh (written in bash and awk, not installed) 
     
    815  and prints to stdout `bus' statements reflecting the currently detected 
    916  adapters. 
     17 
    1018* prog/daemon/healthd.sh (written in bash, not installed) 
    1119  An example of a very simple hardware health monitoring daemon. 
     20 
     21* prog/detect/i2cdetect (written in C, not installed) 
     22  This program scans your complete I2C or SMBus adapter for connected devices. 
     23  Not all devices can be detected in this way, though; and it may hang your 
     24  bus. Syntax: 
     25    ./i2cdetect 0 
     26  Here the '0' stands for the bus number (run i2cdetect with no arguments  
     27  to list all installed busses). 
     28 
    1229* prog/detect/sensors-detect (written in Perl, installed by 'make install') 
    1330  This program tries to detect the available SMBus adapters and the chips 
     
    1532  and module options. This program is interactive and will ask you about 
    1633  all information it needs. 
    17 * prog/detect/i2cdetect (written in C, not installed) 
    18   This program scans your complete I2C or SMBus adapter for connected devices. 
    19   Not all devices can be detected in this way, though; and it may hang your 
    20   bus. Syntax: 
    21     ./i2cdetect 0 
    22   Here the '0' stands for i2c-0 (check /proc/bus/i2c to find out which bus 
    23   you need). 
     34 
    2435* prog/doc/doc-features.pl (written in Perl, not installed) 
    2536  This program is used to help us generate driver documentation; it scans 
     
    2940  PREFIX is one of more prefixes of chips you want documented; if left out, 
    3041  all chips are documented. 
     42 
    3143* prog/doc/doc-insmod.pl (written in Perl, not installed) 
    3244  This program is used to help us generate driver documentation; it reads 
    3345  all module information and outputs insmod parameter information. Syntax: 
    3446    ./doc-insmod.pl DRIVER 
     47 
    3548* prog/dump/i2cdump (written in C, not installed) 
    3649  This program helps to dump the registers of a I2C device that understands 
    37   the 'byte data' or 'word data' SMBus protocols. Usual syntax: 
     50  the 'byte data' or 'word data' and block read SMBus protocols. 
     51  Usual syntax: 
    3852    ./i2cdump 0 0x49 b 
    39   Here the '0' stands for i2c-0 (check /proc/bus/i2c to find out which bus 
    40   you need), '0x49' is the device address, and 'b' or 'w' stands for byte 
     53  Here the '0' stands for the bus number (run i2cdump with no arguments  
     54  to list all installed busses). 
     55  0x49' is the device address, and 'b' or 'w' stands for byte 
    4156  or word data. 
     57 
    4258* prog/dump/isadump (written in C, not installed) 
    4359  This program helps to dump the registers of LM78-like chips, or more 
     
    4561  data register. Usual syntax:  
    4662     ./isadump 0x295 0x296 
     63 
    4764* prog/eeprom/decode-dimms.pl (written in Perl 5, not installed) 
    4865  This program decodes the information generated by the `eeprom.o' module. 
    4966  It will only work for the installed eeprom module from the src/ directory, 
    5067  not for the old one in the i2c/drivers/ directory. 
     68 
     69* prog/hotplug/m7101.o (kernel module, not installed) 
     70  An experimental kernel module to enable the Acer Labs 7101 PCI device. 
     71  See prog/hotplug/README for details. 
     72 
     73* prog/matorb/displayit.pl (written in Perl, not installed) 
     74  A simple Perl script to display a 'screen' on a Matrix Orbital Display. 
     75 
     76* prog/maxilife/sysinfo.sh (written in shell, not installed) 
     77  Write system information to the HP Maxilife LCD display using writelcd.sh. 
     78 
     79* prog/maxilife/writelcd.sh (written in shell, not installed) 
     80  Write a string to the HP Maxilife LCD display. 
     81 
    5182* prog/mkdev/mkdev.sh (written in bash, not installed) 
    5283  This script creates the /dev/i2c-* files. Please check the source before 
    5384  you run it, as you may need to set some variables first. 
     85 
    5486* prog/sensord/sensord (written in C, installed by `make install-prog-sensord') 
    5587  This daemon can be used to periodically log sensor readings from 
     
    5789  when a sensor alarm is signalled; for example, if a fan fails, a temperature 
    5890  limit is exceeded, etc. 
     91 
    5992* prog/sensors/sensors (written in C, installed by `make install') 
    6093  This pretty-prints the information provided by the modules. It is a normal 
    61   console application, using stdin and stdout. It is essential, because 
     94  console application, using stdout. It is essential, because 
    6295  unlike the raw /proc/sys/dev/sensors/*/* files, it takes your configuration 
    6396  file into account. 
    64 * prog/xeon/decode-xeon.pl (written in perl, not installed) 
     97 
     98* prog/xeon/decode-xeon.pl (written in Perl, not installed) 
    6599  ID ROM data decoding for Xeon processors.