summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorkhali <khali@7894878c-1315-0410-8ee3-d5d059ff63e0>2007-09-24 12:13:29 +0000
committerkhali <khali@7894878c-1315-0410-8ee3-d5d059ff63e0>2007-09-24 12:13:29 +0000
commitae21739d455df5548798a19140277358b45b3002 (patch)
tree68444c25f0742159bfa5e9833c0fb35689883351 /README
parentd254aa3f75d162b2dcd70fc945d64d7b676043aa (diff)
downloadlm-sensors-ae21739d455df5548798a19140277358b45b3002.tar.gz
Fold BACKGROUND into README.
git-svn-id: http://lm-sensors.org/svn/lm-sensors/branches/lm-sensors-3.0.0@4874 7894878c-1315-0410-8ee3-d5d059ff63e0
Diffstat (limited to 'README')
-rw-r--r--README32
1 files changed, 32 insertions, 0 deletions
diff --git a/README b/README
index cd719f95..16e91340 100644
--- a/README
+++ b/README
@@ -33,6 +33,8 @@ See the INSTALL file.
HARDWARE SUPPORT
----------------
+To find out what hardware you have, just run 'sensors-detect' as root.
+
Most modern mainboards incorporate some form of hardware monitoring chips.
These chips read things like chip temperatures, fan rotation speeds and
voltage levels. There are quite a few different chips which can be used by
@@ -52,6 +54,36 @@ even need to wait for a new kernel driver to be written. Updating the
lm-sensors package itself will not help.
+LIBSENSORS
+----------
+
+The kernel drivers communicate their information through the /sys
+interface. Because every motherboard is different, the drivers always
+advert the measurements at their pins. This means that the values they
+report are not always immediately relevant to you. They have to be
+labelled properly, and sometimes they must be scaled to correspond to
+real-world values.
+
+libsensors is a (shared or static) library of access functions. It
+offers a simple-to-use interface for applications to access the sensor
+chip readings and configure them as you like. It has a configuration
+file where you can put all the motherboard-specific labels and
+conversion rules. That way, all applications do not need to duplicate
+the effort and can simply link with libsensors and work out of the box.
+
+
+APPLICATIONS
+------------
+
+This package does not contain a nice graphical monitor. Look at the file
+doc/useful_addresses.html for pointers to such programs. It does contain
+an example console program that reports all current sensors values. This
+program is called 'sensors'. You can use it as a reference implementation
+for more intricate programs. It also contains a daemon watching for
+sensor values, logging alarms and feeding an RRD database with the sensor
+measurements.
+
+
OTHER INFORMATION
-----------------