1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
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 | &lfs122_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 \
|
---|
139 | EXLDFLAGS=</userinput></screen>
|
---|
140 |
|
---|
141 | <para>
|
---|
142 | This package does not come with a test suite.
|
---|
143 | </para>
|
---|
144 |
|
---|
145 | <para>
|
---|
146 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
147 | </para>
|
---|
148 |
|
---|
149 | <screen role="root"><userinput>make PREFIX=/usr \
|
---|
150 | BUILD_STATIC_LIB=0 \
|
---|
151 | MANDIR=/usr/share/man install &&
|
---|
152 |
|
---|
153 | install -v -m755 -d /usr/share/doc/lm_sensors-&lm-sensors-version; &&
|
---|
154 | cp -rv README INSTALL doc/* \
|
---|
155 | /usr/share/doc/lm_sensors-&lm-sensors-version;</userinput></screen>
|
---|
156 | </sect2>
|
---|
157 |
|
---|
158 | <sect2 role="commands">
|
---|
159 | <title>Command Explanations</title>
|
---|
160 |
|
---|
161 | <para>
|
---|
162 | <parameter>BUILD_STATIC_LIB=0</parameter>: This parameter disables
|
---|
163 | compiling and installing the static version of
|
---|
164 | <filename class="libraryfile">libsensors</filename>.
|
---|
165 | </para>
|
---|
166 |
|
---|
167 | <para>
|
---|
168 | <parameter>EXLDFLAGS=</parameter>: This parameter disables
|
---|
169 | hard coding library search paths (rpath) into the
|
---|
170 | binary executable files and shared libraries. This package does not
|
---|
171 | need rpath for an installation into the standard location, and rpath
|
---|
172 | may sometimes cause unwanted effects or even security issues.
|
---|
173 | </para>
|
---|
174 |
|
---|
175 | <para>
|
---|
176 | <option>PROG_EXTRA=sensord</option>: This parameter enables
|
---|
177 | compiling <command>sensord</command>, a daemon that can monitor your
|
---|
178 | system at regular intervals. Compiling <command>sensord</command> requires
|
---|
179 | <ulink url="https://oss.oetiker.ch/rrdtool/">RRDtool</ulink>. Be sure
|
---|
180 | to install RRDtool in <filename class="directory">/usr</filename>
|
---|
181 | by running <command>make prefix=/usr</command> when building it.
|
---|
182 | Otherwise, Lm_sensors will not find it easily.
|
---|
183 | </para>
|
---|
184 |
|
---|
185 | </sect2>
|
---|
186 |
|
---|
187 | <sect2 role="configuration">
|
---|
188 | <title>Configuring Lm_sensors</title>
|
---|
189 |
|
---|
190 | <sect3 id="lm_sensors-config">
|
---|
191 | <title>Config File</title>
|
---|
192 |
|
---|
193 | <para>
|
---|
194 | <filename>/etc/sensors3.conf</filename>
|
---|
195 | </para>
|
---|
196 |
|
---|
197 | <indexterm zone="lm_sensors lm_sensors-config">
|
---|
198 | <primary
|
---|
199 | sortas="e-etc-path-Configfilename2">/etc/sensors3.conf</primary>
|
---|
200 | </indexterm>
|
---|
201 |
|
---|
202 | </sect3>
|
---|
203 | <!-- Completely outdated. It only sets a list of kernel modules which
|
---|
204 | should be loaded by lm_sensors. But today udev will load them
|
---|
205 | once the sensor device is detected by the kernel.
|
---|
206 | <sect3><title>Configuration Information</title>
|
---|
207 |
|
---|
208 | <para>
|
---|
209 | To find out what hardware sensors your system has, issue the following
|
---|
210 | command as the <systemitem class="username">root</systemitem> user:
|
---|
211 | </para>
|
---|
212 |
|
---|
213 | <screen role="root"><userinput>sensors-detect</userinput></screen>
|
---|
214 |
|
---|
215 | <para>
|
---|
216 | The appropriate modules should have been loaded and a summary is
|
---|
217 | displayed at the end. Now you know what is needed and you can recompile
|
---|
218 | your kernel to enable just the options you need (i.e., don't enable the
|
---|
219 | modules you cannot use).
|
---|
220 | </para>
|
---|
221 |
|
---|
222 | </sect3>
|
---|
223 | -->
|
---|
224 | </sect2>
|
---|
225 |
|
---|
226 | <sect2 role="content">
|
---|
227 | <title>Contents</title>
|
---|
228 |
|
---|
229 | <segmentedlist>
|
---|
230 | <segtitle>Installed Programs</segtitle>
|
---|
231 | <segtitle>Installed Library</segtitle>
|
---|
232 | <segtitle>Installed Directories</segtitle>
|
---|
233 |
|
---|
234 | <seglistitem>
|
---|
235 | <seg>
|
---|
236 | fancontrol, isadump, isaset, pwmconfig, sensors, sensors-conf-convert,
|
---|
237 | sensors-detect, and optionally, sensord
|
---|
238 | </seg>
|
---|
239 | <seg>
|
---|
240 | libsensors.so
|
---|
241 | </seg>
|
---|
242 | <seg>
|
---|
243 | /etc/sensors.d,
|
---|
244 | /usr/include/sensors and
|
---|
245 | /usr/share/doc/lm_sensors-&lm-sensors-version;
|
---|
246 | </seg>
|
---|
247 | </seglistitem>
|
---|
248 | </segmentedlist>
|
---|
249 |
|
---|
250 | <variablelist>
|
---|
251 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
252 | <?dbfo list-presentation="list"?>
|
---|
253 | <?dbhtml list-presentation="table"?>
|
---|
254 |
|
---|
255 | <varlistentry id="fancontrol">
|
---|
256 | <term><command>fancontrol</command></term>
|
---|
257 | <listitem>
|
---|
258 | <para>
|
---|
259 | is a shell script for use with <application>lm_sensors</application>.
|
---|
260 | It reads its configuration from a file<!--what file?-->, then
|
---|
261 | calculates fan speeds from temperatures and sets the corresponding
|
---|
262 | PWM outputs to the computed values
|
---|
263 | </para>
|
---|
264 | <indexterm zone="lm_sensors fancontrol">
|
---|
265 | <primary sortas="b-fancontrol">fancontrol</primary>
|
---|
266 | </indexterm>
|
---|
267 | </listitem>
|
---|
268 | </varlistentry>
|
---|
269 |
|
---|
270 | <varlistentry id="isadump">
|
---|
271 | <term><command>isadump</command></term>
|
---|
272 | <listitem>
|
---|
273 | <para>
|
---|
274 | is a small helper program to examine registers visible through the
|
---|
275 | ISA bus. It is intended to probe any chip that lives on the ISA bus
|
---|
276 | working with an address register and a data register (I2C-like
|
---|
277 | access) or a flat range (of up to 256 bytes)
|
---|
278 | </para>
|
---|
279 | <indexterm zone="lm_sensors isadump">
|
---|
280 | <primary sortas="b-isadump">isadump</primary>
|
---|
281 | </indexterm>
|
---|
282 | </listitem>
|
---|
283 | </varlistentry>
|
---|
284 |
|
---|
285 | <varlistentry id="isaset">
|
---|
286 | <term><command>isaset</command></term>
|
---|
287 | <listitem>
|
---|
288 | <para>
|
---|
289 | is a small helper program to set registers visible through the ISA
|
---|
290 | bus
|
---|
291 | </para>
|
---|
292 | <indexterm zone="lm_sensors isaset">
|
---|
293 | <primary sortas="b-isaset">isaset</primary>
|
---|
294 | </indexterm>
|
---|
295 | </listitem>
|
---|
296 | </varlistentry>
|
---|
297 |
|
---|
298 | <varlistentry id="pwmconfig">
|
---|
299 | <term><command>pwmconfig</command></term>
|
---|
300 | <listitem>
|
---|
301 | <para>
|
---|
302 | tests the pulse width modulation (PWM) outputs of sensors and
|
---|
303 | configures fancontrol
|
---|
304 | </para>
|
---|
305 | <indexterm zone="lm_sensors pwmconfig">
|
---|
306 | <primary sortas="b-pwmconfig">pwmconfig</primary>
|
---|
307 | </indexterm>
|
---|
308 | </listitem>
|
---|
309 | </varlistentry>
|
---|
310 |
|
---|
311 | <varlistentry id="sensors">
|
---|
312 | <term><command>sensors</command></term>
|
---|
313 | <listitem>
|
---|
314 | <para>
|
---|
315 | prints the current readings of all sensor chips
|
---|
316 | </para>
|
---|
317 | <indexterm zone="lm_sensors sensors">
|
---|
318 | <primary sortas="b-sensors">sensors</primary>
|
---|
319 | </indexterm>
|
---|
320 | </listitem>
|
---|
321 | </varlistentry>
|
---|
322 |
|
---|
323 | <varlistentry id="sensors-conf-convert">
|
---|
324 | <term><command>sensors-conf-convert</command></term>
|
---|
325 | <listitem>
|
---|
326 | <para>
|
---|
327 | is a <application>Perl</application> script to convert
|
---|
328 | <application>lm-sensors</application> version 2 configuration files
|
---|
329 | to work with version 3
|
---|
330 | </para>
|
---|
331 | <indexterm zone="lm_sensors sensors-conf-convert">
|
---|
332 | <primary sortas="b-sensors-conf-convert">sensors-conf-convert</primary>
|
---|
333 | </indexterm>
|
---|
334 | </listitem>
|
---|
335 | </varlistentry>
|
---|
336 |
|
---|
337 | <varlistentry id="sensors-detect">
|
---|
338 | <term><command>sensors-detect</command></term>
|
---|
339 | <listitem>
|
---|
340 | <para>
|
---|
341 | is a <application>Perl</application> script that will walk you
|
---|
342 | through the process of scanning your system for various hardware
|
---|
343 | monitoring chips (sensors) supported by
|
---|
344 | <filename class="libraryfile">libsensors</filename>, or more
|
---|
345 | generally by the <application>lm_sensors</application> tool suite
|
---|
346 | </para>
|
---|
347 | <indexterm zone="lm_sensors sensors-detect">
|
---|
348 | <primary sortas="b-sensors-detect">sensors-detect</primary>
|
---|
349 | </indexterm>
|
---|
350 | </listitem>
|
---|
351 | </varlistentry>
|
---|
352 |
|
---|
353 | <varlistentry id="sensord">
|
---|
354 | <term><command>sensord</command></term>
|
---|
355 | <listitem>
|
---|
356 | <para>
|
---|
357 | (optional) is a daemon that can be used to periodically log sensor
|
---|
358 | readings
|
---|
359 | </para>
|
---|
360 | <indexterm zone="lm_sensors sensord">
|
---|
361 | <primary sortas="b-sensord">sensord</primary>
|
---|
362 | </indexterm>
|
---|
363 | </listitem>
|
---|
364 | </varlistentry>
|
---|
365 |
|
---|
366 | <varlistentry id="libsensors">
|
---|
367 | <term><filename class="libraryfile">libsensors.so</filename></term>
|
---|
368 | <listitem>
|
---|
369 | <para>
|
---|
370 | contains the <application>lm_sensors</application> API functions
|
---|
371 | </para>
|
---|
372 | <indexterm zone="lm_sensors libsensors">
|
---|
373 | <primary sortas="c-libsensors">libsensors.so</primary>
|
---|
374 | </indexterm>
|
---|
375 | </listitem>
|
---|
376 | </varlistentry>
|
---|
377 |
|
---|
378 | </variablelist>
|
---|
379 |
|
---|
380 | </sect2>
|
---|
381 |
|
---|
382 | </sect1>
|
---|