r3060 - trunk/util/superiotool

Author: uwe
Date: 2008-01-18 19:04:28 +0100 (Fri, 18 Jan 2008)
New Revision: 3060

Modified:
   trunk/util/superiotool/README
   trunk/util/superiotool/superiotool.8
Log:
Document the --list-supported option. Various small fixes (trivial).

Signed-off-by: Uwe Hermann 
Acked-by: Uwe Hermann

Modified: trunk/util/superiotool/README
===================================================================
--- trunk/util/superiotool/README	2008-01-18 17:48:51 UTC (rev 3059)
+++ trunk/util/superiotool/README	2008-01-18 18:04:28 UTC (rev 3060)
@@ -30,9 +30,10 @@
 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 @@
 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 @@
 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

Modified: trunk/util/superiotool/superiotool.8
===================================================================
--- trunk/util/superiotool/superiotool.8	2008-01-18 17:48:51 UTC (rev 3059)
+++ trunk/util/superiotool/superiotool.8	2008-01-18 18:04:28 UTC (rev 3060)
@@ -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 @@
 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 @@
 .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 @@
 .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 @@
 .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