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