#1051123 sensors-detect.8: some notes and editorial fixes for the manual

Package:
lm-sensors
Source:
lm-sensors
Description:
utilities to read temperature/voltage/fan sensors
Submitter:
Bjarni Ingi Gislason
Date:
2023-09-03 03:39:04 UTC
Severity:
normal
Tags:
#1051123#5
Date:
2023-09-03 03:35:30 UTC
From:
To:
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"