shroudBNC 1.2 TCL Commands

Commands and variables which have been implemented as part of the eggdrop emulation are not listed in this file. For a list of such commands you should read “tcl-commands.doc” (which is part of the eggdrop package) instead.

• Syntax: addbncuser <User> <Password>
• Description: Creates a new bouncer user. If the user already exists his password is modified.
• Returns: Nothing.

• Syntax: bnccheckpassword <User> <Password>
• Description: Checks whether a given password matches a specific user's password.
• Returns: 1 if the <Password> is correct, 0 otherwise.

• Syntax:
• Description: Returns a list of all bouncer accounts.
• Returns: A tcl list.

• Syntax: delbncuser <User>
• Description: Deletes a bouncer user.
• Returns: Nothing.

• Syntax: getbncuser <User> <Type> [Parameter]
• Description: Get a value from the user config.
• Returns: A tcl list.

• Syntax: setbncuser <User> <Type> [<Value>] [<Value2>]
• Description: Set a value in the user config.
• Returns: Nothing.

• Syntax: trafficstats <User> [<ConnectionType>] [<Type>]
• Description: Returns traffic statistics for the specified user. ConnectionType can be either server or client. Type can be in or out.
• Returns: The traffic (in bytes).

• Syntax: floodcontrol <Function>
• Description: Enables or disables the flood-protection for a user or returns status information about it.

Valid values for <Function>:

  bytes - returns the number of bytes in the user's queue.
  items - just like 'bytes', however it returns the number of items.
  on - enables the flood protection
  off - disables the flood protection

• Returns: 1 if successful, 0 otherwise, e.g. when <User> is not a valid user.

• Syntax: getusermodes
• Description: Returns the user's usermodes.
• Returns: A string.

• Syntax: hijacksocket
• Description: Converts a client object into a tcl socket idx. The socket is then owned by the tcl script. This function can only be used in a “client” internalbind. The line which the “client” bind was triggered for will be copied to the new socket buffer.
• Returns: A socket idx.

• Syntax: putclient <Text>
• Description: Sends <Text> to the client connection that is attached to a bouncer user.
• Returns: 1 if successful, 0 otherwise, e.g. when the current context is not valid or when the user is not logged in.

• Syntax: simul <User> <Command>
• Description: Simulates <Command> in the context of <User>. shroudBNC performs the <Command> as if the user has typed /<Command>.
• Returns: 1 if successful, 0 otherwise, e.g. when <User> is not a valid user.

• Syntax: getctx
• Description: Returns the current context.
• Returns: A context.

• Syntax: setctx <Context>
• Description: Sets the context which is used for executing commands.
• Returns: Nothing.

• Syntax: impulse <Impulse>
• Description: Sends various debug commands.
• Returns: Usually nothing.

• Syntax: internalbind <Type> <Proc> [<MatchText>] [<User>]
• Description: Create an internalbind.
• Returns: Nothing.

• Syntax: internalbinds
• Description: Returns a list of the current internalbinds.
• Returns: A list.

• Syntax: internalchanlist <Channel>
• Description: Do not use this. Use chanlist instead. See tcl-commands.doc for more details.
• Returns: A tcl list.

• Syntax: internalchannels
• Description: Do not use this. Use channels instead. See tcl-commands.doc for more details.
• Returns: A tcl list.

• Syntax: internalclosesocket <idx>
• Description: Do not use this. Use killdcc instead. See tcl-commands.doc for more details.
• Returns: Nothing.

• Syntax: internalconnect <Host> <Port>
• Description: Do not use this. Use connect instead. See tcl-commands.doc for more details.
• Returns: A 'dcc' idx.

• Syntax: internalgetchanidle <Nick> <Channel>
• Description: Do not use this. Use getchanidle instead. See tcl-commands.doc for more details.
• Returns: The nick's idletime in seconds.

• Syntax: internallisten <Port> <Type> <Options> <Flag> <SSL> <BindIp>
• Description: Do not use this. Use listen instead. See tcl-commands.doc for more details.
• Returns: A 'dcc' idx.

• Syntax: internalsocketwriteln <idx> <Line>
• Description: Do not use this. Use putdcc instead. See tcl-commands.doc for more details.
• Returns: Nothing.

• Syntax: internalunbind <Type> <Proc> [<Pattern>] [<User>]
• Description: Unbind an internalbind.
• Returns: Nothing.

• Syntax: bnccanhostconnect TODO
• Description: TODO
• Returns: TODO

undocumented :

• Syntax: bncgetsendq TODO
• Description: TODO
• Returns: TODO

• Syntax: TODO
• Description: TODO
• Returns: TODO

• Syntax: TODO
• Description: TODO
• Returns: TODO

• Syntax: TODO
• Description: TODO
• Returns: TODO

• Syntax: TODO
• Description: TODO
• Returns: TODO

• Syntax: internaltimer <interval(seconds)> <Repeat(0|1)> <command> [<parameter(s?)>]
• Description: TODO
• Returns: 1 on success
• Sample: internaltimer 10 0 putmainlog “hello world”
• SampleComment: It will say hello world one time in 10s

• Syntax: internaltimers
• Description: TODO
• Returns: list of active timers. each item of the list contains 4 sub items : command, interval, repeat and parameter(s?) like the internaltimer arguments.

• Syntax: internalvalidsocket TODO
• Description: TODO
• Returns: TODO

