Package twisted :: Package scripts :: Module tkconch :: Class GeneralOptions
[show private | hide private]
[frames | no frames]

Class GeneralOptions

UserDict --+    
           |    
     Options --+
               |
              GeneralOptions


Method Summary
  __init__(self)
(inherited from Options)
  __cmp__(self, dict)
(inherited from UserDict)
  __contains__(self, key)
(inherited from UserDict)
  __delitem__(self, key)
(inherited from UserDict)
  __getattr__(self, attr)
I make sure that old style 'optObj.option' access still works. (inherited from Options)
  __getitem__(self, key)
(inherited from UserDict)
  __hash__(self)
(inherited from Options)
  __len__(self)
(inherited from UserDict)
  __repr__(self)
(inherited from UserDict)
  __setitem__(self, key, item)
(inherited from UserDict)
  __str__(self, width)
(inherited from Options)
  clear(self)
(inherited from UserDict)
  copy(self)
(inherited from UserDict)
  get(self, key, failobj)
(inherited from UserDict)
  has_key(self, key)
(inherited from UserDict)
  items(self)
(inherited from UserDict)
  iteritems(self)
(inherited from UserDict)
  iterkeys(self)
(inherited from UserDict)
  itervalues(self)
(inherited from UserDict)
  keys(self)
(inherited from UserDict)
  opt_compress(self)
  opt_help(self)
Display this help and exit. (inherited from Options)
  opt_identity(self, i)
  opt_localforward(self, f)
  opt_remoteforward(self, f)
  opt_version(self)
(inherited from Options)
  parseArgs(self)
I am called with any leftover arguments which were not options.
  parseOptions(self, options)
The guts of the command-line parser. (inherited from Options)
  popitem(self)
(inherited from UserDict)
  postOptions(self)
I am called after the options are parsed. (inherited from Options)
  setdefault(self, key, failobj)
(inherited from UserDict)
  update(self, dict)
(inherited from UserDict)
  values(self)
(inherited from UserDict)

Class Variable Summary
list identitys
list localForwards
list optFlags
list optParameters
list remoteForwards
str synopsis

Method Details

parseArgs(self, *args)

I am called with any leftover arguments which were not options.

Override me to do something with the remaining arguments on the command line, those which were not flags or options. e.g. interpret them as a list of files to operate on.

Note that if there more arguments on the command line than this method accepts, parseArgs will blow up with a getopt.error. This means if you don't override me, parseArgs will blow up if I am passed any arguments at all!
Overrides:
twisted.python.usage.Options.parseArgs (inherited documentation)

Class Variable Details

identitys

Type:
list
Value:
[]                                                                     

localForwards

Type:
list
Value:
[]                                                                     

optFlags

Type:
list
Value:
[['tty', 't', 'Tty; allocate a tty even if command is given.'],
 ['notty', 'T', 'Do not allocate a tty.'],
 ['version', 'V', 'Display version number only.'],
 ['compress', 'C', 'Enable compression.'],
 ['noshell', 'N', 'Do not execute a shell or command.'],
 ['subsystem', 's', 'Invoke command (mandatory) as SSH2 subsystem.'],
 ['log', 'v', 'Log to stderr'],
 ['ansilog', 'a', 'Print the receieved data to stdout']]               

optParameters

Type:
list
Value:
[['user', 'l', None, 'Log in using this user name.'],
 ['identity',
  'i',
  '~/.ssh/identity',
  'Identity for public key authentication'],
 ['escape', 'e', '~', "Set escape character; ``none'' = disable"],
 ['cipher', 'c', None, 'Select encryption algorithm.'],
 ['macs', 'm', None, 'Specify MAC algorithms for protocol version 2.']\
...                                                                    

remoteForwards

Type:
list
Value:
[]                                                                     

synopsis

Type:
str
Value:
'''Usage:    tkconch [options] host [command]
 '''                                                                   

Generated by Epydoc 1.2 prerelease on Wed Jan 29 06:25:59 2003 http://epydoc.sf.net