From: adam@algroup.co.uk <adam@algroup.co.uk@ef4ab9da-24cd-11de-8aaa-f3a34680c41f>
Date: Sun, 12 Jul 2009 12:52:21 +0000 (+0000)
Subject: add extended help feature
X-Git-Tag: v1.0.0~570
X-Git-Url: http://git.zerfleddert.de/cgi-bin/gitweb.cgi/proxmark3-svn/commitdiff_plain/7f93ef2c228855f26d3eb88ee1c878fbb6b53a12?ds=sidebyside;hp=1dd2335295d411a7965a936e7c8535ea86fcd877

add extended help feature
---

diff --git a/winsrc/command.cpp b/winsrc/command.cpp
index 349ede69..86b0d446 100644
--- a/winsrc/command.cpp
+++ b/winsrc/command.cpp
@@ -2647,6 +2647,14 @@ static struct {
 	{"zerocrossings",	CmdZerocrossings,1,	"    Count time between zero-crossings"},
 };
 
+static struct {
+	char *name;
+	char *args;
+	char *argshelp;
+	char *description;
+	} 	CommandExtendedHelp[]= {
+		{"detectreader","'l'|'h'","'l' specifies LF antenna scan only, 'h' specifies HF antenna scan only.","Monitor antenna for changes in voltage. Output is in three fields: CHANGED, CURRENT, PERIOD,\nwhere CHANGED is the value just changed from, CURRENT is the current value and PERIOD is the\nnumber of program loops since the last change.\n\nThe RED LED indicates LF field detected, and the GREEN LED indicates HF field detected.\n"},
+		};
 
 //-----------------------------------------------------------------------------
 // Entry point into our code: called whenever the user types a command and
@@ -2655,15 +2663,29 @@ static struct {
 void CommandReceived(char *cmd)
 {
 	int i;
+	char line[256];
 
 	PrintToScrollback("> %s", cmd);
 
-	if(strcmp(cmd, "help")==0) {
+	if(strcmp(cmd, "help") == 0 || strncmp(cmd,"help ",strlen("help ")) == 0) {
+		// check if we're doing extended help
+		if(strlen(cmd) > strlen("help ")) {
+			cmd += strlen("help ");
+			for(i = 0; i < sizeof(CommandExtendedHelp) / sizeof(CommandExtendedHelp[0]); i++) {
+				if(strcmp(CommandExtendedHelp[i].name,cmd) == 0) {
+					PrintToScrollback("\nExtended help for '%s':\n", cmd);
+					PrintToScrollback("Args: %s\t- %s\n",CommandExtendedHelp[i].args,CommandExtendedHelp[i].argshelp);
+					PrintToScrollback(CommandExtendedHelp[i].description);
+					return;
+				}
+			}
+		PrintToScrollback("No extended help available for '%s'", cmd);
+		return;
+		}
 		if (offline) PrintToScrollback("Operating in OFFLINE mode (no device connected)");
 		PrintToScrollback("\r\nAvailable commands:");
 		for(i = 0; i < sizeof(CommandTable) / sizeof(CommandTable[0]); i++) {
 			if (offline && (CommandTable[i].offline==0)) continue;
-			char line[256];
 			memset(line, ' ', sizeof(line));
 			strcpy(line+2, CommandTable[i].name);
 			line[strlen(line)] = ' ';
@@ -2671,7 +2693,7 @@ void CommandReceived(char *cmd)
 			PrintToScrollback("%s", line);
 		}
 		PrintToScrollback("");
-		PrintToScrollback("and also: help, cls");
+		PrintToScrollback("'help <command>' for extended help on that command");
 		return;
 	}