This site is deprecated; docs have moved to docs.inspircd.org!

Difference between revisions of "Commands"

From the makers of InspIRCd.
Jump to: navigation, search
(/STATS characters)
m (Fixed spelling and repeat in the stats characters)
Line 96: Line 96:
 
q  Show q-lines (nick mask bans)
 
q  Show q-lines (nick mask bans)
 
u  Show server uptime
 
u  Show server uptime
T  Show stastics
+
T  Show statistics
z  Show memory usage statistics
+
 
I  Show connect class permissions
 
I  Show connect class permissions
 
P  Show online opers and their idle times
 
P  Show online opers and their idle times
 
U  Show u-lined servers
 
U  Show u-lined servers
 
y  Show connection classes
 
y  Show connection classes
z  Show memory debug information
+
z  Show memory usage statistics
 
Z  Show z-lines (ip mask bans)
 
Z  Show z-lines (ip mask bans)
 
</pre>
 
</pre>

Revision as of 22:42, 11 August 2006

All commands shown here are implemented by the core of the ircd, e.g. they are always available, no matter which modules are currently loaded (unless of course a module disables a command!) Any commands implemented by modules can be found in that modules help page on our Modules List.

Contents

User Commands

/USER [ident] [local host] [remote host] :[GECOS]

This command is used by your client to register your IRC session. You should not use it during an established connection.

/NICK [new nick]

Change your nickname to [new nick].

/QUIT [reason]

Quit from IRC and end your current session. The session may not close instantly, because InspIRCd places its quit handling at a lower priority than users who are still currently connected.

/VERSION {servermask}

Returns the server's version number and information. Always provide this information with any bug reports to The Bugtracker! If a servername is given, the remote server's version information is shown. Not all software supports remote versioning and may not return a version string. If you provide a wildcard string, the first server which matches will be shown.

/PING [server]

Ping a server. Target server will answer with a PONG.

/PONG [server]

Your client should send this to answer server PINGs. You should not issue this command manually.

/ADMIN [server]

Fetches the administrative information on the given server.

/PRIVMSG [target] [text]

Sends a message to a user or channel specified in [target]. You may not send messages to channels which have the +n mode set unless you are a member of the channel or are connecting from a ulined connection.

/NOTICE [target] [text]

Sends a notice to a user or channel specified in [target]. You may not send notices to channels which have the +n mode set unless you are a member of the channel or are connecting from a ulined connection.

/JOIN [channel]{,[channel]} [key]{,[key]}

Joins one or more channels you provide the names for. The key is optional.

/NAMES [channel]{,[channel]}

Return a list of users on the channels you provide. If the channel is +s, you must be on the channel to perform this command.

/PART [channel]{,[channel]}

Leaves one or more channels you specify.

/KICK [channel] [nick] {reason}

Kicks a user from a channel you specify. You must be at least a channel halfoperator (%) to kick a user, where halfop is enabled, or a channel operator (@) otherwise.

/MODE [target] [+|-][modes]{[+|-][modes]} {mode parameters}

Sets the mode for a channel or a nickname specified in [target] A user may only set modes upon themselves, and may not set the +o usermode, and a user may only change channel modes of channels where they are at least a halfoperator.

/TOPIC [channel] {topic}

Sets or retrieves the channel topic. If a channel topic is given in the command and the channel is either not +t, or you are at least a halfoperator, the channel topic will be changed to the new one you provide.

/WHO [channel|nick|servermask|0 o]

Looks up the information of users matching the range you provide. You may only /WHO nicknames in channels or on servers where you share a common channel with them. The syntax '/WHO 0 o' shows a list of online IRC operators.

/MOTD [server]

Show the message of the day for [server]. Messages of the day contain important server rules and notice and should be read before using a server in any way!

/RULES

Show the rules file for the local server. This is similar in effect to /MOTD except that rules are optional. All users are sent the MOTD when they connect without having to request it.

/OPER [login] [password]

Attempts to authenticate a user as an IRC operator. Please be aware that both successful and unsucessful oper attempts Are logged, and sent to online IRC operators

/LIST [pattern]

Creates a list of all existing channels matching the glob pattern [pattern], e.g. *chat* or bot*

/LUSERS

Shows a count of local and remote users, servers and channels.

/STATS [symbol]

Shows various server statistics. Depending on configuration this command may be reserved for oper-only use. Note that all /STATS use is broadcast to online IRC operators.

/STATS characters

c  Show link blocks
e  Show e-lines (local ban exemptions)
g  Show g-lines (global bans)
k  Show k-lines (local bans)
l  Show all client connections with information and host
L  Show all client connections with information and IP address (1.1 only)
m  Show command statistics, number of times commands have been used
o  Show a list of all valid oper usernames and hostmasks
q  Show q-lines (nick mask bans)
u  Show server uptime
T  Show statistics
I  Show connect class permissions
P  Show online opers and their idle times
U  Show u-lined servers
y  Show connection classes
z  Show memory usage statistics
Z  Show z-lines (ip mask bans)

/USERHOST [nickname]

Returns the hostname and nickname of a user, and some other miscellanious information.

/AWAY {message}

If a message is given, marks you as being away, otherwise removes your away status and previous message

/ISON [nick] {[nick]...}

