Improve --help output. Mention --help in README.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
diff --git a/README b/README
index 01455c1..452fa5d 100644
--- a/README
+++ b/README
@@ -19,3 +19,4 @@ Basic WIN32 build instructions (on Fedora 13; requires mingw32):
make
./mknsis.sh
+Usage instructions: Run "minerd --help" to see options.
diff --git a/cpu-miner.c b/cpu-miner.c
index 9690d29..e487c58 100644
--- a/cpu-miner.c
+++ b/cpu-miner.c
@@ -62,28 +62,28 @@ static struct option_help options_help[] = {
{ "help",
"(-h) Display this help text" },
- { "algo",
+ { "algo XXX",
"(-a XXX) Specify sha256 implementation:\n"
- "\tc\t\tLinux kernel sha256, implemented in C"
+ "\tc\t\tLinux kernel sha256, implemented in C (default)"
#ifdef __SSE__
"\n\t4way\t\ttcatm's 4-way SSE2 implementation"
#endif
},
{ "debug",
- "(-D) Enable debug output" },
+ "(-D) Enable debug output (default: off)" },
{ "protocol-dump",
- "(-P) Verbose dump of protocol-level activities" },
+ "(-P) Verbose dump of protocol-level activities (default: off)" },
- { "threads",
+ { "threads N",
"(-t N) Number of miner threads (default: 1)" },
- { "url",
+ { "url URL",
"URL for bitcoin JSON-RPC server "
"(default: " DEF_RPC_URL ")" },
- { "userpass",
+ { "userpass USERNAME:PASSWORD",
"Username:Password pair for bitcoin JSON-RPC server "
"(default: " DEF_RPC_USERPASS ")" },
};
@@ -317,7 +317,7 @@ static void show_usage(void)
{
int i;
- printf("Summary: minerd [options]\n\nSupported options:\n");
+ printf("Usage:\tminerd [options]\n\nSupported options:\n");
for (i = 0; i < ARRAY_SIZE(options_help); i++) {
struct option_help *h;