- 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 connecion 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 the current IRC server.
- If <server> has been given, it shows the INFO of the specific <server>.
+ Show the version, birth & online time 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 connecion is used when <target> is omitted.
+
+ References:
+ - RFC 2812, 3.4.10 "Info command"
- ISON
- ISON <nicknames>
- .
- Queries the server to see if the clients in the space-separated list
- <nicknames> are currently on the network.
+ ISON <nickname> [<nickname> [...]]
.
- 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 nicknes 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 connecion 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 connecion 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 connecion is used when <target> is omitted.
+
+ References:
+ - RFC 2812, 3.2.5 "Names message"
- STATS
- STATS <flag> [<server>]
+ STATS [<query> [<target>]]
+ .
+ Show statistics and other information of type <query> of a particular
+ IRC server in the network.
.
- Returns statistics about the current server, or of a specified <server>.
+ The following <query> types are supported (case-insensitive):
.
- STATS flags:
+ - 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.
.
- 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
+ <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 connecion is used when <target> is omitted.
+
+ References:
+ - RFC 2812, 3.4.4 "Stats message"
- TIME
- TIME [<server>]
+ TIME [<target>]
.
- Show the local time of the current server, or of a specified <server>.
+ Show the local time 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 connecion is used when <target> is omitted.
+
+ References
+ - RFC 2812, 3.4.6 "Time message"
- TRACE
TRACE [<server>]