doc/Commands.txt

   1
   2                      ngIRCd - Next Generation IRC Server
   3                            http://ngircd.barton.de/
   4
   5                (c)2001-2013 Alexander Barton and Contributors.
   6                ngIRCd is free software and published under the
   7                    terms of the GNU General Public License.
   8
   9                               -- Commands.txt --
  10
  11
  12 This file lists all commands available on ngIRCd. It is written in a format
  13 that is human readable as well as machine parseable and therefore can be used
  14 as "help text file" of the daemon.
  15
  16 In short, the daemon reads this file on startup and parses it as following
  17 when an user issues a "HELP <cmd>" command:
  18
  19  1. Search the file for a line "- <cmd>",
  20  2. Output all subsequent lines that start with a TAB (ASCII 9) character
  21     to the client using NOTICE commands, treat lines containing a single "."
  22     after the TAB as empty lines.
  23  3. Break at the first line not starting with a TAB character.
  24
  25 This format allows to have information to each command stored in this file
  26 which will not be sent to an IRC user requesting help which enables us to
  27 have additional annotations stored here which further describe the origin,
  28 implementation details, or limits of the specific command which are not
  29 relevant to an end-user but administrators and developers.
  30
  31 A special "Intro" block is returned to the user when the HELP command is
  32 used without a command name:
  33
  34
  35 - Intro
  36         This is ngIRCd, a server software for Internet Relay Chat (IRC)
  37         networks. You can find more information about ngIRCd on its homepage:
  38                 <http://ngircd.barton.de>
  39         .
  40         Use "HELP COMMANDS" to get a list of all available commands and
  41         "HELP <command-name>" to get help for a specific IRC command, for
  42         example "HELP quit" or "HELP privmsg".
  43
  44
  45 Connection Handling Commands
  46 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  47
  48 - CAP
  49         See doc/Capabilities.txt
  50
  51 - CHARCONV
  52         See doc/Protocol.txt
  53
  54 - NICK
  55         NICK <nick>
  56         .
  57         Change your nickname to <nick>.
  58
  59 - PASS
  60         PASS <password> <version> <flags> [<options>]
  61         .
  62         Set a connection <password>. This command must be sent before the
  63         NICK/USER registration combination.
  64         .
  65         See doc/Protocol.txt for more info.
  66
  67 - PING
  68         PING <server1> [<server2>]
  69         .
  70         Tests the presence of a connection. A PING message results in a PONG
  71         reply. If <server2> is specified, the message gets passed on to it.
  72
  73 - PONG
  74         PONG <server1> [<server2>]
  75         .
  76         This command is a reply to the PING command and works in much the
  77         same way.
  78
  79 - QUIT
  80         QUIT [<quit-message>]
  81         .
  82         End IRC session and disconnect from the server.
  83         .
  84         If a <quit-message> has been given, it is displayed to all the
  85         channels that you are a member of when leaving.
  86
  87 - USER
  88         USER <user> <modes> <realname>
  89         .
  90         This command is used at the beginning of a connection to specify the
  91         <user>name, hostname, <realname> and initial user <modes> of the
  92         connecting client.
  93         .
  94         <realname> may contain spaces, and thus must be prefixed with a colon.
  95
  96 - WEBIRC
  97         See doc/Protocol.txt
  98
  99
 100 General Commands
 101 ~~~~~~~~~~~~~~~~
 102
 103 - AWAY
 104         AWAY [<message>]
 105         .
 106         Provides the server with a message to automatically send in reply to a
 107         PRIVMSG directed at the user, but not to a channel they are on.
 108         .
 109         If <message> is omitted, the away status is removed.
 110
 111 - HELP
 112         HELP [<command>]
 113         .
 114         Show help information for a specific IRC <command>. The <command> name
 115         is case-insensitive.
 116         .
 117         Use the command "HELP Commands" to get a list of all available commands.
 118
 119         The HELP command isn't specified by any RFC but implemented by most
 120         daemons. If no help text could be read in, ngIRCd outputs a list of all
 121         implemented commands when receiving a plain "HELP" command as well as
 122         on "HELP Commands".
 123
 124         ngIRCd replies using "NOTICE" commands like ircd 2.10/2.11; other
 125         implementations are using numerics 704, 705, and 706.
 126
 127
 128 - MODE
 129         MODE <nickname> <flags> (user)
 130         MODE <channel> <flags> [<args>]
 131         .
 132         The MODE command is dual-purpose. It can be used to set both (user) and
 133         <channel> modes.
 134         .
 135         See doc/Modes.txt for more information.
 136
 137 - NOTICE
 138         NOTICE <target> <notice>
 139         .
 140         Send <notice> to <target> (nick or channel).
 141         .
 142         This command works similarly to PRIVMSG, except automatic replies must
 143         never be sent in reply to NOTICE messages.
 144
 145 - PRIVMSG
 146         PRIVMSG <target> <message>
 147         .
 148         Send <message> to <target> (nick or channel).
 149         .
 150         Common IRC clients use MSG as PRIVMSG alias.
 151         (Some clients use "QUERY <nick> [<message>]" to open a private chat.)
 152
 153
 154 Status and Informational Commands
 155 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 156
 157 - ADMIN
 158         ADMIN [<server>]
 159         .
 160         Show administrative information about an IRC server in the network.
 161         If no server name has been given, the local server will respond.
 162
 163 - INFO
 164         INFO [<server>]
 165         .
 166         Show the version, birth & online time of the current IRC server.
 167         If <server> has been given, it shows the INFO of the specific <server>.
 168
 169 - ISON
 170         ISON <nicknames>
 171         .
 172         Queries the server to see if the clients in the space-separated list
 173         <nicknames> are currently on the network.
 174         .
 175         The server returns only the <nicknames> that are on the network in a
 176         space-separated list. If none of the clients are on the network the
 177         server returns an empty list.
 178
 179 - LINKS
 180         LINKS [<remote server> [<server mask>]]
 181         .
 182         Lists all server links matching <server mask>, if given,
 183         on <remote server>, or the current server if omitted.
 184
 185 - LUSERS
 186         LUSERS [<mask> [<server>]]
 187         .
 188         Return statistics about the size of the network. If called with no
 189         arguments, the statistics will reflect the entire network.
 190         .
 191         If <mask> is given, it will return only statistics reflecting the
 192         masked subset of the network.
 193         If <server> is given, the command will be forwarded to <server>
 194         for evaluation.
 195
 196 - MOTD
 197         MOTD [<server>]
 198         .
 199         Show "Message Of The Day" of the current server or specified <server>.
 200
 201 - NAMES
 202         NAMES [<channels> [<server>]]
 203         .
 204         Returns a list of who is on the comma-separated list of <channels>,
 205         by channel name.
 206         .
 207         If <channels> is omitted, all users are shown, grouped by channel name
 208         with all users who are not on a channel being shown as part of channel
 209         "*".
 210         If <server> is specified, the command is sent to <server> for
 211         evaluation.
 212
 213 - STATS
 214         STATS <flag> [<server>]
 215         .
 216         Returns statistics about the current server, or of a specified <server>.
 217         .
 218         STATS flags:
 219         .
 220         g = G-Lines (Network-wide bans)
 221         k = K-Lines (Server-local bans)
 222         l = Link status (Parent server and own link)
 223         m = IRC command status (usage count)
 224         u = Server uptime
 225
 226 - TIME
 227         TIME [<server>]
 228         .
 229         Show the local time of the current server, or of a specified <server>.
 230
 231 - TRACE
 232         TRACE [<server>]
 233         .
 234         Trace a path across the IRC network of the current server, or if given
 235         of a specific <server>, in a similar method to traceroute.
 236
 237 - USERHOST
 238         USERHOST <nicknames>
 239         .
 240         Show the user-host of <nicknames> (seperated by space).
 241         "-" means <nick> is away,
 242         "+" means <nick> is available,
 243         "*" indicates your connection.
 244
 245 - VERSION
 246         VERSION [<server>]
 247         .
 248         Show the ngIRCd version of the current server, or specified <server>.
 249
 250 - WHO
 251         WHO [<target> ["o"]]
 252         .
 253         Returns a list of users who match <target> (nick, hostmask or channel).
 254         .
 255         If the flag "o" is given, the server will only return information about
 256         IRC Operators.
 257
 258 - WHOIS
 259         WHOIS [<server>] <nicknames>
 260         .
 261         Returns information about the comma-separated list of <nicknames>.
 262         .
 263         If <server> is given, the command is forwarded to it for processing.
 264
 265 - WHOWAS
 266         WHOWAS <nickname> [<count> [<server>]]
 267         .
 268         Used to return information about <nicknames> that are no longer in use
 269         (due to client disconnection, or nickname changes).
 270         .
 271         If given, the server will return information from the last <count> times
 272         the nickname has been used.
 273         If <server> is given, the command is forwarded to it for processing.
 274
 275
 276 Channel Commands
 277 ~~~~~~~~~~~~~~~~
 278
 279 - INVITE
 280         INVITE <nick> <channel>
 281         .
 282         Invites <nick> to <channel>.
 283         <channel> does not have to exist, but if it does, only members of the
 284         channel are allowed to invite other clients.
 285         .
 286         If the <channel> mode "+i" is set, only <channel> operators may invite
 287         other clients.
 288
 289 - JOIN
 290         JOIN <channels> [<channel-keys>]
 291         .
 292         Makes the client join the <channels> (comma-separated list), specifying
 293         the passwords, if needed, in the comma-separated <channel-keys> list.
 294         A <channel-key> is only needed, if the <channel> mode "+k" is set.
 295         .
 296         If the channel(s) do not exist, then they will be created.
 297
 298 - KICK
 299         KICK <channel> <nick> [<kick-message>]
 300         .
 301         Remove <nick> from <channel>, optional with a <kick-message>.
 302         .
 303         Only <channel> operators are able to KICK.
 304
 305 - LIST
 306         LIST [<channels> [<server>]]
 307         .
 308         List all visible <channels> (comma-seperated list) on the current
 309         server.
 310         If <server> is given, the command will be forwarded to <server> for
 311         evaluation.
 312
 313 - PART
 314         PART <channels> [<part-message>]
 315         .
 316         Leave <channels> (comma-separated list), optional with a
 317         <part-message>.
 318
 319 - TOPIC
 320         TOPIC <channel> <topic>
 321         .
 322         Set a <topic> for <channel>.
 323         .
 324         Only <channel> operators are able to set a <topic>.
 325
 326
 327 Administrative Commands
 328 ~~~~~~~~~~~~~~~~~~~~~~~
 329
 330 - CONNECT
 331         CONNECT <target server> [<port> [<remote server> [<mypwd> <peerpwd>]]]
 332         .
 333         Instructs the current server, or <remote server> if specified,
 334         to connect to <target server>.
 335         .
 336         To connect <remote server> you need to have remote oper status.
 337         If <port> is omitted, it uses the server port of the configuration.
 338         If <mypwd> and <peerpwd> is given, it uses those passwords instead
 339         of the ones in the configuration.
 340
 341 - DIE
 342         DIE
 343         .
 344         Instructs the server to shut down.
 345
 346 - DISCONNECT
 347         DISCONNECT [<remote server>]
 348         .
 349         Disconnects the current server, or <remote server> if specified.
 350         To disconnect a <remote server> you need to have remote oper status.
 351
 352 - GLINE
 353         GLINE <nick!user@hostmask> <seconds> :<reason>
 354         .
 355         This command provides timed G-Lines (Network-wide bans).
 356         If a client matches a G-Line, it cannot connect to any server on
 357         the IRC network. If you put 0 as <seconds>, it makes the G-Line
 358         permanent.
 359         .
 360         To remove a G-Line, type "GLINE <nick!user@hostmask>".
 361         To list the G-Lines, type "STATS g".
 362
 363 - KILL
 364         KILL <nick> <reason>
 365         .
 366         Forcibly removes <nick> from the IRC network with a <reason>.
 367
 368 - KLINE
 369         KLINE <nick!user@hostmask> <seconds> :<reason>
 370         .
 371         This command provides timed K-Lines (Server-local bans).
 372         If a client matches a K-Line, it cannot connect to the issued server.
 373         If you put 0 as <seconds>, it makes the K-Line permanent.
 374         .
 375         To remove a K-Line, type "KLINE <nick!user@hostmask>".
 376         To list the K-Lines, type "STATS k".
 377
 378 - OPER
 379         OPER <user> <password>
 380         .
 381         Authenticates <user> as an IRC operator on the current server/network.
 382
 383 - REHASH
 384         REHASH
 385         .
 386         Causes the server to re-read and re-process its configuration file(s).
 387
 388 - RESTART
 389         RESTART
 390         .
 391         Restart the server.
 392
 393 - WALLOPS
 394         WALLOPS <message>
 395         .
 396         Sends <message> to all users with user mode "+w".
 397
 398
 399 IRC Service Commands
 400 ~~~~~~~~~~~~~~~~~~~~
 401
 402 - SERVICE
 403
 404 - SERVLIST
 405
 406 - SQUERY
 407
 408 - SVSNICK
 409
 410
 411 Server Protocol Commands
 412 ~~~~~~~~~~~~~~~~~~~~~~~~
 413
 414 - CHANINFO
 415         CHANINFO <channel> +<modes> [[<key> <limit>] <topic>]
 416         .
 417         CHANINFO is used by servers to inform each other about a channel:
 418         its modes, channel key, user limits and its topic.
 419         .
 420         See doc/Protocol.txt for more information.
 421
 422 - ERROR
 423         ERROR [<message> [<> [...]]]
 424         .
 425         Return an error message to the server. The first parameter, if given,
 426         will be logged by the server, all further parameters are silently
 427         ignored.
 428         .
 429         This command is silently ignored on non-server and non-service links.
 430
 431 - METADATA
 432         METADATA <target> <key> <value>
 433         .
 434         The METADATA command is used on server-links to update "metadata"
 435         information of clients, like the hostname, the info text ("real name"),
 436         or the user name.
 437         .
 438         See doc/Protocol.txt for more information.
 439
 440 - NJOIN
 441
 442 - SERVER
 443
 444 - SQUIT
 445         SQUIT <server>
 446         .
 447         Disconnects an IRC Server from the network.
 448
 449
 450 Dummy Commands
 451 ~~~~~~~~~~~~~~
 452
 453 - SUMMON
 454
 455 - USERS
 456
 457 - GET
 458
 459 - POST