Package: lm-sensors
Version: 1:3.6.0-8
Severity: minor
Tags: patch
Dear Maintainer,
here are some remarks and editorial (formatting) fixes 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, 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.1
Change -- in x--y to \(em (em-dash), or, if an
option, to \-\-
39:.B sensors --bus-list
48:.B sensors --bus-list
52:.IP "-c, --config-file config-file"
56:.IP "-h, --help"
58:.IP "-s, --set"
62:.IP "-A, --no-adapter"
71:.IP "-v, --version"
73:.IP "-f, --fahrenheit"
75:.IP --bus-list
-.-.
Change a HYPHEN-MINUS (code 0x55, 2D) to a minus (\-), if in front of a
name for an option.
35:.B sensors -s [
45:.B sensors -s
52:.IP "-c, --config-file config-file"
56:.IP "-h, --help"
58:.IP "-s, --set"
62:.IP "-A, --no-adapter"
64:.IP -u
69:.IP -j
71:.IP "-v, --version"
73:.IP "-f, --fahrenheit"
-.-.
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.
53:Specify a configuration file. If no file is specified, the libsensors
54:default configuration file is used. Use `-c /dev/null' to temporarily
59:Evaluate all `set' statements in the configuration file and exit. You must
60:be `root' to do this. If this parameter is not specified, no `set' statement
65:Raw output. This mode is suitable for debugging and for post-processing
66:of the output by scripts. It is also useful when writing a configuration
70:Json output. This mode is suitable for post-processing of the output by
scripts.
76:Generate bus statements suitable for using in sensors.conf. Such bus
statements
78:buses of the same type. As bus numbers are usually not guaranteed to be
stable
86:The system wide configuration file. See
-.-.
The name of a man page is set in bold type and the section in roman (see
man-pages(7)).
92:sensors.conf(5), sensors-detect(8).
-.-.
-- 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.1 2023-09-01 00:44:25.000000000 +0000
+++ sensors.1.new 2023-09-01 01:01:03.000000000 +0000
@@ -32,67 +32,74 @@ sensors \- print sensors information
.I chips
.B ]
.br
-.B sensors -s [
+.B sensors \-s [
.I chips
.B ]
.br
-.B sensors --bus-list
+.B sensors \-\-bus-list
.SH DESCRIPTION
.B sensors
is used to show the current readings of all sensor chips.
.br
-.B sensors -s
+.B sensors \-s
is used to set all limits as specified in the configuration file.
.br
-.B sensors --bus-list
+.B sensors \-\-bus-list
is used to generate bus statements suitable for the configuration file.
.SH OPTIONS
-.IP "-c, --config-file config-file"
-Specify a configuration file. If no file is specified, the libsensors
-default configuration file is used. Use `-c /dev/null' to temporarily
-disable this default configuration file.
-.IP "-h, --help"
+.IP "\-c, \-\-config-file config-file"
+Specify a configuration file.
+If no file is specified,
+the libsensors default configuration file is used.
+Use `\-c /dev/null' to temporarily disable this default configuration file.
+.IP "\-h, \-\-help"
Print a help text and exit.
-.IP "-s, --set"
-Evaluate all `set' statements in the configuration file and exit. You must
-be `root' to do this. If this parameter is not specified, no `set' statement
-is evaluated.
-.IP "-A, --no-adapter"
+.IP "\-s, \-\-set"
+Evaluate all `set' statements in the configuration file and exit.
+You must be `root' to do this.
+If this parameter is not specified,
+no `set' statement is evaluated.
+.IP "\-A, \-\-no-adapter"
Do not show the adapter for each chip.
-.IP -u
-Raw output. This mode is suitable for debugging and for post-processing
-of the output by scripts. It is also useful when writing a configuration
-file because it shows the raw input names which must be referenced in the
-configuration file.
-.IP -j
-Json output. This mode is suitable for post-processing of the output by scripts.
-.IP "-v, --version"
+.IP \-u
+Raw output.
+This mode is suitable for debugging and for post-processing of the
+output by scripts.
+It is also useful when writing a configuration file
+because it shows the raw input names
+which must be referenced in the configuration file.
+.IP \-j
+Json output.
+This mode is suitable for post-processing of the output by scripts.
+.IP "\-v, \-\-version"
Print the program version and exit.
-.IP "-f, --fahrenheit"
+.IP "\-f, \-\-fahrenheit"
Print the temperatures in degrees Fahrenheit instead of Celsius.
-.IP --bus-list
-Generate bus statements suitable for using in sensors.conf. Such bus statements
-are only needed if you have several chips sharing the same address on different
-buses of the same type. As bus numbers are usually not guaranteed to be stable
-over reboots, these statements let you refer to each bus by its name rather
-than numbers.
+.IP \-\-bus-list
+Generate bus statements suitable for using in sensors.conf.
+Such bus statements are only needed
+if you have several chips sharing the same address on different
+buses of the same type.
+As bus numbers are usually not guaranteed to be stable over reboots,
+these statements let you refer to each bus by its name rather than
+numbers.
.SH FILES
.I /etc/sensors3.conf
.br
.I /etc/sensors.conf
.RS
-The system wide configuration file. See
+The system wide configuration file.
+See
.BR sensors.conf (5)
for further details.
.RE
.SH SEE ALSO
-sensors.conf(5), sensors-detect(8).
+.BR sensors.conf (5),
+.BR sensors-detect (8).
.SH AUTHOR
Frodo Looijaard and the lm_sensors group
https://hwmon.wiki.kernel.org/lm_sensors
-
-
