Merge tag 'bitmain-soc-5.2' of git://git.kernel.org/pub/scm/linux/kernel/git/mani...
[sfrench/cifs-2.6.git] / Documentation / hwmon / userspace-tools
1 Introduction
2 ------------
3
4 Most mainboards have sensor chips to monitor system health (like temperatures,
5 voltages, fans speed). They are often connected through an I2C bus, but some
6 are also connected directly through the ISA bus.
7
8 The kernel drivers make the data from the sensor chips available in the /sys
9 virtual filesystem. Userspace tools are then used to display the measured
10 values or configure the chips in a more friendly manner.
11
12 Lm-sensors
13 ----------
14
15 Core set of utilities that will allow you to obtain health information,
16 setup monitoring limits etc. You can get them on their homepage
17 http://www.lm-sensors.org/ or as a package from your Linux distribution.
18
19 If from website:
20 Get lm-sensors from project web site. Please note, you need only userspace
21 part, so compile with "make user" and install with "make user_install".
22
23 General hints to get things working:
24
25 0) get lm-sensors userspace utils
26 1) compile all drivers in I2C and Hardware Monitoring sections as modules
27    in your kernel
28 2) run sensors-detect script, it will tell you what modules you need to load.
29 3) load them and run "sensors" command, you should see some results.
30 4) fix sensors.conf, labels, limits, fan divisors
31 5) if any more problems consult FAQ, or documentation
32
33 Other utilities
34 ---------------
35
36 If you want some graphical indicators of system health look for applications
37 like: gkrellm, ksensors, xsensors, wmtemp, wmsensors, wmgtemp, ksysguardd,
38 hardware-monitor
39
40 If you are server administrator you can try snmpd or mrtgutils.