Xirc Scripting Reference
Introduction
Functions Events

Commands

 

ACTIVATE
Renders a channel/console the current context in the main window
ADMIN
Requests the admin info from a server
ALIAS
Adds e new alias or modifies an existing one
ALLCHAN
Sends a message to all joined channels
ALLSERV
Sends a command to all servers where you are connected
AWAY
Marks you in 'away' state
BACK
Allows you to return from being away
BAN
Add a ban mask for the channel
BEEP
Plays the system beep
BREAK
Interrupts an iteration loop (for, foreach, while)
BYE
Closes the current connection or the applicatio (see QUIT)
CHAN.LOGCLOSE
Stops logging for the specified channel (Plugin Channel)
CHAN.LOGOPEN
Starts logging for the specified channel (Plugin Channel)
CHAN.SHEET
Opens chan attributes sheet for the specified channel (Plugin Channel)
CLEAR
Clear the current context (console, channel, DCC Chat)
CONFIG.CLEAR
Clears a config file (Plugin Config)
CONFIG.CLEARSECTION
Clears a section in a config file (Plugin Config)
CONFIG.CLOSE
Closes a config file (Plugin Config)
CONFIG.FLUSH
Flushes a config file (Plugin Config)
CONFIG.SETSECTION
Changes the current section of a config file (Plugin Config)
CONFIG.WRITE
Writes value and key pair to a config file (Plugin Config)
CTCP
Sends a CTCP message
CYCLE
Parts current channel and immeditaely rejoins
DCC.AUDIOSTREAM
Starts a DCC Audiostream connection
DCC.CHAT
Starts a DCC Chat connection
DCC.CHATPANEL
Shows the shared DCC Chat panel
DCC.GET
Sends DCC file request
DCC.RSEND
Sends a file using the DCC Reverse Send subprotocol
DCC.SEND
Sends a file using the DCC protocol
DCC.SENDPANEL
Shows the shared DCC Send panel
DEFMENU
Define a new cotextual menu or remove an exsiting one
DEHOP
Removes channel half-op status (-h) to the specified user
DEOP
Removes channel operator status (-o) for the specified user
DEVOICE
Removed the voice flag (-v) for the specified user
DIE
Sends DIE command to the server
ECHO
Outputs a text to a Xirc context/window
EMAIL
Sends an email message using message.framework
EVAL
Evaluates an expression, command and function
EVENT
Adds a new event handler or remove an existing one
EVENTEXE
Executes an event handler for debugging purposes
EXECAS
Executes the given AppleScript script
EXTPROC
Creates and Launch a subprocess
FOR
Executes an iteration
FOREACH
Executes an iteration
GROWL.NOTIFY
Sends a 'growl' notification to the user (Plugin Growl)
HALT
Stops the execution of the current script
HASH
Sends the HASH command to the current server
HELP
Shows help for the given command/function/plugin
HISTORY
Returns the history entry at index
HOP
Gives channel half-op status (+h) to the specified user
HOST
DNS lookup
IDENT.START
Starts the Xirc internal ident deamon
IDENT.STOP
Stops the Xirc internal ident deamon
IF
Flow control command
IGNORE
Ignores the specified user
INFO
Requests the server deamon info from a server
INVITE
Invites an user to a channel
ISON
Sends ISON command to a server
JOIN
Joins the specified channels
KICK
Kicks an user from a channel
KILL
Sends the KILL command to a server
KILLTIMER
Invalidates and stops a timer (see TIMER)
LEAVE
Alias for PART command
LOADAS
Loads and executes an AppleScript script
LUSERS
Requests statics about users on IRC
ME
Sends a CTCP ACTION
MODE
Sends a MODE irc command
MOTD
Requests and shows the Message Of Day
MSG
Alias for PRIVMSG command
NICK
Changes your nickname
NOTICE
Sends a private notice
NOTIFY
Adds a user notification to the Notify Manager
OMSG
Sends a private message to all channel operator
ONOTICE
Sends a notice to all channel operator
OP
Gives the channel operator status (+o) to the given users
OPENURL
Opens the specified URL in the default browser
OPER
Requests IRC operator status
PANEL.TEXTINPUT
Opens a dialog that accepts user input as text (Plugin Panel)
PANEL.MESSAGE
Shows a message box (Plugin Panel)
PARSE
Loads and executes a script from a file
PART
Leaves the specified channels
PERL.BEGIN
Starts a perl code snippet (Plugin Perl)
PERL.DESTROY
Destroys a perl execution context (Plugin Perl)
PERL.END
Ends a perl code snippet (Plugin Perl)
POPUP
Shows the specified contextual menu
PRIVMSG
Sends a message to the specified users or subprocess
QUERY
Opens one or more query context
QUIT
Terminates the current IRC connection or the entire application
QUOTE
Sends raw to the current IRC connection
REBIND
Rebinds the command sequence to a specified context/window
RETURN
Returns from the current command sequence and sets it ret. value
SAY
Sends a message in the current context
SERVER
Connects to the specified server
SERVER.LOGCLOSE
Stops logging for the specified server (Plugin Server)
SERVER.LOGOPEN
Starts logging for the specified server (Plugin Server)
SETRETURN
Sets the return value of the current command sequence
SLEEP
Blocks the command execution for the specified seconds
SQUIT
Disconnects a server socket (ircops only)
STATS
Requests the stats info from a server
SWITCH
Flow control command
TIME
Requests the current local time info from a server
TIMER
Starts a timer
TOPIC
Changes topic for the specified channel
TRACE
Requests trace info about a specified machine in the network
UNBAN
Removes ban masks for the channel
UNLOADS
Un loads a previously loaded AppleScript script
VERSION
Requests the version of a server
VOICE
Sets the voice flag (+v) for the given users
WAIT
Executes the callback_command immediately after receiving output
from the server of the previous command
WALLOPS
Sends WALLOPS message (ircops only)
WHILE
Iteration command
WHO
Requests WHO information (WHO server command)
WHOIS
Requests user information (WHOIS server command)
WHOWAS
Requests user information (WHOWAS server command)


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