summaryrefslogtreecommitdiff
path: root/doc/en/irc_commands.xml
blob: 620f10d8c3212087190fc8327fb5566c1088341c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
<?xml version="1.0" encoding="iso-8859-1"?>

<!-- ********* WARNING! *********

     This file is automatically built with a Perl script. DO NOT EDIT!
-->

<command>admin  [target]</command>
<programlisting>
find information about the administrator of the server

target: server

</programlisting>
<command>ame  message</command>
<programlisting>
send a CTCP action to all channels of all connected servers

message: message to send

</programlisting>
<command>amsg  text</command>
<programlisting>
send message to all channels of all connected servers

text: text to send

</programlisting>
<command>away  [-all] [message]</command>
<programlisting>
toggle away status

   -all: toggle away status on all connected servers
message: message for away (if no message is given, away status is removed)

</programlisting>
<command>ban  [channel] [nickname [nickname ...]]</command>
<programlisting>
bans nicks or hosts

 channel: channel for ban
nickname: user or host to ban

</programlisting>
<command>ctcp  nickname type [arguments]</command>
<programlisting>
send a CTCP message (Client-To-Client Protocol)

 nickname: user to send CTCP to
     type: CTCP type (examples: "version", "ping", ..)
arguments: arguments for CTCP

</programlisting>
<command>cycle  [channel[,channel]] [part_message]</command>
<programlisting>
leave and rejoin a channel

     channel: channel name for cycle
part_message: part message (displayed to other users)

</programlisting>
<command>dcc  action [nickname [file]]</command>
<programlisting>
starts DCC (file or chat) or close chat

  action: 'send' (file) or 'chat' or 'close' (chat)
nickname: nickname to send file or chat
    file: filename (on local host)

</programlisting>
<command>dehalfop  [nickname [nickname]]</command>
<programlisting>
removes half channel operator status from nickname(s)

</programlisting>
<command>deop  [nickname [nickname]]</command>
<programlisting>
removes channel operator status from nickname(s)

</programlisting>
<command>devoice  [nickname [nickname]]</command>
<programlisting>
removes voice from nickname(s)

</programlisting>
<command>die</command>
<programlisting>
shutdown the server

</programlisting>
<command>halfop  [nickname [nickname]]</command>
<programlisting>
gives half channel operator status to nickname(s)

</programlisting>
<command>info  [target]</command>
<programlisting>
get information describing the server

target: server name

</programlisting>
<command>invite  nickname channel</command>
<programlisting>
invite a nick on a channel

nickname: nick to invite
 channel: channel to invite

</programlisting>
<command>ison  nickname [nickname ...]</command>
<programlisting>
check if a nickname is currently on IRC

nickname: nickname

</programlisting>
<command>join  channel[,channel] [key[,key]]</command>
<programlisting>
join a channel

channel: channel name to join
    key: key to join the channel

</programlisting>
<command>kick  [channel] nickname [comment]</command>
<programlisting>
forcibly remove a user from a channel

 channel: channel where user is
nickname: nickname to kick
 comment: comment for kick

</programlisting>
<command>kickban  [channel] nickname [comment]</command>
<programlisting>
kicks and bans a nick from a channel

 channel: channel where user is
nickname: nickname to kick and ban
 comment: comment for kick

</programlisting>
<command>kill  nickname comment</command>
<programlisting>
close client-server connection

nickname: nickname
 comment: comment for kill

</programlisting>
<command>links  [[server] server_mask]</command>
<programlisting>
list all servernames which are known by the server answering the query

     server: this server should answer the query
server_mask: list of servers must match this mask

</programlisting>
<command>list  [channel[,channel] [server]]</command>
<programlisting>
list channels and their topic

channel: channel to list (a regexp is allowed)
server: server name

</programlisting>
<command>lusers  [mask [target]]</command>
<programlisting>
get statistics about the size of the IRC network

  mask: servers matching the mask only
target: server for forwarding request

</programlisting>
<command>me  message</command>
<programlisting>
send a CTCP action to the current channel

message: message to send

</programlisting>
<command>mode  { channel {[+|-]|o|p|s|i|t|n|b|v} [limit] [user] [ban mask] } | { nickname {[+|-]|i|w|s|o} }</command>
<programlisting>
change channel or user mode

channel modes:
  channel: channel name to modify
  o: give/take channel operator privileges
  p: private channel flag
  s: secret channel flag
  i: invite-only channel flag
  t: topic settable by channel operator only flag
  n: no messages to channel from clients on the outside
  m: moderated channel
  l: set the user limit to channel
  b: set a ban mask to keep users out
  e: set exception mask
  v: give/take the ability to speak on a moderated channel
  k: set a channel key (password)
user modes:
  nickname: nickname to modify
  i: mark a user as invisible
  s: mark a user for receive server notices
  w: user receives wallops
  o: operator flag

