nicer help output

This commit is contained in:
Johannes Findeisen 2013-10-28 04:30:10 +01:00
commit ea9e92f87a

View file

@ -89,7 +89,9 @@ class Exit(CommandBase, object):
return self.can_exit() return self.can_exit()
def help_exit(self): def help_exit(self):
print("Exits Linspector") print('''
Exits Linspector
''')
class Command(object): class Command(object):
@ -120,7 +122,9 @@ class LishCommander(Exit):
exec text exec text
def help_python(self): def help_python(self):
print("Executes Python code using 'exec'.") print('''
Executes Python code using 'exec'
''')
def print_color(self, color, text): def print_color(self, color, text):
print(color + str(text) + END) print(color + str(text) + END)
@ -164,7 +168,8 @@ class LishCommander(Exit):
return self.get_completion(["enable", "disable"], text) return self.get_completion(["enable", "disable"], text)
def help_job(self): def help_job(self):
print('''Usage: print('''
Usage:
<ID>: Prints extended information about this job <ID>: Prints extended information about this job
<ID> enable: Enables a job <ID> enable: Enables a job
<ID> disable: Disables a job <ID> disable: Disables a job
@ -189,39 +194,47 @@ class LishCommander(Exit):
self.help_jobs() self.help_jobs()
def help_jobs(self): def help_jobs(self):
print('''Usage: print('''
Usage:
count: Show count of all jobs count: Show count of all jobs
list: Lists all jobs''') list: Lists all jobs
''')
def do_host(self, text): def do_host(self, text):
pass pass
def help_host(self): def help_host(self):
print('''Usage: print('''
Usage:
<HOST>: Prints extended information about <HOST> <HOST>: Prints extended information about <HOST>
<HOST> enable: Enables all jobs for <HOST> <HOST> enable: Enables all jobs for <HOST>
<HOST> disable: Disables all jobs for <HOST> <HOST> disable: Disables all jobs for <HOST>
<HOST> list: Lists all jobs for <HOST>''') <HOST> list: Lists all jobs for <HOST>
''')
def do_hostgroup(self, text): def do_hostgroup(self, text):
pass pass
def help_hostgroup(self): def help_hostgroup(self):
print('''Usage: print('''
Usage:
<HOSTGROUP>: Prints extended information about <HOSTGROUP> <HOSTGROUP>: Prints extended information about <HOSTGROUP>
<HOSTGROUP> enable: Enables all jobs for <HOSTGROUP> <HOSTGROUP> enable: Enables all jobs for <HOSTGROUP>
<HOSTGROUP> disable: Disables all jobs for <HOSTGROUP> <HOSTGROUP> disable: Disables all jobs for <HOSTGROUP>
<HOSTGROUP> list: Lists all jobs for <HOSTGROUP>''') <HOSTGROUP> list: Lists all jobs for <HOSTGROUP>
''')
def do_hostgrouphost(self, text): def do_hostgrouphost(self, text):
pass pass
def help_hostgrouphost(self): def help_hostgrouphost(self):
print('''Usage: print('''
Usage:
<HOSTGROUP> <HOST>: Prints extended information about <HOST> in <HOSTGROUP> <HOSTGROUP> <HOST>: Prints extended information about <HOST> in <HOSTGROUP>
<HOSTGROUP> <HOST> enable: Enables all jobs for <HOST> in <HOSTGROUP> <HOSTGROUP> <HOST> enable: Enables all jobs for <HOST> in <HOSTGROUP>
<HOSTGROUP> <HOST> disable: Disables all jobs for <HOST> in <HOSTGROUP> <HOSTGROUP> <HOST> disable: Disables all jobs for <HOST> in <HOSTGROUP>
<HOSTGROUP> <HOST> list: Lists all jobs for <HOST> in <HOSTGROUP>''') <HOSTGROUP> <HOST> list: Lists all jobs for <HOST> in <HOSTGROUP>
''')
def do_shell(self, text): def do_shell(self, text):
os.system(text) os.system(text)
@ -251,8 +264,10 @@ class LishCommander(Exit):
self.help_log() self.help_log()
def help_log(self): def help_log(self):
print('''Usage: print('''
tail: Do a "tail -F" on the linspector logfile (Ctrl+C to exit)''') Usage:
tail: Do a "tail -F" on the linspector logfile (Ctrl+C to exit)
''')
def do_status(self, text): def do_status(self, text):
# TODO: print instance name from core config # TODO: print instance name from core config
@ -266,7 +281,9 @@ class LishCommander(Exit):
#print GREEN + "Core Version" + END + ":\t" + __linspector_version__ #print GREEN + "Core Version" + END + ":\t" + __linspector_version__
def help_status(self): def help_status(self):
print('''Show status information about the Linspector instance''') print('''
Show status information about the Linspector instance
''')
def do_about(self, text): def do_about(self, text):
self.print_color(GREEN, "Linspector Monitoring\n") self.print_color(GREEN, "Linspector Monitoring\n")
@ -278,13 +295,17 @@ class LishCommander(Exit):
self.print_color(PURPLE, "License: GNU Affero General Public License Version 3.0") self.print_color(PURPLE, "License: GNU Affero General Public License Version 3.0")
def help_about(self): def help_about(self):
print('''Show information about Linspector''') print('''
Show information about Linspector
''')
def do_license(self, text): def do_license(self, text):
os.system("less " + os.path.dirname(os.path.abspath(__file__)) + "/../../LICENSE") os.system("less " + os.path.dirname(os.path.abspath(__file__)) + "/../../LICENSE")
def help_license(self): def help_license(self):
print('''Show license information''') print('''
Show license information
''')
def do_man(self, text): def do_man(self, text):
try: try:
@ -296,5 +317,7 @@ class LishCommander(Exit):
self.help_man() self.help_man()
def help_man(self): def help_man(self):
print('''Usage: print('''
<PAGE>: Show manual page <PAGE>''') Usage:
<PAGE>: Show manual page <PAGE>
''')