summaryrefslogtreecommitdiff
path: root/util/superiotool/README
diff options
context:
space:
mode:
authorUwe Hermann <uwe@hermann-uwe.de>2007-09-19 16:26:18 +0000
committerUwe Hermann <uwe@hermann-uwe.de>2007-09-19 16:26:18 +0000
commite47495659080e136a405483a6cb4413dbcb09925 (patch)
tree2fd860367d22f28c2b8e10a201055d45911ca207 /util/superiotool/README
parent7e7e9ac6078efb61ce7b531b084a410cb73e1b92 (diff)
downloadcoreboot-e47495659080e136a405483a6cb4413dbcb09925.tar.xz
Implement usage for --help and put the same information into the README, too.
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@2790 2b7e53f0-3cfb-0310-b3e9-8179ed1497e1
Diffstat (limited to 'util/superiotool/README')
-rw-r--r--util/superiotool/README21
1 files changed, 18 insertions, 3 deletions
diff --git a/util/superiotool/README b/util/superiotool/README
index 2502fbfcea..f0294d41cc 100644
--- a/util/superiotool/README
+++ b/util/superiotool/README
@@ -28,10 +28,25 @@ Installation
Usage
-----
- $ superiotool
+ $ superiotool [-d] [-V] [-v] [-h]
-Currently the tool will automatically try to detect which Super I/O you
-have, and also dump the register contents.
+ -d | --dump Dump Super I/O registers
+ -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.
+
+Typical usage of superiotool:
+
+ - Probe/detect the Super I/O in your mainboard:
+
+ $ superiotool
+
+ - Detailed register dump of the Super I/O (if detected):
+
+ $ superiotool -d
Supported Super I/O Chips