~team-iquik/lmsensors/trunk

3822 by khali
Update for version 3. List the build-time and run-time dependencies.
1
INSTALLATION INSTRUCTIONS
2
=========================
3
4
The lm-sensors package, version 3, provides user-space support for the
5
hardware monitoring drivers in Linux 2.6.5 and later. For older kernel
6
versions, you have to use lm-sensors version 2.
7
8
9
Dependencies
10
============
11
12
Build-time dependencies:
13
* GNU make
14
* gcc
15
* bison
16
* flex
17
* rrd header files (optional, for sensord)
18
19
Run-time dependencies:
20
* perl (for sensors-detect)
3909 by khali
sensord: Drop workaround needed by old versions of rrdtool. The bug
21
* rrdtool >= 1.2.1 (optional, for sensord)
3823 by khali
Fold QUICKSTART into INSTALL.
22
* proper kernel configuration (see below)
774 by frodo
small INSTALL update
23
552 by frodo
Updated INSTALL and README files
24
3514 by khali
Delete mkpatch and all references thereto. The kernel modules will soon
25
Compilation
26
===========
552 by frodo
Updated INSTALL and README files
27
3822 by khali
Update for version 3. List the build-time and run-time dependencies.
28
At the top of the Makefile are a couple of configuration variables that
29
you may want to change. There's a description of what each variable does
30
in the Makefile itself.
31
32
Compilation is done by `make all'. You will get a lot of warnings about
33
files which are not found, all ending in `.*d'. You can safely ignore
34
this; they contain dependency information, which is regenerated on the
35
spot.
36
37
`make install' installs the package (to /usr/local by default).
552 by frodo
Updated INSTALL and README files
38
39
3823 by khali
Fold QUICKSTART into INSTALL.
40
Kernel configuration
41
====================
42
43
This package assumes that you have a properly configured kernel. If
44
you run a distribution kernel, that should be the case. If you're
45
building your own kernel, here are some recommendations:
46
* Enable "I2C support" (CONFIG_I2C=y or m). On many motherboards, the
47
  sensor chip is connected to the SMBus, which is supported by I2C
48
  in the Linux kernel.
49
* Enable "I2C device interface" (CONFIG_I2C_CHARDEV=m). sensors-detect
50
  needs this to probe for SMBus hardware monitoring chips.
51
* In I2C Hardware Bus support, enable all drivers you might need,
52
  preferably as modules. If you're not sure, select them all.
53
* Enable "Hardware Monitoring support" (CONFIG_HWMON=y or m).
54
* Enable all hardware monitoring drivers you might need, preferably
55
  as modules. If you're not sure, select them all.
56
57
552 by frodo
Updated INSTALL and README files
58
Using the sensors package
59
=========================
60
3389 by khali
Documentation update. I tried to remove or update all outdated stuff, it
61
There is a scanning program installed called sensors-detect. It
3822 by khali
Update for version 3. List the build-time and run-time dependencies.
62
will scan all available I2C and SMBus adapters for all known sensor
63
devices, and will also look for ISA, PCI and Super-I/O chips with
64
sensors, and give you a list of what kernel drivers you need to load
65
(using modprobe).
617 by frodo
Some remarks in INSTALL about adding /usr/local/lib to
66
3823 by khali
Fold QUICKSTART into INSTALL.
67
After loading the suggested drivers, you can use the installed sensors
3890 by khali
Typo fix.
68
program to get a report of all detected sensor devices. Check the manual
3823 by khali
Fold QUICKSTART into INSTALL.
69
page for available options.
70
71
The initial output of `sensors' will not be perfect. You have to adjust
3878 by khali
Use /etc/sensors3.conf as the default configuration file. If it can't
72
the configuration file (/etc/sensors3.conf) to match your motherboard.
3823 by khali
Fold QUICKSTART into INSTALL.
73
This includes (re)labelling inputs, ignoring unused inputs, changing
74
voltage compute lines and setting limits. Write down all the sensor
75
information your BIOS displays as a hint to what you are supposed to
76
obtain in the end. Make sure you modify the right chip section.
77
78
Once you are done with editing the configuration file, calling
79
`sensors -s' will set the new limits. Then the output of `sensors'
80
should look much better.
552 by frodo
Updated INSTALL and README files
81
554 by frodo
More documentation updates
82
There are many auxiliary programs not installed. You can find them under
83
the prog subdirectory. A list can be found in doc/progs.