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 <nicknames>
 232         .
 233         Queries the server to see if the clients in the space-separated list
 234         <nicknames> are currently on the network.
 235         .
 236         The server returns only the <nicknames> that are on the network in a
 237         space-separated list. If none of the clients are on the network the
 238         server returns an empty list.
 239
 240 - LINKS
 241         LINKS [<remote server> [<server mask>]]
 242         .
 243         Lists all server links matching <server mask>, if given,
 244         on <remote server>, or the current server if omitted.
 245
 246 - LUSERS
 247         LUSERS [<mask> [<server>]]
 248         .
 249         Return statistics about the size of the network. If called with no
 250         arguments, the statistics will reflect the entire network.
 251         .
 252         If <mask> is given, it will return only statistics reflecting the
 253         masked subset of the network.
 254         If <server> is given, the command will be forwarded to <server>
 255         for evaluation.
 256
 257 - MOTD
 258         MOTD [<server>]
 259         .
 260         Show "Message Of The Day" of the current server or specified <server>.
 261
 262 - NAMES
 263         NAMES [<channels> [<server>]]
 264         .
 265         Returns a list of who is on the comma-separated list of <channels>,
 266         by channel name.
 267         .
 268         If <channels> is omitted, all users are shown, grouped by channel name
 269         with all users who are not on a channel being shown as part of channel
 270         "*".
 271         If <server> is specified, the command is sent to <server> for
 272         evaluation.
 273
 274 - STATS
 275         STATS <flag> [<server>]
 276         .
 277         Returns statistics about the current server, or of a specified <server>.
 278         .
 279         STATS flags:
 280         .
 281         g = G-Lines (Network-wide bans)
 282         k = K-Lines (Server-local bans)
 283         l = Link status (Parent server and own link)
 284         m = IRC command status (usage count)
 285         u = Server uptime
 286
 287 - TIME
 288         TIME [<server>]
 289         .
 290         Show the local time of the current server, or of a specified <server>.
 291
 292 - TRACE
 293         TRACE [<server>]
 294         .
 295         Trace a path across the IRC network of the current server, or if given
 296         of a specific <server>, in a similar method to traceroute.
 297
 298 - USERHOST
 299         USERHOST <nicknames>
 300         .
 301         Show the user-host of <nicknames> (seperated by space).
 302         "-" means <nick> is away,
 303         "+" means <nick> is available,
 304         "*" indicates your connection.
 305
 306 - VERSION
 307         VERSION [<server>]
 308         .
 309         Show the ngIRCd version of the current server, or specified <server>.
 310
 311 - WHO
 312         WHO [<target> ["o"]]
 313         .
 314         Returns a list of users who match <target> (nick, hostmask or channel).
 315         .
 316         If the flag "o" is given, the server will only return information about
 317         IRC Operators.
 318
 319 - WHOIS
 320         WHOIS [<server>] <nicknames>
 321         .
 322         Returns information about the comma-separated list of <nicknames>.
 323         .
 324         If <server> is given, the command is forwarded to it for processing.
 325
 326 - WHOWAS
 327         WHOWAS <nickname> [<count> [<server>]]
 328         .
 329         Used to return information about <nicknames> that are no longer in use
 330         (due to client disconnection, or nickname changes).
 331         .
 332         If given, the server will return information from the last <count> times
 333         the nickname has been used.
 334         If <server> is given, the command is forwarded to it for processing.
 335
 336
 337 Channel Commands
 338 ~~~~~~~~~~~~~~~~
 339
 340 - INVITE
 341         INVITE <nick> <channel>
 342         .
 343         Invites <nick> to <channel>.
 344         <channel> does not have to exist, but if it does, only members of the
 345         channel are allowed to invite other clients.
 346         .
 347         If the <channel> mode "+i" is set, only <channel> operators may invite
 348         other clients.
 349
 350 - JOIN
 351         JOIN <channels> [<channel-keys>]
 352         .
 353         Makes the client join the <channels> (comma-separated list), specifying
 354         the passwords, if needed, in the comma-separated <channel-keys> list.
 355         A <channel-key> is only needed, if the <channel> mode "+k" is set.
 356         .
 357         If the channel(s) do not exist, then they will be created.
 358
 359 - KICK
 360         KICK <channel> <nick> [<kick-message>]
 361         .
 362         Remove <nick> from <channel>, optional with a <kick-message>.
 363         .
 364         Only <channel> operators are able to KICK.
 365
 366 - LIST
 367         LIST [<channels> [<server>]]
 368         .
 369         List all visible <channels> (comma-seperated list) on the current
 370         server.
 371         If <server> is given, the command will be forwarded to <server> for
 372         evaluation.
 373
 374 - PART
 375         PART <channels> [<part-message>]
 376         .
 377         Leave <channels> (comma-separated list), optional with a
 378         <part-message>.
 379
 380 - TOPIC
 381         TOPIC <channel> <topic>
 382         .
 383         Set a <topic> for <channel>.
 384         .
 385         Only <channel> operators are able to set a <topic>.
 386
 387
 388 Administrative Commands
 389 ~~~~~~~~~~~~~~~~~~~~~~~
 390
 391 - CONNECT
 392         CONNECT <target server> [<port> [<remote server> [<mypwd> <peerpwd>]]]
 393         .
 394         Instructs the current server, or <remote server> if specified,
 395         to connect to <target server>.
 396         .
 397         To connect <remote server> you need to have remote oper status.
 398         If <port> is omitted, it uses the server port of the configuration.
 399         If <mypwd> and <peerpwd> is given, it uses those passwords instead
 400         of the ones in the configuration.
 401
 402 - DIE
 403         DIE
 404         .
 405         Instructs the server to shut down.
 406
 407 - DISCONNECT
 408         DISCONNECT [<remote server>]
 409         .
 410         Disconnects the current server, or <remote server> if specified.
 411         To disconnect a <remote server> you need to have remote oper status.
 412
 413 - GLINE
 414         GLINE <nick!user@hostmask> <seconds> :<reason>
 415         .
 416         This command provides timed G-Lines (Network-wide bans).
 417         If a client matches a G-Line, it cannot connect to any server on
 418         the IRC network. If you put 0 as <seconds>, it makes the G-Line
 419         permanent.
 420         .
 421         To remove a G-Line, type "GLINE <nick!user@hostmask>".
 422         To list the G-Lines, type "STATS g".
 423
 424 - KILL
 425         KILL <nick> <reason>
 426         .
 427         Forcibly removes <nick> from the IRC network with a <reason>.
 428
 429 - KLINE
 430         KLINE <nick!user@hostmask> <seconds> :<reason>
 431         .
 432         This command provides timed K-Lines (Server-local bans).
 433         If a client matches a K-Line, it cannot connect to the issued server.
 434         If you put 0 as <seconds>, it makes the K-Line permanent.
 435         .
 436         To remove a K-Line, type "KLINE <nick!user@hostmask>".
 437         To list the K-Lines, type "STATS k".
 438
 439 - OPER
 440         OPER <user> <password>
 441         .
 442         Authenticates <user> as an IRC operator on the current server/network.
 443
 444 - REHASH
 445         REHASH
 446         .
 447         Causes the server to re-read and re-process its configuration file(s).
 448
 449 - RESTART
 450         RESTART
 451         .
 452         Restart the server.
 453
 454 - WALLOPS
 455         WALLOPS <message>
 456         .
 457         Sends <message> to all users with user mode "+w".
 458
 459
 460 IRC Service Commands
 461 ~~~~~~~~~~~~~~~~~~~~
 462
 463 - SERVICE
 464
 465 - SERVLIST
 466
 467 - SQUERY
 468
 469 - SVSNICK
 470
 471
 472 Server Protocol Commands
 473 ~~~~~~~~~~~~~~~~~~~~~~~~
 474
 475 - CHANINFO
 476         CHANINFO <channel> +<modes> [[<key> <limit>] <topic>]
 477         .
 478         CHANINFO is used by servers to inform each other about a channel:
 479         its modes, channel key, user limits and its topic.
 480         .
 481         See doc/Protocol.txt for more information.
 482
 483 - ERROR
 484         ERROR [<message> [<> [...]]]
 485         .
 486         Return an error message to the server. The first parameter, if given,
 487         will be logged by the server, all further parameters are silently
 488         ignored.
 489         .
 490         This command is silently ignored on non-server and non-service links.
 491
 492 - METADATA
 493         METADATA <target> <key> <value>
 494         .
 495         The METADATA command is used on server-links to update "metadata"
 496         information of clients, like the hostname, the info text ("real name"),
 497         or the user name.
 498         .
 499         See doc/Protocol.txt for more information.
 500
 501 - NJOIN
 502
 503 - SERVER
 504
 505 - SQUIT
 506         SQUIT <server>
 507         .
 508         Disconnects an IRC Server from the network.
 509
 510
 511 Dummy Commands
 512 ~~~~~~~~~~~~~~
 513
 514 - SUMMON
 515
 516 - USERS
 517
 518 - GET
 519
 520 - POST