Package jazzparser :: Package shell :: Module tools :: Class HelpTool
[hide private]
[frames] | no frames]

Class HelpTool

source code

object --+    
         |    
      Tool --+
             |
            HelpTool

Display shell help.

Instance Methods [hide private]
 
run(self, args, state)
Main operation of tool, taking arguments in args and reading and potentially manipulating the shell state.
source code

Inherited from Tool: process_option_list

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __init__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables [hide private]
  name = 'Help'
hash(x)
  commands = ['help', 'h']
  usage = ('help [<command>]', 'print out usage info for command...
  help = '\nDisplay usage info for a particular command.\nIf no ...

Inherited from Tool: tool_options

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

run(self, args, state)

source code 

Main operation of tool, taking arguments in args and reading and potentially manipulating the shell state.

By the time this is called, the options dict is available in self.options.

Overrides: Tool.run
(inherited documentation)

Class Variable Details [hide private]

usage

Value:
('help [<command>]',
 'print out usage info for commands or help info.')

help

Value:
'''
Display usage info for a particular command.
If no command is given, displays brief usage info for all commands.
'''