source: general/sysutils/lm_sensors.xml@ 45ab6c7

11.0 11.1 11.2 11.3 12.0 12.1 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since 45ab6c7 was 45ab6c7, checked in by Xi Ruoyao <xry111@…>, 3 years ago

more SVN prop clean up

Remove "$LastChanged$" everywhere, and also some unused $Date$
  • Property mode set to 100644
File size: 12.3 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://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 <sect1info>
19 <date>$Date$</date>
20 </sect1info>
21
22 <title>lm-sensors-&lm-sensors-version;</title>
23
24 <indexterm zone="lm_sensors">
25 <primary sortas="a-lm_sensors">lm_sensors</primary>
26 </indexterm>
27
28 <sect2 role="package">
29 <title>Introduction to lm_sensors</title>
30
31 <para>
32 The <application>lm_sensors</application> package provides user-space
33 support for the hardware monitoring drivers in the Linux kernel.
34 This is useful for monitoring the temperature of the CPU and adjusting the
35 performance of some hardware (such as cooling fans).
36 </para>
37
38 &lfs101_checked;
39
40 <bridgehead renderas="sect3">Package Information</bridgehead>
41 <itemizedlist spacing="compact">
42 <listitem>
43 <para>
44 Download (HTTP): <ulink url="&lm_sensors-download-http;"/>
45 </para>
46 </listitem>
47 <listitem>
48 <para>
49 Download (FTP): <ulink url="&lm_sensors-download-ftp;"/>
50 </para>
51 </listitem>
52 <listitem>
53 <para>
54 Download MD5 sum: &lm_sensors-md5sum;
55 </para>
56 </listitem>
57 <listitem>
58 <para>
59 Download size: &lm_sensors-size;
60 </para>
61 </listitem>
62 <listitem>
63 <para>
64 Estimated disk space required: &lm_sensors-buildsize;
65 </para>
66 </listitem>
67 <listitem>
68 <para>
69 Estimated build time: &lm_sensors-time;
70 </para>
71 </listitem>
72 </itemizedlist>
73
74<!-- <bridgehead renderas="sect3">Additional Downloads</bridgehead>
75 <itemizedlist spacing="compact">
76 <listitem>
77 <para>
78 Required patch:
79 <ulink url="&patch-root;/lm_sensors-&lm_sensors-version;-upstream_fixes-1.patch"/>
80 </para>
81 </listitem>
82 </itemizedlist> -->
83
84 <bridgehead renderas="sect3">lm_sensors Dependencies</bridgehead>
85
86 <bridgehead renderas="sect4">Required</bridgehead>
87 <para role="required">
88 <xref linkend="which"/>
89 </para>
90
91 <bridgehead renderas="sect4">Optional</bridgehead>
92 <para role="optional">
93 <ulink url="http://oss.oetiker.ch/rrdtool/">RRDtool</ulink> (required to
94 build the <command>sensord</command> program)
95 </para>
96
97 <para condition="html" role="usernotes">
98 User Notes: <ulink url="&blfs-wiki;/lm_sensors"/>
99 </para>
100 </sect2>
101
102 <sect2 role="kernel" id="lm_sensors-kernel">
103 <title>Kernel Configuration</title>
104
105 <para>
106 Getting your kernel config right is an iterative process that may require
107 that you recompile your kernel a couple of times. The simplest way to go
108 about it is to start by enabling modules and then compile everything that
109 may be needed by Lm Sensors as a module:
110 </para>
111
112<screen><literal>Bus options (PCI etc.) ---&gt;
113 [*] PCI support [CONFIG_PCI]
114
115[*] Enable loadable module support ---&gt; [CONFIG_MODULES]
116
117Device Drivers ---&gt;
118 I2C support ---&gt;
119 &lt;*/M&gt; I2C device interface [CONFIG_I2C_CHARDEV]<!--
120Seems to be automatically selected and invisible on linux 3.17:
121 I2C Algorithms -&45;-&gt;
122 &lt;M&gt; (configure all of them as modules)-->
123 I2C Hardware Bus support ---&gt;
124 &lt;M&gt; (configure all of them as modules)
125 &lt;*/M&gt; Hardware Monitoring support ---&gt; [CONFIG_HWMON]
126 &lt;M&gt; (configure all of them as modules)</literal></screen>
127
128 <para>
129 Recompile your kernel and reboot into the new kernel. Don't forget to
130 <command>make modules_install</command> We will come back to the kernel in
131 the Configuring section below.
132 </para>
133
134 <indexterm zone="lm_sensors lm_sensors-kernel">
135 <primary sortas="d-lm_sensors">lm_sensors</primary>
136 </indexterm>
137 </sect2>
138
139 <sect2 role="installation">
140 <title>Installation of lm_sensors</title>
141
142 <para>
143 Install <application>lm_sensors</application> by running the following
144 commands:
145 </para>
146
147<!-- <screen><userinput>patch -Np1 -i ../lm_sensors-&lm_sensors-version;-upstream_fixes-1.patch &amp;&amp; -->
148<screen><userinput>make PREFIX=/usr \
149 BUILD_STATIC_LIB=0 \
150 MANDIR=/usr/share/man</userinput></screen>
151
152 <para>
153 This package does not come with a test suite.
154 </para>
155
156 <para>
157 Now, as the <systemitem class="username">root</systemitem> user:
158 </para>
159
160<screen role="root"><userinput>make PREFIX=/usr \
161 BUILD_STATIC_LIB=0 \
162 MANDIR=/usr/share/man install &amp;&amp;
163
164install -v -m755 -d /usr/share/doc/lm_sensors-&lm-sensors-version; &amp;&amp;
165cp -rv README INSTALL doc/* \
166 /usr/share/doc/lm_sensors-&lm-sensors-version;</userinput></screen>
167 </sect2>
168
169 <sect2 role="commands">
170 <title>Command Explanations</title>
171
172 <para>
173 <parameter>BUILD_STATIC_LIB=0</parameter>: This parameter disables
174 compiling and installing the static version of
175 <filename class="libraryfile">libsensors</filename>.
176 </para>
177
178 <para>
179 <parameter>PROG_EXTRA=sensord</parameter>: This parameter enables
180 compiling <command>sensord</command>, a daemon that can monitor your
181 system at regular intervals. Compiling <command>sensord</command> requires
182 <ulink url="http://oss.oetiker.ch/rrdtool/">RRDtool</ulink>. Compiling
183 RRDtool 1.4.6 requires a sed: <command>sed -i '/ sv_undef/d'
184 bindings/perl-shared/RRDs.xs</command>.
185 </para>
186
187 </sect2>
188
189 <sect2 role="configuration">
190 <title>Configuring lm_sensors</title>
191
192 <sect3 id="lm_sensors-config">
193 <title>Config File</title>
194
195 <para>
196 <filename>/etc/sensors3.conf</filename>
197 </para>
198
199 <indexterm zone="lm_sensors lm_sensors-config">
200 <primary
201 sortas="e-etc-path-Configfilename2">/etc/sensors3.conf</primary>
202 </indexterm>
203
204 </sect3>
205
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>
Note: See TracBrowser for help on using the repository browser.