Changeset 4175

Show
Ignore:
Timestamp:
09/24/06 22:17:43 (2 years ago)
Author:
khali
Message:

More documentation updates.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • lm-sensors/trunk/doc/modules

    r1353 r4175  
    22================== 
    33 
    4 For 2.4+ kernels that use the new directory structure 
    5 under /lib/modules/x.y.z/ , 
    6 'make install' will install modules in the subdirectories 
    7 kernel/drivers/i2c and kernel/drivers/sensors. This puts 
    8 the modules in the same location as a kernel 
    9 'make modules_install' does so that there will not 
    10 be duplicate modules. 
    11  
    12 For older kernels, 'make install' will install the modules 
    13 in the subdirectory misc . 
    14  
    15 If the kernel headers for the kernel you are running are 
    16 not in /usr/src/linux, you should do 
    17 'make install LINUX=/path-to-linux-source', otherwise 
    18 the modules may get installed into the wrong 
    19 kernel version directory under /lib/modules. 
     4'make install' will install the kernel modules modules in the 
     5subdirectories /lib/modules/$version/kernel/drivers/i2c and 
     6/lib/modules/$version/kernel/drivers/sensors. This puts the modules 
     7in the same location as a kernel 'make modules_install' does so 
     8that there will be no duplicate modules. 
    209 
    2110If 'make install' fails, particularly on Mandrake kernels, 
    22 see FAQ #3.8. (fix MODPREF in the Makefile). 
    23  
    24 After 'make install', you must do 'depmod'. 
    25  
    26 If you have symbol errors, do 'depmod -e' to identify 
    27 the particluar modules with errors. Then see #3.9 in 
    28 the FAQ for additional assistance. 
     11see FAQ #3.8 (fix MODPREF in the Makefile) and #3.9. 
    2912 
    3013For details on options that apply to most modules, see 
    3114doc/chips/MODPARMS. For details on options specific to particular 
    3215modules, see the documentation in doc/chips/ and doc/busses/. 
    33  
    34  
    35 Older documentation 
    36 ------------------- 
    37  
    38 The hardcore way is to insmod each of them by hand. This is not very 
    39 practical, though. It is better to install them in a subdirectory that 
    40 modprobe examines. /lib/modules/current/extra/misc comes to mind, or 
    41 perhaps /lib/modules/`uname -r`/extra/misc (depending on your distribution). 
    42 You need to add this path to your /etc/modules.conf (or /etc/conf.modules, 
    43 which file is used depends on your distribution): 
    44   (modules-2.0.0, modutils-2.3.x): 
    45     path[misc]=/lib/modules/current/extra/misc 
    46   (modutils-2.1.x): 
    47     path=/lib/modules/current/extra 
    48 Do always a `depmod -a' after changing either your configuration file or  
    49 changing a module in one of the module directories; you also need to do 
    50 a 'killall -HUP kerneld' if you still use kerneld (kernel 2.2.x usually 
    51 uses kmod); this command is probably not even needed for kerneld, so 
    52 don't worry about it too much). 
    53  
    54 Now you can do 'modprobe lm78', and all dependent modules are loaded 
    55 automatically. You could, of course, add this statement (and related 
    56 statements for other drivers) somewhere in your rc files. But, most 
    57 distributions are set up to load automatically all files in the 
    58 'boot' directories on system start, so why not use this? The best 
    59 way to do this is to create directory /lib/modules/boot, and to 
    60 put *links* to the real modules in there. Why links? Well, by linking 
    61 to /lib/modules/current/whatever, this will function for any kernel 
    62 (provided /lib/modules/current is correctly set up to point to the 
    63 current kernel). So: 
    64   mkdir -p /lib/modules/boot 
    65   ln -s ../current/extra/misc/lm78.o /lib/modules/boot/lm78.o 
    66   # etc. 
    67  
    68 It is also possible to specify default options, that you would normally 
    69 enter at the insmod command, in the configuration file. The syntax is 
    70 as follows: 
    71   options i2c-core debug=2 
    72  
    73 With the above, the managing of all those modules is suddenly no problem 
    74 at all! 

  • lm-sensors/trunk/doc/progs

    r2572 r4175  
    11This 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 
     2`make install', and that can be found in the `prog' directory of 
    33this package. 
    44 
    …… 
    99see useful_addresses.html. 
    1010 
    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. 
    1711 
    1812* prog/config/grab_busses.sh (written in bash and awk, not installed) 
    …… 
    2721* prog/detect/i2cdetect (written in C, installed by 'make install') 
    2822  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  
     23  Syntax: 
     24    i2cdetect 0 
     25  Here the '0' stands for the bus number (run "i2cdetect -l" 
    3326  to list all installed busses). 
    3427 
    3528* prog/detect/sensors-detect (written in Perl, installed by 'make install') 
    3629  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. 
     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. 
    4032 
    4133* prog/doc/doc-features.pl (written in Perl, not installed) 
    …… 
    5345 
    5446* prog/dump/i2cdump (written in C, installed by 'make install') 
    55   This program dumps the registers of a I2C device that understands 
    56   the 'byte data' or 'word data' and block read SMBus protocols. 
     47  This program dumps the registers of an I2C device. 
    5748  Usual syntax: 
    58     ./i2cdump 0 0x49 b 
     49    i2cdump 0 0x4c b 
    5950  Here the '0' stands for the bus number (run i2cdump with no arguments  
    6051  to list all installed busses). 
    …… 
    6354 
    6455* prog/dump/i2cset (written in C, installed by 'make install') 
    65   This program is used to write the register of a I2C device. 
    66   Usual syntax: 
    67     ./i2cset bus device address data 
     56  prog/dump/i2cget (written in C, installed by 'make install') 
     57  These programs are used to write to or read from a register of an 
     58  I2C device. Usual syntax: 
     59    i2cset bus device address data 
     60    i2cget bus device address 
    6861 
    6962* prog/dump/isadump (written in C, installed by 'make install') 
    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 
     63  This program dumps the registers of ISA or Super-I/O chips. 
     64  Usual syntax: 
     65     isadump 0x295 0x296 
     66     isadump -k 0x55 0x2e 0x2f 
    7467 
    75 * prog/eeprom/decode-dimms.pl (written in Perl 5, installed by 'make install') 
    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. 
     68* prog/eeprom/decode-dimms.pl (perl script, installed by 'make install') 
     69  This program decodes the information found in a memory module SPD EEPROM. 
    7970 
    80 * prog/eeprom/decode-vaio.pl (written in Perl 5, installed by 'make install') 
     71* prog/eeprom/decode-vaio.pl (perl script, installed by 'make install') 
    8172  This program decodes the information in a Sony Vaio laptop 
    8273  identification eeprom at 0x57. 
     74 
     75* prog/eeprom/ddcmon (perl script, installed by 'make install') 
     76  prog/eeprom/decode-edid.pl (perl script, installed by 'make install') 
     77  These programs decode the information found in a display EEPROM. They 
     78  require a bus driver for your video adapter, for DDC access to the display. 
    8379 
    8480* prog/eepromer/eepromer (written in C, not installed)