From: Constantin Berhard <constantin@exxxtremesys.lu>
Date: Sun, 20 Oct 2013 02:44:35 +0000 (+0200)
Subject: help strings for commands
X-Git-Url: https://git.ralfj.de/saartuer.git/commitdiff_plain/110416af543da9bffe1d02fa31885b5731a22aef

help strings for commands
---

diff --git a/tyshell b/tyshell
index 708ac50..f30b9d7 100755
--- a/tyshell
+++ b/tyshell
@@ -21,7 +21,11 @@ atexit.register(readline.write_history_file, histfile)
 
 # available commands
 def helpcmd(c):
-	print("Available commands: %s" % ", ".join(sorted(commands.keys())))
+	if (len(c) > 1):
+		print(commands.get(c[1],(None,'Can\'t find help for command %s'%(c[1])))[1])
+	else:
+		print("Available commands: %s" % ", ".join(sorted(commands.keys())))
+		print("Use 'help command' to get more information on the command 'command'")
 
 def extcmd(cmd):
 	def run(c):
@@ -57,11 +61,11 @@ def alias (cmds, aliases):
 	return cmds
 
 commands = alias({
-	'exit': exitcmd,
-	'help': helpcmd,
-	'open': sendcmd(tuerSock, 'unlock'),
-	'buzz': sendcmd(tuerSock, 'buzz'),
-	'who': whocmd,
+	'exit': (exitcmd, 'Quits this shell'),
+	'help': (helpcmd, 'Helps you getting to know the available commands'),
+	'open': (sendcmd(tuerSock, 'unlock'), 'Will try to unlock the apartment door'),
+	'buzz': (sendcmd(tuerSock, 'buzz'), 'Will buzz the buzzer for the street door'),
+	'who': (whocmd, 'Shows the list of people, who are allowed to control this system'),
 },{
 	# aliases
 	'unlock': 'open',
@@ -93,7 +97,7 @@ while True:
 		print("Command %s not found. Use help." % command[0])
 	elif len(cmdoptions) == 1: # exactly one command fits (prefix)
 		try:
-			res = commands[cmdoptions[0]](command)
+			res = commands[cmdoptions[0]][0](command)
 			if res: break
 		except Exception as e:
 			print("Error while executing %s: %s" % (command[0], str(e)))