Package: lm-sensors
Version: 1:3.6.0-8
Severity: minor
Tags: patch
Dear Maintainer,
here are some notes and editorial fixes for the manual
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)
-.-.
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.
Or
add the italic corrections.
47:Four options must be provided to isaset. \fIaddrreg\fR contains the
48:ISA address of the address register for the chip to probe; \fIdatareg\fR
55:The \fIaddress\fR and \fIvalue\fR parameters are two integers between
56:0x00 and 0xFF. isaset will write value \fIvalue\fR to address \fIaddress\fR.
57:An optional \fImask\fR can be provided as a fifth parameter, preserving
62:be provided. \fIaddress\fR contains the ISA address of the register to
65:will write value \fIvalue\fR at this address.
66:An optional \fImask\fR can be provided as a third parameter, preserving
-.-.
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 ]
17:.B -f
18:.RB [ -y ]
19:.RB [ -W | -L ]
31:.B -f
34:.B -y
40:.B -W
43:.B -L
-.-.
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.
35:Disable interactive mode. By default, isaset 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
47:Four options must be provided to isaset. \fIaddrreg\fR contains the
49:contains the address of the data register. Both addresses are integers
between
50:0x0000 and 0x3FFF. Usually, if the chip's base address is 0x0nn0, the
51:address register is at 0x0nn5 and the data register is at 0x0nn6. The most
56:0x00 and 0xFF. isaset will write value \fIvalue\fR to address \fIaddress\fR.
62:be provided. \fIaddress\fR contains the ISA address of the register to
63:write to; it is an integer between 0x0000 and 0xFFFF. Basically, it is
64:the sum of the chip's base address and the chip register's address. isaset
79:Mark D. Studebaker, and the lm_sensors group
-.-.
Rephrase the beginning of a sentence, if it starts with a digit (see
a style manual).
50:0x0000 and 0x3FFF. Usually, if the chip's base address is 0x0nn0, the
56:0x00 and 0xFF. isaset will write value \fIvalue\fR to address \fIaddress\fR.
-.-.
The name of a man page is set in bold type and the section in roman (see
man-pages(7)).
76:i2cset(8), isadump(8)
-.-.
Start a sentence in parenthesis on a new line.
isaset.8:46:.SH OPTIONS (I2C-like access mode)
isaset.8:60:.SH OPTIONS (flat address space mode)
-.-.
Additional.
Name of the command is typeset in bold, see man-pages(7).
-- 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
--- isaset.8 2023-09-02 23:34:19.000000000 +0000
+++ isaset.8.new 2023-09-02 23:51:06.000000000 +0000
@@ -4,8 +4,8 @@ isaset \- set ISA registers
.SH SYNOPSIS
.B isaset
-.RB [ -y ]
-.RB [ -W | -L ]
+.RB [ \-y ]
+.RB [ \-W | \-L ]
.I addrreg
.I datareg
.I address
@@ -14,66 +14,95 @@ isaset \- set ISA registers
#for I2C-like access
.br
.B isaset
-.B -f
-.RB [ -y ]
-.RB [ -W | -L ]
+.B \-f
+.RB [ \-y ]
+.RB [ \-W | \-L ]
.I address
.I value
.RI [ mask ]
#for flat address space
.SH DESCRIPTION
-isaset is a small helper program to set registers visible through the ISA
-bus.
+.B isaset
+is a small helper program to set registers visible through the ISA bus.
.SH OPTIONS
.TP
-.B -f
+.B \-f
Enable flat address space mode.
.TP
-.B -y
-Disable interactive mode. By default, isaset 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,
+.B isaset
+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 -W
+.B \-W
Perform a 16-bit write.
.TP
-.B -L
+.B \-L
Perform a 32-bit write.
.SH OPTIONS (I2C-like access mode)
-Four options must be provided to isaset. \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.
+Four options must be provided to
+.BR isaset .
+.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.
For Super-I/O chips, address register is typically at 0x2E with data
register at 0x2F.
-The \fIaddress\fR and \fIvalue\fR parameters are two integers between
-0x00 and 0xFF. isaset will write value \fIvalue\fR to address \fIaddress\fR.
-An optional \fImask\fR can be provided as a fifth parameter, preserving
-unmasked bits at the written location.
+The
+.I address
+and
+.I value
+parameters are two integers between 0x00 and 0xFF.
+.B isaset
+will write value
+.I value
+to address
+.IR address .
+An optional
+.I mask
+can be provided as a fifth parameter,
+preserving unmasked bits at the written location.
.SH OPTIONS (flat address space mode)
In flat mode, two parameters must
-be provided. \fIaddress\fR contains the ISA address of the register to
-write to; it is an integer between 0x0000 and 0xFFFF. Basically, it is
-the sum of the chip's base address and the chip register's address. isaset
-will write value \fIvalue\fR at this address.
-An optional \fImask\fR can be provided as a third parameter, preserving
-unmasked bits at the written location.
+be provided.
+.I address
+contains the ISA address of the register to write to;
+it is an integer between 0x0000 and 0xFFFF.
+Basically, it is
+the sum of the chip's base address and the chip register's address.
+.B isaset
+will write value
+.I value
+at this address.
+An optional
+.I mask
+can be provided as a third parameter,
+preserving unmasked bits at the written location.
.SH WARNING
Poking around in ISA data space is extremely dangerous.
-Running isaset with random parameters can cause system
-crashes, data loss, and worse! Be extremely careful when using
-this program.
+Running
+.B isaset
+with random parameters can cause system
+crashes, data loss, and worse!
+Be extremely careful when using this program.
.SH SEE ALSO
-i2cset(8), isadump(8)
+.BR i2cset (8),
+.BR isadump (8)
.SH AUTHOR
Mark D. Studebaker, and the lm_sensors group
