Add a manpage for superiotool (trivial).
[coreboot.git] / util / superiotool / superiotool.8
1 .TH SUPERIOTOOL 8 "October 7, 2007"
2 .SH NAME
3 superiotool \- Super I/O detection tool
4 .SH SYNOPSIS
5 .B superiotool \fR[\fB\-dDVvh\fR] 
6 .SH DESCRIPTION
7 .B superiotool
8 is a GPL'd user-space utility which can
9 .PP
10  * detect which Super I/O chip is soldered onto your mainboard,
11 .PP
12  * at which configuration port it's located (usually 0x2e or 0x4e), and
13 .PP
14  * dump all register contents of the Super I/O chip, together with the
15    default values as per datasheet (to make comparing the values easy).
16 .PP
17 It is mainly used for LinuxBIOS development purposes (see linuxbios.org
18 for details on LinuxBIOS), but it may also be useful for other things.
19 .SH OPTIONS
20 If no command line option is specified,
21 .B superiotool
22 merely tries to detect the Super I/O chip.
23 You must use either the
24 .BR "\-d" " or the " "\-D"
25 option to dump the Super I/O register contents.
26 .TP
27 .B "\-d, \-\-dump"
28 Dump Super I/O registers (if the Super I/O chip is detected and
29 .B superiotool
30 supports the
31 .B "\-\-dump"
32 option for this chip).
33 .TP
34 .B "\-D, \-\-dump-readable"
35 Dump Super I/O registers in human-readable format (if the Super I/O chip
36 is detected and
37 .B superiotool
38 supports the
39 .B "\-\-dump-readable"
40 option for this chip).
41 .TP
42 .B "\-V, \-\-verbose"
43 Enable verbose mode. This option can be used together with the
44 .BR "\-d" " or " "\-D" " option".
45 .TP
46 .B "\-v, \-\-version"
47 Show version information and exit.
48 .TP
49 .B "\-h, \-\-help"
50 Show a help text and exit.
51 .SH BUGS
52 Please report any bugs at http://tracker.linuxbios.org/trac/LinuxBIOS/
53 or on the LinuxBIOS mailing list (http://linuxbios.org/Mailinglist).
54 .SH LICENCE
55 .B superiotool
56 is covered by the GNU General Public License (GPL), version 2 or later.
57 .SH SEE ALSO
58 .BR sensors-detect (8)