- doc/Capabilities.txt
- CHARCONV
- See doc/Protocol.txt
+ CHARCONV <client-charset>
+ .
+ Set client character set encoding to <client-charset>.
+ .
+ After receiving such a command, the server translates all message
+ data received from the client using the set <client-charset> to the
+ server encoding (UTF-8), and all message data which is to be sent to
+ the client from the server encoding (UTF-8) to <client-charset>.
+ .
+ This enables older clients and clients using "strange" character sets
+ to transparently participate in channels and direct messages to
+ clients using UTF-8, which should be the default today.
+
+ References:
+ - <http://ngircd.barton.de/doc/Protocol.txt>
+ - doc/Protocol.txt
- NICK
NICK <nick>
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- ADMIN
- ADMIN [<server>]
+ ADMIN [<target>]
.
Show administrative information about an IRC server in the network.
- If no server name has been given, the local server will respond.
+ .
+ <target> can be a server name, the nickname of a client connected to
+ a specific server, or a mask matching a server name in the network.
+ The server of the current connection is used when <target> is omitted.
+
+ References:
+ - RFC 2812, 3.4.9 "Admin command"
- INFO
- INFO [<server>]
+ INFO [<target>]
+ .
+ Show the version, birth & online time of an IRC server in the network.
.
- Show the version, birth & online time of the current IRC server.
- If <server> has been given, it shows the INFO of the specific <server>.
+ <target> can be a server name, the nickname of a client connected to
+ a specific server, or a mask matching a server name in the network.
+ The server of the current connection is used when <target> is omitted.
+
+ References:
+ - RFC 2812, 3.4.10 "Info command"
- ISON
- ISON <nicknames>
+ ISON <nickname> [<nickname> [...]]
.
- Queries the server to see if the clients in the space-separated list
- <nicknames> are currently on the network.
- .
- The server returns only the <nicknames> that are on the network in a
- space-separated list. If none of the clients are on the network the
- server returns an empty list.
+ Query online status of a list of nicknames. The server replies with
+ a list only containing nicknames actually connected to a server in
+ the network. If no nicknames of the given list are online, an empty
+ list is returned to the client requesting the information.
+
+ Please note that "all" IRC daemons even parse separate nicknames in
+ a single parameter (like ":nick1 nick2"), and therefore ngIRCd
+ implements this behaviour, too.
+
+ References:
+ - RFC 2812, 4.9 "Ison message"
- LINKS
- LINKS [<remote server> [<server mask>]]
+ LINKS [[<target>] [<mask>]
+ .
+ List all servers currently registered in the network matching <mask>,
+ or all servers if <mask> has been omitted, as seen by the server
+ specified by <target> or the local server when <target> is omitted.
.
- Lists all server links matching <server mask>, if given,
- on <remote server>, or the current server if omitted.
+ <target> can be a server name, the nickname of a client connected to
+ a specific server, or a mask matching a server name in the network.
+
+ References:
+ - RFC 2812, 3.4.5 "Links message"
- LUSERS
- LUSERS [<mask> [<server>]]
+ LUSERS [<mask> [<target>]]
.
- Return statistics about the size of the network. If called with no
- arguments, the statistics will reflect the entire network.
+ Return statistics about the number of clients (users, servers,
+ services, ...) in the network as seen by the server <target>.
.
- If <mask> is given, it will return only statistics reflecting the
- masked subset of the network.
- If <server> is given, the command will be forwarded to <server>
- for evaluation.
+ <target> can be a server name, the nickname of a client connected to
+ a specific server, or a mask matching a server name in the network.
+ The server of the current connection is used when <target> is omitted.
+
+ Please note that ngIRCd ignores the <mask> parameter entirely: it
+ is not possible to get information for a part of the network only.
+
+ References:
+ - RFC 2812, 3.4.2 "Lusers message"
- MOTD
- MOTD [<server>]
+ MOTD [<target>]
.
- Show "Message Of The Day" of the current server or specified <server>.
+ Show the "Message of the Day" (MOTD) of an IRC server in the network.
+ .
+ <target> can be a server name, the nickname of a client connected to
+ a specific server, or a mask matching a server name in the network.
+ The server of the current connection is used when <target> is omitted.
+
+ References:
+ - RFC 2812, 3.4.1 "Motd message"
- NAMES
- NAMES [<channels> [<server>]]
+ NAMES [<channel>[,<channel>[,...]] [<target>]]
.
- Returns a list of who is on the comma-separated list of <channels>,
- by channel name.
+ Show the list of users that are members of a particular <channel>
+ (and that are visible for the client requesting this information) as
+ seen by the server <target>. More than one <channel> can be given
+ separated by "," (but not whitespaces!).
.
- If <channels> is omitted, all users are shown, grouped by channel name
- with all users who are not on a channel being shown as part of channel
- "*".
- If <server> is specified, the command is sent to <server> for
- evaluation.
+ If <channel> has been omitted, all visible users are shown, grouped
+ by channel name, and all visible users not being members of at least
+ one channel are shown as members of the pseudo channel "*".
+ .
+ <target> can be a server name, the nickname of a client connected to
+ a specific server, or a mask matching a server name in the network.
+ The server of the current connection is used when <target> is omitted.
+
+ References:
+ - RFC 2812, 3.2.5 "Names message"
- STATS
- STATS <flag> [<server>]
+ STATS [<query> [<target>]]
.
- Returns statistics about the current server, or of a specified <server>.
+ Show statistics and other information of type <query> of a particular
+ IRC server in the network.
.
- STATS flags:
+ The following <query> types are supported (case-insensitive):
.
- g = G-Lines (Network-wide bans)
- k = K-Lines (Server-local bans)
- l = Link status (Parent server and own link)
- m = IRC command status (usage count)
- u = Server uptime
+ - g Network-wide bans ("G-Lines").
+ - k Server-local bans ("K-Lines").
+ - l Link status (parent server and own link only).
+ - m Command usage count.
+ - u Server uptime.
+ .
+ <target> can be a server name, the nickname of a client connected to
+ a specific server, or a mask matching a server name in the network.
+ The server of the current connection is used when <target> is omitted.
+
+ References:
+ - RFC 2812, 3.4.4 "Stats message"
- TIME
- TIME [<server>]
+ TIME [<target>]
+ .
+ Show the local time of an IRC server in the network.
.
- Show the local time of the current server, or of a specified <server>.
+ <target> can be a server name, the nickname of a client connected to
+ a specific server, or a mask matching a server name in the network.
+ The server of the current connection is used when <target> is omitted.
+
+ References
+ - RFC 2812, 3.4.6 "Time message"
- TRACE
TRACE [<server>]
of a specific <server>, in a similar method to traceroute.
- USERHOST
- USERHOST <nicknames>
+ USERHOST <nickname> [<nickname> [...]]
+ .
+ Show flags and the hostmasks (<user>@<host>) of the <nickname>s,
+ separated by spaces. The following flags are used:
.
- Show the user-host of <nicknames> (seperated by space).
- "-" means <nick> is away,
- "+" means <nick> is available,
- "*" indicates your connection.
+ - "-" The client is "away" (the mode "+a" is set on this client).
+ - "+" Client seems to be available, at least it isn't marked "away".
+ - "*" The client is an IRC operator (the mode "+o" is set).
+
+ References:
+ - RFC 2812, 4.8 "Userhost message"
- VERSION
- VERSION [<server>]
+ VERSION [<target>]
.
- Show the ngIRCd version of the current server, or specified <server>.
+ Show version information about a particular IRC server in the network.
+ .
+ <target> can be a server name, the nickname of a client connected to
+ a specific server, or a mask matching a server name in the network.
+ The server of the current connection is used when <target> is omitted.
+ .
+ Please note: in normal operation, the version number ends in a dot
+ (".", for example "ngIRCd-20.1."). If it ends in ".1" (for example
+ "ngIRCd-20.1.1", same version than before!), the server is running in
+ debug-mode; and if it ends in ".2", the "network sniffer" is active!
+ Keep your privacy in mind ...
+
+ References:
+ - RFC 2812, 3.4.3 "Version message"
- WHO
- WHO [<target> ["o"]]
+ WHO [<mask> ["o"]]
.
- Returns a list of users who match <target> (nick, hostmask or channel).
+ Show a list of users who match the <mask>, or all visible users when
+ the <mask> has been omitted. (Special case: the <mask> "0" is
+ equivalent to "*")
.
If the flag "o" is given, the server will only return information about
IRC Operators.
+ References:
+ - RFC 2812, 3.6.1 "Who query"
+
- WHOIS
- WHOIS [<server>] <nicknames>
+ WHOIS [<target>] <mask>[,<mask>[,...]]
.
- Returns information about the comma-separated list of <nicknames>.
+ Query information about users matching the <mask> parameter(s) as seen
+ by the server <target>; up to 3 <masks> are supported.
.
- If <server> is given, the command is forwarded to it for processing.
+ <target> can be a server name, the nickname of a client connected to a
+ specific server, or a mask matching a server name in the network. The
+ server of the current connection is used when <target> is omitted.
+
+ References:
+ - RFC 2812, 3.6.2 "Whois query"
- WHOWAS
- WHOWAS <nickname> [<count> [<server>]]
+ WHOWAS <nickname>[,<nickname>[,...]] [<count> [<target>]]
.
- Used to return information about <nicknames> that are no longer in use
- (due to client disconnection, or nickname changes).
+ Query information about nicknames no longer in use in the network,
+ either because of nickname changes or disconnects. The history is
+ searched backwards, returning the most recent entry first. If there
+ are multiple entries, up to <count> entries will be shown (or all of
+ them, if no <count> has been given).
.
- If given, the server will return information from the last <count> times
- the nickname has been used.
- If <server> is given, the command is forwarded to it for processing.
+ <target> can be a server name, the nickname of a client connected to a
+ specific server, or a mask matching a server name in the network. The
+ server of the current connection is used when <target> is omitted.
+
+ References:
+ - RFC 2812, 3.6.3 "Whowas"
Channel Commands
- SERVICE
- SERVLIST
+ SERVLIST [<mask> [<type>]]
+ .
+ List all IRC services currently registered in the network.
+ .
+ The optional <mask> and <type> parameters can be used to limit the
+ listing to services matching the <mask> and that are of type <type>.
+ .
+ Please note that ngIRCd doesn't use any service types at the moment
+ and therefore all services are of type "0".
+
+ References:
+ - RFC 2812, 3.5.1 "Servlist message"
- SQUERY
~~~~~~~~~~~~~~
- SUMMON
+ SUMMON <user> [<target> [<channel>]]
+ .
+ This command was intended to call people into IRC who are directly
+ connected to the terminal console of the IRC server -- but is
+ deprecated today. Therefore ngIRCd doesn't really implement this
+ command and always returns an error message, regardless of the
+ parameters given.
+
+ References:
+ - RFC 2812, 4.5 "Summon message"
- USERS
+ USERS [<target>]
+ .
+ This command was intended to list users directly logged in into the
+ console of the IRC server -- but is deprecated today. Therefore ngIRCd
+ doesn't really implement this command and always returns an error
+ message, regardless of the parameters given.
+
+ References:
+ - RFC 2812, 4.6 "Users"
- GET