Xirc Scripting Reference
Introduction
Functions Events

Commands

ACTIVATE

activate [-q] <window_id>

Description forthcoming


ADMIN

admin [<server>]

Description forthcoming


ALIAS

alias [-t] (<alias_name>)
{
    <implementation>
}

Description forthcoming


ALLCHAN

allchan <cmd>[;<cmd>...]

Description forthcoming


ALLSERV

allserv <cmd>[;<cmd>...]

Description forthcoming


AWAY

away [-time] [-notify] [<reason>]

Description forthcoming


BACK

back

Description forthcoming


BAN

ban <mask>[,<mask> ...]

Description forthcoming


BEEP

beep

Description forthcoming


BREAK

break

Description forthcoming


BYE

bye [-q] [-f] [<reason>]

Description forthcoming


CHAN.LOGCLOSE

chan.logclose <channel id>

Description forthcoming


CHAN.LOGOPEN

chan.logopen <channel id>

Description forthcoming


CHAN.SHEET

chan.sheet <channel id>

Description forthcoming


CLEAR

clear [-h] [<cid>]

Description forthcoming


CONFIG.CLEAR

config.clear <id>

Description forthcoming


CONFIG.CLEARSECTION

config.clearsection <id> <section name>

Description forthcoming


CONFIG.CLOSE

config.close [-q] <id>

Description forthcoming


CONFIG.FLUSH

config.flush [-q] <id>

Description forthcoming


CONFIG.SETSECTION

config.setsection <id> <section name>

Description forthcoming


CONFIG.WRITE

config.write <id> <key> <value>

Description forthcoming


CYCLE

cycle

Description forthcoming


CTCP

ctcp <target> <cmd>

Description forthcoming


DCC.AUDIOSTREAM

dcc.audiostream [-n] [-c] [-w] [-b] [-g=<audio format>] [-i=<bind address>] [-p=<port>] [-a=<fake address>] [-f=<fake port>] <nickname>

Description forthcoming


DCC.CHAT

dcc.chat [-s] [-c] [-n] [-i=<bind address>] [-p=<port>] [-a=<fake address>] [-f=<fake port>] <nick>

Description forthcoming


DCC.CHATPANEL

dcc.chatpanel(<target>[,<context id>])
{
    <implementation>
}

Description forthcoming


DCC.GET

dcc.get [-s] [-t] <nick> <filename> [<filesize>]

Description forthcoming


DCC.RSEND

dcc.rsend [-s] [-t] <nick> <filename>

Description forthcoming


DCC.SEND

dcc.send [-s] [-g=<filesize>] [-c] [-n] [-i=<bind address>] [-p=<port>] [-a=<fake address>] [-f=<fake port>] <nick> <filepath>

Description forthcoming


DCC.SENDPANEL

dcc.sendpanel(<target>[,<directory>][,<context>])
{
    <implementation>
}

Description forthcoming


DEFMENU

