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
  50 - CHARCONV
  51
  52 - NICK
  53
  54 - PASS
  55
  56 - PING
  57
  58 - PONG
  59
  60 - QUIT
  61         QUIT [<quit-message>]
  62         .
  63         End IRC session and disconnect from the server.
  64         .
  65         If a <quit-message> has been given, it is displayed to all the
  66         channels that you are a member of when leaving.
  67
  68 - USER
  69
  70 - WEBIRC
  71
  72
  73 General Commands
  74 ~~~~~~~~~~~~~~~~
  75
  76 - AWAY
  77
  78 - HELP
  79         HELP [<command>]
  80         .
  81         Show help information for a specific IRC <command>. The <command> name
  82         is case-insensitive.
  83         .
  84         Use the command "HELP Commands" to get a list of all available commands.
  85
  86         The HELP command isn't specified by any RFC but implemented by most
  87         daemons. If no help text could be read in, ngIRCd outputs a list of all
  88         implemented commands when receiving a plain "HELP" command as well as
  89         on "HELP Commands".
  90
  91         ngIRCd replies using "NOTICE" commands like ircd 2.10/2.11; other
  92         implementations are using numerics 704, 705, and 706.
  93
  94
  95 - MODE
  96
  97 - NOTICE
  98
  99 - PRIVMSG
 100
 101
 102 Status and Informational Commands
 103 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 104
 105 - ADMIN
 106         ADMIN [<server>]
 107         .
 108         Show administrative information about an IRC server in the network.
 109         If no server name has been given, the local server will respond.
 110
 111 - INFO
 112
 113 - ISON
 114
 115 - LINKS
 116
 117 - LUSERS
 118
 119 - MOTD
 120
 121 - NAMES
 122
 123 - STATS
 124
 125 - TIME
 126
 127 - TRACE
 128
 129 - USERHOST
 130
 131 - VERSION
 132
 133 - WHO
 134
 135 - WHOIS
 136
 137 - WHOWAS
 138
 139
 140 Channel Commands
 141 ~~~~~~~~~~~~~~~~
 142
 143 - INVITE
 144
 145 - JOIN
 146
 147 - KICK
 148
 149 - LIST
 150
 151 - PART
 152
 153 - TOPIC
 154
 155
 156 Administrative Commands
 157 ~~~~~~~~~~~~~~~~~~~~~~~
 158
 159 - CONNECT
 160
 161 - DIE
 162
 163 - DISCONNECT
 164
 165 - GLINE
 166
 167 - KILL
 168
 169 - KLINE
 170
 171 - OPER
 172
 173 - REHASH
 174
 175 - RESTART
 176
 177 - WALLOPS
 178
 179
 180 IRC Service Commands
 181 ~~~~~~~~~~~~~~~~~~~~
 182
 183 - SERVICE
 184
 185 - SERVLIST
 186
 187 - SQUERY
 188
 189 - SVSNICK
 190
 191
 192 Server Protocol Commands
 193 ~~~~~~~~~~~~~~~~~~~~~~~~
 194
 195 - CHANINFO
 196
 197 - ERROR
 198         ERROR [<message> [<> [...]]]
 199         .
 200         Return an error message to the server. The first parameter, if given,
 201         will be logged by the server, all further parameters are silently
 202         ignored.
 203         .
 204         This command is silently ignored on non-server and non-service links.
 205
 206 - METADATA
 207
 208 - NJOIN
 209
 210 - SERVER
 211
 212 - SQUIT
 213
 214
 215 Dummy Commands
 216 ~~~~~~~~~~~~~~
 217
 218 - SUMMON
 219
 220 - USERS
 221
 222 - GET
 223
 224 - POST