Returns a subset of the nicks you give, showing only those that are currently online.

/SUMMON [user]

Summons a user from the shell where the ircd is running onto irc This command is deprecated in the current protocol.

/USERS

Shows users logged into the shell where the ircd is running. This command is deprecated in the current protocol.

/INVITE [nick] [channel]

Invites a user to a channel. If the channel is NOT +i, any user, channel op or not, may invite any other user to the channel, so long as they are a member of that channel. Otherwise, if +i is set only channel halfoperators and above may invite users into the channel

/PASS [password]

This command is used by your irc client when setting up your irc session, and should not be issued by a fully connected client.

/WHOWAS [nick]

Returns a list of times the user was last seen on irc along with the time they were last seen and their server.

/WHOIS [nick] {nick}

Returns the WHOIS information of a user, their channels, hostname, etc. If a second nickname or server is provided, then a whois is performed from the server where the user is actually located rather than locally, showing idle and signon times.

/TIME {servermask}

Returns the local time of the server, or remote time of another server.

/LINKS

Shows all servers linked to this one. Note that in this server implementation all links will be flattened as a tree based layout is not in use.

/MAP

Shows a graphical representation of all users and servers on the network. The tree diagram is inaccurate in this implementation as a tree based network is not in place.

/SERVER

This command is a booby-trap which will cause all opers to be notified of possible malicious activity. InspIRCd does not support the RFC1459 /SERVER command on ports marked as client ports, neither does it accept client commands such as /NICK and /USER on ports designated for server connections.

/MODULES

Lists currently loaded modules, their memory offsets, flags and version numbers. This command has recently been made available to non-opers but if the user is not opered, they will only see the module name and no version information.

If an oper issues this command, they will be shown a set of flags next to each module name. The meaning of these flags is shown below:

* static                module cannot be unloaded as doing so will cause sync issues
* vendor                module is a vendor module (came in the original tarball, not third-party)
* service provider      module provides a service to other modules (can be a dependency)
* common                module needs to be common on all servers to link

/COMMANDS

Lists all currently available commands, the module which provides them (or the core) and the number of parameters they take as a minimum.


Oper Commands

/KLINE [[email protected]] {[duration] :[reason]}

Sets or removes a k-line (host based ban) on a host and ident mask. You must specify at least 3 parameters to add a ban, and one parameter to remove a ban (just the [email protected] section). The duration may be specified in seconds, or in the following format 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours, 5 minutes and 6 seconds. All fields in this format are optional.

/ZLINE [ipmask] {[duration] :[reason]}

Sets or removes a z-line (ip based ban) on an ip range mask. You must specify at least 3 parameters to add a ban, and one parameter to remove a ban (just the [email protected] section). The duration may be specified in seconds, or in the following format 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours, 5 minutes and 6 seconds. All fields in this format are optional.

/QLINE [nickmask] {[duration] :[reason]}

Sets or removes a q-line (nick based ban) on a nick mask. You must specify at least 3 parameters to add a ban, and one parameter to remove a ban (just the [email protected] section). The duration may be specified in seconds, or in the following format 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours, 5 minutes and 6 seconds. All fields in this format are optional.

/GLINE [[email protected]] {[duration] :[reason]}

Sets or removes a g-line (global host based ban) on host mask. You must specify at least 3 parameters to add a ban, and one parameter to remove a ban (just the [email protected] section). The duration may be specified in seconds, or in the following format 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours, 5 minutes and 6 seconds. All fields in this format are optional.

/ELINE [[email protected]] {[duration] :[reason]}

Sets or removes a e-line (local ban exception) on host mask. You must specify at least 3 parameters to add an exception, and one parameter to remove an exception (just the [email protected] section). The duration may be specified in seconds, or in the following format 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours, 5 minutes and 6 seconds. All fields in this format are optional.

/DIE [password]

If the correct password is provided, and you are an operator, this command will shut down the local server.

/RESTART [password]

If the correct password is provided, and you are an operator, this command will restart the local server.

/KILL [user] [reason]

This command will disconnect a user from IRC with the given reason.

/REHASH

This command will cause the server configuration file to be re-read and values re-initialised. All modules which are able will reload their settings and re-initialize. The core will also unload any modules which you have removed from the config, and load any new modules which you have added since the last time the Configuration file was read.

/TRACE [nick|[email protected]|servermask]

This command will provide a list of all users and servers which must be passed through or over to reach a given object (server or user)

/CONNECT [servermask]

Create a connection to the given servermask. You must have configured the server for linking in your configuration file, and provided a password.

/SQUIT [servermask]

This causes the given (local) server to be disconnected from the server you are on.

/LOADMODULE [filename.so]

Loads a new module into the IRCd. Be very careful with your use of this command! When you load a module it is initialized, and any modes or commands the module implements will instantly become available. Note that if you add a module to your server which other servers on the network do not have, and it implements a user or channel mode, you will desynchronise your network! The module is loaded from the modules directory you configured when you compiled your ircd.

/UNLOADMODULE [filename.so]

This unloads an existing module from the ircd. Note that you may not unload a module which has marked itself as static without first restarting the irc server (these are usually modules which implement channel or user modes, type /modules for a list of flags associated with each module).