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