Commands.txt 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991
  1. ngIRCd - Next Generation IRC Server
  2. http://ngircd.barton.de/
  3. (c)2001-2013 Alexander Barton and Contributors.
  4. ngIRCd is free software and published under the
  5. terms of the GNU General Public License.
  6. -- Commands.txt --
  7. This file lists all commands available on ngIRCd. It is written in a format
  8. that is human readable as well as machine parseable and therefore can be used
  9. as "help text file" of the daemon.
  10. In short, the daemon reads this file on startup and parses it as following
  11. when an user issues a "HELP <cmd>" command:
  12. 1. Search the file for a line "- <cmd>",
  13. 2. Output all subsequent lines that start with a TAB (ASCII 9) character
  14. to the client using NOTICE commands, treat lines containing a single "."
  15. after the TAB as empty lines.
  16. 3. Break at the first line not starting with a TAB character.
  17. This format allows to have information to each command stored in this file
  18. which will not be sent to an IRC user requesting help which enables us to
  19. have additional annotations stored here which further describe the origin,
  20. implementation details, or limits of the specific command which are not
  21. relevant to an end-user but administrators and developers.
  22. A special "Intro" block is returned to the user when the HELP command is
  23. used without a command name:
  24. - Intro
  25. This is ngIRCd, a server software for Internet Relay Chat (IRC)
  26. networks. You can find more information about ngIRCd on its homepage:
  27. <http://ngircd.barton.de>
  28. .
  29. Use "HELP COMMANDS" to get a list of all available commands and
  30. "HELP <command-name>" to get help for a specific IRC command, for
  31. example "HELP quit" or "HELP privmsg".
  32. Connection Handling Commands
  33. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  34. - CAP
  35. CAP LS
  36. CAP LIST
  37. CAP REQ <capabilities>
  38. CAP ACK <capabilities>
  39. CAP NAK <capabilities>
  40. CAP CLEAR
  41. CAP END
  42. .
  43. List, request, and clear "IRC Capabilities".
  44. .
  45. Using this command, an IRC client can request additional "IRC
  46. capabilities" during login or later on, which influences the
  47. communication between server and client. Normally, these commands
  48. aren't directly used by humans, but automatically by their client
  49. software. And please note that issuing such commands manually can
  50. irritate the client software used, because of the "non-standard"
  51. behavior of the server!
  52. .
  53. - CAP LS: list all available capabilities.
  54. - CAP LIST: list active capabilities of this connection.
  55. - CAP REQ: Request particular capabilities.
  56. - CAP ACK: Acknowledge a set of capabilities to be enabled/disabled.
  57. - CAP NAK: Reject a set of capabilities.
  58. - CAP CLEAR: Clear all set capabilities.
  59. - CAP END: Indicate end of capability negotiation during login,
  60. ignored in an fully registered session.
  61. Please note that the <capabilities> must be given in a single
  62. parameter but whitespace separated, therefore a command could look
  63. like this: "CAP REQ :capability1 capability2 capability3" for example.
  64. References:
  65. - <http://ircv3.atheme.org/specification/capability-negotiation-3.1>
  66. - <http://ngircd.barton.de/doc/Capabilities.txt>
  67. - doc/Capabilities.txt
  68. - CHARCONV
  69. CHARCONV <client-charset>
  70. .
  71. Set client character set encoding to <client-charset>.
  72. .
  73. After receiving such a command, the server translates all message
  74. data received from the client using the set <client-charset> to the
  75. server encoding (UTF-8), and all message data which is to be sent to
  76. the client from the server encoding (UTF-8) to <client-charset>.
  77. .
  78. This enables older clients and clients using "strange" character sets
  79. to transparently participate in channels and direct messages to
  80. clients using UTF-8, which should be the default today.
  81. References:
  82. - IRC+, <http://ngircd.barton.de/doc/Protocol.txt>
  83. - IRC+, doc/Protocol.txt
  84. - NICK
  85. NICK <nickname>
  86. NICK <nickname> [<hops>]
  87. NICK <nickname> <hops> <username> <host> <servertoken> <usermodes> <realname>
  88. .
  89. Set or change the <nickname> of a client (first form) and register
  90. remote clients (second and third form; servers only).
  91. References:
  92. - RFC 1459, 4.1.2 "Nick message" (old client and server protocol)
  93. - RFC 2812, 3.1.2 "Nick message" (client protocol)
  94. - RFC 2813, 4.1.3 "Nick" (server protocol)
  95. - PASS
  96. PASS <password>
  97. PASS <password> <version> <flags> [<options>]
  98. .
  99. Set a connection <password>. This command must be the first command
  100. sent to the server, even before the NICK/USER or SERVER commands.
  101. .
  102. The first form is used by user sessions or (old) RFC 1459 servers,
  103. the second form is used by RFC 2812 or IRC+ compliant servers and
  104. enables the server to indicate its version and supported protocol
  105. features.
  106. References:
  107. - RFC 1459, 4.1.1 "Password message" (old client and server protocol)
  108. - RFC 2812, 3.1.1 "Password message" (client protocol)
  109. - RFC 2813, 4.1.1 "Password message" (server protocol)
  110. - IRC+, <http://ngircd.barton.de/doc/Protocol.txt>
  111. - IRC+, doc/Protocol.txt
  112. - PING
  113. PING <token> [<target>]
  114. .
  115. Tests the presence of a connection to a client or server.
  116. .
  117. If no <target> has been given, the local server is used. User clients
  118. can only use other servers as <target>, no user clients.
  119. .
  120. A PING message results in a PONG reply containing the <token>, which
  121. can be arbitrary text.
  122. Please note:
  123. The RFCs state that the <token> parameter is used to specify the
  124. origin of the PING command when forwarded in the network, but this
  125. is not the case: the sender is specified using the prefix as usual,
  126. and the parameter is used to identify the PONG reply in practice.
  127. References:
  128. - RFC 2812, 3.7.2 "Ping message"
  129. - PONG
  130. PONG <target> [<token>]
  131. .
  132. Reply to a "PING" command, indicate that the connection is alive.
  133. .
  134. The <token> is the arbitrary text received in the "PING" command and
  135. can be used to identify the correct PONG sent as answer.
  136. .
  137. When the "PONG" command is received from a user session, the <target>
  138. parameter is ignored; otherwise the PONG is forwarded to this client.
  139. References:
  140. - RFC 2812, 3.7.3 "Pong message"
  141. - QUIT
  142. QUIT [<quit-message>]
  143. .
  144. Terminate a user session.
  145. .
  146. When received from a user, the server acknowledges this by sending
  147. an "ERROR" message back to the client and terminates the connection.
  148. .
  149. When a <quit-message> has been given, it is sent to all the channels
  150. that the client is a member of when leaving.
  151. References:
  152. - RFC 2812, 3.1.7 "Quit"
  153. - RFC 2813, 4.1.5 "Quit"
  154. - USER
  155. USER <username> <hostname> <unused> <realname>
  156. .
  157. Register (and authenticate) a new user session with a short <username>
  158. and a human-readable <realname>.
  159. .
  160. The parameter <hostname> is only used when received by an other server
  161. and ignored otherwise; and the parameter <unused> is always ignored.
  162. But both parameters are required on each invocation by the protocol
  163. and can be set to arbitrary characters/text when not used.
  164. .
  165. If <username> contains an "@" character, the full <username> is used
  166. for authentication, but only the first part up to this character is
  167. set as "user name" for this session.
  168. References:
  169. - RFC 2812, 3.1.3 "User message"
  170. - WEBIRC
  171. WEBIRC <password> <username> <hostname> <ip-address>
  172. .
  173. Allow Web-to-IRC gateway software (for example) to set the correct
  174. user name and host name of users instead of their own.
  175. .
  176. It must be the very first command sent to the server, even before
  177. USER and NICK commands!
  178. .
  179. The <password> must be set in the server configuration file to prevent
  180. unauthorized clients to fake their identity; it is an arbitrary string.
  181. References:
  182. - IRC+, <http://ngircd.barton.de/doc/Protocol.txt>
  183. - IRC+, doc/Protocol.txt
  184. General Commands
  185. ~~~~~~~~~~~~~~~~
  186. - AWAY
  187. AWAY [<message>]
  188. .
  189. Provides the server with a message to automatically send in reply to a
  190. PRIVMSG directed at the user, but not to a channel they are on.
  191. .
  192. If <message> is omitted, the away status is removed.
  193. References:
  194. - RFC 2812, 4.1 "Away"
  195. - HELP
  196. HELP [<command>]
  197. .
  198. Show help information for a specific IRC <command>. The <command> name
  199. is case-insensitive.
  200. .
  201. Use the command "HELP Commands" to get a list of all available commands.
  202. The HELP command isn't specified by any RFC but implemented by most
  203. daemons. If no help text could be read in, ngIRCd outputs a list of all
  204. implemented commands when receiving a plain "HELP" command as well as
  205. on "HELP Commands".
  206. ngIRCd replies using "NOTICE" commands like ircd 2.10/2.11; other
  207. implementations are using numerics 704, 705, and 706.
  208. - MODE
  209. MODE <nickname> [{+|-}<mode>[<mode>] [{+|-}<mode>[<mode>] [...]]]
  210. MODE <channel> [{+|-}<mode>[<mode>] [<arg> [<arg> [...]]] [{+|-}<mode>[<mode>] [<arg> [<arg> [...]]] [...]]]
  211. .
  212. Set and get user and channel modes.
  213. .
  214. When no mode parameters are given, the currently set user or channel
  215. modes are returned. Otherwise the modes are adjusted accordingly
  216. and the changes will be reported back to the client.
  217. .
  218. All user and channel "modes" are indicated by single case-sensitive
  219. characters.
  220. .
  221. Please note that a user can only get and set his own modes, and not
  222. all user "levels" are allowed to change all channel modes ...
  223. .
  224. The mode parameters can become quite complex, especially when dealing
  225. with channel modes that require additional arguments:
  226. .
  227. {+|-}<mode(s}> -- set or unset one or more modes.
  228. +<mode(s)> -<mode(s)> -- set some modes and unset others.
  229. +<modes> <arg1> <arg2> -- set (at least) two modes with arguments.
  230. .
  231. Some examples:
  232. .
  233. MODE nick +i -- set user to "invisible".
  234. MODE #chan +tn -- set "topic lock" and "no external messages".
  235. MODE #chan -t +l 50 -- remove "topic lock", set "user limit" to 50.
  236. MODE #chan +ov nick1 nick2 -- set "channel op" and "voice" mode
  237. to nick1 and nick2 in channel #chan.
  238. .
  239. A complete list of all modes supported by ngIRCd can be found online
  240. here: <http://ngircd.barton.de/doc/Modes.txt>.
  241. References:
  242. - RFC 2811, 4. "Channel Modes"
  243. - RFC 2812, 3.1.5 "User mode message"
  244. - RFC 2812, 3.2.3 "Channel mode message"
  245. - <http://ngircd.barton.de/doc/Modes.txt>
  246. - doc/Modes.txt
  247. - NOTICE
  248. NOTICE <target>[,<target>[,...]] <message>
  249. .
  250. Send a <message> to a given <target>, which can be a user or a
  251. channel, but DON'T report any error.
  252. .
  253. The "NOTICE" command exactly behaves like the "PRIVMSG" command, but
  254. doesn't report any errors it encounters (like an unknown <target>).
  255. Please see the help text of the "PRIVMSG" command for a detailed
  256. description of the parameters!
  257. References:
  258. - RFC 2812, 2.3.1 "Message format in Augmented BNF"
  259. - RFC 2812, 3.3 "Sending messages"
  260. - RFC 2812, 3.3.2 "Notice"
  261. - PRIVMSG
  262. PRIVMSG <target>[,<target>[,...]] <message>
  263. .
  264. Send a <message> to a given <target>, which can be a user or a
  265. channel, and report all errors.
  266. .
  267. The <target> must follow one of these syntax variants:
  268. .
  269. - <nickname>
  270. - <channel>
  271. - <user>[%<host>]@<server>
  272. - <user>%<host>
  273. - <nickname>!<user>@<host>
  274. .
  275. If the <target> is a user, a private message is sent directly to this
  276. user; if it resolves to a channel name, a public message is sent
  277. to all the members of that channel.
  278. .
  279. In addition, IRC Ops can use these two forms to specify the <target>:
  280. .
  281. - #<hostmask>
  282. - #<servermask>
  283. .
  284. The <mask> can contain the wildcard characters "*" and "?", but must
  285. contain at least one dot (".") and no wildcard after the last one.
  286. Then, the <message> is sent to all users matching this <mask>.
  287. .
  288. All warnings and errors are reported back to the initiator using
  289. numeric status codes, which is the only difference to the "NOTICE"
  290. command, which doesn't report back any errors or warnings at all.
  291. .
  292. Please note that clients often use "MSG" as an alias to PRIVMSG, and
  293. a command "QUERY <nick> [<message>]" to initiate private chats. Both
  294. are command extensions of the client and never sent to the server.
  295. References:
  296. - RFC 2812, 2.3.1 "Message format in Augmented BNF"
  297. - RFC 2812, 3.3 "Sending messages"
  298. - RFC 2812, 3.3.1 "Private messages"
  299. Status and Informational Commands
  300. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  301. - ADMIN
  302. ADMIN [<target>]
  303. .
  304. Show administrative information about an IRC server in the network.
  305. .
  306. <target> can be a server name, the nickname of a client connected to
  307. a specific server, or a mask matching a server name in the network.
  308. The server of the current connection is used when <target> is omitted.
  309. References:
  310. - RFC 2812, 3.4.9 "Admin command"
  311. - INFO
  312. INFO [<target>]
  313. .
  314. Show the version, birth & online time of an IRC server in the network.
  315. .
  316. <target> can be a server name, the nickname of a client connected to
  317. a specific server, or a mask matching a server name in the network.
  318. The server of the current connection is used when <target> is omitted.
  319. References:
  320. - RFC 2812, 3.4.10 "Info command"
  321. - ISON
  322. ISON <nickname> [<nickname> [...]]
  323. .
  324. Query online status of a list of nicknames. The server replies with
  325. a list only containing nicknames actually connected to a server in
  326. the network. If no nicknames of the given list are online, an empty
  327. list is returned to the client requesting the information.
  328. Please note that "all" IRC daemons even parse separate nicknames in
  329. a single parameter (like ":nick1 nick2"), and therefore ngIRCd
  330. implements this behaviour, too.
  331. References:
  332. - RFC 2812, 4.9 "Ison message"
  333. - LINKS
  334. LINKS [[<target>] [<mask>]
  335. .
  336. List all servers currently registered in the network matching <mask>,
  337. or all servers if <mask> has been omitted, as seen by the server
  338. specified by <target> or the local server when <target> is omitted.
  339. .
  340. <target> can be a server name, the nickname of a client connected to
  341. a specific server, or a mask matching a server name in the network.
  342. References:
  343. - RFC 2812, 3.4.5 "Links message"
  344. - LUSERS
  345. LUSERS [<mask> [<target>]]
  346. .
  347. Return statistics about the number of clients (users, servers,
  348. services, ...) in the network as seen by the server <target>.
  349. .
  350. <target> can be a server name, the nickname of a client connected to
  351. a specific server, or a mask matching a server name in the network.
  352. The server of the current connection is used when <target> is omitted.
  353. Please note that ngIRCd ignores the <mask> parameter entirely: it
  354. is not possible to get information for a part of the network only.
  355. References:
  356. - RFC 2812, 3.4.2 "Lusers message"
  357. - MOTD
  358. MOTD [<target>]
  359. .
  360. Show the "Message of the Day" (MOTD) of an IRC server in the network.
  361. .
  362. <target> can be a server name, the nickname of a client connected to
  363. a specific server, or a mask matching a server name in the network.
  364. The server of the current connection is used when <target> is omitted.
  365. References:
  366. - RFC 2812, 3.4.1 "Motd message"
  367. - NAMES
  368. NAMES [<channel>[,<channel>[,...]] [<target>]]
  369. .
  370. Show the list of users that are members of a particular <channel>
  371. (and that are visible for the client requesting this information) as
  372. seen by the server <target>. More than one <channel> can be given
  373. separated by "," (but not whitespaces!).
  374. .
  375. If <channel> has been omitted, all visible users are shown, grouped
  376. by channel name, and all visible users not being members of at least
  377. one channel are shown as members of the pseudo channel "*".
  378. .
  379. <target> can be a server name, the nickname of a client connected to
  380. a specific server, or a mask matching a server name in the network.
  381. The server of the current connection is used when <target> is omitted.
  382. References:
  383. - RFC 2812, 3.2.5 "Names message"
  384. - STATS
  385. STATS [<query> [<target>]]
  386. .
  387. Show statistics and other information of type <query> of a particular
  388. IRC server in the network.
  389. .
  390. The following <query> types are supported (case-insensitive where
  391. applicable):
  392. .
  393. - g Network-wide bans ("G-Lines").
  394. - k Server-local bans ("K-Lines").
  395. - L Link status (servers and user links).
  396. - l Link status (servers and own link).
  397. - m Command usage count.
  398. - u Server uptime.
  399. .
  400. <target> can be a server name, the nickname of a client connected to
  401. a specific server, or a mask matching a server name in the network.
  402. The server of the current connection is used when <target> is omitted.
  403. .
  404. To use "STATS L" the user must be an IRC Operator.
  405. References:
  406. - RFC 2812, 3.4.4 "Stats message"
  407. - TIME
  408. TIME [<target>]
  409. .
  410. Show the local time of an IRC server in the network.
  411. .
  412. <target> can be a server name, the nickname of a client connected to
  413. a specific server, or a mask matching a server name in the network.
  414. The server of the current connection is used when <target> is omitted.
  415. References
  416. - RFC 2812, 3.4.6 "Time message"
  417. - TRACE
  418. TRACE [<target>]
  419. .
  420. Find the route to a specific server and send information about its
  421. peers. Each server that processes this command reports back to the
  422. sender about it: the replies from pass-through servers form a chain
  423. which shows the route to the destination.
  424. .
  425. <target> can be a server name, the nickname of a client connected to
  426. a specific server, or a mask matching a server name in the network.
  427. The server of the current connection is used when <target> is omitted.
  428. References:
  429. - RFC 2812, 3.4.8 "Trace message"
  430. - USERHOST
  431. USERHOST <nickname> [<nickname> [...]]
  432. .
  433. Show flags and the hostmasks (<user>@<host>) of the <nickname>s,
  434. separated by spaces. The following flags are used:
  435. .
  436. - "-" The client is "away" (the mode "+a" is set on this client).
  437. - "+" Client seems to be available, at least it isn't marked "away".
  438. - "*" The client is an IRC operator (the mode "+o" is set).
  439. References:
  440. - RFC 2812, 4.8 "Userhost message"
  441. - VERSION
  442. VERSION [<target>]
  443. .
  444. Show version information about a particular IRC server in the network.
  445. .
  446. <target> can be a server name, the nickname of a client connected to
  447. a specific server, or a mask matching a server name in the network.
  448. The server of the current connection is used when <target> is omitted.
  449. .
  450. Please note: in normal operation, the version number ends in a dot
  451. (".", for example "ngIRCd-20.1."). If it ends in ".1" (for example
  452. "ngIRCd-20.1.1", same version than before!), the server is running in
  453. debug-mode; and if it ends in ".2", the "network sniffer" is active!
  454. Keep your privacy in mind ...
  455. References:
  456. - RFC 2812, 3.4.3 "Version message"
  457. - WHO
  458. WHO [<mask> ["o"]]
  459. .
  460. Show a list of users who match the <mask>, or all visible users when
  461. the <mask> has been omitted. (Special case: the <mask> "0" is
  462. equivalent to "*")
  463. .
  464. If the flag "o" is given, the server will only return information about
  465. IRC Operators.
  466. References:
  467. - RFC 2812, 3.6.1 "Who query"
  468. - WHOIS
  469. WHOIS [<target>] <mask>[,<mask>[,...]]
  470. .
  471. Query information about users matching the <mask> parameter(s) as seen
  472. by the server <target>; up to 3 <masks> are supported.
  473. .
  474. <target> can be a server name, the nickname of a client connected to a
  475. specific server, or a mask matching a server name in the network. The
  476. server of the current connection is used when <target> is omitted.
  477. References:
  478. - RFC 2812, 3.6.2 "Whois query"
  479. - WHOWAS
  480. WHOWAS <nickname>[,<nickname>[,...]] [<count> [<target>]]
  481. .
  482. Query information about nicknames no longer in use in the network,
  483. either because of nickname changes or disconnects. The history is
  484. searched backwards, returning the most recent entry first. If there
  485. are multiple entries, up to <count> entries will be shown (or all of
  486. them, if no <count> has been given).
  487. .
  488. <target> can be a server name, the nickname of a client connected to a
  489. specific server, or a mask matching a server name in the network. The
  490. server of the current connection is used when <target> is omitted.
  491. References:
  492. - RFC 2812, 3.6.3 "Whowas"
  493. Channel Commands
  494. ~~~~~~~~~~~~~~~~
  495. - INVITE
  496. INVITE <nickname> <channel>
  497. .
  498. Invite <nickname> to join channel <channel>.
  499. .
  500. <channel> does not have to exist, but if it does, only members of the
  501. channel are allowed to invite other users. If the channel mode "+i"
  502. is set, only channel "half-ops" (and above) may invite other clients,
  503. and if channel mode "+V" is set, nobody can invite other users.
  504. References:
  505. - RFC 2812, 3.2.7 "Invite message"
  506. - JOIN
  507. JOIN {<channel>[,<channel>[,...]] [<key>[,<key>[,...]]] | 0}
  508. .
  509. Makes the client join the <channel> (comma-separated list), specifying
  510. the channel keys ("passwords"). A <channel-key> is only needed if the
  511. <channel> has the mode "+k" set.
  512. .
  513. If the channel(s) do not exist, then they will be created.
  514. .
  515. Using "JOIN 0" parts all channels at once.
  516. References:
  517. - RFC 2812, 3.2.1 "Join message" (client protocol)
  518. - RFC 2813, 4.2.1 "Join message" (server protocol)
  519. - KICK
  520. KICK <channel>[,<channel>[,...]] <nickname>[,<nickname>[,...]] [<reason>]
  521. .
  522. Remove users(s) with <nickname>(s) from <channel>(s).
  523. .
  524. There must be either exactly one <channel> parameter and multiple
  525. <nickname> parameters, or as many <channel> parameters as there are
  526. <nickname> parameters. The <reason> is shown to the users being
  527. kicked, and the nickname of the current user is used when <reason>
  528. is omitted.
  529. References:
  530. - RFC 2812, 3.2.8 "Kick command"
  531. - LIST
  532. LIST [<channel>[,<channel>[,...]] [<server>]]
  533. .
  534. List all visible <channels> (comma-separated list).
  535. .
  536. If <server> is given, the command will be forwarded to <server> for
  537. evaluation.
  538. References:
  539. - RFC 2812, 3.2.6 "List message"
  540. - PART
  541. PART <channel>[,<channel>[,...]] [<part-message>]
  542. .
  543. Leave <channel> (comma-separated list), optionally with sending a
  544. <part-message> to all the other channel members.
  545. References:
  546. - RFC 2812, 3.2.2 "Part message"
  547. - TOPIC
  548. TOPIC <channel> [<topic>]
  549. .
  550. Change or view the topic of a channel.
  551. .
  552. The topic for channel <channel> is returned if there is no <topic>
  553. given. If the <topic> parameter is present, the topic for that
  554. channel will be changed, if this action is allowed for the user
  555. requesting it. If the <topic> parameter is an empty string, the
  556. topic for that channel will be removed.
  557. References:
  558. - RFC 2812, 3.2.4 "Topic message"
  559. Administrative Commands
  560. ~~~~~~~~~~~~~~~~~~~~~~~
  561. - CONNECT
  562. CONNECT <server> [<port> [<remote-server> [<my-pwd> <peer-pwd>]]]
  563. .
  564. Instructs the current server, or <remote-server> if specified,
  565. to connect to the server named <server>, which must be configured
  566. in the server configuration file.
  567. .
  568. To use this command, the user must be an IRC Operator. To establish
  569. a connection on a <remote-server>, you must have remote IRC operator
  570. privileges.
  571. .
  572. If <port>, <my-pwd> and <peer-pwd> are given, these values override
  573. the ones specified in the server configuration file.
  574. References:
  575. - RFC 2812, 3.4.7 "Connect message"
  576. - DIE
  577. DIE [<message>]
  578. .
  579. Instructs the server to shut down.
  580. .
  581. The optional (and non-standard) <message> text is sent to each client
  582. connected to this server before all connections are closed.
  583. .
  584. To use this command, the user must be an IRC Operator.
  585. References:
  586. - RFC 2812, 4.3 "Die message"
  587. - DISCONNECT
  588. DISCONNECT <server>
  589. .
  590. Disconnect and disable a locally linked server.
  591. .
  592. To use this command, the user must be an IRC Operator.
  593. References:
  594. - This command is not specified in the IRC RFCs, it is an extension
  595. of ngIRCd.
  596. - GLINE
  597. GLINE <nick!user@hostmask> [<timeout> :<reason>]
  598. .
  599. This command provides timed G-Lines (network-wide bans).
  600. .
  601. If a client matches a G-Line, it cannot connect to any server on
  602. the IRC network for <timeout> seconds. When <timeout> is 0, it make
  603. the G-Line permanent.
  604. .
  605. If no <timeout> and no <reason> is given, the G-Line is removed.
  606. .
  607. To use this command, the user must be an IRC Operator.
  608. .
  609. "STATS g" can be used to list all currently active G-Lines.
  610. References:
  611. - This command is not specified in the IRC RFCs, it is an extension
  612. of ngIRCd.
  613. - KILL
  614. KILL <nickname> <reason>
  615. .
  616. Forcibly remove all users with a given <nickname> from the IRC
  617. network and display the given <reason> to them.
  618. .
  619. This command is used internally between servers, too, for example
  620. to disconnect duplicate <nickname>'s after a "net split".
  621. .
  622. To use this command, the user must be an IRC Operator.
  623. References:
  624. - RFC 2812, 3.7.1 "Kill message"
  625. - KLINE
  626. KLINE <nick!user@hostmask> [<timeout> :<reason>]
  627. .
  628. This command provides timed K-Lines (server-local bans).
  629. .
  630. If a client matches a K-Line, it cannot connect to this server for
  631. <timeout> seconds. When <timeout> is 0, it makes the K-Line permanent.
  632. .
  633. If no <timeout> and no <reason> is given, the K-Line is removed.
  634. .
  635. To use this command, the user must be an IRC Operator.
  636. .
  637. "STATS k" can be used to list all currently active K-Lines.
  638. References:
  639. - This command is not specified in the IRC RFCs, it is an extension
  640. of ngIRCd.
  641. - OPER
  642. OPER <name> <password>
  643. .
  644. Authenticates a user named <name> as an IRC operator on the current
  645. server/network.
  646. .
  647. This operator <name> must be configured in the server configuration.
  648. .
  649. Please note that <name> is NOT related to a nickname at all!
  650. References:
  651. - RFC 2812, 3.1.4 "Oper message"
  652. - REHASH
  653. REHASH
  654. .
  655. Causes the server to re-read and re-process its configuration file(s).
  656. .
  657. While rehashing, no new connections are accepted, but all already
  658. established connections stay connected.
  659. .
  660. To use this command, the user must be an IRC Operator.
  661. References:
  662. - RFC 2812, 4.2 "Rehash message"
  663. - RESTART
  664. RESTART
  665. .
  666. Restart the server.
  667. .
  668. While restarting, all connections are reset and no new connections
  669. are accepted.
  670. .
  671. To use this command, the user must be an IRC Operator.
  672. References:
  673. - RFC 2812, 4.4 "Restart message"
  674. - WALLOPS
  675. WALLOPS <message>
  676. .
  677. Sends <message> to all users with user mode "+w".
  678. .
  679. To use this command, the user must be an IRC Operator.
  680. References:
  681. - RFC 2812, 4.7 "Operwall message"
  682. IRC Service Commands
  683. ~~~~~~~~~~~~~~~~~~~~
  684. - SERVICE
  685. SERVICE <name> <reserved1> <distribution> <type> <reserved2> <info>
  686. SERVICE <name> <servertoken> <distribution> {<type>|+<modes>} <hops> <info>
  687. .
  688. Register a new service in the network.
  689. .
  690. The first form is used by directly linked services and isn't supported
  691. by ngIRCd at the moment. The second form announces services connected
  692. to remote "pseudo-servers" ("services hubs").
  693. .
  694. The <distribution> and <type> parameters are ignored by ngIRCd.
  695. References:
  696. - RFC 2812, 3.1.6 "Service message"
  697. - RFC 2813, 4.1.4 "Service message"
  698. - SERVLIST
  699. SERVLIST [<mask> [<type>]]
  700. .
  701. List all IRC services currently registered in the network.
  702. .
  703. The optional <mask> and <type> parameters can be used to limit the
  704. listing to services matching the <mask> and that are of type <type>.
  705. .
  706. Please note that ngIRCd doesn't use any service types at the moment
  707. and therefore all services are of type "0".
  708. References:
  709. - RFC 2812, 3.5.1 "Servlist message"
  710. - SQUERY
  711. SQUERY <target>[,<target>[,...]] <message>
  712. .
  713. Send a <message> to a given <target> IRC service, and report all
  714. errors.
  715. .
  716. The "SQUERY" command exactly behaves like the "PRIVMSG" command, but
  717. enforces that the <target> of the <message> is an IRC service.
  718. Please see the help text of the "PRIVMSG" command for a detailed
  719. description of the parameters!
  720. .
  721. If a user wants to interact with IRC services, he should use "SQUERY"
  722. instead of "PRIVMSG" or "NOTICE": only "SQUERY makes sure that no
  723. regular user, which uses the nickname of an IRC service, receives
  724. the command in error, for example during a "net split"!
  725. References:
  726. - RFC 2812, 2.3.1 "Message format in Augmented BNF"
  727. - RFC 2812, 3.3 "Sending messages"
  728. - RFC 2812, 3.3.2 "Notice"
  729. - SVSNICK
  730. SVSNICK <oldnick> <newnick>
  731. .
  732. Forcefully change foreign user nicknames. This command is allowed
  733. for servers only.
  734. .
  735. The "SVSNICK" command is forwarded to the server to which the user
  736. with nickname <oldnick> is connected to, which in turn generates a
  737. regular "NICK" command that then is sent to the client, so no special
  738. support in the client software is required.
  739. References:
  740. - ngIRCd GIT commit e3f300d3231f
  741. Server Protocol Commands
  742. ~~~~~~~~~~~~~~~~~~~~~~~~
  743. - CHANINFO
  744. CHANINFO <channel> +<modes> [[<key> <limit>] <topic>]
  745. .
  746. CHANINFO is used by servers to inform each other about a channel:
  747. its modes, channel key, user limits and its topic.
  748. .
  749. The CHANINFO command is allowed on server-links only.
  750. References:
  751. - IRC+, <http://ngircd.barton.de/doc/Protocol.txt>
  752. - IRC+, doc/Protocol.txt
  753. - ERROR
  754. ERROR [<message> [<> [...]]]
  755. .
  756. Inform a client or a server about an error condition. The first
  757. parameter, if given, is logged by the server receiving the message,
  758. all other parameters are silently ignored.
  759. .
  760. This command is silently ignored on non-server and non-service links
  761. and shouldn't be used by regular IRC clients.
  762. .
  763. The ERROR message is also sent before terminating a regular client
  764. connection.
  765. References:
  766. - RFC 2812, 3.7.4 "Error message"
  767. - METADATA
  768. METADATA <target> <key> <value>
  769. .
  770. The METADATA command is used on server-links to update "metadata"
  771. information of clients, like the hostname, the info text ("real name"),
  772. or the user name.
  773. .
  774. The METADATA command is allowed on server-links only.
  775. References:
  776. - IRC+, <http://ngircd.barton.de/doc/Protocol.txt>
  777. - IRC+, doc/Protocol.txt
  778. - NJOIN
  779. NJOIN <channel> [<mode>]<nick>[,[<mode>]<nick>[,...]]
  780. .
  781. The NJOIN command is used on server-links to add users with <nick>
  782. and <mode> to a <channel> while peering.
  783. .
  784. The NJOIN command is allowed on server-links only.
  785. References:
  786. - RFC 2813, 4.2.2 "Njoin message"
  787. - SERVER
  788. SERVER <servername> <info>
  789. SERVER <servername> <hopcount> <info>
  790. SERVER <servername> <hopcount> <token> <info>
  791. .
  792. The first form registers the local connection as a new server in the
  793. network, the second (RFC 1459) and third (RFC 2812) form announce a
  794. new remote server in the network.
  795. .
  796. The SERVER command is allowed on unregistered or server-links only.
  797. References:
  798. - RFC 1459, 4.1.4 "Server message"
  799. - RFC 2813, 4.1.2 "Server message"
  800. - SQUIT
  801. SQUIT <server> <comment>
  802. .
  803. Disconnects an IRC Server from the network.
  804. .
  805. This command is used on server-links, but can be used by IRC Operators
  806. to forcefully disconnect servers from the network, too.
  807. References:
  808. - RFC 2812, 3.1.8 "Squit"
  809. - RFC 2813, 4.1.6 "Server quit message"
  810. Dummy Commands
  811. ~~~~~~~~~~~~~~
  812. - SUMMON
  813. SUMMON <user> [<target> [<channel>]]
  814. .
  815. This command was intended to call people into IRC who are directly
  816. connected to the terminal console of the IRC server -- but is
  817. deprecated today. Therefore ngIRCd doesn't really implement this
  818. command and always returns an error message, regardless of the
  819. parameters given.
  820. References:
  821. - RFC 2812, 4.5 "Summon message"
  822. - USERS
  823. USERS [<target>]
  824. .
  825. This command was intended to list users directly logged in into the
  826. console of the IRC server -- but is deprecated today. Therefore ngIRCd
  827. doesn't really implement this command and always returns an error
  828. message, regardless of the parameters given.
  829. References:
  830. - RFC 2812, 4.6 "Users"
  831. - GET
  832. GET [...]
  833. .
  834. Fake HTTP GET command. When received, the connection is shut down
  835. immediately again to protect against crazy web browsers ...
  836. References:
  837. - ngIRCd GIT commit 33e8c2480649
  838. - POST
  839. POST [...]
  840. .
  841. Fake HTTP POST command. When received, the connection is shut down
  842. immediately again to protect against crazy web browsers ...
  843. References:
  844. - ngIRCd GIT commit 33e8c2480649