Package: lm-sensors
Version: 1:3.6.0-8
Severity: minor
Tags: patch
Dear Maintainer,
here are some remarks and editorial fixes for the manual.
The patch is in the attachment.
-.-
The difference between the formatted outputs can be seen with:
nroff -man <file1> > <out1>
nroff -man <file2> > <out2>
diff -u <out1> <out2>
and for groff, using
"printf '%s\n%s\n' '.kern 0' '.ss 12 0' | groff -man -Z - "
instead of "nroff -man"
Add the option "-t", if the file contains a table.
Read the output of "diff -u" with "less -R" or similar.
-.-.
If "man" (man-db) is used to check the manual for warnings,
the following must be set:
The option "-warnings=w"
The environmental variable:
export MAN_KEEP_STDERR=yes (or any non-empty value)
or
(produce only warnings):
export MANROFFOPT="-ww -z"
export MAN_KEEP_STDERR=yes (or any non-empty value)
-.-.
Change -- in x--y to \(em (em-dash), or, if an
option, to \-\-
279:.B sensors --bus-list
-.-.
Wrong distance between sentences.
Separate the sentences and subordinate clauses; each begins on a new
line. See man-pages(7) ("Conventions for source file layout") and
"info groff" ("Input Conventions").
The best procedure is to always start a new sentence on a new line,
at least, if you are typing on a computer.
Remember coding: Only one command ("sentence") on each (logical) line.
E-mail: Easier to quote exactly the relevant lines.
Generally: Easier to edit the sentence.
Patches: Less unaffected text.
Search for two adjacent words is easier, when they belong to the same line,
and the same phrase.
The amount of space between sentences in the output can then be
controlled with the ".ss" request.
N.B
The number of lines affected is too large to be in the patch.
35:Each chip may have several features. For example, the LM78 monitors 7
36:voltage inputs, 3 fans and one temperature. Feature names are
37:standardized. Typical feature names are in0, in1, in2... for voltage
38:inputs, fan1, fan2, fan3... for fans and temp1, temp2, temp3... for
43:limit, alarm, etc. Sub\-feature names are standardized as well. For
46:(high limit) and in0_alarm (alarm flag). Which sub\-features are
67:statements are meant. A chip
70:statement. Example:
80:dashes. The first element is the chip type, the second element is
82:of the chip. Such chip descriptions are printed by sensors(1) as the
97:statement. This list isn't necessarily exhaustive as support for other
102:for every element. Note however that it wouldn't make any sense to specify
126:statement describes how a feature should be called. Features without a
128:statement are just called by their feature name. Applications can use this
129:to label the readings they present. Example:
135:The first argument is the feature name. The second argument is the feature
139:one displayed by "sensors" by default. Use "sensors \-u" to see the raw
140:feature names. Same applies to all other statement types below.
148:sensor is not connected). Example:
154:The only argument is the feature name. Please note that this does not
disable
164:to a raw value again. This is most useful for voltage sensors, because
174:using two resistors of values 6.8 Ohm and 10 Ohm, respectively. See the
178:The first argument is the feature name. The second argument is an expression
180:`@' stands here for the raw value. This is the formula which will be applied
181:when reading values from the chip. The third argument is an expression that
183:`@' stands here for the real\-world value. This is the formula which will be
184:applied when writing values to the chip. The two formulas are obviously
190:it makes sense. For example, the above example would affect sub\-features
203:are substituted. You should be careful though to avoid circular references.
214:statement is used to write a sub\-feature value to the chip. Of course not
216:and alarm flags can not. Valid sub\-features are usually min/max limits.
229:The first argument is the feature name. The second argument is an expression
230:which determines the written value. If there is an applying
236:are substituted. You should be careful though to avoid circular references.
242:option. Typical graphical sensors applications do not care about these
252:adapters (which may change from moment to moment). Example:
258:The first argument is the bus number. It is the literal text
260:followed by a number. As there is a dash in this argument, it must
273:is referred to. Still, as a matter of good style, we suggest you place
285:statement is the configuration file it was defined in. This makes it
294:value is changed. Even if the driver does, it's still better to put
332:voltage value into the 0 \- 4.08 V range. Some use an inverting
333:amplifier, others use a positive reference voltage. This leads to
334:different computation formulas. Note that most users won't have to care
351:one motherboard to the next. For these chips, the driver usually
382:usually only support some of the types above. Please refer to the
392:limits as simple limits. Instead, they have two values for each
394:one which clears the alarm when the temperature falls. The latter is
395:typically a few degrees below the former. This mechanism is known as
401:fan. This should normally let the temperature fall in a timely manner.
405:fan off loop. The hysteresis mechanism ensures that the system is
410:sub-feature. Likewise, tempX_crit often comes with tempX_crit_hyst.
426:the limit value it relates to in the configuration file. Implementation
432:Some chips support alarms with beep warnings. When an alarm is triggered
433:you can be warned by a beeping signal through your computer speaker. On
435:switch to enable or disable beeping globally. Enable beeping using:
450:the last one in the configuration file is used. So usually, you should
456:Comments are introduced by hash marks. A comment continues to the end of the
457:line. Empty lines, and lines containing only whitespace or comments are
458:ignored. Other lines have one of the below forms. There must be whitespace
459:between each element, but the amount of whitespace is unimportant. A line
490:is a string. If it only contains letters, digits and underscores, it does
not
543:is a floating\-point number. `10', `10.4' and `.4' are examples of valid
553:configuration file. /etc/sensors3.conf is tried first, and if it doesn't
exist,
561:the default configuration file. Files with names that start with a dot are
-.-.
Use \(en for a dash (en-dash) between space characters, not a minus
(\-) or a hyphen (-), except in the NAME section.
sensors.conf.5:146:statement is a hint that a specific feature should be
ignored - probably
-.-.
The name of a man page is set in bold type and the section in roman (see
man-pages(7)).
82:of the chip. Such chip descriptions are printed by sensors(1) as the
240:statements are only executed by sensors(1) when you use the
-.-.
Split a punctuation from a single argument, if a two-font macro is meant
89:.I spi-*,
-.-.
Name of a manual is set in bold, the section in roman.
See man-pages(7).
566:libsensors(3)
-.-.
Use "\(en" (en-dash) to indicate a range, not a minus (\-);
this is not a substraction.
304:The driver reports the value at the chip's pin (0 \- 4.08 V), and the
332:voltage value into the 0 \- 4.08 V range. Some use an inverting
346:Many recent monitoring chips have a 0 \- 2.04 V range, so scaling resistors
-.-.
-- System Information:
Debian Release: trixie/sid
APT prefers testing
APT policy: (990, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.4.11-1 (SMP w/2 CPU threads; PREEMPT)
Locale: LANG=is_IS.iso88591, LC_CTYPE=is_IS.iso88591 (charmap=ISO-8859-1),
LANGUAGE not set
Shell: /bin/sh linked to /usr/bin/dash
Init: sysvinit (via /sbin/init)
Versions of packages lm-sensors depends on:
ii libc6 2.37-7
ii libsensors5 1:3.6.0-8
ii perl 5.36.0-7
ii sed 4.9-1
lm-sensors recommends no packages.
Versions of packages lm-sensors suggests:
pn fancontrol <none>
pn i2c-tools <none>
pn read-edid <none>
-- no debconf information
The difference between the formatted outputs can be seen with:
nroff -man <file1> > <out1>
nroff -man <file2> > <out2>
diff -u <out1> <out2>
and for groff, using
"printf '%s\n%s\n' '.kern 0' '.ss 12 0' | groff -man -Z - "
instead of "nroff -man"
Add the option "-t", if the file contains a table.
Read the output of "diff -u" with "less -R" or similar.
-.-.
If "man" (man-db) is used to check the manual, the following
must be set:
The option "-warnings=w"
The environmental variable:
export MAN_KEEP_STDERR=yes (or any non-empty value)
or
(produce only warnings):
export MANROFFOPT="-ww -z"
export MAN_KEEP_STDERR=yes (or any non-empty value)
-.-.
Change -- in x--y to \(em (em-dash), or, if an
option, to \-\-
279:.B sensors --bus-list
-.-.
Wrong distance between sentences.
Separate the sentences and subordinate clauses; each begins on a new
line. See man-pages(7) ("Conventions for source file layout") and
"info groff" ("Input Conventions").
The best procedure is to always start a new sentence on a new line,
at least, if you are typing on a computer.
Remember coding: Only one command ("sentence") on each (logical) line.
E-mail: Easier to quote exactly the relevant lines.
Generally: Easier to edit the sentence.
Patches: Less unaffected text.
Search for two adjacent words is easier, when they belong to the same line,
and the same phrase.
The amount of space between sentences in the output can then be
controlled with the ".ss" request.
N.B
The number of lines affected is too large to be in the patch.
35:Each chip may have several features. For example, the LM78 monitors 7
36:voltage inputs, 3 fans and one temperature. Feature names are
37:standardized. Typical feature names are in0, in1, in2... for voltage
38:inputs, fan1, fan2, fan3... for fans and temp1, temp2, temp3... for
43:limit, alarm, etc. Sub\-feature names are standardized as well. For
46:(high limit) and in0_alarm (alarm flag). Which sub\-features are
67:statements are meant. A chip
70:statement. Example:
80:dashes. The first element is the chip type, the second element is
82:of the chip. Such chip descriptions are printed by sensors(1) as the
97:statement. This list isn't necessarily exhaustive as support for other
102:for every element. Note however that it wouldn't make any sense to specify
126:statement describes how a feature should be called. Features without a
128:statement are just called by their feature name. Applications can use this
129:to label the readings they present. Example:
135:The first argument is the feature name. The second argument is the feature
139:one displayed by "sensors" by default. Use "sensors \-u" to see the raw
140:feature names. Same applies to all other statement types below.
148:sensor is not connected). Example:
154:The only argument is the feature name. Please note that this does not
disable
164:to a raw value again. This is most useful for voltage sensors, because
174:using two resistors of values 6.8 Ohm and 10 Ohm, respectively. See the
178:The first argument is the feature name. The second argument is an expression
180:`@' stands here for the raw value. This is the formula which will be applied
181:when reading values from the chip. The third argument is an expression that
183:`@' stands here for the real\-world value. This is the formula which will be
184:applied when writing values to the chip. The two formulas are obviously
190:it makes sense. For example, the above example would affect sub\-features
203:are substituted. You should be careful though to avoid circular references.
214:statement is used to write a sub\-feature value to the chip. Of course not
216:and alarm flags can not. Valid sub\-features are usually min/max limits.
229:The first argument is the feature name. The second argument is an expression
230:which determines the written value. If there is an applying
236:are substituted. You should be careful though to avoid circular references.
242:option. Typical graphical sensors applications do not care about these
252:adapters (which may change from moment to moment). Example:
258:The first argument is the bus number. It is the literal text
260:followed by a number. As there is a dash in this argument, it must
273:is referred to. Still, as a matter of good style, we suggest you place
285:statement is the configuration file it was defined in. This makes it
294:value is changed. Even if the driver does, it's still better to put
332:voltage value into the 0 \- 4.08 V range. Some use an inverting
333:amplifier, others use a positive reference voltage. This leads to
334:different computation formulas. Note that most users won't have to care
351:one motherboard to the next. For these chips, the driver usually
382:usually only support some of the types above. Please refer to the
392:limits as simple limits. Instead, they have two values for each
394:one which clears the alarm when the temperature falls. The latter is
395:typically a few degrees below the former. This mechanism is known as
401:fan. This should normally let the temperature fall in a timely manner.
405:fan off loop. The hysteresis mechanism ensures that the system is
410:sub-feature. Likewise, tempX_crit often comes with tempX_crit_hyst.
426:the limit value it relates to in the configuration file. Implementation
432:Some chips support alarms with beep warnings. When an alarm is triggered
433:you can be warned by a beeping signal through your computer speaker. On
435:switch to enable or disable beeping globally. Enable beeping using:
450:the last one in the configuration file is used. So usually, you should
456:Comments are introduced by hash marks. A comment continues to the end of the
457:line. Empty lines, and lines containing only whitespace or comments are
458:ignored. Other lines have one of the below forms. There must be whitespace
459:between each element, but the amount of whitespace is unimportant. A line
490:is a string. If it only contains letters, digits and underscores, it does
not
543:is a floating\-point number. `10', `10.4' and `.4' are examples of valid
553:configuration file. /etc/sensors3.conf is tried first, and if it doesn't
exist,
561:the default configuration file. Files with names that start with a dot are
-.-.
Use \(en for a dash (en-dash) between space characters, not a minus
(\-) or a hyphen (-), except in the NAME section.
sensors.conf.5:146:statement is a hint that a specific feature should be
ignored - probably
-.-.
The name of a man page is set in bold type and the section in roman (see
man-pages(7)).
82:of the chip. Such chip descriptions are printed by sensors(1) as the
240:statements are only executed by sensors(1) when you use the
-.-.
Split a punctuation from a single argument, if a two-font macro is meant
89:.I spi-*,
-.-.
Name of a manual is set in bold, the section in roman.
See man-pages(7).
566:libsensors(3)
-.-.
Use "\(en" (en-dash) to indicate a range, not a minus (\-);
this is not a substraction.
304:The driver reports the value at the chip's pin (0 \- 4.08 V), and the
332:voltage value into the 0 \- 4.08 V range. Some use an inverting
346:Many recent monitoring chips have a 0 \- 2.04 V range, so scaling resistors
-.-.