</programlisting>
<command>motd  [target]</command>
<programlisting>
get the "Message Of The Day"

target: server name

</programlisting>
<command>msg  receiver[,receiver] text</command>
<programlisting>
send message to a nick or channel

receiver: nick or channel (may be mask, '*' = current channel)
text: text to send

</programlisting>
<command>names  [channel[,channel]]</command>
<programlisting>
list nicknames on channels

channel: channel name

</programlisting>
<command>nick  [-all] nickname</command>
<programlisting>
change current nickname

    -all: set new nickname for all connected servers
nickname: new nickname

</programlisting>
<command>notice  nickname text</command>
<programlisting>
send notice message to user

nickname: user to send notice to
    text: text to send

</programlisting>
<command>op  nickname [nickname]</command>
<programlisting>
gives channel operator status to nickname(s)

</programlisting>
<command>oper  user password</command>
<programlisting>
get operator privileges

user/password: used to get privileges on current IRC server

</programlisting>
<command>part  [channel[,channel]] [part_message]</command>
<programlisting>
leave a channel

     channel: channel name to leave
part_message: part message (displayed to other users)

</programlisting>
<command>ping  server1 [server2]</command>
<programlisting>
ping server

server1: server to ping
server2: forward ping to this server

</programlisting>
<command>pong  daemon [daemon2]</command>
<programlisting>
answer to a ping message

 daemon: daemon who has responded to Ping message
daemon2: forward message to this daemon

</programlisting>
<command>query  nickname [text]</command>
<programlisting>
send a private message to a nick

nickname: nickname for private conversation
    text: text to send

</programlisting>
<command>quit  [quit_message]</command>
<programlisting>
close all connections and quit

quit_message: quit message (displayed to other users)

</programlisting>
<command>quote  data</command>
<programlisting>
send raw data to server without parsing

data: raw data to send

</programlisting>
<command>rehash</command>
<programlisting>
tell the server to reload its config file

</programlisting>
<command>restart</command>
<programlisting>
tell the server to restart itself

</programlisting>
<command>service  nickname reserved distribution type reserved info</command>
<programlisting>
register a new service

distribution: visibility of service
        type: reserved for future usage

</programlisting>
<command>servlist  [mask [type]]</command>
<programlisting>
list services currently connected to the network

mask: list only services matching this mask
type: list only services of this type

</programlisting>
<command>squery  service text</command>
<programlisting>
deliver a message to a service

service: name of service
text: text to send

</programlisting>
<command>squit  server comment</command>
<programlisting>
disconnect server links

server: server name
comment: comment for quit

</programlisting>
<command>stats  [query [server]]</command>
<programlisting>
query statistics about server

 query: c/h/i/k/l/m/o/y/u (see RFC1459)
server: server name

</programlisting>
<command>summon  user [target [channel]]</command>
<programlisting>
give users who are on a host running an IRC server a message asking them to please join IRC

   user: username
target: server name
channel: channel name

</programlisting>
<command>time  [target]</command>
<programlisting>
query local time from server

target: query time from specified server

</programlisting>
<command>topic  [channel] [topic]</command>
<programlisting>
get/set channel topic

channel: channel name
topic: new topic for channel (if topic is "-delete" then topic is deleted)

</programlisting>
<command>trace  [target]</command>
<programlisting>
find the route to specific server

target: server

</programlisting>
<command>unban  [channel] nickname [nickname ...]</command>
<programlisting>
unbans nicks or hosts

 channel: channel for unban
nickname: user or host to unban

</programlisting>
<command>userhost  nickname [nickname ...]</command>
<programlisting>
return a list of information about nicknames

nickname: nickname

</programlisting>
<command>users  [target]</command>
<programlisting>
list of users logged into the server

target: server

</programlisting>
<command>version  [server | nickname]</command>
<programlisting>
gives the version info of nick or server (current or specified)

  server: server name
nickname: nickname

</programlisting>
<command>voice  [nickname [nickname]]</command>
<programlisting>
gives voice to nickname(s)

</programlisting>
<command>wallops  text</command>
<programlisting>
send a message to all currently connected users who have set the 'w' user mode for themselves

text to send

</programlisting>
<command>who  [mask ["o"]]</command>
<programlisting>
generate a query which returns a list of information

mask: only information which match this mask
   o: only operators are returned according to the mask supplied

</programlisting>
<command>whois  [server] nickname[,nickname]</command>
<programlisting>
query information about user(s)

  server: server name
nickname: nickname (may be a mask)

</programlisting>
<command>whowas  nickname [,nickname [,nickname ...]] [count [target]]</command>
<programlisting>
ask for information about a nickname which no longer exists

nickname: nickname to search
   count: number of replies to return (full search if negative number)
  target: reply should match this mask

</programlisting>