mirror of
https://github.com/Limnoria/Limnoria-doc.git
synced 2025-04-07 15:59:50 +00:00
Review and update the layout.
This commit is contained in:
@ -4,20 +4,60 @@
|
||||
The Network plugin
|
||||
==================
|
||||
|
||||
.. _command-driver:
|
||||
Getting status
|
||||
--------------
|
||||
|
||||
driver [<network>]
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
.. _command-network-driver:
|
||||
|
||||
network 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.
|
||||
|
||||
.. _command-network-networks:
|
||||
|
||||
.. _command-connect:
|
||||
network networks
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
connect [--ssl] <network> [<host[:port]>] [<password>]
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
Returns the networks to which the bot is currently connected.
|
||||
|
||||
.. _command-network-latency:
|
||||
|
||||
network 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.
|
||||
|
||||
Running commands
|
||||
----------------
|
||||
|
||||
.. _command-network-whois:
|
||||
|
||||
network 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.
|
||||
|
||||
.. _command-network-command:
|
||||
|
||||
network command <network> <command> [<arg> ...]
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Gives the bot *<command>* (with its associated *<arg>*s) on *<network>*.
|
||||
|
||||
(Dis)connecting
|
||||
---------------
|
||||
|
||||
.. _command-network-connect:
|
||||
|
||||
network connect [--ssl] <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
|
||||
@ -25,63 +65,23 @@ defaults to 6667, the default port for IRC. If password is
|
||||
provided, it will be sent to the server in a PASS command. If *--ssl* is
|
||||
provided, an SSL connection will be attempted.
|
||||
|
||||
.. _command-network-reconnect:
|
||||
|
||||
.. _command-reconnect:
|
||||
|
||||
reconnect [<network>] [<quit message>]
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
network 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
|
||||
(:ref:`supybot.plugins.Owner.quitMsg`) or the nick of the person giving the
|
||||
command.
|
||||
|
||||
.. _command-network-disconnect:
|
||||
|
||||
.. _command-networks:
|
||||
|
||||
networks
|
||||
^^^^^^^^
|
||||
|
||||
Returns the networks to which the bot is currently connected.
|
||||
|
||||
|
||||
.. _command-latency:
|
||||
|
||||
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.
|
||||
|
||||
|
||||
.. _command-disconnect:
|
||||
|
||||
disconnect [<network>] [<quit message>]
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
network 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. *<network>* is only necessary if the network is different
|
||||
from the network the command is sent on.
|
||||
|
||||
|
||||
.. _command-whois:
|
||||
|
||||
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.
|
||||
|
||||
|
||||
.. _command-command:
|
||||
|
||||
command <network> <command> [<arg> ...]
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Gives the bot *<command>* (with its associated *<arg>*s) on *<network>*.
|
||||
|
||||
|
||||
|
Reference in New Issue
Block a user