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