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