help strings for commands

[saartuer.git] / tyshell

diff --git a/tyshell b/tyshell
index f8627d214cf05c29f6d5cad27ee92a1d0d5f76fd..f30b9d797928f06d10dda8c3638480c04df70d11 100755 (executable)
--- a/tyshell
+++ b/tyshell
@@ -21,7 +21,11 @@ atexit.register(readline.write_history_file, histfile)
 
 # available commands
 def helpcmd(c):
 
 # 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):
 
 def extcmd(cmd):
        def run(c):


@@ -51,14 +55,21 @@ def whocmd(c):
                p = pwd.getpwnam(n)
                print (p.pw_name, " - ", p.pw_gecos)
 
                p = pwd.getpwnam(n)
                print (p.pw_name, " - ", p.pw_gecos)
 

-commands = {
-       'exit': exitcmd,
-       'help': helpcmd,
-       'open': sendcmd(tuerSock, 'unlock'),
-       'unlock': sendcmd(tuerSock, 'unlock'),
-       'buzz': sendcmd(tuerSock, 'buzz'),
-       'who': whocmd,
-}
+def alias (cmds, aliases):
+       for newname, oldname in aliases.items():
+               cmds[newname] = cmds[oldname]
+       return cmds
+
+commands = alias({
+       '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',
+})

 
 def complete_command(cmd):
        '''returns a list of commands (as strings) starting with cmd'''
 
 def complete_command(cmd):
        '''returns a list of commands (as strings) starting with cmd'''


@@ -86,7 +97,7 @@ while True:
                print("Command %s not found. Use help." % command[0])
        elif len(cmdoptions) == 1: # exactly one command fits (prefix)
                try:
                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)))
                        if res: break
                except Exception as e:
                        print("Error while executing %s: %s" % (command[0], str(e)))