833af36b08
Starting with this commit, there should be no "original" text in READMEs. Instead, the entire text should be in docstrings, and READMEs should be automatically generated from these docstrings. Motivation: * The same help is available both via IRC and in the README (although the README can be more detailed, as only the first paragraph will be shown on IRC) * This will allow auto-generating plugin help on docs.limnoria.net using the same content as the README, as it's sourced from the docstrings Additionally, this converts all READMEs from Markdown to ReST, because the documentation already uses ReST, and other docstrings in the codebase are in ReST for this reason. |
||
|---|---|---|
| .. | ||
| locales | ||
| __init__.py | ||
| config.py | ||
| messages.pot | ||
| plugin.py | ||
| README.rst | ||
| test.py | ||
Documentation for the Network plugin for Supybot
Purpose
Includes commands for connecting, disconnecting, and reconnecting to multiple networks, as well as several other utility functions related to IRC networks like showing the latency.
Usage
Provides network-related commands, such as connecting to multiple networks and checking latency to the server.
Commands
- capabilities [<network>]
-
Returns the list of IRCv3 capabilities available on the network.
- cmdall <command> [<arg> ...]
-
Perform <command> (with its associated <arg>s) on all networks.
- command <network> <command> [<arg> ...]
-
Gives the bot <command> (with its associated <arg>s) on <network>.
- connect [--nossl] <network> [<host[:port]>] [<password>]
-
Connects to another network (which will be represented by the name provided in <network>) at <host:port>. If port is not provided, it defaults to 6697, the default port for IRC with SSL. If password is provided, it will be sent to the server in a PASS command. If --nossl is provided, an SSL connection will not be attempted, and the port will default to 6667.
- disconnect <network> [<quit message>]
-
Disconnects from the network represented by the network <network>. If <quit message> is given, quits the network with the given quit message.
- driver [<network>]
-
Returns the current network driver for <network>. <network> is only necessary if the message isn't sent on the network to which this command is to apply.
- latency [<network>]
-
Returns the current latency to <network>. <network> is only necessary if the message isn't sent on the network to which this command is to apply.
- networks [--all]
-
Returns the networks to which the bot is currently connected. If --all is given, also includes networks known by the bot, but not connected to.
- reconnect [<network>] [<quit message>]
-
Disconnects and then reconnects to <network>. If no network is given, disconnects and then reconnects to the network the command was given on. If no quit message is given, uses the configured one (supybot.plugins.Owner.quitMsg) or the nick of the person giving the command.
- uptime [<network>]
-
Returns the time duration since the connection was established.
- whois [<network>] <nick>
-
Returns the WHOIS response <network> gives for <nick>. <network> is only necessary if the network is different than the network the command is sent on.
- whowas [<network>] <nick>
-
Returns the WHOIS response <network> gives for <nick>. <network> is only necessary if the network is different than the network the command is sent on.
Configuration
- supybot.plugins.Network.public
-
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.