Small coding style fixes and documentation updates (trivial).

[coreboot.git] / util / superiotool / README

diff --git a/util/superiotool/README b/util/superiotool/README
index 9fef6306ccf02cb6bc5a8d0ce56f4d5b01c6c7d1..cd7d566b21fe144b9cc4ccc92e80ebbfa1a21040 100644 (file)
--- a/util/superiotool/README
+++ b/util/superiotool/README
@@ -11,14 +11,16 @@ Superiotool is a user-space utility which can
  - dump all register contents of the Super I/O chip, together with the
    default values as per datasheet (to make comparing the values easy).
 
-It is mainly used for LinuxBIOS development purposes (see linuxbios.org
-for details on LinuxBIOS), but it may also be useful for other things.
+It is mainly used for coreboot development purposes (see coreboot.org
+for details on coreboot), but it may also be useful for other things.
 
 
 Installation
 ------------
 
- $ svn co svn://linuxbios.org/repos/trunk/util/superiotool
+ $ svn co svn://coreboot.org/repos/trunk/util/superiotool
+
+ $ cd superiotool
 
  $ make
 
@@ -28,16 +30,17 @@ Installation
 Usage
 -----
 
- $ superiotool [-d] [-D] [-V] [-v] [-h]
+ $ superiotool [-d] [-e] [-l] [-V] [-v] [-h]
 
- -d | --dump            Dump Super I/O registers
- -D | --dump-readable   Dump Super I/O registers in human-readable format
+ -d | --dump            Dump Super I/O register contents
+ -e | --extra-dump      Dump secondary registers too (e.g. EC registers)
+ -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
 
 Per default (no options) superiotool will just probe for a Super I/O
-and print its vendor, name, ID, version, and config port.
+and print its vendor, name, ID, revision, and config port.
 
 Typical usage of superiotool:
 
@@ -49,24 +52,27 @@ Typical usage of superiotool:
 
    $ superiotool -d
 
- - Detailed register dump in human-readable format:
-
-   $ superiotool -D
-
 
 Supported Super I/O Chips
 -------------------------
 
-Please see http://linuxbios.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 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).
 
 
 Website and Mailing List
 ------------------------
 
-The main website is http://linuxbios.org/Superiotool.
+The main website is http://coreboot.org/Superiotool.
 
 For additional information, patches, and discussions, please join the
-LinuxBIOS mailing list at http://linuxbios.org/Mailinglist, where most
+coreboot mailing list at http://coreboot.org/Mailinglist, where most
 superiotool developers are subscribed.
 
 
@@ -77,5 +83,22 @@ 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
+------------
 
+Bingxun Shi <bingxunshi@gmail.com>
+Carl-Daniel Hailfinger <c-d.hailfinger.devel.2006@gmx.net>
+David Hendricks <david.hendricks@gmail.com>
+Frieder Ferlemann <Frieder.Ferlemann@web.de>
+Idwer Vollering <idwer_v@hotmail.com>
+Rasmus Wiman <rasmus@wiman.org>
+Robinson P. Tryon <bishop.robinson@gmail.com>
+Ronald Hoogenboom <hoogenboom30@zonnet.nl>
+Ronald Minnich <rminnich@gmail.com>
+Stefan Reinauer <stepan@coresystems.de>
+Ulf Jordan <jordan@chalmers.se>
+Uwe Hermann <uwe@hermann-uwe.de>
+Ward Vandewege <ward@gnu.org>