Previous
Next
Table of Contents
3.2 Basic commands
PyIRC provides basic commands that can be used on the
command line:
- admin [<server>|<nickname>]:
displays the administrative details about the given server. If no
server is specified, the server you are connected to is used. If a
nickname is supplied then it gives the administrative information for
that person's current server.
- away [<away message>]: marks you as
"away". Whenever someone sends you a message or does a whois on
you, they will automatically see whatever message you set. Using
away with no parameters marks you as no longer being away.
- beep: makes the client beep.
- cd [<path>]: if a <path> is
specified, this changes PyIRC's working directory. cd with no
arguments shows you the current directory.
- clear [<window>]: clears the window named
<window>. If no parameters is used, it clears the window where the
command was entered. See the section about window names to get
information on window names.
- close [<window>]: closes the window named
<window>. If no parameters is given, it closes the window where
the command was entered.
- ctcp <nick> <command>
[<args>]: sends a ctcp <command> to
<nick> with optional <args>.
- ctcp_reply <nick> <command>
[<args>]: sends a ctcp reply <command> to
<nick> with optional <args>.
- info [<server>]: shows info
about <server>, or your server if no parameters.
- invite <nickname>
[<channel>]: invites another user to a channel. If no
channel is specified, the channel from which you entered the command
is used.
- join <channel> [<key>]:
makes you join the channel <channel>. Channel names begin with a
# or & and may contain any character except space, carriage
return, null and line feed. Channel names beginning with & are
local to your server. The channel will be created if the specified
channel does not already exist. Otherwise, if
MODE +k <key>
is enabled on the channel, you wil have to supply the <key> to
complete join.
- kick [<channel>] <nick>
[<comment>]: kicks <nick> from <channel>
using <comment> for reason. If <channel> is not supplied,
it will be set to the channel from which you entered the command. You
must have channel operator priviledges to use this command.
- kill <nickname> <comment>: removes
<nickname> from IRC. You need to have IRC operator priviledges
to use this command, with extreme caution.
- leave [<channel>]: leave a
channel you are on. If no channel is specified, it will leave the
channel from which you issued the command.
- links [<wildcard>]: shows all
of the servers currently connected to your IRC network. If
<wildcard> is specified, it shows any server matching the given
wildcard.
- list [<channel>]: lists the
channel <channel> or all the channels if <channel> is not
supplied.
- load <file>: loads <file> into
IRC. This is the only way to load and execute scripts. See the section
about scripts in this document for further details.
- me <action description>: sends a
description of what you are doing or how you are feeling or anything
else to the current window.
- mode
- motd
[<server>|<nickname>]: gives the
message-of-the-day of <server> or of <nickname>'s
server. If no parameter is given, it prints your server's MOTD.
- msg <nickname>|<channel>
<text>: sends a private message to <nickname> or sends a
message to the channel <channel>. Note that you only can a
message to <channel> if it exists and its mode is not +n or if
your on the channel.
- nick <nickname>: changes your nickname to
<nickname>. Valid nicknames are up to 9 characters long. If
<nickname> is bigger, it will be truncated.
- notice <nickname>|<channel>
<text>: sends a private message to <nickname> or to
lt;channel>. Unlike msg, no automated response messages will
be sent in response to a notice. It's the only difference with
msg.
- on: see the chapter about this command.
- oper [<nickname>
[<password>]]: gives you IRC operator
priviledges if the correct nickname and password are given. If
password is not given, you will be prompted for one. If no nickname is
given, your current nickname will be used.
- ping <nickname>: sends a CTCP PING
<current time> to <nickname>. It's a good way to measure
the lag.
- query <nickname>: pops up a message
window, to start a private conversation with <nickname>. It does
not verify that <nickname> exist.
- quit [<reason>]: disconnects
from the server. It does not close your PyIRC session. To finish your
PyIRC session, you have to use close in the server window.
- quote <server command>: sends <server
command> directly to the server. No parsing or verification is done
by the client.
- say <text>: sends <text> as if you
had typed it in the window.
- stats c|h|k|i|l|m|o|u|y
[<server>]: shows some irc server usage
statistics.
- c - Shows C and N lines for a given
server. These are the names of the servers that are allowed to
connect.
- h - Shows H and L lines for a given server
(Hubs and Leaves).
- k - Shows K lines for a server. This shows
who is not allowed to connect and possibly at what time they are not
allowed to connect.
- i - Shows I lines. This is who CAN connect
to a server.
- l - Shows information about amount of
information passed to servers and users.
- m - Shows a count for the number of timers
the various commands have been used since the server was booted.
- o - Shows the list of authorized operators
on the server.
- u - Shows the uptime of the server.
- y - Show Y lines, which lists the various
connection classes for a given server.
- topic [<channel>]
[<topic for channel>]: changes the topic for the
named channel. You have to be on the channel to change the topic, and
if the channel mode is +t, then only a channel operator can change the
topic.
- version [<server>]: shows the
version number of the server specified. If no server is specified, the
version of your current server is shown.
- whois [<server>]
<nickname>: shows more detailed information about the nickname
specified. If you specify the server, the answer will come from it. If
you query <nickname>'s server, you will receive extra info about
his idle time.
- whowas <nickname>
[<count>]: shows information about who used the given
nickname last, even if nobody is currently using it. if <count>
is specified, then only the last <count> entries are
shown.
Previous
Next
Table of Contents