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