summaryrefslogtreecommitdiff
path: root/doc/en/autogen/user/irc_commands.txt
blob: 3fa5d0772a28ce949fdc4d9f7d91c7a760860853 (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
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
[command]*`admin`* find information about the administrator of the server::
........................................
/admin  [<target>]

target: server
........................................

[command]*`allchan`* execute a command on all channels of all connected servers::
........................................
/allchan  [-current] [-exclude=<channel>[,<channel>...]] <command> [<arguments>]

 -current: execute command for channels of current server only
 -exclude: exclude some channels ('*' is allowed at beginning or end of channel name, to exclude many channels)
  command: command to execute
arguments: arguments for command

Examples:
  execute '/me is testing' on all channels:
    /allchan me is testing
  say 'hello' everywhere but not on #weechat:
    /allchan -exclude=#weechat msg * hello
  say 'hello' everywhere but not on #weechat and channels beginning with #linux:
    /allchan -exclude=#weechat,#linux* msg * hello
........................................

[command]*`allserv`* execute a command on all connected servers::
........................................
/allserv  [-exclude=<server>[,<server>...]] <command> [<arguments>]

 -exclude: exclude some servers ('*' is allowed at beginning or end of server name, to exclude many servers)
  command: command to execute
arguments: arguments for command

Examples:
  change nick on all servers:
    /allserv nick newnick
  set away on all servers:
    /allserv away I'm away
........................................

[command]*`ban`* ban nicks or hosts::
........................................
/ban  [<channel>] [<nick> [<nick>...]]

channel: channel for ban
   nick: user or host to ban
........................................

[command]*`connect`* connect to IRC server(s)::
........................................
/connect  [<server> [<server>...] | <hostname>[/<port>]] [-<option>[=<value>]] [-no<option>] [-nojoin] [-switch]
          -all|-open [-nojoin] [-switch]

    server: internal server name to connect (server must have been created by /server add)
  hostname: hostname (or IP) of a server (this will create a TEMPORARY server)
      port: port for server (6667 by default)
    option: set option for server (for boolean option, value can be omitted)
  nooption: set boolean option to 'off' (for example: -nossl)
      -all: connect to all servers defined in configuration
     -open: connect to all opened servers that are not currently connected
   -nojoin: do not join any channel (even if autojoin is enabled on server)
   -switch: switch to next server address

Examples:
  /connect freenode
  /connect irc.oftc.net/6667
  /connect irc6.oftc.net/6667 -ipv6
  /connect irc6.oftc.net/6697 -ipv6 -ssl
  /connect my.server.org/6697 -ssl -password=test
  /connect -switch
........................................

[command]*`ctcp`* send a CTCP message (Client-To-Client Protocol)::
........................................
/ctcp  <target> <type> [<arguments>]

 target: nick or channel to send CTCP to
   type: CTCP type (examples: "version", "ping", ..)
arguments: arguments for CTCP
........................................

[command]*`cycle`* leave and rejoin a channel::
........................................
/cycle  [<channel>[,<channel>...]] [<message>]

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

[command]*`dcc`* start a DCC (file transfer or direct chat)::
........................................
/dcc  chat <nick>
      send <nick> <file>

nick: nick for chat or file
file: filename (on local host)

Examples:
  chat with nick "toto":
    /dcc chat toto
  send file "/home/foo/bar.txt" to nick "toto":
    /dcc send toto /home/foo/bar.txt
........................................

[command]*`dehalfop`* remove channel half-operator status from nick(s)::
........................................
/dehalfop  <nick> [<nick>...]
........................................

[command]*`deop`* remove channel operator status from nick(s)::
........................................
/deop  <nick> [<nick>...]
........................................

[command]*`devoice`* remove voice from nick(s)::
........................................
/devoice  <nick> [<nick>...]
........................................

[command]*`die`* shutdown the server::
........................................
........................................

[command]*`disconnect`* disconnect from IRC server(s)::
........................................
/disconnect  <server> [<server>...]
             -all

server: server name to disconnect
  -all: disconnect from all servers
........................................

[command]*`halfop`* give channel half-operator status to nick(s)::
........................................
/halfop  <nick> [<nick>...]
........................................

[command]*`ignore`* ignore nicks/hosts from servers or channels::
........................................
/ignore  list
         add [re:]<nick> [<server> [<channel>]]
         del <number>|-all

     list: list all ignores
      add: add an ignore
     nick: nick or hostname (can be regular expression if "re:" is given or a mask using "*" to replace one or more chars)
      del: delete an ignore
   number: number of ignore to delete (look at list to find it)
     -all: delete all ignores
   server: internal server name where ignore is working
  channel: channel name where ignore is working

Examples:
  ignore nick "toto" everywhere:
    /ignore add toto
  ignore host "toto@domain.com" on freenode server:
    /ignore add toto@domain.com freenode
  ignore host "toto*@*.domain.com" on freenode/#weechat:
    /ignore add toto*@*.domain.com freenode #weechat
........................................

[command]*`info`* get information describing the server::
........................................
/info  [<target>]

target: server name
........................................

[command]*`invite`* invite a nick on a channel::
........................................
/invite  <nick> <channel>

   nick: nick to invite
channel: channel to invite
........................................

[command]*`ison`* check if a nick is currently on IRC::
........................................
/ison  <nick> [<nick>...]

nick: nick
........................................

[command]*`join`* join a channel::
........................................
/join  [-server <server>] [<channel1>[,<channel2>...]] [<key1>[,<key2>...]]

 server: send to this server (internal name)
channel: channel name to join
    key: key to join the channel (channels with a key must be the first in list)

Examples:
  /join #weechat
  /join #protectedchan,#weechat key
  /join -server freenode #weechat
........................................

[command]*`kick`* forcibly remove a user from a channel::
........................................
/kick  [<channel>] <nick> [<reason>]

channel: channel where user is
   nick: nick to kick
 reason: reason for kick
........................................

[command]*`kickban`* kicks and bans a nick from a channel::
........................................
/kickban  [<channel>] <nick> [<reason>]

channel: channel where user is
   nick: nick to kick and ban
 reason: reason for kick

It is possible to kick/ban with a mask, nick will be extracted from mask and replaced by "*".

Example:
  ban "*!*@host.com" and then kick "toto":
    /kickban toto!*@host.com
........................................

[command]*`kill`* close client-server connection::
........................................
/kill  <nick> <reason>

  nick: nick to kill
reason: reason for kill
........................................

[command]*`links`* list all servernames which are known by the server answering the query::
........................................
/links  [[<server>] <server_mask>]

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

[command]*`list`* list channels and their topic::
........................................
/list  [<channel>[,<channel>...]] [<server>] [-re <regex>]

channel: channel to list
 server: server name
  regex: regular expression used to filter results

Examples:
  list all channels on server (can be very slow on large networks):
    /list
  list channel #weechat:
    /list #weechat
  list all channels beginning with "#weechat" (can be very slow on large networks):
    /list -re #weechat.*
........................................

[command]*`lusers`* get statistics about the size of the IRC network::
........................................
/lusers  [<mask> [<target>]]

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

[command]*`map`* show a graphical map of the IRC network::
........................................
........................................

[command]*`me`* send a CTCP action to the current channel::
........................................
/me  <message>

message: message to send
........................................

[command]*`mode`* change channel or user mode::
........................................
/mode  [<channel>] [+|-]o|p|s|i|t|n|b|v [<arguments>]
       <nick> [+|-]i|w|s|o

channel modes:
  channel: channel name to modify (default is current one)
  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:
  nick: nick to modify
  i: mark a user as invisible
  s: mark a user for receive server notices
  w: user receives wallops
  o: operator flag

List of modes is not comprehensive, you should read documentation about your server to see all possible modes.

Examples:
  protect topic on channel #weechat:
    /mode #weechat +t
  become invisible on server:
    /mode nick +i
........................................

[command]*`motd`* get the "Message Of The Day"::
........................................
/motd  [<target>]

target: server name
........................................

[command]*`msg`* send message to a nick or channel::
........................................
/msg  [-server <server>] <target>[,<target>...] <text>

server: send to this server (internal name)
target: nick or channel (may be mask, '*' = current channel)
  text: text to send
........................................

[command]*`names`* list nicks on channels::
........................................
/names  [<channel>[,<channel>...]]

channel: channel name
........................................

[command]*`nick`* change current nick::
........................................
/nick  [-all] <nick>

-all: set new nick for all connected servers
nick: new nick
........................................

[command]*`notice`* send notice message to user::
........................................
/notice  [-server <server>] <target> <text>

server: send to this server (internal name)
target: nick or channel
  text: text to send
........................................

[command]*`notify`* add a notification for presence or away status of nicks on servers::
........................................
/notify  add <nick> [<server> [-away]]
         del <nick>|-all [<server>]

   add: add a notification
  nick: nick
server: internal server name (by default current server)
 -away: notify when away message is changed (by doing whois on nick)
   del: delete a notification
  -all: delete all notifications

Without argument, this command displays notifications for current server (or all servers if command is issued on core buffer).

Examples:
  notify when "toto" joins/quits current server:
    /notify add toto
  notify when "toto" joins/quits freenode server:
    /notify add toto freenode
  notify when "toto" is away or back on freenode server:
    /notify add toto freenode -away
........................................

[command]*`op`* give channel operator status to nick(s)::
........................................
/op  <nick> [<nick>...]
........................................

[command]*`oper`* get operator privileges::
........................................
/oper  <user> <password>

    user: user
password: password
........................................

[command]*`part`* leave a channel::
........................................
/part  [<channel>[,<channel>...]] [<message>]

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

[command]*`ping`* send a ping to server::
........................................
/ping  <server1> [<server2>]

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

[command]*`pong`* answer to a ping message::
........................................
/pong  <daemon> [<daemon2>]

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

[command]*`query`* send a private message to a nick::
........................................
/query  [-server <server>] <nick> [<text>]

server: send to this server (internal name)
  nick: nick for private conversation
  text: text to send
........................................

[command]*`quote`* send raw data to server without parsing::
........................................
/quote  [-server <server>] <data>

server: send to this server (internal name)
  data: raw data to send
........................................

[command]*`reconnect`* reconnect to server(s)::
........................................
/reconnect  <server> [<server>...] [-nojoin] [-switch]
            -all [-nojoin] [-switch]

 server: server name to reconnect
   -all: reconnect to all servers
-nojoin: do not join any channel (even if autojoin is enabled on server)
-switch: switch to next server address
........................................

[command]*`rehash`* tell the server to reload its config file::
........................................
/rehash  [<option>]

option: extra option, for some servers
........................................

[command]*`restart`* tell the server to restart itself::
........................................
........................................

[command]*`sajoin`* force a user to join channel(s)::
........................................
/sajoin  <nick> <channel>[,<channel>...]

   nick: nick
channel: channel name
........................................

[command]*`samode`* change mode on channel, without having operator status::
........................................
/samode  <channel> <mode>

channel: channel name
   mode: mode for channel
........................................

[command]*`sanick`* force a user to use another nick::
........................................
/sanick  <nick> <new_nick>

    nick: nick
new_nick: new nick
........................................

[command]*`sapart`* force a user to leave channel(s)::
........................................
/sapart  <nick> <channel>[,<channel>...]

   nick: nick
channel: channel name
........................................

[command]*`saquit`* force a user to quit server with a reason::
........................................
/saquit  <nick> <reason>

  nick: nick
reason: reason
........................................

[command]*`server`* list, add or remove IRC servers::
........................................
/server  list|listfull [<server>]
         add <server> <hostname>[/<port>] [-temp] [-<option>[=<value>]] [-no<option>]
         copy|rename <server> <new_name>
         del|keep <server>
         deloutq|jump|raw

    list: list servers (without argument, this list is displayed)
listfull: list servers with detailed info for each server
     add: create a new server
  server: server name, for internal and display use
hostname: name or IP address of server, with optional port (default: 6667), many addresses can be separated by a comma
    temp: create temporary server (not saved)
  option: set option for server (for boolean option, value can be omitted)
nooption: set boolean option to 'off' (for example: -nossl)
    copy: duplicate a server
  rename: rename a server
    keep: keep server in config file (for temporary servers only)
     del: delete a server
 deloutq: delete messages out queue for all servers (all messages WeeChat is currently sending)
    jump: jump to server buffer
     raw: open buffer with raw IRC data

Examples:
  /server listfull
  /server add oftc irc.oftc.net/6697 -ssl -autoconnect
  /server add oftc6 irc6.oftc.net/6697 -ipv6 -ssl
  /server add freenode2 chat.eu.freenode.net/6667,chat.us.freenode.net/6667
  /server add freenode3 irc.freenode.net -password=mypass
  /server copy oftc oftcbis
  /server rename oftc newoftc
  /server del freenode
  /server deloutq
........................................

[command]*`service`* register a new service::
........................................
/service  <nick> <reserved> <distribution> <type> <reserved> <info>

distribution: visibility of service
        type: reserved for future usage
........................................

[command]*`servlist`* list services currently connected to the network::
........................................
/servlist  [<mask> [<type>]]

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

[command]*`squery`* deliver a message to a service::
........................................
/squery  <service> <text>

service: name of service
   text: text to send
........................................

[command]*`squit`* disconnect server links::
........................................
/squit  <server> <comment>

 server: server name
comment: comment for quit
........................................

[command]*`stats`* query statistics about server::
........................................
/stats  [<query> [<server>]]

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

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

   user: username
 target: server name
channel: channel name
........................................

[command]*`time`* query local time from server::
........................................
/time  [<target>]

target: query time from specified server
........................................

[command]*`topic`* get/set channel topic::
........................................
/topic  [<channel>] [<topic>|-delete]

channel: channel name
  topic: new topic for channel
-delete: delete channel topic
........................................

[command]*`trace`* find the route to specific server::
........................................
/trace  [<target>]

target: server
........................................

[command]*`unban`* unban nicks or hosts::
........................................
/unban  [<channel>] <nick> [<nick>...]

channel: channel for unban
   nick: user or host to unban
........................................

[command]*`userhost`* return a list of information about nicks::
........................................
/userhost  <nick> [<nick>...]

nick: nick
........................................

[command]*`users`* list of users logged into the server::
........................................
/users  [<target>]

target: server
........................................

[command]*`version`* give the version info of nick or server (current or specified)::
........................................
/version  [<server>|<nick>]

server: server name
  nick: nick
........................................

[command]*`voice`* give voice to nick(s)::
........................................
/voice  <nick> [<nick>...]
........................................

[command]*`wallchops`* send a notice to channel ops::
........................................
/wallchops  [<channel>] <text>

channel: channel name
   text: text to send
........................................

[command]*`wallops`* send a message to all currently connected users who have set the 'w' user mode for themselves::
........................................
/wallops  <text>

text: text to send
........................................

[command]*`who`* generate a query which returns a list of information::
........................................
/who  [<mask> [o]]

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

[command]*`whois`* query information about user(s)::
........................................
/whois  [<server>] <nick>[,<nick>...]

server: server name
  nick: nick (may be a mask)
........................................

[command]*`whowas`* ask for information about a nick which no longer exists::
........................................
/whowas  <nick>[,<nick>...] [<count> [<target>]]

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