Scripting Commands » History » Version 158
Per Amundsen, 01/13/2017 08:27 PM
1 | 73 | Per Amundsen | {{>toc}} |
---|---|---|---|
2 | |||
3 | 1 | Per Amundsen | h1. Scripting Commands |
4 | |||
5 | 2 | Per Amundsen | Parameters in [x] means they are optional. |
6 | Parameters in <x> means they are required. |
||
7 | Parameters with a x|y means either x or y can be used. |
||
8 | |||
9 | 3 | Per Amundsen | Click on a command to read more about it. |
10 | |||
11 | 154 | Per Amundsen | _Commands in bold is AdiIRC only._ |
12 | 27 | Per Amundsen | |
13 | 123 | Per Amundsen | | [[/abook]] |
14 | *[[/aclear]]* |
||
15 | 1 | Per Amundsen | [[/action]] |
16 | 27 | Per Amundsen | *[[/advertise]]* |
17 | 1 | Per Amundsen | [[/ajinvite]] |
18 | [[/alias]] |
||
19 | [[/aline]] |
||
20 | [[/amark]] |
||
21 | [[/ame]] |
||
22 | [[/amsg]] |
||
23 | 84 | Per Amundsen | *[[/allnick]]* |
24 | 1 | Per Amundsen | [[/anick]] |
25 | 74 | Per Amundsen | [[/auser]] |
26 | 136 | Per Amundsen | *[[/autoconnect]]* |
27 | 53 | Per Amundsen | [[/autojoin]] |
28 | 27 | Per Amundsen | *[[/aquit]]* |
29 | 1 | Per Amundsen | [[/away]] |
30 | 27 | Per Amundsen | *[[/back]]* |
31 | 1 | Per Amundsen | [[/background]] |
32 | [[/ban]] |
||
33 | 27 | Per Amundsen | *[[/banlist]]* |
34 | 1 | Per Amundsen | [[/bcopy]] |
35 | [[/beep]] |
||
36 | 27 | Per Amundsen | *[[/betaup]]* |
37 | *[[/bin2txt]]* |
||
38 | 1 | Per Amundsen | [[/bindip]] |
39 | [[/bread]] |
||
40 | [[/break]] |
||
41 | [[/breplace]] |
||
42 | [[/bset]] |
||
43 | [[/btrunc]] |
||
44 | [[/bunset]] |
||
45 | 27 | Per Amundsen | *[[/bw]]* |
46 | 1 | Per Amundsen | [[/bwrite]] |
47 | [[/channel]] |
||
48 | 147 | Per Amundsen | *[[/channels]]* |
49 | 27 | Per Amundsen | *[[/charset]]* |
50 | 1 | Per Amundsen | [[/clear]] |
51 | [[/clearall]] |
||
52 | [[/cline]] |
||
53 | [[/clipboard]] |
||
54 | [[/close]] |
||
55 | 141 | Per Amundsen | [[/cnick]] |
56 | 1 | Per Amundsen | [[/color]] |
57 | [[/colour]] |
||
58 | 145 | Per Amundsen | | [[/comclose]] |
59 | [[/comlist]] |
||
60 | 123 | Per Amundsen | [[/comopen]] |
61 | 84 | Per Amundsen | [[/comreg]] |
62 | 74 | Per Amundsen | *[[/config]]* |
63 | 32 | Per Amundsen | [[/continue]] |
64 | 66 | Per Amundsen | [[/copy]] |
65 | 1 | Per Amundsen | [[/ctcp]] |
66 | [[/ctcps]] |
||
67 | 57 | Per Amundsen | [[/ctcpreply]] |
68 | 158 | Per Amundsen | *[[/cycleall]]* |
69 | 54 | Per Amundsen | [[/dcc]] |
70 | 52 | Per Amundsen | [[/dde]] |
71 | 41 | Per Amundsen | [[/ddeserver]] |
72 | [[/debug]] |
||
73 | 32 | Per Amundsen | [[/dec]] |
74 | 27 | Per Amundsen | *[[/dehalfop]]* |
75 | *[[/deop]]* |
||
76 | 1 | Per Amundsen | [[/describe]] |
77 | 27 | Per Amundsen | *[[/desop]]* |
78 | *[[/devoice]]* |
||
79 | 1 | Per Amundsen | [[/dialog]] |
80 | [[/did]] |
||
81 | [[/didtok]] |
||
82 | [[/disable]] |
||
83 | [[/disconnect]] |
||
84 | 94 | Per Amundsen | [[/dlevel]] |
85 | 1 | Per Amundsen | [[/dline]] |
86 | [[/dll]] |
||
87 | [[/dns]] |
||
88 | 27 | Per Amundsen | *[[/dock]]* |
89 | *[[/dockpanels]]* |
||
90 | 128 | Per Amundsen | *[[/download]]* |
91 | 1 | Per Amundsen | [[/drawcopy]] |
92 | [[/drawdot]] |
||
93 | [[/drawfill]] |
||
94 | [[/drawline]] |
||
95 | [[/drawpic]] |
||
96 | [[/drawrect]] |
||
97 | [[/drawreplace]] |
||
98 | [[/drawrot]] |
||
99 | [[/drawsave]] |
||
100 | [[/drawscroll]] |
||
101 | 141 | Per Amundsen | [[/drawtext]] |
102 | 136 | Per Amundsen | [[/ebeeps]] |
103 | 145 | Per Amundsen | | [[/echo]] |
104 | *[[/echomonitor]]* |
||
105 | 123 | Per Amundsen | *[[/echox]]* |
106 | 97 | Per Amundsen | *[[/edit]]* |
107 | 94 | Per Amundsen | [[/editbox]] |
108 | 84 | Per Amundsen | [[/else]] |
109 | 74 | Per Amundsen | [[/elseif]] |
110 | 88 | Per Amundsen | [[/emailaddr]] |
111 | 66 | Per Amundsen | [[/enable]] |
112 | 1 | Per Amundsen | *[[/encoding]]* |
113 | [[/events]] |
||
114 | [[/exit]] |
||
115 | 60 | Per Amundsen | *[[/fakeraw]]* |
116 | 57 | Per Amundsen | [[/fclose]] |
117 | 144 | Per Amundsen | *[[/fget]]* |
118 | 54 | Per Amundsen | [[/filter]] |
119 | 52 | Per Amundsen | [[/findtext]] |
120 | 50 | Per Amundsen | [[/flash]] |
121 | 1 | Per Amundsen | [[/flist]] |
122 | [[/flushini]] |
||
123 | 67 | Per Amundsen | [[/font]] |
124 | 124 | Per Amundsen | [[/fopen]] |
125 | 39 | Per Amundsen | [[/fseek]] |
126 | 144 | Per Amundsen | [[/fsend]] |
127 | 85 | Per Amundsen | [[/fullname]] |
128 | 45 | Per Amundsen | *[[/fullscreen]]* |
129 | 36 | Per Amundsen | [[/fwrite]] |
130 | 33 | Per Amundsen | *[[/gcmem]]* |
131 | 32 | Per Amundsen | *[[/google]]* |
132 | 23 | Per Amundsen | [[/goto]] |
133 | 143 | Per Amundsen | [[/groups]] |
134 | 77 | Per Amundsen | [[/guser]] |
135 | 1 | Per Amundsen | [[/hadd]] |
136 | 27 | Per Amundsen | *[[/halfop]]* |
137 | 1 | Per Amundsen | [[/halt]] |
138 | [[/haltdef]] |
||
139 | [[/hdec]] |
||
140 | [[/hdel]] |
||
141 | [[/help]] |
||
142 | 48 | Per Amundsen | [[/hfree]] |
143 | 1 | Per Amundsen | *[[/highlight]]* |
144 | [[/hinc]] |
||
145 | 144 | Per Amundsen | [[/hload]] |
146 | 143 | Per Amundsen | [[/hmake]] |
147 | 141 | Per Amundsen | [[/hop]] |
148 | 157 | Per Amundsen | | [[/hotlink]] |
149 | [[/hsave]] |
||
150 | 145 | Per Amundsen | [[/ialmark]] |
151 | 1 | Per Amundsen | [[/identd]] |
152 | 128 | Per Amundsen | *[[/icon]]* |
153 | 140 | Per Amundsen | [[/if]] |
154 | 124 | Per Amundsen | [[/ignore]] |
155 | 123 | Per Amundsen | [[/iline]] |
156 | 122 | Per Amundsen | [[/inc]] |
157 | 141 | Per Amundsen | *[[/inick]]* |
158 | 96 | Per Amundsen | [[/invite]] |
159 | 94 | Per Amundsen | [[/iuser]] |
160 | 89 | Per Amundsen | [[/join]] |
161 | 88 | Per Amundsen | [[/kick]] |
162 | 85 | Per Amundsen | [[/kill]] |
163 | 84 | Per Amundsen | *[[/lag]]* |
164 | 126 | Per Amundsen | [[/leave]] |
165 | 149 | Per Amundsen | *[[/linemarker]]* |
166 | 78 | Per Amundsen | [[/linesep]] |
167 | 77 | Per Amundsen | [[/list]] |
168 | 74 | Per Amundsen | [[/load]] |
169 | 67 | Per Amundsen | [[/loadbuf]] |
170 | 66 | Per Amundsen | *[[/lock]]* |
171 | 130 | Per Amundsen | [[/log]] |
172 | 1 | Per Amundsen | *[[/logs]]* |
173 | [[/logview]] |
||
174 | [[/markall]] |
||
175 | 69 | Per Amundsen | [[/mdi]] |
176 | 57 | Per Amundsen | [[/me]] |
177 | 1 | Per Amundsen | [[/menubar]] |
178 | [[/mkdir]] |
||
179 | 85 | Per Amundsen | [[/mnick]] |
180 | 52 | Per Amundsen | [[/mode]] |
181 | 50 | Per Amundsen | [[/msg]] |
182 | 95 | Per Amundsen | *[[/msgbox]]* |
183 | 1 | Per Amundsen | *[[/mute]]* |
184 | *[[/nextunread]]* |
||
185 | [[/nick]] |
||
186 | 64 | Per Amundsen | [[/nickcolumn]] |
187 | 1 | Per Amundsen | [[/nicklist]] |
188 | [[/nickcolor]] |
||
189 | 39 | Per Amundsen | *[[/nmsg]]* |
190 | 144 | Per Amundsen | [[/noop]] |
191 | 1 | Per Amundsen | [[/notice]] |
192 | [[/notify]] |
||
193 | 157 | Per Amundsen | | *[[/np]]* |
194 | *[[/oline]]* |
||
195 | 149 | Per Amundsen | [[/omsg]] |
196 | 145 | Per Amundsen | [[/onotice]] |
197 | 132 | Per Amundsen | [[/op]] |
198 | 130 | Per Amundsen | *[[/options]]* |
199 | 128 | Per Amundsen | [[/parseline]] |
200 | 126 | Per Amundsen | [[/part]] |
201 | 125 | Per Amundsen | [[/partall]] |
202 | 123 | Per Amundsen | *[[/paths]]* |
203 | 122 | Per Amundsen | [[/perform]] |
204 | 121 | Per Amundsen | *[[/pgoogle]]* |
205 | 118 | Per Amundsen | *[[/plugins]]* |
206 | 99 | Per Amundsen | *[[/priv]]* |
207 | 137 | Per Amundsen | [[/proxy]] |
208 | 96 | Per Amundsen | [[/query]] |
209 | 95 | Per Amundsen | [[/queryrn]] |
210 | 94 | Per Amundsen | *[[/quickconnect]]* |
211 | 89 | Per Amundsen | *[[/quicksave]]* |
212 | 88 | Per Amundsen | [[/quit]] |
213 | 1 | Per Amundsen | [[/quote]] |
214 | 85 | Per Amundsen | [[/raw]] |
215 | 84 | Per Amundsen | *[[/rawx]]* |
216 | *[[/rawlog]]* |
||
217 | 85 | Per Amundsen | *[[/realname]]* |
218 | 77 | Per Amundsen | *[[/reconnect]]* |
219 | 74 | Per Amundsen | *[[/rejoin]]* |
220 | 69 | Per Amundsen | [[/reload]] |
221 | 67 | Per Amundsen | [[/remini]] |
222 | 66 | Per Amundsen | [[/remote]] |
223 | 1 | Per Amundsen | [[/remove]] |
224 | [[/rename]] |
||
225 | [[/renwin]] |
||
226 | [[/reseterror]] |
||
227 | 82 | Per Amundsen | [[/resetidle]] |
228 | 1 | Per Amundsen | *[[/resolve]]* |
229 | 57 | Per Amundsen | *[[/restart]]* |
230 | 54 | Per Amundsen | [[/return]] |
231 | 1 | Per Amundsen | [[/returnex]] |
232 | 79 | Per Amundsen | [[/rlevel]] |
233 | 144 | Per Amundsen | [[/rline]] |
234 | 1 | Per Amundsen | [[/rmdir]] |
235 | [[/run]] |
||
236 | [[/ruser]] |
||
237 | 140 | Per Amundsen | [[/say]] |
238 | 157 | Per Amundsen | |^. [[/savebuf]] |
239 | [[/saveini]] |
||
240 | 149 | Per Amundsen | [[/scid]] |
241 | 145 | Per Amundsen | [[/scon]] |
242 | 132 | Per Amundsen | *[[/scripts]]* |
243 | 130 | Per Amundsen | *[[/search]]* |
244 | 128 | Per Amundsen | [[/server]] |
245 | 126 | Per Amundsen | *[[/serverlist]]* |
246 | 124 | Per Amundsen | [[/set]] |
247 | 123 | Per Amundsen | *[[/setconfig]]* |
248 | 122 | Per Amundsen | [[/setlayer]] |
249 | 123 | Per Amundsen | *[[/setoption]]* |
250 | *[[/showadiirc]]* |
||
251 | 148 | Per Amundsen | *[[/showmenu]]* |
252 | 98 | Per Amundsen | [[/showmirc]] |
253 | 96 | Per Amundsen | [[/signal]] |
254 | 95 | Per Amundsen | *[[/slap]]* |
255 | 94 | Per Amundsen | *[[/sleep]]* |
256 | 89 | Per Amundsen | [[/sline]] |
257 | 88 | Per Amundsen | [[/sockaccept]] |
258 | 1 | Per Amundsen | [[/sockclose]] |
259 | [[/socklist]] |
||
260 | 85 | Per Amundsen | [[/socklisten]] |
261 | 84 | Per Amundsen | [[/sockmark]] |
262 | 82 | Per Amundsen | [[/sockopen]] |
263 | 80 | Per Amundsen | [[/sockpause]] |
264 | 79 | Per Amundsen | [[/sockread]] |
265 | 77 | Per Amundsen | [[/sockrename]] |
266 | 1 | Per Amundsen | [[/sockudp]] |
267 | [[/sockwrite]] |
||
268 | *[[/sop]]* |
||
269 | 69 | Per Amundsen | [[/splay]] |
270 | 1 | Per Amundsen | *[[/statusbar]]* |
271 | 66 | Per Amundsen | [[/switchbar]] |
272 | 1 | Per Amundsen | *[[/tab]]* |
273 | 63 | Per Amundsen | *[[/themes]]* |
274 | 1 | Per Amundsen | [[/time]] |
275 | [[/timestamp]] |
||
276 | [[/timer]] |
||
277 | [[/tip]] |
||
278 | 143 | Per Amundsen | [[/tips]] |
279 | 1 | Per Amundsen | [[/titlebar]] |
280 | 141 | Per Amundsen | [[/tokenize]] |
281 | 140 | Per Amundsen | [[/toolbar]] |
282 | 139 | Per Amundsen | [[/topic]] |
283 | 157 | Per Amundsen | |^. *[[/topicbox]]* |
284 | [[/treebar]] |
||
285 | 149 | Per Amundsen | [[/ulist]] |
286 | 148 | Per Amundsen | *[[/usernick]]* |
287 | 145 | Per Amundsen | *[[/txt2bin]]* |
288 | 128 | Per Amundsen | *[[/unban]]* |
289 | 127 | Per Amundsen | *[[/unignore]]* |
290 | 126 | Per Amundsen | [[/unload]] |
291 | 124 | Per Amundsen | *[[/unnotify]]* |
292 | 123 | Per Amundsen | [[/unset]] |
293 | 122 | Per Amundsen | [[/unsetall]] |
294 | *[[/update]]* |
||
295 | 135 | Per Amundsen | [[/updatenl]] |
296 | 129 | Per Amundsen | [[/url]] |
297 | 123 | Per Amundsen | [[/uwho]] |
298 | 118 | Per Amundsen | [[/var]] |
299 | 98 | Per Amundsen | *[[/vars]]* |
300 | 96 | Per Amundsen | *[[/viewlog]]* |
301 | 95 | Per Amundsen | *[[/voice]]* |
302 | 94 | Per Amundsen | [[/vol]] |
303 | 91 | Per Amundsen | *[[/wdown]]* |
304 | 90 | Per Amundsen | [[/while]] |
305 | 89 | Per Amundsen | [[/window]] |
306 | 88 | Per Amundsen | *[[/wjump]]* |
307 | 87 | Per Amundsen | *[[/wnext]]* |
308 | 1 | Per Amundsen | *[[/wpause]]* |
309 | *[[/wplay]]* |
||
310 | 85 | Per Amundsen | *[[/wprev]]* |
311 | 84 | Per Amundsen | [[/write]] |
312 | 82 | Per Amundsen | [[/writeini]] |
313 | 81 | Per Amundsen | *[[/wsearch]]* |
314 | 80 | Per Amundsen | *[[/wseekf]]* |
315 | 79 | Per Amundsen | *[[/wseekr]]* |
316 | 78 | Per Amundsen | *[[/wselect]]* |
317 | 77 | Per Amundsen | *[[/wstop]]* |
318 | 76 | Per Amundsen | *[[/wup]]* |
319 | 16 | Per Amundsen | | |
320 | 1 | Per Amundsen | |
321 | 150 | Per Amundsen | h2. System information Commands |
322 | 117 | Per Amundsen | |
323 | 142 | Per Amundsen | Output from these are set in [[Options_Dialog|Options]] -> [[Sysinfo Options|Sysinfo]] and are merely convenient aliases. |
324 | 16 | Per Amundsen | |
325 | /sysinfo |
||
326 | 1 | Per Amundsen | /gfxinfo |
327 | 31 | Per Amundsen | /cpuinfo |
328 | 1 | Per Amundsen | /meminfo |
329 | /diskinfo |
||
330 | /audioinfo |
||
331 | /uptime |
||
332 | /bw |
||
333 | |||
334 | 150 | Per Amundsen | h2. Missing Commands |
335 | 1 | Per Amundsen | |
336 | 138 | Per Amundsen | /aop |
337 | 1 | Per Amundsen | /avoice |
338 | /creq |
||
339 | /dccserver |
||
340 | /dqwindow |
||
341 | /firewall |
||
342 | /flood |
||
343 | /flush |
||
344 | /fserve |
||
345 | /ghide |
||
346 | /gload |
||
347 | /gopts |
||
348 | /gplay |
||
349 | /gpoint |
||
350 | /gqreq |
||
351 | /gshow |
||
352 | /gsize |
||
353 | /gstop |
||
354 | /gtalk |
||
355 | 119 | Per Amundsen | /gunload |
356 | 1 | Per Amundsen | /ial |
357 | /ialclear |
||
358 | 30 | Per Amundsen | /links |
359 | 1 | Per Amundsen | /localinfo |
360 | /pdcc |
||
361 | /play |
||
362 | /playctrl |
||
363 | /pop |
||
364 | /protect |
||
365 | /pvoice |
||
366 | /qme |
||
367 | /qmsg |
||
368 | /save |
||
369 | /sound |
||
370 | /speak |
||
371 | /sreq |
||
372 | /strip |
||
373 | /tnick |
||
374 | /tray |
||
375 | /vcadd |
||
376 | /vcmd |
||
377 | /vcrem |
||
378 | /winhelp |
||
379 | |||
380 | 150 | Per Amundsen | h2. Command prefixes |
381 | |||
382 | /! prefix will execute the internal command, even if there is a alias with the same name. |
||
383 | |||
384 | Example: |
||
385 | |||
386 | <pre> |
||
387 | ; Override the /me command, |
||
388 | alias me { |
||
389 | ; use the /! prefix to call the internal command. |
||
390 | /!me $1- |
||
391 | } |
||
392 | </pre> |
||
393 | |||
394 | /. prefix can be used to silence the output from many command. |
||
395 | |||
396 | Example: |
||
397 | |||
398 | <pre> |
||
399 | 155 | Per Amundsen | /.msg #channel This message will be hidden from your client, but still sent to the server. |
400 | 150 | Per Amundsen | </pre> |
401 | |||
402 | Both prefix's can be used at the same time. |
||
403 | |||
404 | Example: |
||
405 | |||
406 | <pre> |
||
407 | 155 | Per Amundsen | /!.msg #channel This message will be hidden from your client, but still sent to the server. |
408 | 150 | Per Amundsen | </pre> |
409 | |||
410 | h2. Evaluate identifiers from Editbox |
||
411 | 105 | Per Amundsen | |
412 | 156 | Per Amundsen | Typing a command in the Editbox with double slashes// will evaluate [[Scripting Identifiers|$identifiers]] in the line before running it. |
413 | 105 | Per Amundsen | E.g //echo -ag My nick is $me |
414 | |||
415 | 156 | Per Amundsen | You can also [[tabcomplete]] [[Scripting Identifiers|$identifiers]] manually using $me<tab>. |
416 | 107 | Per Amundsen | |
417 | 151 | Per Amundsen | h2. Creating a new command |
418 | 107 | Per Amundsen | |
419 | 112 | Per Amundsen | You can create a new command by opening the menu Tools -> Edit Aliases. |
420 | 107 | Per Amundsen | |
421 | 108 | Per Amundsen | The format for the command is <command> <script to execute>. |
422 | 107 | Per Amundsen | |
423 | *Example* |
||
424 | |||
425 | <pre> |
||
426 | 108 | Per Amundsen | ; Creates a new command '/p' which will evaluate and then execute the script '/part $chan'. |
427 | 1 | Per Amundsen | /p /part $chan |
428 | 108 | Per Amundsen | </pre> |
429 | |||
430 | 110 | Per Amundsen | You can also add a command from the script editor, the syntax there is alias <command> <script to execute> |
431 | 108 | Per Amundsen | |
432 | *Example* |
||
433 | |||
434 | <pre> |
||
435 | ; Creates a new command '/p' which will evaluate and then execute the script '/part $chan'. |
||
436 | ; Same as previous example. |
||
437 | alias p /part $chan |
||
438 | </pre> |
||
439 | |||
440 | 111 | Per Amundsen | If you want to use scripts with multiple lines, you can enclose them with {} brackets in both Edit Aliases and Script Editor. |
441 | 108 | Per Amundsen | |
442 | *Example* |
||
443 | <pre> |
||
444 | ; Edit Aliases |
||
445 | 109 | Per Amundsen | /p { |
446 | 108 | Per Amundsen | /echo -ag I am parting $chan |
447 | /part $chan |
||
448 | } |
||
449 | |||
450 | ; Script editor |
||
451 | alias p { |
||
452 | /echo -ag I am parting $chan |
||
453 | /part $chan |
||
454 | } |
||
455 | </pre> |
||
456 | |||
457 | Almost all built-in commands can be overridden to execute your own script. |
||
458 | |||
459 | *Example* |
||
460 | |||
461 | <pre> |
||
462 | ; Create your own /part command |
||
463 | alias part { |
||
464 | /echo -ag I am parting $chan |
||
465 | raw PART $chan |
||
466 | } |
||
467 | |||
468 | 114 | Per Amundsen | ; Create your own /part command, but execute the built-in /part command after executing your own script. |
469 | 108 | Per Amundsen | alias part { |
470 | /echo -ag I am parting $chan |
||
471 | |||
472 | ; Execute the built-in part command |
||
473 | !part $chan |
||
474 | } |
||
475 | 107 | Per Amundsen | </pre> |
476 | 113 | Per Amundsen | |
477 | A command can also be called as a $identifier. |
||
478 | |||
479 | *Example* |
||
480 | |||
481 | <pre> |
||
482 | ; Create a command. |
||
483 | alias mycommand { |
||
484 | 115 | Per Amundsen | echo -ag I was called as a $iif($isid,identifier,command) |
485 | 113 | Per Amundsen | } |
486 | |||
487 | ; Call the command as identifier. |
||
488 | //noop $mycommand |
||
489 | |||
490 | 116 | Per Amundsen | ; Call the command as a command. |
491 | 113 | Per Amundsen | /mycommand |
492 | </pre> |