Class Variable synopsis Undocumented
Class Variable longdesc Undocumented
Class Variable optParameters Undocumented
Class Variable optFlags Undocumented
Class Variable compData Undocumented
Class Variable localForwards Undocumented
Class Variable remoteForwards Undocumented
Method opt_escape Set escape character; ``none'' = disable
Method opt_localforward Forward local port to remote address (lport:host:port)
Method opt_remoteforward Forward remote port to local address (rport:host:port)
Method parseArgs I am called with any leftover arguments which were not options.

Inherited from ConchOptions:

Method __init__ Undocumented
Instance Variable identitys Undocumented
Instance Variable conns Undocumented
Method opt_identity Identity for public-key authentication
Method opt_ciphers Select encryption algorithms
Method opt_macs Specify MAC algorithms
Method opt_host_key_algorithms Select host key algorithms
Method opt_user_authentications Choose how to authenticate to the remote server

Inherited from Options (via ConchOptions):

Instance Variable subCommand Undocumented
Class Variable defaultSubCommand Undocumented
Class Variable parent Undocumented
Class Variable completionData Undocumented
Instance Variable opts Undocumented
Instance Variable defaults Undocumented
Instance Variable longOpt Undocumented
Instance Variable shortOpt Undocumented
Instance Variable docs Undocumented
Instance Variable synonyms Undocumented
Method opt_help Display this help and exit.
Method opt_version Display Twisted version and exit.
Method parseOptions The guts of the command-line parser.
Instance Variable subOptions Undocumented
Method postOptions I am called after the options are parsed.
Method __str__ Undocumented
Method getSynopsis Returns a string containing a description of these options and how to pass them to the executed file.
Method getUsage Undocumented
Instance Variable _dispatch Undocumented
Method _generic_flag Undocumented
Method _gather_flags Gather up boolean (flag) options.
Method _gather_parameters Gather options which take a value.
Method _gather_handlers Gather up options with their own handler methods.
synopsis =
(type: str)
longdesc =
(type: str)
optParameters =
(type: List)
optFlags =
(type: List)
compData =
localForwards =
(type: List)
remoteForwards =
(type: List)
def opt_escape(self, esc): (source)

Set escape character; ``none'' = disable

def opt_localforward(self, f): (source)

Forward local port to remote address (lport:host:port)

def opt_remoteforward(self, f): (source)

Forward remote port to local address (rport:host:port)

def parseArgs(self, host, *command): (source)

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!

API Documentation for Twisted, generated by pydoctor at 2020-03-20 23:54:06.