Package: lm-sensors
Version: 1:3.6.0-8
Severity: minor
Tags: patch
Dear Maintainer,
here are some remarks and an editorial patch 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)
-.-.
Output from "mandoc -T lint isadump.8":
mandoc: isadump.8:113:81: STYLE: input text line longer than 80 bytes: the
Debian GNU/Linux...
-.-.
Use a macro to change to the italic font, instead of \fI, if
possible (see man-pages(7)).
The macros have the italic corrections, but "\c" removes the "\/" part,
which is in the macro.
So "\/" must be added between the italic argument and the "\c" string.
53:At least two options must be provided to isadump. \fIaddrreg\fR contains the
54:ISA address of the address register for the chip to probe; \fIdatareg\fR
63:The \fIbank\fR and \fIbankreg\fR parameters are useful on the Winbond chips
65:\fIbank\fR is an integer between 0 and 31, and \fIbankreg\fR is an integer
72:mandatory. \fIaddress\fR contains the ISA address of the chip to probe;
74:If provided, \fIrange\fR is how many bytes should be read (must be a
78:The \fIbank\fR and \fIbankreg\fR parameters are useful on the National
80:\fIbank\fR is an integer between 0 and 31, and \fIbankreg\fR is an integer
-.-.
Change a HYPHEN-MINUS (code 0x55, 2D) to a minus (\-), if in front of a
name for an option.
7:.RB [ -y ]
8:.RB [ -W | -L ]
9:.RB [ "-k V1,V2..." ]
16:.B -f
17:.RB [ -y ]
18:.RB [ -W | -L ]
31:.B -f
34:.B -y
40:.B -k V1,V2...
46:.B -W
49:.B -L
95:isadump -f 0xecc0 16.
-.-.
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.
25:bus. It is intended to probe any chip that lives on the ISA bus working with
an
35:Disable interactive mode. By default, isadump will wait for a confirmation
36:from the user before messing with the ISA bus. When this flag is used, it
37:will perform the operation directly. This is mainly meant to be used in
42:the chip configuration mode. Most Super-I/O chips need this.
53:At least two options must be provided to isadump. \fIaddrreg\fR contains the
55:contains the address of the data register. Both addresses are integers
between
56:0x0000 and 0x3FFF. Usually, if the chip's base address is 0x0nn0, the
57:address register is at 0x0nn5 and the data register is at 0x0nn6. The most
67:for Super-I/O chips). The W83781D datasheet has more information on bank
72:mandatory. \fIaddress\fR contains the ISA address of the chip to probe;
75:multiple of 16). If the range isn't provided, it defaults to 256 bytes
82:range). See the PC87365 datasheet for more information on bank selection.
89:Dumping Super-I/O chips is typically a two-step process. First, you will have
92:This will select logical device 9 (correct value depend on the chip). At 0x60
96:This will dump the logical device registers. The correct range depends on
109:Frodo Looijaard, Mark D. Studebaker, and the lm_sensors group
113:the Debian GNU/Linux system. It was then reviewed and augmented by the
lm_sensors
-.-.
Split lines longer than 80 characters into two or more lines.
Appropriate break points are the end of a sentence and a subordinate
clause; after punctuation marks.
isadump.8: line 113 length 81
the Debian GNU/Linux system. It was then reviewed and augmented by the
lm_sensors
-.-.
Rephrase the beginning of a sentence, if it starts with a digit (see
a style manual).
56:0x0000 and 0x3FFF. Usually, if the chip's base address is 0x0nn0, the
-.-.
The name of a man page is set in bold type and the section in roman (see
man-pages(7)).
106:i2cdump(8), isaset(8)
-.-.
Start a sentence in parenthesis on a new line.
isadump.8:26:address register and a data register (I2C-like access) or a flat
range (of up
isadump.8:92:This will select logical device 9 (correct value depend on the
chip). At 0x60
-.-.
Additional.
Spelling:
(correct value depend on the chip). -> ... values ...
-- 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
--- isadump.8 2023-09-02 21:49:00.000000000 +0000
+++ isadump.8.new 2023-09-02 22:22:48.000000000 +0000
@@ -4,97 +4,126 @@ isadump \- examine ISA registers
.SH SYNOPSIS
.B isadump
-.RB [ -y ]
-.RB [ -W | -L ]
-.RB [ "-k V1,V2..." ]
+.RB [ \-y ]
+.RB [ \-W | \-L ]
+.RB [ "\-k V1,V2..." ]
.I addrreg
.I datareg
.RI [ "bank " [ bankreg ]]
#for I2C-like access
.br
.B isadump
-.B -f
-.RB [ -y ]
-.RB [ -W | -L ]
+.B \-f
+.RB [ \-y ]
+.RB [ \-W | \-L ]
.I address
.RI [ "range " [ "bank " [ bankreg ]]]
#for flat address space
.SH DESCRIPTION
isadump is a small helper program to examine registers visible through the ISA
-bus. It is intended to probe any chip that lives on the ISA bus working with an
-address register and a data register (I2C-like access) or a flat range (of up
-to 256 bytes).
+bus.
+It is intended to probe any chip that lives on the ISA bus working with an
+address register and a data register
+(I2C-like access)
+or a flat range
+(of up to 256 bytes).
.SH OPTIONS
.TP
-.B -f
+.B \-f
Enable flat address space mode.
.TP
-.B -y
-Disable interactive mode. By default, isadump will wait for a confirmation
-from the user before messing with the ISA bus. When this flag is used, it
-will perform the operation directly. This is mainly meant to be used in
-scripts.
+.B \-y
+Disable interactive mode.
+By default, isadump will wait for a confirmation
+from the user before messing with the ISA bus.
+When this flag is used,
+it will perform the operation directly.
+This is mainly meant to be used in scripts.
.TP
-.B -k V1,V2...
+.B \-k V1,V2...
Specify a comma-separated list of bytes to send as the key sequence to enter
-the chip configuration mode. Most Super-I/O chips need this.
+the chip configuration mode.
+Most Super-I/O chips need this.
Known key sequences are: 0x87,0x01,0x55,0x55 for ITE, 0x55 for SMSC, 0x87,0x87
for Winbond and VIA, none needed for National Semiconductor.
.TP
-.B -W
+.B \-W
Perform 16-bit reads.
.TP
-.B -L
+.B \-L
Perform 32-bit reads.
.SH OPTIONS (I2C-like access mode)
-At least two options must be provided to isadump. \fIaddrreg\fR contains the
-ISA address of the address register for the chip to probe; \fIdatareg\fR
-contains the address of the data register. Both addresses are integers between
-0x0000 and 0x3FFF. Usually, if the chip's base address is 0x0nn0, the
-address register is at 0x0nn5 and the data register is at 0x0nn6. The most
-common base address for hardware monitoring chips is 0x0290.
+At least two options must be provided to isadump.
+.I addrreg
+contains the ISA address of the address register for the chip to probe;
+.I datareg
+contains the address of the data register.
+Both addresses are integers between 0x0000 and 0x3FFF.
+Usually, if the chip's base address is 0x0nn0,
+the address register is at 0x0nn5 and the data register is at 0x0nn6.
+The most common base address for hardware monitoring chips is 0x0290.
.PP
For Super-I/O chips, address register is typically at 0x2E with data
register at 0x2F.
.PP
-The \fIbank\fR and \fIbankreg\fR parameters are useful on the Winbond chips
+The
+.I bank
+and
+.I bankreg
+parameters are useful on the Winbond chips
as well as on Super-I/O chips.
-\fIbank\fR is an integer between 0 and 31, and \fIbankreg\fR is an integer
-between 0x00 and 0xFF (default value: 0x4E for Winbond chips, 0x07
-for Super-I/O chips). The W83781D datasheet has more information on bank
-selection.
+.I bank
+is an integer between 0 and 31, and
+.I bankreg
+is an integer between 0x00 and 0xFF
+(default value: 0x4E for Winbond chips, 0x07 for Super-I/O chips).
+The W83781D datasheet has more information on bank selection.
.SH OPTIONS (flat address space mode)
In flat mode, only one parameter is
-mandatory. \fIaddress\fR contains the ISA address of the chip to probe;
+mandatory.
+.I address
+contains the ISA address of the chip to probe;
it is an integer between 0x0000 and 0xFFFF.
-If provided, \fIrange\fR is how many bytes should be read (must be a
-multiple of 16). If the range isn't provided, it defaults to 256 bytes
-and the address is forcibly aligned on a 256-byte boundary.
+If provided,
+.I range
+is how many bytes should be read
+(must be a multiple of 16).
+If the range isn't provided, it defaults to 256 bytes and
+the address is forcibly aligned on a 256-byte boundary.
.PP
-The \fIbank\fR and \fIbankreg\fR parameters are useful on the National
-Semiconductor PC87365 and PC87366 Super-I/O chips.
-\fIbank\fR is an integer between 0 and 31, and \fIbankreg\fR is an integer
-between 0x00 and 0xFF (default value: 0x09; must fit in the specified
-range). See the PC87365 datasheet for more information on bank selection.
+The
+.I bank
+and
+.I bankreg
+parameters are useful on the National Semiconductor PC87365 and
+PC87366 Super-I/O chips.
+.I bank
+is an integer between 0 and 31, and
+.I bankreg
+is an integer between 0x00 and 0xFF
+(default value: 0x09; must fit in the specified range).
+See the PC87365 datasheet for more information on bank selection.
.SH NOTES
If no bank is specified, no bank change operation is performed.
.PP
If a bank is specified, the original value is restored before isadump exits.
.PP
-Dumping Super-I/O chips is typically a two-step process. First, you will have
-to access the main Super-I/O address using a command like:
+Dumping Super-I/O chips is typically a two-step process.
+First,
+you will have to access the main Super-I/O address using a command like:
isadump 0x2e 0x2f 0x09.
-This will select logical device 9 (correct value depend on the chip). At 0x60
-you will find the logical device address word, for example "ec c0".
+This will select logical device 9
+(correct value depend on the chip).
+At 0x60 you will find the logical device address word, for example "ec c0".
Then you can use a command like:
-isadump -f 0xecc0 16.
-This will dump the logical device registers. The correct range depends on
-the chip.
+isadump \-f 0xecc0 16.
+This will dump the logical device registers.
+The correct range depends on the chip.
.SH WARNING
Poking around in ISA data space is extremely dangerous.
@@ -103,12 +132,14 @@ crashes, data loss, and worse! Be extre
this program.
.SH SEE ALSO
-i2cdump(8), isaset(8)
+.BR i2cdump (8),
+.BR isaset (8)
.SH AUTHOR
Frodo Looijaard, Mark D. Studebaker, and the lm_sensors group
(https://hwmon.wiki.kernel.org/lm_sensors)
.PP
This manual page was originally written by David Z Maze <dm...@debian.org> for
-the Debian GNU/Linux system. It was then reviewed and augmented by the lm_sensors
-team and is now part of the lm_sensors source distribution.
+the Debian GNU/Linux system.
+It was then reviewed and augmented by the lm_sensors team and
+is now part of the lm_sensors source distribution.