• Syntax: bncaddcommand <Name> <Category> <Description> [<HelpText>]
• Description: Adds a new command for /sbnc help. This command can only be used in an “internalbind command”-proc which was triggered for the command “help”.
• Returns: Nothing.

• Syntax: bnccommand <Command> <Parameters>
• Description: Executes a module-specific command. This is used to communicate with other sBNC modules.
• Returns: The return value is module specific. If no module processed the command an empty string is returned.

• Syntax: bncdeletecommand <Name>
• Description: Removes a command (that was added via bncaddcommand) from the help command list.
• Returns: Nothing.

• Syntax: bncdisconnect <Reason>
• Description: Disconnects a user from the IRC server
• Returns: Nothing.

• Syntax: bncgetglobaltag <Name>
• Description: Returns the value of a global tag.
• Returns: A string or NULL.

• Syntax: bncgetglobaltags
• Description: Returns a list of global tags.
• Returns: A list.

• Syntax: bncgetgvhost
• Description: Returns the default vhost.
• Returns: A string.

• Syntax: bncgetmotd
• Description: Returns the current motd.
• Returns: A string.

• Syntax: bncgetreslimit <Resource> [<User>]
• Description: Determines the limit for a resource. If no user is specified the global limit is returned.
• Returns: An integer.

TODO: list every available Resources

• Syntax: bncgettag <Channel> <Nick> <Tag>
• Description:
• Returns:

• Syntax: bncisipblocked <Ip>
• Description: Checks whether an IP address is temporarily blocked (i.e. can't be used to login).
• Returns: 1 if the ip is blocked, 0 otherwise.

• Syntax: bncjoinchans <User>
• Description:
• Returns:

• Syntax: bnckill <Reason>
• Description: Disconnects a user from the bouncer.
• Returns: Nothing.

• Syntax: bnclogbadlogin <Ip>
• Description: Logs a bad login attempt for the specified IP address.
• Returns: Nothing.

• Syntax: bncmodules
• Description: Returns a list of the loaded modules.
• Returns: A list of the loaded modules.

• Syntax: bncnumversion
• Description: Returns the version of sBNC, e.g. 0090000
• Returns: A string identifying the current version.

• Syntax: bncreply <text>
• Description: Sends a notice/msg to the current user (depending on how the command-bind was triggered.)
• Returns: Nothing.

• Syntax: bncsetglobaltag <Name> <Value>
• Description: Creates/sets a global tag. Global tags are stored in the sbnc.conf configuration file.
• Returns: Nothing.

• Syntax: bncsetgvhost <Host>
• Description: Sets the default vhost.
• Returns: Nothing.

• Syntax: bncsetmotd <Motd>
• Description: Sets the motd.
• Returns: Nothing.

• Syntax: bncsetreslimit <Resource> <NewLimit> [<User>]
• Description: Sets a new limit for a resource. If no user is specified the global limit is set.
• Returns: Nothing.

• Syntax: bncsettag <Channel> <Nick> <Tag> <Value>
• Description:
• Returns:

• Syntax: bncuptime
• Description: Returns the timestamp of the time when sBNC was started.
• Returns: A UNIX timestamp.

• Syntax: bncvaliduser <Username>
• Description: Checks whether the specified user exists.
• Returns: 1 if the username exsists, 0 otherwise.

• Syntax: bncvalidusername <Username>
• Description: Checks whether something is a valid username.
• Returns: 1 if the username is valid, 0 otherwise.

• Syntax: bncversion
• Description: Returns the version of sBNC, e.g. 0.9 0090000.
• Returns: A string identifying the current version.

• Syntax: debugout <String>
• Description: Echos <String> in the debug console. This command is Win32-specific.
• Returns: Nothing.

• Syntax: getchanprefix <Channel> <Nick>
• Description: Returns the “best” prefix of a nick.
• Returns: The prefix (e.g. @ or +).

• Syntax: getchanrealname <Channel> [<Nick>]
• Description: Returns the user's realname.
• Returns: A string or NULL.

• Syntax: getcurrentnick
• Description: Use $::botnick instead.
• Returns: The bot's current nick.

• Syntax: getisupport <Feature>
• Description: Returns a specific feature's value from the server's 005 replies.
• Returns: The value of the feature.

• Syntax: haltoutput
• Description: Halts further processing and output.
• Returns: Nothing.

• Syntax: isprefixmode <Mode>
• Description: Returns whether a channel-mode can be applied to nicks (e.g. +o or +v).
• Returns: 1 if the mode can be applied to nicks, 0 otherwise.

• Syntax: md5 <String> [<Salt>]
• Description: Calculates an MD5 hash for <String>.
• Returns: An MD5 hash. If the <Salt> argument is not empty, the returned format is <Salt>$<MD5Hash> and the <MD5Hash> is the hash of <String><Salt>.

• Syntax: putmainlog <Text>
• Description: Logs something in the main log. Each connected admin see it.
• Returns: Nothing.

• Syntax: requiresparam <Mode>
• Description: Returns whether a channel-mode requires a parameter.
• Returns: 3 if the mode is a list (e.g. the banlist) and requires a parameter for setting and unsetting, 2 if the mode needs a parameter for setting and unsetting. 1 if the mode requires a parameter for setting it, 0 if the mode does not require a parameter for setting it.

• Syntax: synthwho <Channel> <Simulate>
• Description: Synthesizes a /who reply for the given channel.
• Returns: 1 if successful, 0 otherwise. Undefined behaviour can occur when Simulate and the reply are both 0.

• Syntax: putlog <Text>
• Description: …
• Returns: …