[9166fa4] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
| 7 | <!ENTITY lm_sensors-download-http
|
---|
[c7ce750a] | 8 | "http://dl.lm-sensors.org/lm-sensors/releases/lm_sensors-&lm_sensors-version;.tar.bz2">
|
---|
[9166fa4] | 9 | <!ENTITY lm_sensors-download-ftp
|
---|
[c7ce750a] | 10 | "ftp://ftp.netroedge.com/pub/lm-sensors/lm_sensors-&lm_sensors-version;.tar.bz2">
|
---|
| 11 | <!ENTITY lm_sensors-md5sum "73c2fcccdab6049d289c5e0c596192a1">
|
---|
| 12 | <!ENTITY lm_sensors-size "172 KB">
|
---|
[9166fa4] | 13 | <!ENTITY lm_sensors-buildsize "2.4 MB">
|
---|
| 14 | <!ENTITY lm_sensors-time "0.1 SBU">
|
---|
| 15 | ]>
|
---|
| 16 |
|
---|
| 17 | <sect1 id="lm_sensors" xreflabel="lm_sensors-&lm_sensors-version;">
|
---|
| 18 | <?dbhtml filename="lm_sensors.html"?>
|
---|
| 19 |
|
---|
| 20 | <sect1info>
|
---|
| 21 | <othername>$LastChangedBy$</othername>
|
---|
| 22 | <date>$Date$</date>
|
---|
| 23 | </sect1info>
|
---|
| 24 |
|
---|
| 25 | <title>lm_sensors-&lm_sensors-version;</title>
|
---|
| 26 |
|
---|
| 27 | <indexterm zone="lm_sensors">
|
---|
| 28 | <primary sortas="a-lm_sensors">lm_sensors</primary>
|
---|
| 29 | </indexterm>
|
---|
| 30 |
|
---|
| 31 | <sect2 role="package">
|
---|
[af373d35] | 32 | <title>Introduction to lm_sensors</title>
|
---|
[9166fa4] | 33 |
|
---|
| 34 | <para>
|
---|
[af373d35] | 35 | The <application>lm_sensors</application> package provides user-space
|
---|
[9166fa4] | 36 | support for the hardware monitoring drivers in the Linux kernel.
|
---|
| 37 | This is useful for monitoring the temperature of the CPU and adjusting the
|
---|
[0d7900a] | 38 | performance of some hardware (such as cooling fans).
|
---|
[9166fa4] | 39 | </para>
|
---|
| 40 |
|
---|
[d0323de] | 41 | &lfs73_checked;
|
---|
[9166fa4] | 42 |
|
---|
| 43 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 44 | <itemizedlist spacing="compact">
|
---|
| 45 | <listitem>
|
---|
| 46 | <para>
|
---|
| 47 | Download (HTTP): <ulink url="&lm_sensors-download-http;"/>
|
---|
| 48 | </para>
|
---|
| 49 | </listitem>
|
---|
| 50 | <listitem>
|
---|
| 51 | <para>
|
---|
| 52 | Download (FTP): <ulink url="&lm_sensors-download-ftp;"/>
|
---|
| 53 | </para>
|
---|
| 54 | </listitem>
|
---|
| 55 | <listitem>
|
---|
| 56 | <para>
|
---|
| 57 | Download MD5 sum: &lm_sensors-md5sum;
|
---|
| 58 | </para>
|
---|
| 59 | </listitem>
|
---|
| 60 | <listitem>
|
---|
| 61 | <para>
|
---|
| 62 | Download size: &lm_sensors-size;
|
---|
| 63 | </para>
|
---|
| 64 | </listitem>
|
---|
| 65 | <listitem>
|
---|
| 66 | <para>
|
---|
| 67 | Estimated disk space required: &lm_sensors-buildsize;
|
---|
| 68 | </para>
|
---|
| 69 | </listitem>
|
---|
| 70 | <listitem>
|
---|
| 71 | <para>
|
---|
| 72 | Estimated build time: &lm_sensors-time;
|
---|
| 73 | </para>
|
---|
| 74 | </listitem>
|
---|
| 75 | </itemizedlist>
|
---|
| 76 |
|
---|
[af373d35] | 77 | <bridgehead renderas="sect3">lm_sensors Dependencies</bridgehead>
|
---|
[9166fa4] | 78 |
|
---|
| 79 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 80 | <para role="required">
|
---|
[c7ce750a] | 81 | <xref linkend="which"/>
|
---|
[9166fa4] | 82 | </para>
|
---|
| 83 |
|
---|
| 84 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 85 | <para role="optional">
|
---|
[af373d35] | 86 | <ulink url="http://oss.oetiker.ch/rrdtool/">RRDtool (required to build the
|
---|
| 87 | <command>sensord</command> program)</ulink>
|
---|
[9166fa4] | 88 | </para>
|
---|
| 89 |
|
---|
| 90 | <para condition="html" role="usernotes">
|
---|
| 91 | User Notes: <ulink url="&blfs-wiki;/lm_sensors"/>
|
---|
| 92 | </para>
|
---|
| 93 | </sect2>
|
---|
| 94 |
|
---|
| 95 | <sect2 role="kernel" id="lm_sensors-kernel">
|
---|
| 96 | <title>Kernel Configuration</title>
|
---|
| 97 |
|
---|
| 98 | <para>
|
---|
| 99 | Getting your kernel config right is an iterative process that may require
|
---|
[02159a2] | 100 | that you recompile your kernel a couple of times. The simplest way to go
|
---|
[9166fa4] | 101 | about it is to start by enabling modules and then compile everything that
|
---|
| 102 | may be needed by Lm Sensors as a module:
|
---|
| 103 | </para>
|
---|
| 104 |
|
---|
| 105 | <screen><literal>General setup --->
|
---|
| 106 | [*] Prompt for development and/or incomplete code/drivers
|
---|
| 107 |
|
---|
| 108 | [*] Enable loadable module support --->
|
---|
| 109 |
|
---|
| 110 | Bus options (PCI etc.) --->
|
---|
| 111 | [*] PCI support
|
---|
| 112 |
|
---|
| 113 | Device Drivers --->
|
---|
| 114 | [*] I2C support
|
---|
| 115 | [*] I2C device interface
|
---|
| 116 | I2C Algorithms --->
|
---|
| 117 | <M> (configure all of them as modules)
|
---|
| 118 | I2C Hardware Bus support --->
|
---|
| 119 | <M> (configure all of them as modules)
|
---|
| 120 | I2C Hardware Bus support --->
|
---|
| 121 | <M> (configure all of them as modules)
|
---|
| 122 | [*] Hardware Monitoring support --->
|
---|
| 123 | <M> (configure all of them as modules)</literal></screen>
|
---|
| 124 |
|
---|
| 125 | <para>
|
---|
| 126 | Recompile your kernel and reboot into the new kernel. Don't forget to
|
---|
| 127 | <command>make modules_install</command> We will come back to the kernel in
|
---|
| 128 | the Configuring section below.
|
---|
| 129 | </para>
|
---|
| 130 |
|
---|
| 131 | <indexterm zone="lm_sensors lm_sensors-kernel">
|
---|
| 132 | <primary sortas="d-lm_sensors">lm_sensors</primary>
|
---|
| 133 | </indexterm>
|
---|
| 134 | </sect2>
|
---|
| 135 |
|
---|
| 136 | <sect2 role="installation">
|
---|
[af373d35] | 137 | <title>Installation of lm_sensors</title>
|
---|
[9166fa4] | 138 |
|
---|
| 139 | <para>
|
---|
[af373d35] | 140 | Install <application>lm_sensors</application> by running the following
|
---|
[9166fa4] | 141 | commands:
|
---|
| 142 | </para>
|
---|
| 143 |
|
---|
[af373d35] | 144 | <screen><userinput>make PREFIX=/usr \
|
---|
| 145 | BUILD_STATIC_LIB=0 \
|
---|
[c7ce750a] | 146 | MANDIR=/usr/share/man</userinput></screen>
|
---|
[9166fa4] | 147 |
|
---|
| 148 | <para>
|
---|
| 149 | This package does not come with a test suite.
|
---|
| 150 | </para>
|
---|
| 151 |
|
---|
| 152 | <para>
|
---|
| 153 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 154 | </para>
|
---|
| 155 |
|
---|
[af373d35] | 156 | <screen role="root"><userinput>make PREFIX=/usr \
|
---|
| 157 | BUILD_STATIC_LIB=0 \
|
---|
[c7ce750a] | 158 | MANDIR=/usr/share/man install &&
|
---|
[af373d35] | 159 | install -v -m755 -d /usr/share/doc/lm_sensors-&lm_sensors-version; &&
|
---|
| 160 | cp -rv README INSTALL doc/* \
|
---|
| 161 | /usr/share/doc/lm_sensors-&lm_sensors-version;</userinput></screen>
|
---|
[9166fa4] | 162 | </sect2>
|
---|
| 163 |
|
---|
| 164 | <sect2 role="commands">
|
---|
| 165 | <title>Command Explanations</title>
|
---|
| 166 |
|
---|
| 167 | <para>
|
---|
| 168 | <parameter>BUILD_STATIC_LIB=0</parameter>: This parameter disables
|
---|
[af373d35] | 169 | compiling and installing the static version of
|
---|
| 170 | <filename class="libraryfile">libsensors</filename>.
|
---|
[9166fa4] | 171 | </para>
|
---|
| 172 |
|
---|
| 173 | <para>
|
---|
| 174 | <parameter>PROG_EXTRA=sensord</parameter>: This parameter enables
|
---|
[af373d35] | 175 | compiling <command>sensord</command>, a daemon that can monitor your
|
---|
| 176 | system at regular intervals. Compiling <command>sensord</command> requires
|
---|
[9166fa4] | 177 | <ulink url="http://oss.oetiker.ch/rrdtool/">RRDtool</ulink>. Compiling
|
---|
| 178 | RRDtool 1.4.6 requires a sed: <command>sed -i '/ sv_undef/d'
|
---|
| 179 | bindings/perl-shared/RRDs.xs</command>.
|
---|
| 180 | </para>
|
---|
[c7ce750a] | 181 |
|
---|
[9166fa4] | 182 | </sect2>
|
---|
| 183 |
|
---|
| 184 | <sect2 role="configuration">
|
---|
| 185 | <title>Configuring Lm Sensors</title>
|
---|
| 186 |
|
---|
| 187 | <sect3 id="lm_sensors-config">
|
---|
| 188 | <title>Config File</title>
|
---|
[c7ce750a] | 189 |
|
---|
| 190 | <para>
|
---|
| 191 | <filename>/etc/sensors3.conf</filename>
|
---|
| 192 | </para>
|
---|
[9166fa4] | 193 |
|
---|
| 194 | <indexterm zone="lm_sensors lm_sensors-config">
|
---|
| 195 | <primary
|
---|
| 196 | sortas="e-etc-path-Configfilename2">/etc/sensors3.conf</primary>
|
---|
| 197 | </indexterm>
|
---|
[c7ce750a] | 198 |
|
---|
[9166fa4] | 199 | </sect3>
|
---|
| 200 |
|
---|
| 201 | <sect3><title>Configuration Information</title>
|
---|
| 202 |
|
---|
| 203 | <para>
|
---|
[af373d35] | 204 | To find out what hardware sensors your system has, issue the following
|
---|
| 205 | command as the <systemitem class="username">root</systemitem> user:
|
---|
[9166fa4] | 206 | </para>
|
---|
| 207 |
|
---|
| 208 | <screen role="root"><userinput>sensors-detect</userinput></screen>
|
---|
| 209 |
|
---|
| 210 | <para>
|
---|
[af373d35] | 211 | The appropriate modules should have been loaded and a summary is
|
---|
| 212 | displayed at the end. Now you know what is needed and you can recompile
|
---|
| 213 | your kernel to enable just the options you need (i.e., don't enable the
|
---|
| 214 | modules you cannot use).
|
---|
[9166fa4] | 215 | </para>
|
---|
[c7ce750a] | 216 |
|
---|
[9166fa4] | 217 | </sect3>
|
---|
[c7ce750a] | 218 |
|
---|
[9166fa4] | 219 | </sect2>
|
---|
| 220 |
|
---|
| 221 | <sect2 role="content">
|
---|
| 222 | <title>Contents</title>
|
---|
| 223 |
|
---|
| 224 | <segmentedlist>
|
---|
| 225 | <segtitle>Installed Programs</segtitle>
|
---|
| 226 | <segtitle>Installed Library</segtitle>
|
---|
| 227 | <segtitle>Installed Directories</segtitle>
|
---|
| 228 |
|
---|
| 229 | <seglistitem>
|
---|
| 230 | <seg>
|
---|
[af373d35] | 231 | fancontrol, isadump, isaset, pwmconfig, sensors, sensors-conf-convert,
|
---|
| 232 | sensors-detect, and optionally, sensord
|
---|
[c7ce750a] | 233 | </seg>
|
---|
| 234 | <seg>
|
---|
| 235 | libsensors.so
|
---|
[9166fa4] | 236 | </seg>
|
---|
| 237 | <seg>
|
---|
| 238 | /usr/include/sensors and
|
---|
[c7ce750a] | 239 | /usr/share/doc/lm_sensors-&lm_sensors-version;
|
---|
[9166fa4] | 240 | </seg>
|
---|
| 241 | </seglistitem>
|
---|
| 242 | </segmentedlist>
|
---|
| 243 |
|
---|
| 244 | <variablelist>
|
---|
| 245 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 246 | <?dbfo list-presentation="list"?>
|
---|
| 247 | <?dbhtml list-presentation="table"?>
|
---|
| 248 |
|
---|
| 249 | <varlistentry id="fancontrol">
|
---|
| 250 | <term><command>fancontrol</command></term>
|
---|
| 251 | <listitem>
|
---|
| 252 | <para>
|
---|
[af373d35] | 253 | is a shell script for use with <application>lm_sensors</application>.
|
---|
| 254 | It reads its configuration from a file<!--what file?-->, then
|
---|
| 255 | calculates fan speeds from temperatures and sets the corresponding
|
---|
| 256 | PWM outputs to the computed values.
|
---|
[9166fa4] | 257 | </para>
|
---|
| 258 | <indexterm zone="lm_sensors fancontrol">
|
---|
| 259 | <primary sortas="b-fancontrol">fancontrol</primary>
|
---|
| 260 | </indexterm>
|
---|
| 261 | </listitem>
|
---|
| 262 | </varlistentry>
|
---|
| 263 |
|
---|
| 264 | <varlistentry id="isadump">
|
---|
| 265 | <term><command>isadump</command></term>
|
---|
| 266 | <listitem>
|
---|
| 267 | <para>
|
---|
| 268 | is a small helper program to examine registers visible through the
|
---|
| 269 | ISA bus. It is intended to probe any chip that lives on the ISA bus
|
---|
| 270 | working with an address register and a data register (I2C-like
|
---|
| 271 | access) or a flat range (of up to 256 bytes).
|
---|
| 272 | </para>
|
---|
| 273 | <indexterm zone="lm_sensors isadump">
|
---|
| 274 | <primary sortas="b-isadump">isadump</primary>
|
---|
| 275 | </indexterm>
|
---|
| 276 | </listitem>
|
---|
| 277 | </varlistentry>
|
---|
| 278 |
|
---|
| 279 | <varlistentry id="isaset">
|
---|
| 280 | <term><command>isaset</command></term>
|
---|
| 281 | <listitem>
|
---|
| 282 | <para>
|
---|
| 283 | is a small helper program to set registers visible through the ISA
|
---|
| 284 | bus.
|
---|
| 285 | </para>
|
---|
| 286 | <indexterm zone="lm_sensors isaset">
|
---|
| 287 | <primary sortas="b-isaset">isaset</primary>
|
---|
| 288 | </indexterm>
|
---|
| 289 | </listitem>
|
---|
| 290 | </varlistentry>
|
---|
| 291 |
|
---|
| 292 | <varlistentry id="pwmconfig">
|
---|
| 293 | <term><command>pwmconfig</command></term>
|
---|
| 294 | <listitem>
|
---|
| 295 | <para>
|
---|
| 296 | tests the pulse width modulation (PWM) outputs of sensors and
|
---|
| 297 | configures fancontrol.
|
---|
| 298 | </para>
|
---|
| 299 | <indexterm zone="lm_sensors pwmconfig">
|
---|
| 300 | <primary sortas="b-pwmconfig">pwmconfig</primary>
|
---|
| 301 | </indexterm>
|
---|
| 302 | </listitem>
|
---|
| 303 | </varlistentry>
|
---|
| 304 |
|
---|
| 305 | <varlistentry id="sensors">
|
---|
| 306 | <term><command>sensors</command></term>
|
---|
| 307 | <listitem>
|
---|
| 308 | <para>
|
---|
| 309 | prints the current readings of all sensor chips.
|
---|
| 310 | </para>
|
---|
| 311 | <indexterm zone="lm_sensors sensors">
|
---|
| 312 | <primary sortas="b-sensors">sensors</primary>
|
---|
| 313 | </indexterm>
|
---|
| 314 | </listitem>
|
---|
| 315 | </varlistentry>
|
---|
| 316 |
|
---|
| 317 | <varlistentry id="sensors-conf-convert">
|
---|
| 318 | <term><command>sensors-conf-convert</command></term>
|
---|
| 319 | <listitem>
|
---|
| 320 | <para>
|
---|
[af373d35] | 321 | is a <application>Perl</application> script to convert
|
---|
| 322 | <application>lm-sensors</application> version 2 configuration files
|
---|
[9166fa4] | 323 | to work with version 3.
|
---|
| 324 | </para>
|
---|
| 325 | <indexterm zone="lm_sensors sensors-conf-convert">
|
---|
| 326 | <primary sortas="b-sensors-conf-convert">sensors-conf-convert</primary>
|
---|
| 327 | </indexterm>
|
---|
| 328 | </listitem>
|
---|
| 329 | </varlistentry>
|
---|
| 330 |
|
---|
| 331 | <varlistentry id="sensors-detect">
|
---|
| 332 | <term><command>sensors-detect</command></term>
|
---|
| 333 | <listitem>
|
---|
| 334 | <para>
|
---|
[af373d35] | 335 | is a <application>Perl</application> script that will walk you
|
---|
| 336 | through the process of scanning your system for various hardware
|
---|
| 337 | monitoring chips (sensors) supported by
|
---|
| 338 | <filename class="libraryfile">libsensors</filename>, or more
|
---|
| 339 | generally by the <application>lm_sensors</application> tool suite.
|
---|
[9166fa4] | 340 | </para>
|
---|
| 341 | <indexterm zone="lm_sensors sensors-detect">
|
---|
| 342 | <primary sortas="b-sensors-detect">sensors-detect</primary>
|
---|
| 343 | </indexterm>
|
---|
| 344 | </listitem>
|
---|
| 345 | </varlistentry>
|
---|
| 346 |
|
---|
| 347 | <varlistentry id="libsensors">
|
---|
| 348 | <term><filename class="libraryfile">libsensors.so</filename></term>
|
---|
| 349 | <listitem>
|
---|
| 350 | <para>
|
---|
[af373d35] | 351 | contains the <application>lm_sensors</application> API functions.
|
---|
[9166fa4] | 352 | </para>
|
---|
| 353 | <indexterm zone="lm_sensors libsensors">
|
---|
| 354 | <primary sortas="c-libsensors">libsensors.so</primary>
|
---|
| 355 | </indexterm>
|
---|
| 356 | </listitem>
|
---|
| 357 | </varlistentry>
|
---|
[c7ce750a] | 358 |
|
---|
[9166fa4] | 359 | </variablelist>
|
---|
[c7ce750a] | 360 |
|
---|
[9166fa4] | 361 | </sect2>
|
---|
[c7ce750a] | 362 |
|
---|
[9166fa4] | 363 | </sect1>
|
---|