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         CAP LS
  50         CAP LIST
  51         CAP REQ <capabilities>
  52         CAP ACK <capabilities>
  53         CAP NAK <capabilities>
  54         CAP CLEAR
  55         CAP END
  56         .
  57         List, request, and clear "IRC Capabilities".
  58         .
  59         Using this command, an IRC client can request additional "IRC
  60         capabilities" during login or later on, which influences the
  61         communication between server and client. Normally, these commands
  62         aren't directly used by humans, but automatically by their client
  63         software. And please note that issuing such commands manually can
  64         irritate the client software used, because of the "non-standard"
  65         behavior of the server!
  66         .
  67         - CAP LS: list all available capabilities.
  68         - CAP LIST: list active capabilities of this connection.
  69         - CAP REQ: Request particular capabilities.
  70         - CAP ACK: Acknowledge a set of capabilities to be enabled/disabled.
  71         - CAP NAK: Reject a set of capabilities.
  72         - CAP CLEAR: Clear all set capabilities.
  73         - CAP END: Indicate end of capability negotiation during login,
  74           ignored in an fully registered session.
  75
  76         Please note that the <capabilities> must be given in a single
  77         parameter but whitespace separated, therefore a command could look
  78         like this: "CAP REQ :capability1 capability2 capability3" for example.
  79
  80         References:
  81          - <http://ircv3.atheme.org/specification/capability-negotiation-3.1>
  82          - <http://ngircd.barton.de/doc/Capabilities.txt>
  83          - doc/Capabilities.txt
  84
  85 - CHARCONV
  86         CHARCONV <client-charset>
  87         .
  88         Set client character set encoding to <client-charset>.
  89         .
  90         After receiving such a command, the server translates all message
  91         data received from the client using the set <client-charset> to the
  92         server encoding (UTF-8), and all message data which is to be sent to
  93         the client from the server encoding (UTF-8) to <client-charset>.
  94         .
  95         This enables older clients and clients using "strange" character sets
  96         to transparently participate in channels and direct messages to
  97         clients using UTF-8, which should be the default today.
  98
  99         References:
 100          - <http://ngircd.barton.de/doc/Protocol.txt>
 101          - doc/Protocol.txt
 102
 103 - NICK
 104         NICK <nick>
 105         .
 106         Change your nickname to <nick>.
 107
 108 - PASS
 109         PASS <password> <version> <flags> [<options>]
 110         .
 111         Set a connection <password>. This command must be sent before the
 112         NICK/USER registration combination.
 113         .
 114         See doc/Protocol.txt for more info.
 115
 116 - PING
 117         PING <server1> [<server2>]
 118         .
 119         Tests the presence of a connection. A PING message results in a PONG
 120         reply. If <server2> is specified, the message gets passed on to it.
 121
 122 - PONG
 123         PONG <server1> [<server2>]
 124         .
 125         This command is a reply to the PING command and works in much the
 126         same way.
 127
 128 - QUIT
 129         QUIT [<quit-message>]
 130         .
 131         End IRC session and disconnect from the server.
 132         .
 133         If a <quit-message> has been given, it is displayed to all the
 134         channels that you are a member of when leaving.
 135
 136 - USER
 137         USER <user> <modes> <realname>
 138         .
 139         This command is used at the beginning of a connection to specify the
 140         <user>name, hostname, <realname> and initial user <modes> of the
 141         connecting client.
 142         .
 143         <realname> may contain spaces, and thus must be prefixed with a colon.
 144
 145 - WEBIRC
 146         See doc/Protocol.txt
 147
 148
 149 General Commands
 150 ~~~~~~~~~~~~~~~~
 151
 152 - AWAY
 153         AWAY [<message>]
 154         .
 155         Provides the server with a message to automatically send in reply to a
 156         PRIVMSG directed at the user, but not to a channel they are on.
 157         .
 158         If <message> is omitted, the away status is removed.
 159
 160 - HELP
 161         HELP [<command>]
 162         .
 163         Show help information for a specific IRC <command>. The <command> name
 164         is case-insensitive.
 165         .
 166         Use the command "HELP Commands" to get a list of all available commands.
 167
 168         The HELP command isn't specified by any RFC but implemented by most
 169         daemons. If no help text could be read in, ngIRCd outputs a list of all
 170         implemented commands when receiving a plain "HELP" command as well as
 171         on "HELP Commands".
 172
 173         ngIRCd replies using "NOTICE" commands like ircd 2.10/2.11; other
 174         implementations are using numerics 704, 705, and 706.
 175
 176
 177 - MODE
 178         MODE <nickname> <flags> (user)
 179         MODE <channel> <flags> [<args>]
 180         .
 181         The MODE command is dual-purpose. It can be used to set both (user) and
 182         <channel> modes.
 183         .
 184         See doc/Modes.txt for more information.
 185
 186 - NOTICE
 187         NOTICE <target> <notice>
 188         .
 189         Send <notice> to <target> (nick or channel).
 190         .
 191         This command works similarly to PRIVMSG, except automatic replies must
 192         never be sent in reply to NOTICE messages.
 193
 194 - PRIVMSG
 195         PRIVMSG <target> <message>
 196         .
 197         Send <message> to <target> (nick or channel).
 198         .
 199         Common IRC clients use MSG as PRIVMSG alias.
 200         (Some clients use "QUERY <nick> [<message>]" to open a private chat.)
 201
 202
 203 Status and Informational Commands
 204 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 205
 206 - ADMIN
 207         ADMIN [<target>]
 208         .
 209         Show administrative information about an IRC server in the network.
 210         .
 211         <target> can be a server name, the nickname of a client connected to
 212         a specific server, or a mask matching a server name in the network.
 213         The server of the current connecion is used when <target> is omitted.
 214
 215         References:
 216          - RFC 2812, 3.4.9 "Admin command"
 217
 218 - INFO
 219         INFO [<target>]
 220         .
 221         Show the version, birth & online time of an IRC server in the network.
 222         .
 223         <target> can be a server name, the nickname of a client connected to
 224         a specific server, or a mask matching a server name in the network.
 225         The server of the current connecion is used when <target> is omitted.
 226
 227         References:
 228          - RFC 2812, 3.4.10 "Info command"
 229
 230 - ISON
 231         ISON <nickname> [<nickname> [...]]
 232         .
 233         Query online status of a list of nicknames. The server replies with
 234         a list only containing nicknes actually connected to a server in
 235         the network. If no nicknames of the given list are online, an empty
 236         list is returned to the client requesting the information.
 237
 238         Please note that "all" IRC daemons even parse separate nicknames in
 239         a single parameter (like ":nick1 nick2"), and therefore ngIRCd
 240         implements this behaviour, too.
 241
 242         References:
 243          - RFC 2812, 4.9 "Ison message"
 244
 245 - LINKS
 246         LINKS [[<target>] [<mask>]
 247         .
 248         List all servers currently registered in the network matching <mask>,
 249         or all servers if <mask> has been omitted, as seen by the server
 250         specified by <target> or the local server when <target> is omitted.
 251         .
 252         <target> can be a server name, the nickname of a client connected to
 253         a specific server, or a mask matching a server name in the network.
 254
 255         References:
 256          - RFC 2812, 3.4.5 "Links message"
 257
 258 - LUSERS
 259         LUSERS [<mask> [<server>]]
 260         .
 261         Return statistics about the size of the network. If called with no
 262         arguments, the statistics will reflect the entire network.
 263         .
 264         If <mask> is given, it will return only statistics reflecting the
 265         masked subset of the network.
 266         If <server> is given, the command will be forwarded to <server>
 267         for evaluation.
 268
 269 - MOTD
 270         MOTD [<server>]
 271         .
 272         Show "Message Of The Day" of the current server or specified <server>.
 273
 274 - NAMES
 275         NAMES [<channels> [<server>]]
 276         .
 277         Returns a list of who is on the comma-separated list of <channels>,
 278         by channel name.
 279         .
 280         If <channels> is omitted, all users are shown, grouped by channel name
 281         with all users who are not on a channel being shown as part of channel
 282         "*".
 283         If <server> is specified, the command is sent to <server> for
 284         evaluation.
 285
 286 - STATS
 287         STATS <flag> [<server>]
 288         .
 289         Returns statistics about the current server, or of a specified <server>.
 290         .
 291         STATS flags:
 292         .
 293         g = G-Lines (Network-wide bans)
 294         k = K-Lines (Server-local bans)
 295         l = Link status (Parent server and own link)
 296         m = IRC command status (usage count)
 297         u = Server uptime
 298
 299 - TIME
 300         TIME [<server>]
 301         .
 302         Show the local time of the current server, or of a specified <server>.
 303
 304 - TRACE
 305         TRACE [<server>]
 306         .
 307         Trace a path across the IRC network of the current server, or if given
 308         of a specific <server>, in a similar method to traceroute.
 309
 310 - USERHOST
 311         USERHOST <nicknames>
 312         .
 313         Show the user-host of <nicknames> (seperated by space).
 314         "-" means <nick> is away,
 315         "+" means <nick> is available,
 316         "*" indicates your connection.
 317
 318 - VERSION
 319         VERSION [<server>]
 320         .
 321         Show the ngIRCd version of the current server, or specified <server>.
 322
 323 - WHO
 324         WHO [<target> ["o"]]
 325         .
 326         Returns a list of users who match <target> (nick, hostmask or channel).
 327         .
 328         If the flag "o" is given, the server will only return information about
 329         IRC Operators.
 330
 331 - WHOIS
 332         WHOIS [<server>] <nicknames>
 333         .
 334         Returns information about the comma-separated list of <nicknames>.
 335         .
 336         If <server> is given, the command is forwarded to it for processing.
 337
 338 - WHOWAS
 339         WHOWAS <nickname> [<count> [<server>]]
 340         .
 341         Used to return information about <nicknames> that are no longer in use
 342         (due to client disconnection, or nickname changes).
 343         .
 344         If given, the server will return information from the last <count> times
 345         the nickname has been used.
 346         If <server> is given, the command is forwarded to it for processing.
 347
 348
 349 Channel Commands
 350 ~~~~~~~~~~~~~~~~
 351
 352 - INVITE
 353         INVITE <nick> <channel>
 354         .
 355         Invites <nick> to <channel>.
 356         <channel> does not have to exist, but if it does, only members of the
 357         channel are allowed to invite other clients.
 358         .
 359         If the <channel> mode "+i" is set, only <channel> operators may invite
 360         other clients.
 361
 362 - JOIN
 363         JOIN <channels> [<channel-keys>]
 364         .
 365         Makes the client join the <channels> (comma-separated list), specifying
 366         the passwords, if needed, in the comma-separated <channel-keys> list.
 367         A <channel-key> is only needed, if the <channel> mode "+k" is set.
 368         .
 369         If the channel(s) do not exist, then they will be created.
 370
 371 - KICK
 372         KICK <channel> <nick> [<kick-message>]
 373         .
 374         Remove <nick> from <channel>, optional with a <kick-message>.
 375         .
 376         Only <channel> operators are able to KICK.
 377
 378 - LIST
 379         LIST [<channels> [<server>]]
 380         .
 381         List all visible <channels> (comma-seperated list) on the current
 382         server.
 383         If <server> is given, the command will be forwarded to <server> for
 384         evaluation.
 385
 386 - PART
 387         PART <channels> [<part-message>]
 388         .
 389         Leave <channels> (comma-separated list), optional with a
 390         <part-message>.
 391
 392 - TOPIC
 393         TOPIC <channel> <topic>
 394         .
 395         Set a <topic> for <channel>.
 396         .
 397         Only <channel> operators are able to set a <topic>.
 398
 399
 400 Administrative Commands
 401 ~~~~~~~~~~~~~~~~~~~~~~~
 402
 403 - CONNECT
 404         CONNECT <target server> [<port> [<remote server> [<mypwd> <peerpwd>]]]
 405         .
 406         Instructs the current server, or <remote server> if specified,
 407         to connect to <target server>.
 408         .
 409         To connect <remote server> you need to have remote oper status.
 410         If <port> is omitted, it uses the server port of the configuration.
 411         If <mypwd> and <peerpwd> is given, it uses those passwords instead
 412         of the ones in the configuration.
 413
 414 - DIE
 415         DIE
 416         .
 417         Instructs the server to shut down.
 418
 419 - DISCONNECT
 420         DISCONNECT [<remote server>]
 421         .
 422         Disconnects the current server, or <remote server> if specified.
 423         To disconnect a <remote server> you need to have remote oper status.
 424
 425 - GLINE
 426         GLINE <nick!user@hostmask> <seconds> :<reason>
 427         .
 428         This command provides timed G-Lines (Network-wide bans).
 429         If a client matches a G-Line, it cannot connect to any server on
 430         the IRC network. If you put 0 as <seconds>, it makes the G-Line
 431         permanent.
 432         .
 433         To remove a G-Line, type "GLINE <nick!user@hostmask>".
 434         To list the G-Lines, type "STATS g".
 435
 436 - KILL
 437         KILL <nick> <reason>
 438         .
 439         Forcibly removes <nick> from the IRC network with a <reason>.
 440
 441 - KLINE
 442         KLINE <nick!user@hostmask> <seconds> :<reason>
 443         .
 444         This command provides timed K-Lines (Server-local bans).
 445         If a client matches a K-Line, it cannot connect to the issued server.
 446         If you put 0 as <seconds>, it makes the K-Line permanent.
 447         .
 448         To remove a K-Line, type "KLINE <nick!user@hostmask>".
 449         To list the K-Lines, type "STATS k".
 450
 451 - OPER
 452         OPER <user> <password>
 453         .
 454         Authenticates <user> as an IRC operator on the current server/network.
 455
 456 - REHASH
 457         REHASH
 458         .
 459         Causes the server to re-read and re-process its configuration file(s).
 460
 461 - RESTART
 462         RESTART
 463         .
 464         Restart the server.
 465
 466 - WALLOPS
 467         WALLOPS <message>
 468         .
 469         Sends <message> to all users with user mode "+w".
 470
 471
 472 IRC Service Commands
 473 ~~~~~~~~~~~~~~~~~~~~
 474
 475 - SERVICE
 476
 477 - SERVLIST
 478
 479 - SQUERY
 480
 481 - SVSNICK
 482
 483
 484 Server Protocol Commands
 485 ~~~~~~~~~~~~~~~~~~~~~~~~
 486
 487 - CHANINFO
 488         CHANINFO <channel> +<modes> [[<key> <limit>] <topic>]
 489         .
 490         CHANINFO is used by servers to inform each other about a channel:
 491         its modes, channel key, user limits and its topic.
 492         .
 493         See doc/Protocol.txt for more information.
 494
 495 - ERROR
 496         ERROR [<message> [<> [...]]]
 497         .
 498         Return an error message to the server. The first parameter, if given,
 499         will be logged by the server, all further parameters are silently
 500         ignored.
 501         .
 502         This command is silently ignored on non-server and non-service links.
 503
 504 - METADATA
 505         METADATA <target> <key> <value>
 506         .
 507         The METADATA command is used on server-links to update "metadata"
 508         information of clients, like the hostname, the info text ("real name"),
 509         or the user name.
 510         .
 511         See doc/Protocol.txt for more information.
 512
 513 - NJOIN
 514
 515 - SERVER
 516
 517 - SQUIT
 518         SQUIT <server>
 519         .
 520         Disconnects an IRC Server from the network.
 521
 522
 523 Dummy Commands
 524 ~~~~~~~~~~~~~~
 525
 526 - SUMMON
 527
 528 - USERS
 529
 530 - GET
 531
 532 - POST