[LinuxBIOS] r2790 - trunk/util/superiotool

[svn at openbios.org]

Author: uwe
Date: 2007-09-19 18:26:18 +0200 (Wed, 19 Sep 2007)
New Revision: 2790

Modified:
   trunk/util/superiotool/README
   trunk/util/superiotool/superiotool.c
   trunk/util/superiotool/superiotool.h
Log:
Implement usage for --help and put the same information into the README, too.

Signed-off-by: Uwe Hermann <uwe at hermann-uwe.de>
Acked-by: Uwe Hermann <uwe at hermann-uwe.de>



Modified: trunk/util/superiotool/README
===================================================================
--- trunk/util/superiotool/README	2007-09-19 15:52:23 UTC (rev 2789)
+++ trunk/util/superiotool/README	2007-09-19 16:26:18 UTC (rev 2790)
@@ -28,12 +28,27 @@
 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
 -------------------------
 

Modified: trunk/util/superiotool/superiotool.c
===================================================================
--- trunk/util/superiotool/superiotool.c	2007-09-19 15:52:23 UTC (rev 2789)
+++ trunk/util/superiotool/superiotool.c	2007-09-19 16:26:18 UTC (rev 2790)
@@ -164,7 +164,7 @@
 			exit(0);
 			break;
 		case 'h':
-			printf("Usage: superiotool [-d] [-V] [-v] [-h]\n");
+			printf(USAGE);
 			exit(0);
 			break;
 		default:

Modified: trunk/util/superiotool/superiotool.h
===================================================================
--- trunk/util/superiotool/superiotool.h	2007-09-19 15:52:23 UTC (rev 2789)
+++ trunk/util/superiotool/superiotool.h	2007-09-19 16:26:18 UTC (rev 2790)
@@ -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 */