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``

module documentation
(source)

Undocumented

Class | `ClientOptions` | No class docstring; 0/7 class variable, 3/4 methods documented
Class | `SSHConnectForwardingChannel` | Undocumented
Class | `SSHConnection` | Undocumented
Class | `SSHListenClientForwardingChannel` | Undocumented
Class | `SSHSession` | Undocumented
Function | `beforeShutdown` | Undocumented
Function | `doConnect` | Undocumented
Function | `handleError` | Undocumented
Function | `onConnect` | Undocumented
Function | `reConnect` | Undocumented
Function | `run` | Undocumented
Function | `stopConnection` | Undocumented
Variable | `conn` | Undocumented
Variable | `exitStatus` | Undocumented
Variable | `old` | Undocumented
Variable | `options` | Undocumented
Class | `_KeepAlive` | Undocumented
Function | `_ebExit` | Undocumented
Function | `_enterRawMode` | Undocumented
Function | `_leaveRawMode` | Undocumented
Function | `_stopReactor` | Undocumented
Variable | `_inRawMode` | Undocumented
Variable | `_savedRawMode` | Undocumented

def beforeShutdown(): (source)

Undocumented

def doConnect(): (source)

Undocumented

def handleError(): (source)

Undocumented

def onConnect(): (source)

Undocumented

def reConnect(): (source)

Undocumented

def run(): (source)

Undocumented

def stopConnection(): (source)

Undocumented

conn = (source)

Undocumented

exitStatus: `int` = (source)

Undocumented

old = (source)

Undocumented

options = (source)

Undocumented

def _ebExit(f): (source)

Undocumented

def _enterRawMode(): (source)

Undocumented

def _leaveRawMode(): (source)

Undocumented

def _stopReactor(): (source)

Undocumented

_inRawMode: `int` = (source)

Undocumented

_savedRawMode = (source)

Undocumented