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