Add ifdtool, utility to read / modify Intel Firmware Descriptor images
[coreboot.git] / util / superiotool / superiotool.8
index 711509ceedba611cffc327e2781258da89b5125b..8bbcddfd93821a96b1b285e93bb49dcfc996d3f5 100644 (file)
@@ -1,8 +1,8 @@
-.TH SUPERIOTOOL 8 "October 11, 2007"
+.TH SUPERIOTOOL 8 "January 18, 2008"
 .SH NAME
 superiotool \- Super I/O detection tool
 .SH SYNOPSIS
-.B superiotool \fR[\fB\-dDVvh\fR] 
+.B superiotool \fR[\fB\-delVvh\fR]
 .SH DESCRIPTION
 .B superiotool
 is a GPL'd user-space utility which can
@@ -14,18 +14,19 @@ is a GPL'd 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).
 .PP
-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.
 .PP
-The list of supported Super I/O chips is available at:
-.br
-.B http://linuxbios.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
 merely tries to detect the Super I/O chip.
-You must use either the
-.BR "\-d" " or the " "\-D"
+You must use the
+.B "\-d"
 option to dump the Super I/O register contents.
 .TP
 .B "\-d, \-\-dump"
@@ -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
@@ -72,20 +73,29 @@ which can mean several things. It's recommended to consult the datasheet for
 detailed information about the
 .BR MM " fields."
 .TP
-.B "\-D, \-\-dump-readable"
-Dump Super I/O registers in human-readable format (if the Super I/O chip
-is detected and
+.B "\-e, \-\-extra-dump"
+Dump extra secondary register contents too, if available. Only in combination
+with the
+.B --dump
+option. This option will, for instance, dump the environmental controller (EC)
+configuration registers for the ITE IT8716F chip. The format is similar to
+the output of the
+.B --dump
+option.
+.TP
+.B "\-l, \-\-list-supported"
+List all Super I/O chips recognized by
+.BR superiotool ". The phrase"
+.BR "(dump available)"
+following a chip name indicates that
 .B superiotool
 supports the
-.B "\-\-dump-readable"
-option for this chip).
-.sp
-The output format of this option is different for every Super I/O, and only
-very few Super I/Os currently support this option.
+.B --dump
+option for this chip.
 .TP
 .B "\-V, \-\-verbose"
 Enable verbose mode. This option can be used together with the
-.BR "\-d" " or " "\-D" " option (or both)."
+.BR "\-d" " option."
 .sp
 The verbose output will not only list for which type of Super I/O the tool
 is scanning, but also at which configuration port it's probing, and which
@@ -99,8 +109,10 @@ Show version information and exit.
 .B "\-h, \-\-help"
 Show a help text and exit.
 .SH BUGS
-Please report any bugs at http://tracker.linuxbios.org/trac/LinuxBIOS/
-or on the LinuxBIOS mailing list (http://linuxbios.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