summaryrefslogtreecommitdiff
path: root/util/superiotool
diff options
context:
space:
mode:
authorUwe Hermann <uwe@hermann-uwe.de>2008-01-18 18:04:28 +0000
committerUwe Hermann <uwe@hermann-uwe.de>2008-01-18 18:04:28 +0000
commitcd474afd08356bb4dbc7f0b73e9927c05defe3d8 (patch)
treee110089ef44278f106c152183d5ffa096d6e8480 /util/superiotool
parentd84d9ba4450ea2c0dd4f79460b3b4b79739e8566 (diff)
downloadcoreboot-cd474afd08356bb4dbc7f0b73e9927c05defe3d8.tar.xz
Document the --list-supported option. Various small fixes (trivial).
Signed-off-by: Uwe Hermann <uwe@hermann-uwe.de> Acked-by: Uwe Hermann <uwe@hermann-uwe.de> git-svn-id: svn://svn.coreboot.org/coreboot/trunk@3060 2b7e53f0-3cfb-0310-b3e9-8179ed1497e1
Diffstat (limited to 'util/superiotool')
-rw-r--r--util/superiotool/README11
-rw-r--r--util/superiotool/superiotool.819
2 files changed, 18 insertions, 12 deletions
diff --git a/util/superiotool/README b/util/superiotool/README
index c601168a76..b60e861541 100644
--- a/util/superiotool/README
+++ b/util/superiotool/README
@@ -30,9 +30,10 @@ Installation
Usage
-----
- $ superiotool [-d] [-V] [-v] [-h]
+ $ superiotool [-d] [-l] [-V] [-v] [-h]
-d | --dump Dump Super I/O register contents
+ -l | --list-supported Show the list of supported Super I/O chips
-V | --verbose Verbose mode
-v | --version Show the superiotool version
-h | --help Show a short help text
@@ -54,10 +55,12 @@ Typical usage of superiotool:
Supported Super I/O Chips
-------------------------
-Please see http://coreboot.org/Superiotool#Supported_devices.
+Please see http://coreboot.org/Superiotool#Supported_devices, or type
+
+ $ superiotool -l
There's also a collection of sample register dumps from various Super I/O
-chips on that page. Please send further register dumps (either from a
+chips on that web page. Please send further register dumps (either from a
proprietary BIOS and/or from coreboot) to the coreboot mailing list
(http://coreboot.org/Mailinglist).
@@ -79,7 +82,7 @@ Superiotool is copyrighted by a number of individual developers. Please
refer to the respective source code files for details.
It is licensed under the terms of the GNU General Public License (GPL),
-either version 2 of the License, or (at your option) any later version.
+either version 2 of the license, or (at your option) any later version.
Contributors
diff --git a/util/superiotool/superiotool.8 b/util/superiotool/superiotool.8
index 6bd3be0725..b00ae74de8 100644
--- a/util/superiotool/superiotool.8
+++ b/util/superiotool/superiotool.8
@@ -1,4 +1,4 @@
-.TH SUPERIOTOOL 8 "January 13, 2008"
+.TH SUPERIOTOOL 8 "January 18, 2008"
.SH NAME
superiotool \- Super I/O detection tool
.SH SYNOPSIS
@@ -17,9 +17,10 @@ is a GPL'd user-space utility which can
It is mainly used for coreboot development purposes (see coreboot.org
for details on coreboot), but it may also be useful for other things.
.PP
-The list of supported Super I/O chips is available at:
-.br
-.B http://coreboot.org/Superiotool#Supported_devices
+The list of supported Super I/O chips is available at
+.BR http://coreboot.org/Superiotool#Supported_devices ","
+but it can also be viewed by running
+.BR "superiotool -l" "."
.SH OPTIONS
If no command line option is specified,
.B superiotool
@@ -35,7 +36,7 @@ supports the
.B "\-\-dump"
option for this chip). The output will look something like this:
.sp
-.B "$ ./superiotool -d"
+.B "$ superiotool -d"
.br
Found SMSC FDC37N769 (id=0x28, rev=0x01) at 0x3f0
.br
@@ -75,7 +76,7 @@ detailed information about the
.B "\-l, \-\-list-supported"
List all Super I/O chips recognized by
.BR superiotool ". The phrase"
-.BR (dump available)
+.BR "(dump available)"
following a chip name indicates that
.B superiotool
supports the
@@ -98,8 +99,10 @@ Show version information and exit.
.B "\-h, \-\-help"
Show a help text and exit.
.SH BUGS
-Please report any bugs at http://tracker.coreboot.org/trac/coreboot/
-or on the coreboot mailing list (http://coreboot.org/Mailinglist).
+Please report any bugs at
+.B http://tracker.coreboot.org/trac/coreboot/newticket
+or on the coreboot mailing list
+.RB "(" http://coreboot.org/Mailinglist ")."
.SH AUTHORS
Please see the individual source code files and/or the README file.
.SH LICENCE