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`.`endpoints`.`SSHCommandAddress``

class documentation

`class SSHCommandAddress: (source)`

View In Hierarchy

An `SSHCommandAddress` instance represents the address of an SSH server, a username which was used to authenticate with that server, and a command which was run there.

Method | `__init__` | No summary
Instance Variable | `command` | See `__init__`
Instance Variable | `server` | See `__init__`
Instance Variable | `username` | See `__init__`

def __init__(self, server, username, command): (source)

Parameters
server:`IAddress` provider | The address of the SSH server on which the command is running.
username:`bytes` | An authentication username which was used to authenticate against the server at the given address.
command:`bytes` | A command which was run in a session channel on the server at the given address.

command = (source)

See `__init__`

server = (source)

See `__init__`

username = (source)

See `__init__`