source: general/sysutils/lm_sensors.xml@ 5ae3416

10.0 10.1 11.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind ken/refactor-virt lazarus perl-modules qt5new trunk upgradedb xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 5ae3416 was 5ae3416, checked in by Ken Moffat <ken@…>, 4 years ago

Tags.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@19047 af4574ff-66df-0310-9fd7-8a98e5e911e0

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