cleanups - remove parens in synopsis (docbook doesn't like);

replace I\u2\dC with I2C since man2html doesn't translate it


git-svn-id: http://lm-sensors.org/svn/lm-sensors/trunk@2647 7894878c-1315-0410-8ee3-d5d059ff63e0
This commit is contained in:
Mark D. Studebaker committed 2004-07-24 19:00:21 +00:00
1 parent e4790ad057
commit 86e0a5ef92
5 files changed
+24 -24

No files matched your search

+5 -5
View File
@@ -1,6 +1,6 @@
.TH I2CDETECT 8 "March 2004"
.TH I2CDETECT 8 "July 2004"
.SH NAME
i2cdetect \- detect I\u2\dC chips
i2cdetect \- detect I2C chips
.SH SYNOPSIS
.B i2cdetect
@@ -12,13 +12,13 @@ i2cdetect \- detect I\u2\dC chips
.I -l
.SH DESCRIPTION
i2cdetect is a userspace program to scan an I\u2\dC bus for devices. It
i2cdetect is a userspace program to scan an I2C bus for devices. It
outputs a table with the list of detected devices on the specified bus.
\fIi2cbus\fR indicates the number of the I\u2\dC bus to be scanned, and
\fIi2cbus\fR indicates the number of the I2C bus to be scanned, and
should correspond to one of the busses listed by \fIi2cdetect -l\fR.
.SH WARNING
This program can confuse your I\u2\dC bus, cause data loss and worse!
This program can confuse your I2C bus, cause data loss and worse!
.SH OPTIONS
.TP
+5 -5
View File
@@ -1,6 +1,6 @@
.TH I2CDUMP 8 "March 2004"
.TH I2CDUMP 8 "July 2004"
.SH NAME
i2cdump \- examine I\u2\dC registers
i2cdump \- examine I2C registers
.SH SYNOPSIS
.B i2cdump
@@ -11,16 +11,16 @@ i2cdump \- examine I\u2\dC registers
.SH DESCRIPTION
i2cdump is a small helper program to examine registers
visible through the I\u2\dC bus.
visible through the I2C bus.
.SH OPTIONS
At least two options must be provided to i2cdump. \fIi2cbus\fR indicates the
number of the I\u2\dC bus to be scanned. This number should correspond to one
number of the I2C bus to be scanned. This number should correspond to one
of the busses listed by \fIi2cdetect -l\fR. \fIaddress\fR indicates the
address to be scanned on that bus, and is an integer between 0x00 and 0x7F. The
\fImode\fR parameter, if specified, is one of the letters \fBb\fP, \fBw\fP,
\fBs\fP, or \fBi\fP, corresponding to a read size of a single byte, a 16-bit
word, an SMBus block, an I\u2\dC block, respectively. The \fBc\fP mode is a
word, an SMBus block, an I2C block, respectively. The \fBc\fP mode is a
little different, it reads all bytes consecutively, and is useful for chips that
have an address auto-increment feature. A \fBp\fP can also be appended to the
\fImode\fR parameter to enable PEC. If the \fImode\fR parameter is omitted,
+5 -5
View File
@@ -1,6 +1,6 @@
.TH I2CSET 8 "March 2004"
.TH I2CSET 8 "July 2004"
.SH "NAME"
i2cset \- set I\u2\dC registers
i2cset \- set I2C registers
.SH SYNOPSIS
.B i2cset
@@ -11,12 +11,12 @@ i2cset \- set I\u2\dC registers
.RI [ mode ]
.SH DESCRIPTION
i2cset is a small helper program to set registers visible through the I\u2\dC
i2cset is a small helper program to set registers visible through the I2C
bus.
.SH OPTIONS
There are four required options to i2cset. \fIi2cbus\fR indicates the number
of the I\u2\dC bus to be scanned. This number should correspond to one of
of the I2C bus to be scanned. This number should correspond to one of
the busses listed by \fIi2cdetect -l\fR. \fIchip-address\fR specifies the
address of the chip on that bus, and is an integer between 0x00 and 0x7F.
\fIdata-address\fR specifies the address on that chip to write to, and is an
@@ -31,7 +31,7 @@ type (0x00-0xFF for bytes, 0x0000-0xFFFF for words).
.SH WARNING
i2cset can be extremely dangerous if used improperly. It can confuse your
I\u2\dC bus, cause data loss, or have more serious side effects. Writing to
I2C bus, cause data loss, or have more serious side effects. Writing to
a serial EEPROM on a memory DIMM (chip addresses between 0x50 and 0x57) may
DESTROY your memory, leaving your system unbootable! Be extremely careful
using this program.
+5 -5
View File
@@ -1,4 +1,4 @@
.TH ISADUMP 8 "April 2004"
.TH ISADUMP 8 "July 2004"
.SH NAME
isadump \- examine ISA registers
@@ -7,20 +7,20 @@ isadump \- examine ISA registers
.I addrreg
.I datareg
.RI [ "bank " [ bankreg ]]
(for I\u2\dC-like access)
#for I2C-like access
.br
.B isadump
.BI "-f " address
.RI [ "range " [ "bank " [ bankreg ]]]
(for flat address space)
#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 (I\u2\dC-like access) or a flat range (of up
address register and a data register (I2C-like access) or a flat range (of up
to 256 bytes).
.SH OPTIONS (I\u2\dC-like access mode)
.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
+4 -4
View File
@@ -1,4 +1,4 @@
.TH ISASET 8 "April 2004"
.TH ISASET 8 "July 2004"
.SH "NAME"
i2cset \- set ISA registers
@@ -8,18 +8,18 @@ i2cset \- set ISA registers
.I datareg
.I address
.I value
(for I\u2\dC-like access)
#for I2C-like access
.br
.B isaset
.BI "-f " address
.I value
(for flat address space)
#for flat address space
.SH DESCRIPTION
isaset is a small helper program to set registers visible through the ISA
bus.
.SH OPTIONS (I\u2\dC-like access mode)
.SH OPTIONS (I2C-like access mode)
Exactly 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