Package: lm-sensors
Version: 1:3.6.0-8
Severity: minor
Tags: patch
Dear Maintainer,
here are some remarks and editorial corrections for the man page.
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)
-.-
Input file is sensors-detect.8
Change -- in x--y to \(em (em-dash), or, if an
option, to \-\-
7:.I --auto
-.-.
Change a HYPHEN-MINUS (code 0x55, 2D) to a minus (\-), if in front of a
name for an option.
36:.IP "--auto"
-.-.
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.
31:his/her wish. This can be useful if a given system has more than one
32:hardware monitoring chip. Some vendors are known to do this, most notably
37:Run in automatic, non-interactive mode. Assume default answers to all
38:questions. Note that this isn't necessarily safe as the internal logic may
39:lead to potentially dangerous probes being attempted. See the WARNING section
45:identify them. This means that it can access chips in a way these chips do
51:guarantee that sensors-detect will not lock or kill a specific system. So,
54:part of your system. Also, it is recommended to not force a detection step
-.-.
The name of a man page is typeset in bold and the section in roman
(see man-pages(7)).
13:or sensors, supported by libsensors(3), or more generally by the lm_sensors
58:sensors(1), libsensors(3)
-.-.
Start a sentence in parenthesis on a new line.
sensors-detect.8:47:damage (a rare case, thankfully.)
-.-.
Additional.
1) No empty line before a macro like 'SH' as it is included in the
macro. Use a single full stop (.) in the first column to create an
(almost) empty line in the source.
2) "if can't affort" -> "if you can't affort"
-- 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
--- sensors-detect.8 2023-09-03 00:45:12.000000000 +0000
+++ sensors-detect.8.new 2023-09-03 03:23:50.000000000 +0000
@@ -1,19 +1,21 @@
.TH SENSORS-DETECT 8 "September 2013" "lm-sensors 3"
.SH NAME
sensors-detect \- detect hardware monitoring chips
-
+.
.SH SYNOPSIS
-.B sensors-detect [
-.I --auto
-.B ]
-
+.BR sensors-detect " ["
+.BR \-\-auto " ]"
+.
.SH DESCRIPTION
-sensors-detect is an interactive program that will walk you through the
+.B sensors-detect
+is an interactive program that will walk you through the
process of scanning your system for various hardware monitoring chips,
-or sensors, supported by libsensors(3), or more generally by the lm_sensors
-tool suite.
+or sensors, supported by
+.BR libsensors (3),
+or more generally by the lm_sensors tool suite.
-sensors-detect will look for the following devices, in order:
+.B sensors-detect
+will look for the following devices, in order:
.IP \(bu
Sensors embedded in CPUs, south bridges and memory controllers.
.IP \(bu
@@ -24,38 +26,55 @@ Hardware monitoring chips accessed throu
Hardware monitoring chips reachable over the SMBus or more generally
any I2C bus on your system.
.PP
-As the last two detection steps can cause trouble on some systems, they
-are normally not attempted if the second detection step led to the
-discovery of a Super I/O chip with complete hardware monitoring features.
-However, the user is always free to ask for all detection steps if so is
-his/her wish. This can be useful if a given system has more than one
-hardware monitoring chip. Some vendors are known to do this, most notably
-Asus and Tyan.
-
+As the last two detection steps can cause trouble on some systems,
+they are normally not attempted
+if the second detection step led to the discovery of a Super I/O chip
+with complete hardware monitoring features.
+However,
+the user is always free to ask for all detection steps
+if so is his/her wish.
+This can be useful
+if a given system has more than one hardware monitoring chip.
+Some vendors are known to do this,
+most notably Asus and Tyan.
+.
.SH OPTIONS
-.IP "--auto"
-Run in automatic, non-interactive mode. Assume default answers to all
-questions. Note that this isn't necessarily safe as the internal logic may
-lead to potentially dangerous probes being attempted. See the WARNING section
-below.
-
+.IP \-\-auto
+Run in automatic, non-interactive mode.
+Assume default answers to all questions.
+Note that this isn't necessarily safe
+as the internal logic may lead to potentially dangerous probes being attempted.
+See the WARNING section below.
+.
.SH WARNING
-sensors-detect needs to access the hardware for most of the chip detections.
-By definition, it doesn't know which chips are there before it manages to
-identify them. This means that it can access chips in a way these chips do
-not like, causing problems ranging from SMBus lockup to permanent hardware
-damage (a rare case, thankfully.)
-
-The authors made their best to make the detection as safe as possible, and
-it turns out to work just fine in most cases, however it is impossible to
-guarantee that sensors-detect will not lock or kill a specific system. So,
-as a rule of thumb, you should not run sensors-detect on production servers,
-and you should not run sensors-detect if can't afford replacing a random
-part of your system. Also, it is recommended to not force a detection step
-which would have been skipped by default, unless you know what you are doing.
+.B sensors-detect
+needs to access the hardware for most of the chip detections.
+By definition,
+it doesn't know which chips are there
+before it manages to identify them.
+This means that it can access chips in a way these chips do not like,
+causing problems ranging from SMBus lockup to permanent hardware damage
+(a rare case, thankfully.)
+The authors made their best to make the detection as safe as possible,
+and it turns out to work just fine in most cases,
+however it is impossible to guarantee that
+.B sensors-detect
+will not lock or kill a specific system.
+So, as a rule of thumb,
+you should not run
+.B sensors-detect
+on production servers,
+and you should not run
+.B sensors-detect
+if you can't afford replacing a random part of your system.
+Also, it is recommended to not force a detection step
+which would have been skipped by default,
+unless you know what you are doing.
+.
.SH SEE ALSO
-sensors(1), libsensors(3)
-
+.BR sensors (1),
+.BR libsensors (3)
+.
.SH AUTHOR
Frodo Looijaard and Jean Delvare
