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
This commit is contained in:
Uwe Hermann 2007-09-19 16:26:18 +00:00
parent 7e7e9ac607
commit e474956590
3 changed files with 27 additions and 4 deletions

View File

@ -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

View File

@ -164,7 +164,7 @@ int main(int argc, char *argv[])
exit(0);
break;
case 'h':
printf("Usage: superiotool [-d] [-V] [-v] [-h]\n");
printf(USAGE);
exit(0);
break;
default:

View File

@ -31,6 +31,14 @@
#define SUPERIOTOOL_VERSION "0.1"
#define USAGE "Usage: superiotool [-d] [-V] [-v] [-h]\n\n\
-d | --dump Dump Super I/O registers\n\
-V | --verbose Verbose mode\n\
-v | --version Show the superiotool version\n\
-h | --help Show a short help text\n\n\
Per default (no options) superiotool will just probe for a Super I/O\n\
and print its vendor, name, ID, version, and config port.\n"
#define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
#define EOT -1 /* End Of Table */