#1050985 sensors.1: Some remarks and editorial corrections for the manual

Package:
lm-sensors
Source:
lm-sensors
Description:
utilities to read temperature/voltage/fan sensors
Submitter:
Bjarni Ingi Gislason
Date:
2023-09-01 02:09:04 UTC
Severity:
normal
Tags:
#1050985#5
Date:
2023-09-01 02:06:44 UTC
From:
To:
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).

-.-.