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