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