root/lm-sensors/trunk/README @ 5844

Revision 5844, 4.2 KB (checked in by khali, 4 years ago)

Change libsensors license from GPL to LGPL.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
Line 
1OVERVIEW OF THE LM-SENSORS PACKAGE
2==================================
3
4The lm-sensors package, version 3, provides user-space support for the
5hardware monitoring drivers in Linux 2.6.5 and later. For older kernel
6versions, you have to use lm-sensors version 2.
7
8The directories within this package:
9
10* doc
11  Documentation.
12* etc
13  A sample configuration file for libsensors, and a script to convert
14  lm-sensors version 2 configuration files to work with version 3.
15* lib
16  The user-space sensors support library code (libsensors).
17* prog
18  Several supporting programs. The most important ones are:
19  - sensors-detect: A stand-alone program for detecting installed
20    hardware and recommending specific modules to load.
21  - sensors: A console tool to report sensor readings and set new
22    sensor limits.
23  - sensord: A daemon to watch sensor values and log problems. It
24    includes RRD support.
25
26
27INSTALLING LM-SENSORS
28---------------------
29
30See the INSTALL file.
31
32
33HARDWARE SUPPORT
34----------------
35
36To find out what hardware you have, just run 'sensors-detect' as root.
37
38Most modern mainboards incorporate some form of hardware monitoring chips.
39These chips read things like chip temperatures, fan rotation speeds and
40voltage levels. There are quite a few different chips which can be used by
41mainboard builders for approximately the same results.
42
43Laptops, on the other hand, rarely expose any hardware monitoring
44chip. They often have some BIOS and/or ACPI magic to get the CPU
45temperature value, but that's about it. For such laptops, the lm-sensors
46package is of no use (sensors-detect will not find anything), and you have
47to use acpi instead.
48
49This package doesn't contain chip-specific knowledge. It will support all
50the hardware monitoring chips your kernel has drivers for. In other words,
51if you find out that you have unsupported hardware (e.g. sensors-detect
52told you so) then it means that you need a more recent kernel, or you
53even need to wait for a new kernel driver to be written. Updating the
54lm-sensors package itself will not help.
55
56
57LIBSENSORS
58----------
59
60The kernel drivers communicate their information through the /sys
61interface. Because every motherboard is different, the drivers always
62advert the measurements at their pins. This means that the values they
63report are not always immediately relevant to you. They have to be
64labelled properly, and sometimes they must be scaled to correspond to
65real-world values.
66
67libsensors is a (shared or static) library of access functions. It
68offers a simple-to-use interface for applications to access the sensor
69chip readings and configure them as you like. It has a configuration
70file where you can put all the motherboard-specific labels and
71conversion rules. That way, all applications do not need to duplicate
72the effort and can simply link with libsensors and work out of the box.
73
74
75APPLICATIONS
76------------
77
78This package contains an example console program that reports all current
79sensors values. This program is called 'sensors'. You can use it as a
80reference implementation for more intricate programs. It also contains a
81daemon watching for sensor values, logging alarms and feeding an RRD
82database with the sensor measurements.
83
84This package does not contain a nice graphical monitor. See
85http://www.lm-sensors.org/wiki/UsefulLinks for pointers to such programs.
86
87
88OTHER INFORMATION
89-----------------
90
91The developers of this package can be reached through a mailing-list
92(see http://www.lm-sensors.org/wiki/AuthorsAndContributors). Do not hesitate
93to mail us if you have questions, suggestions, problems, want to
94contribute, or just want to report it works for you. But please try to
95read the documentation before you ask any questions! It's all under doc/.
96Also make sure you read the FAQ at http://www.lm-sensors.org/wiki/FAQ.
97
98The latest version of this package can always be found at:
99http://www.lm-sensors.org/wiki/Download. Pre-release versions can be
100retrieved through anonymous SVN; see doc/svn for details.
101
102
103LICENSE
104-------
105
106The library (libsensors) is released under the GNU Lesser General Public
107License (LGPL), as included in the file COPYING.LGPL. The rest of this
108package may be distributed according to the GNU General Public License
109(GPL), as included in the file COPYING.
Note: See TracBrowser for help on using the browser.