Go to the latest version of this document.
search in docstrings

Search bar offers the following options:

- Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: `+foo bar -baz`
- Wildcards. The below example searches for documents with words beginning with “foo”: `foo*`
- Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: `+qname:twisted.mail.* +search`

  Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

- Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: `foo~1`

Results provided by Lunr.js

# ``twisted`.`conch`.`scripts`.`conch`.`ClientOptions``

class documentation

`class ClientOptions(ConchOptions): (source)`

View In Hierarchy

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.
Class Variable | `compData` | Undocumented
Class Variable | `localForwards` | Undocumented
Class Variable | `longdesc` | Undocumented
Class Variable | `optFlags` | Undocumented
Class Variable | `optParameters` | Undocumented
Class Variable | `remoteForwards` | Undocumented
Class Variable | `synopsis` | Undocumented

Inherited from `ConchOptions`:

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

Inherited from `Options` (via `ConchOptions`):

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
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.
Method | `postOptions` | I am called after the options are parsed.
Class Variable | `completionData` | Undocumented
Class Variable | `defaultSubCommand` | Undocumented
Class Variable | `parent` | Undocumented
Instance Variable | `defaults` | Undocumented
Instance Variable | `docs` | Undocumented
Instance Variable | `longOpt` | Undocumented
Instance Variable | `opts` | Undocumented
Instance Variable | `shortOpt` | Undocumented
Instance Variable | `subCommand` | Undocumented
Instance Variable | `subOptions` | Undocumented
Instance Variable | `synonyms` | Undocumented
Method | `_gather_flags` | Gather up boolean (flag) options.
Method | `_gather_handlers` | Gather up options with their own handler methods.
Method | `_gather_parameters` | Gather options which take a value.
Method | `_generic_flag` | Undocumented
Instance Variable | `_dispatch` | Undocumented

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)
overrides `twisted.python.usage.Options.parseArgs`

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!

compData = (source)
overrides `twisted.conch.client.options.ConchOptions.compData`

Undocumented

localForwards: `List[Tuple[int, Tuple[int, int]]]` = (source)

Undocumented

longdesc: `str` = (source)

Undocumented

optFlags: `list` = (source)
overrides `twisted.conch.client.options.ConchOptions.optFlags`

Undocumented

optParameters: `list` = (source)
overrides `twisted.conch.client.options.ConchOptions.optParameters`

Undocumented

remoteForwards: `List[Tuple[int, Tuple[int, int]]]` = (source)

Undocumented

synopsis: `str` = (source)

Undocumented