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

module documentation
(source)

TAP plugin for creating telnet- and ssh-accessible manhole servers.

Author
Jp Calderone

Class | `chainedProtocolFactory` | Undocumented
Class | `makeTelnetProtocol` | Undocumented
Class | `Options` | Undocumented
Function | `makeService` | Create a manhole server service.
Class | `_StupidRealm` | Undocumented

def makeService(options): (source)

Create a manhole server service.

Parameters

options:`dict`

A mapping describing the configuration of the desired service. Recognized key/value pairs are:

        "telnetPort": strports description of the address on which
                      to listen for telnet connections.  If None,
                      no telnet service will be started.

        "sshPort": strports description of the address on which to
                   listen for ssh connections.  If None, no ssh
                   service will be started.

        "namespace": dictionary containing desired initial locals
                     for manhole connections.  If None, an empty
                     dictionary will be used.

        "passwd": Name of a passwd(5)-format username/password file.

        "sshKeyDir": The folder that the SSH server key will be kept in.

        "sshKeyName": The filename of the key.

        "sshKeySize": The size of the key, in bits. Default is 4096.

Returns
`twisted.application.service.IService` | A manhole service.