defmenu [-t] (<menu name>)
{
    item(<name>)
    {
        action { <action commands> }
        validation { <validation commands> }
    }
    [separator]
    [submenu(<name>) { [item1()[,item2()] }]
}

Description forthcoming


DEHOP

dehop <nick>[,<nick>...]

Description forthcoming


DEOP

deop <nick>[,<nick>...]

Description forthcoming


DEVOICE

devoice <nick>[,<nick>...]

Description forthcoming


DIE

die

Description forthcoming


ECHO

echo <text>

Description forthcoming


EMAIL

email <recipient> <subject> [<body>]

Description forthcoming


EVAL

eval [-q] <commands>

Description forthcoming


EVENT

event [-t] (<event name>,<handler name>)
{
    <implementation>
}

Description forthcoming

EVENTEXE

eventexe [-u] [-e] [-d] <event name> <handler name> [<parameters>]

Description forthcoming


EXECAS

execas()
{
    <AppleScript source>
}

Description forthcoming


EXTPROC

extproc [-l|o|e|m=<nick>|n=<nick>|i=°<process id>|<shell commands>] [<arg list>]

Description forthcoming


FOR

for([initialization];<condition>;[operation])
{
    <command>
}

Description forthcoming


FOREACH

foreach(<variable>,[<item>[,<item>[,<item>[...]]])
{
    <command>
}

Description forthcoming


GROWL.NOTIFY

growl.notify [-s] <title> [<description> [<icon path]]

Description forthcoming


HALT

halt

Stop the execution of current script


HASH

hash

Description forthcoming


HELP

help [-p] [-f] [<command>]

Description forthcoming


HISTORY

history [<number>]

Description forthcoming


HOP

hop <nick>[,<nick>...]

Description forthcoming


HOST

host <hostname>

Description forthcoming


IDENT.START

ident.start

Description forthcoming


IDENT.STOP

ident.stop

Description forthcoming


IF

if (<condition>) <command1> [else <command2>]

Description forthcoming


IGNORE

ignore [-n] [-d] [-t=ALL|MSGS|PUBLIC|INVITES|NOTICES|CTCPS|CRAP|WALLS|NONE] [<nick_list>|<user@host_list>]

Description forthcoming


INFO

info [<server>]

Description forthcoming


INVITE

invite <nickname> [<channel>]

Description forthcoming


ISON

ison <nick> [<nick> ...]

Description forthcoming


JOIN

join <channel>[,<channel> ...] [<key>][,<key> ...]

Description forthcoming


KICK

kick <channel> <user> [<comment>]

Description forthcoming


KILLTIMER

killtimer <timer name>

Description forthcoming


LEAVE

leave [<channel>[,<channel> ...]]

Description forthcoming


LOADAS

loadas <applescript script path>

Description forthcoming


LUSERS

lusers [<mask> [<server>]]

Description forthcoming


ME

me <action description>

Description forthcoming


MODE

mode <channel>|<nick> [+|-<modechars>|<umodechars> [<parameters>]]

Description forthcoming


MOTD

motd

Description forthcoming


MSG

msg <nick_list>|°<process id> <message>

Description forthcoming


NICK

nick [<nickname>]

Description forthcoming


NOTICE

notice <target1>[,<target2> ...] <message>

Description forthcoming


NOTIFY

notify [-remove] <nickname> [<nickname> ...]

Description forthcoming


OMSG

omsg [<channel>] <message>

Description forthcoming


ONOTICE

onotice [<channel>] <message>

Description forthcoming


OP

op <nick>[,<nick> ...]

Description forthcoming


OPENURL

openurl <url>

Description forthcoming


OPER

oper <nick> <password>

Description forthcoming


PANEL.TEXTINPUT

panel.textinput(<caption>,<message>,<default value>[,<default button title>[,
<alternate button title>[,<other button title>[,<callback param1>[, ...]]]]])
{
    <implementation>
}

Description forthcoming


PANEL.MESSAGE

panel.message(<caption>,<message>[,<default button title>[,<alternate button title>[,<other button title>[,<callback param1>[, ...]]]]])
{
    <implementation>
}

Description forthcoming


PARSE

parse <filename> [<parameters>]

Description forthcoming


PART

part [<channel>[,<channel> ...]]

Description forthcoming


PERL.BEGIN

perl.begin [-n] [-q] [(<perl_context>[,<arg0>[,<arg1>[...]]])]
<perl code>
perl.end

Description forthcoming


PERL.DESTROY

perl.destroy [-q] <context_name>

Description forthcoming


PERL.END

perl.end

Ends a perl code snippet


POPUP

popup <menu name> [<parameter> [<parameter> ...]]

Description forthcoming


PRIVMSG

privmsg <target>[,<target> ...] <message>

Description forthcoming


QUERY

query <nick>[,<nick> ...] [<message>]

Description forthcoming


QUIT

quit [-q] [-f] [<reason>]

Description forthcoming


QUOTE

quote <raw command>

Description forthcoming


REBIND

rebind [-q] <context>

Description forthcoming


REDIRECT

redirect <nick|channel|°process id> <cmd>

Description forthcoming


RETURN

return <string>

Description forthcoming


REHASH

rehash

Description forthcoming


SAY

say <message>

Description forthcoming


SERVER

server [-nick=<nick>] [-realn=<realname>] [-pw=<password>] <server> [<port>]

Description forthcoming


SERVER.LOGCLOSE

server.logclose <server id>

Description forthcoming


SERVER.LOGOPEN

server.logopen <server id>

Description forthcoming


SETRETURN

setreturn <string>

Description forthcoming


SHAREDFILE.ADD

sharedfile.add [-t=<timeout>] [-n=<visible name>] <filename> [user_mask]

Description forthcoming


SLEEP

sleep <number of seconds>

Description forthcoming


SQUIT

squit <server> <comment>

Description forthcoming


STATS

stats [[c|h|k|i|l|m|u|y] [<server>]]

Description forthcoming


SWITCH

switch [-s] (<expression>)
{
    case(<value>)[:]<command>
    [break]
    match(<wildcard_expression>)[:]<command>
    [break]
    regexpr(<regular_expression>)[:]<command>
    [break]
    default[:]<command>
    [break]
}

Description forthcoming


TIME

time [<server>]

Description forthcoming


TIMER

timer(<name>,<delay in secs>,<repeat>[,<callback param1>[,<callback param2>[,...]]])
{
    <callback command>
}

Description forthcoming


TOPIC

topic <channel> [<topic>]

Description forthcoming


TRACE

trace <server>

Description forthcoming


UNBAN

unban <mask>[,<mask>[, ...]]

Description forthcoming


VERSION

version [<server>]

Description forthcoming


VOICE

voice <nick>[,<nick>[, ...]]

Description forthcoming


WAIT

wait([°<process id>]) { <command> }

Description forthcoming


WALLOPS

wallops <text>

Description forthcoming


WHILE

while(<condition>) { <commands> }

Description forthcoming


WHO

who [<mask>|<channel>] [-o]

Description forthcoming


WHOIS

whois [<server>] <nick>[,<nick>[, ...]]

Description forthcoming


WHOWAS

whowas <nick> [<count>]

Description forthcoming



© 2004-2005 Gian Luca Cannata. All Rights Reserved. (Last updated: 2005-03-02)