From bc0cfc7a32f082cd0b1f12cdd3cb36d29f6d1dad Mon Sep 17 00:00:00 2001 From: Jean Delvare Date: Mon, 24 Sep 2007 13:30:38 +0000 Subject: [PATCH] Fold QUICKSTART into INSTALL. git-svn-id: http://lm-sensors.org/svn/lm-sensors/branches/lm-sensors-3.0.0@4876 7894878c-1315-0410-8ee3-d5d059ff63e0 --- INSTALL | 38 +++++++++++++++++++++++++++++++++----- QUICKSTART | 25 ------------------------- 2 files changed, 33 insertions(+), 30 deletions(-) delete mode 100644 QUICKSTART diff --git a/INSTALL b/INSTALL index 0a8252fe..e8ead18c 100644 --- a/INSTALL +++ b/INSTALL @@ -21,6 +21,7 @@ Run-time dependencies: * libsysfs (from sysfsutils) * perl (for sensors-detect) * rrd (optional, for sensord) +* proper kernel configuration (see below) Compilation @@ -38,6 +39,24 @@ spot. `make install' installs the package (to /usr/local by default). +Kernel configuration +==================== + +This package assumes that you have a properly configured kernel. If +you run a distribution kernel, that should be the case. If you're +building your own kernel, here are some recommendations: +* Enable "I2C support" (CONFIG_I2C=y or m). On many motherboards, the + sensor chip is connected to the SMBus, which is supported by I2C + in the Linux kernel. +* Enable "I2C device interface" (CONFIG_I2C_CHARDEV=m). sensors-detect + needs this to probe for SMBus hardware monitoring chips. +* In I2C Hardware Bus support, enable all drivers you might need, + preferably as modules. If you're not sure, select them all. +* Enable "Hardware Monitoring support" (CONFIG_HWMON=y or m). +* Enable all hardware monitoring drivers you might need, preferably + as modules. If you're not sure, select them all. + + Using the sensors package ========================= @@ -47,11 +66,20 @@ devices, and will also look for ISA, PCI and Super-I/O chips with sensors, and give you a list of what kernel drivers you need to load (using modprobe). -You can use the installed sensors program to get a report of all detected -sensor devices. There is also a manual page for this program. Calling -`sensors -s' will set the limits and other configuration settings -specified in /etc/sensors.conf. Again, read the manual pages for more -information. +After loading the suggested drivers, you can use the installed sensors +program to get a report of all detected sensor devices. Chek the manual +page for available options. + +The initial output of `sensors' will not be perfect. You have to adjust +the configuration file (/etc/sensors.conf) to match your motherboard. +This includes (re)labelling inputs, ignoring unused inputs, changing +voltage compute lines and setting limits. Write down all the sensor +information your BIOS displays as a hint to what you are supposed to +obtain in the end. Make sure you modify the right chip section. + +Once you are done with editing the configuration file, calling +`sensors -s' will set the new limits. Then the output of `sensors' +should look much better. There are many auxiliary programs not installed. You can find them under the prog subdirectory. A list can be found in doc/progs. diff --git a/QUICKSTART b/QUICKSTART deleted file mode 100644 index 092fc3eb..00000000 --- a/QUICKSTART +++ /dev/null @@ -1,25 +0,0 @@ -LM_SENSORS QUICK INSTALLATION INSTRUCTIONS ------------------------------------------- - -The instructions in this document will generally work if you have a standard -system, but not always!! - -Quickstart for Kernel 2.6 -------------------------- - -0) Just compile and install lm-sensors userspace tools. You can do that with: - 'make ; make install' -1) Make sure your kernel has support for all I2C bus drivers and - 'i2c device interface'. If you are using a distribution kernel, all is - already prepared, you don't need to recompile it. -2) Run 'sensors-detect' command, it will tell you what modules you need to load. -3) Load them and run 'sensors' command, you should see some results. -4) Find right section in /etc/sensors.conf, fix labels, limits, fan divisors -5) Run 'sensors -s' to apply the changes. - -You may also try our installation wizard at: - -http://www.lm-sensors.org/wiki/iwizard/1 - -We are aware that the documentation could be improved, please contact us if -you want to help us with that.