diff --git a/doc/sphinx_source/_static/eggdrop.css b/doc/sphinx_source/_static/eggdrop.css index 524dee748f..1a4a4c4e89 100644 --- a/doc/sphinx_source/_static/eggdrop.css +++ b/doc/sphinx_source/_static/eggdrop.css @@ -12,13 +12,14 @@ div.document { width: 85em; } +/* MMX's edit */ div.header, div.content, div.footer { - width: 97vw; /* unset to override agogo.css settings */ + width: unset; /* unset to override agogo.css settings */ } - div.content { display: flex; } +/* END of MMX's edit */ div.sidebar .caption { font-weight: bold; @@ -63,4 +64,25 @@ div.document ul { list-style-type: circle; } -div.cap +/* Tcl command reference */ + +/* + * Sphinx renders reStructuredText transitions (----) as
elements. + * Override the theme's default rule completely so command separators stay + * intentionally subtle regardless of the inherited Agogo styling. + */ +div.body hr { + border: 0 !important; + border-top: 1px solid #dddddd !important; + background: transparent !important; + color: transparent !important; + height: 0 !important; + box-shadow: none !important; + margin: 1.5rem 0 !important; +} + +/* Keep a small visual gap between Module metadata and collapsed examples. */ +div.body .admonition.tcl-example, +div.body aside.admonition.tcl-example { + margin-top: 0.6rem; +} diff --git a/doc/sphinx_source/conf.py b/doc/sphinx_source/conf.py index 41d81bf432..0a3bfe334c 100644 --- a/doc/sphinx_source/conf.py +++ b/doc/sphinx_source/conf.py @@ -21,7 +21,7 @@ # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' +needs_sphinx = '8.2' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom diff --git a/doc/sphinx_source/eggdrop.css b/doc/sphinx_source/eggdrop.css deleted file mode 100644 index 95aae8b5b6..0000000000 --- a/doc/sphinx_source/eggdrop.css +++ /dev/null @@ -1,67 +0,0 @@ -@import url("agogo.css"); - -div.header .headertitle { - margin-bottom: 0px; - font-family: "Palatino Linotype", serif; -} -div.header .headertitle a { - color: #2F2F2F; -} - -div.document { - width: 85em; -} - -/* MMX's edit */ -div.header, div.content, div.footer { - width: unset; /* unset to override agogo.css settings */ -} -div.content { - display: flex; -} -/* END of MMX's edit */ - -div.sidebar .caption { - font-weight: bold; - color: #3465a4; -} - -div.body .toctree-wrapper { - display: none; - font-size: 1px; -} - -div.sidebar li.toctree-l1 a { - background-color: initial; -} - -div.footer, div.footer a { - color: #034f84; -} - -table { - border-collapse: collapse; - margin-bottom: 10px; - margin-top: 10px; -} - -th, td { - padding-right: 4px; - padding-left: 4px; - border: 2px solid #87bdd8; -} - -div.document li.toctree-l1 { - margin-bottom: .5em; -} - -div.document li.toctree-l1 a { - color:black; -} - -div.document ul { - margin: 1.5em; - list-style-type: circle; -} - -div.cap diff --git a/doc/sphinx_source/using/tcl-commands.rst b/doc/sphinx_source/using/tcl-commands.rst index 5ae8be558a..8ee1fc574f 100644 --- a/doc/sphinx_source/using/tcl-commands.rst +++ b/doc/sphinx_source/using/tcl-commands.rst @@ -1,7 +1,7 @@ .. highlight:: text Eggdrop Tcl Commands -Last revised: January 6, 2024 +Last revised: September 13, 2026 ==================== Eggdrop Tcl Commands @@ -17,3811 +17,9897 @@ This list is accurate for Eggdrop v1.10.2. Most scripts written for the v1.3, v1 1.6, 1.8, and 1.9 series of Eggdrop should probably work in their current form, with only a very few needing minor modifications. Scripts which were written for v0.9, v1.0, v1.1 or v1.2 will probably not work without modification. +.. note:: + + **Command notation:** Command headings show the complete Tcl signature and can be linked to directly. + ```` denotes a required argument, while ``[argument]`` denotes an optional argument. + Literal values, flags, identifiers, module names, and exact return values are shown in monospace. + Examples are collapsed by default. + Output Commands --------------- +.. _tcl-putserv: + ^^^^^^^^^^^^^^^^^^^^^^^^ putserv [options] ^^^^^^^^^^^^^^^^^^^^^^^^ - Description: sends text to the server, like '.dump' (intended for direct server commands); output is queued so that the bot won't flood itself off the server. + Description + Sends text to the server, like ``.dump`` (intended for direct server commands); output is queued so that the bot won't flood itself off the server. + + Options + ``-next`` + Push messages to the front of the queue + ``-normal`` + No effect + + Returns + nothing + + + Module + ``server`` + - Options: - -next push messages to the front of the queue - -normal no effect + .. admonition:: Example + :collapsible: closed + :class: tcl-example - Returns: nothing + .. code-block:: tcl - Module: server + putserv "PRIVMSG #lamest :Hello from LamestBot!" + +---- + +.. _tcl-puthelp: ^^^^^^^^^^^^^^^^^^^^^^^^ puthelp [options] ^^^^^^^^^^^^^^^^^^^^^^^^ - Description: sends text to the server, like 'putserv', but it uses a different queue intended for sending messages to channels or people. + Description + Sends text to the server, like ``putserv``, but it uses a different queue intended for sending messages to channels or people. + + Options + ``-next`` + Push messages to the front of the queue + ``-normal`` + No effect + + Returns + nothing + + + Module + ``server`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example - Options: - -next push messages to the front of the queue - -normal no effect + .. code-block:: tcl - Returns: nothing + puthelp "PRIVMSG #lamest :Hello, Foobar!" - Module: server +---- + +.. _tcl-putquick: ^^^^^^^^^^^^^^^^^^^^^^^^^ putquick [options] ^^^^^^^^^^^^^^^^^^^^^^^^^ - Description: sends text to the server, like 'putserv', but it uses a different (and faster) queue. + Description + Sends text to the server, like ``putserv``, but it uses a different (and faster) queue. + + Options + ``-next`` + Push messages to the front of the queue + ``-normal`` + No effect + + Returns + nothing + + + Module + ``server`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl - Options: - -next push messages to the front of the queue - -normal no effect + putquick "NOTICE Foobar :This message uses the quick queue." - Returns: nothing +---- - Module: server +.. _tcl-putnow: ^^^^^^^^^^^^^^^^^^^^^^^^ putnow [-oneline] ^^^^^^^^^^^^^^^^^^^^^^^^ - Description: sends text to the server immediately, bypassing all queues. Use with caution, as the bot may easily flood itself off the server. + Description + Sends text to the server immediately, bypassing all queues. Use with caution, as the bot may easily flood itself off the server. - Options: - -oneline send text up to the first \r or \n, discarding the rest + Options + ``-oneline`` + Send text up to the first \r or \n, discarding the rest - Returns: nothing + Returns + nothing - Module: server + + Module + ``server`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + putnow "PING :irc.example.net" + +---- + +.. _tcl-putkick: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ putkick [reason] ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Description: sends kicks to the server and tries to put as many nicks into one kick command as possible. + Description + Sends kicks to the server and tries to put as many nicks into one kick command as possible. + + Returns + nothing - Returns: nothing - Module: irc + Module + ``irc`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + putkick "#lamest" Foobar "Example kick reason" + +---- + +.. _tcl-putlog: ^^^^^^^^^^^^^ putlog ^^^^^^^^^^^^^ - Description: logs to the logfile and partyline if the 'misc' flag (o) is active via the 'logfile' config file setting and the '.console' partyline setting, respectively. + Description + Logs ```` to the logfile and partyline if the ``misc`` flag (o) is active via the ``logfile`` config file setting and the ``.console`` partyline setting, respectively. + + Returns + nothing + - Returns: nothing + Module + ``core`` - Module: core + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + putlog "LamestBot loaded the example script." + +---- + +.. _tcl-putcmdlog: ^^^^^^^^^^^^^^^^ putcmdlog ^^^^^^^^^^^^^^^^ - Description: logs to the logfile and partyline if the 'cmds' flag (c) is active via the 'logfile' config file setting and the '.console' partyline setting, respectively. + Description + Logs ```` to the logfile and partyline if the ``cmds`` flag (c) is active via the ``logfile`` config file setting and the ``.console`` partyline setting, respectively. + + Returns + nothing + + + Module + ``core`` - Returns: nothing - Module: core + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + putcmdlog "Foobar used an example command." + +---- + +.. _tcl-putxferlog: ^^^^^^^^^^^^^^^^^ putxferlog ^^^^^^^^^^^^^^^^^ - Description: logs to the logfile and partyline if the 'files' flag (x) is active via the 'logfile' config file setting and the '.console' partyline setting, respectively. + Description + Logs ```` to the logfile and partyline if the ``files`` flag (x) is active via the ``logfile`` config file setting and the ``.console`` partyline setting, respectively. + + Returns + nothing + + + Module + ``core`` + - Returns: nothing + .. admonition:: Example + :collapsible: closed + :class: tcl-example - Module: core + .. code-block:: tcl + + putxferlog "Example file transfer completed." + +---- + +.. _tcl-putloglev: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ putloglev ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Description: logs to the logfile and partyline at the log level of the specified flag. Use "*" in lieu of a flag to indicate all log levels. + Description + Logs ```` to the logfile and partyline at the log level of the specified flag. Use ``*`` in lieu of a flag to indicate all log levels. + + Returns + nothing + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example - Returns: nothing + .. code-block:: tcl - Module: core + putloglev o "#lamest" "Example log message." + +---- + +.. _tcl-dumpfile: ^^^^^^^^^^^^^^^^^^^^^^^^^^ dumpfile ^^^^^^^^^^^^^^^^^^^^^^^^^^ - Description: dumps file from the help/text directory to a user on IRC via msg (one line per msg). The user has no flags, so the flag bindings won't work within the file. + Description + Dumps file from the help/text directory to a user on IRC via msg (one line per msg). The user has no flags, so the flag bindings won't work within the file. + + Returns + nothing + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl - Returns: nothing + dumpfile Foobar help.txt - Module: core +---- + +.. _tcl-queuesize: ^^^^^^^^^^^^^^^^^ queuesize [queue] ^^^^^^^^^^^^^^^^^ - Returns: the number of messages in all queues. If a queue is specified, only the size of this queue is returned. Valid queues are: mode, server, help. + Description + Returns the number of messages waiting in Eggdrop's output queues. + + + Returns + the number of messages in all queues. If a queue is specified, only the size of this queue is returned. Valid queues are: mode, server, help. + + + Module + ``server`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl - Module: server + set queued [queuesize server] + +---- + +.. _tcl-clearqueue: ^^^^^^^^^^^^^^^^^^ clearqueue ^^^^^^^^^^^^^^^^^^ - Description: removes all messages from a queue. Valid arguments are: mode, server, help, or all. + Description + Removes all messages from a queue. Valid arguments are: mode, server, help, or all. + + Returns + the number of deleted lines from the specified queue. + + + Module + ``server`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl - Returns: the number of deleted lines from the specified queue. + set removed [clearqueue help] - Module: server +---- + +.. _tcl-cap: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ cap [arg] ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Description: displays CAP status or sends a raw CAP command to the server. "ls" will list the capabilities Eggdrop is internally tracking as supported by the server. "values" will list all capabilities and their associated CAP 302 values (if any) as a key/value pair, and "values" with a capability name as arg will list the values associated for the capability. "enabled" will list the capabilities Eggdrop is internally tracking as negotiated with the server. "req" will request the capabilities listed in "arg" from the server. "raw" will send a raw CAP command to the server. The arg field is a single argument, and should be submitted as a single string. For example, to request capabilities foo and bar, you would use [cap req "foo bar"], and for example purposes, sending the same request as a raw command would be [cap raw "REQ :foo bar"]. + Description + Displays CAP status or sends a raw CAP command to the server. ``ls`` will list the capabilities Eggdrop is internally tracking as supported by the server. ``values`` will list all capabilities and their associated CAP 302 values (if any) as a key/value pair, and ``values`` with a capability name as arg will list the values associated for the capability. ``enabled`` will list the capabilities Eggdrop is internally tracking as negotiated with the server. ``req`` will request the capabilities listed in ``arg`` from the server. ``raw`` will send a raw CAP command to the server. The arg field is a single argument, and should be submitted as a single string. For example, to request capabilities foo and bar, you would use [cap req "foo bar"], and for example purposes, sending the same request as a raw command would be [cap raw ``REQ :foo bar``]. + + Returns + a list of CAP capabilities for the ``enabled`` and ``ls`` sub-commands; a dict of capability/value pairs for the ``values`` command or a list if ``values`` if followed by an argument; otherwise nothing. + + + Module + ``server`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set capabilities [cap ls] - Returns: a list of CAP capabilities for the "enabled" and "ls" sub-commands; a dict of capability/value pairs for the "values" command or a list if "values" if followed by an argument; otherwise nothing. +---- - Module: server +.. _tcl-tagmsg: ^^^^^^^^^^^^^^^^^^^^^^ tagmsg ^^^^^^^^^^^^^^^^^^^^^^ - Description: sends an IRCv3 TAGMSG command to the target. Only works if message-tags has been negotiated with the server via the cap command. tags is a Tcl dict (or space-separated string) of the tags you wish to send separated by commas (do not include the @prefix), and target is the nickname or channel you wish to send the tags to. To send a tag only (not a key/value pair), use a "" as the value for a key in a dict, or a "{}" if you are sending as a space-separated string. + Description + Sends an IRCv3 TAGMSG command to the target. Only works if message-tags has been negotiated with the server via the cap command. tags is a Tcl dict (or space-separated string) of the tags you wish to send separated by commas (do not include the @prefix), and target is the nickname or channel you wish to send the tags to. To send a tag only (not a key/value pair), use a ``""`` as the value for a key in a dict, or a ``{}`` if you are sending as a space-separated string. - Examples: - set mytags [dict create +foo bar moo baa +last ""]; tagmsg $mytags #channel - tagmsg "+foo bar moo baa +last {}" #channel - Returns: nothing + Returns + nothing - Module: server + + Module + ``server`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set tags [dict create +example value] + tagmsg $tags "#lamest" + +---- + +.. _tcl-server-add: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ server add [[+]port [password]] ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Description: adds a server to the list of servers Eggdrop will connect to. Prefix the port with '+' to indicate an SSL-protected port. A port value is required if password is to be specified. The SSL status (+) of the provided port is matched against as well (ie, 7000 is not the same as +7000). + Description + Adds a server to the list of servers Eggdrop will connect to. Prefix the port with ``+`` to indicate an SSL-protected port. A port value is required if password is to be specified. The SSL status (+) of the provided port is matched against as well (ie, 7000 is not the same as +7000). + + Returns + nothing - Returns: nothing - Module: server + Module + ``server`` + + + .. admonition:: Example — Add a server + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + server add irc.example.net +6697 + +---- + +.. _tcl-server-remove: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ server remove [[+]port] ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Description: removes a server from the list of servers Eggdrop will connect to. If no port is provided, all servers matching the ip or hostname provided will be removed, otherwise only the ip/host with the corresponding port will be removed. The SSL status (+) of the provided port is matched against as well (ie, 7000 is not the same as +7000). + Description + Removes a server from the list of servers Eggdrop will connect to. If no port is provided, all servers matching the ip or hostname provided will be removed, otherwise only the ip/host with the corresponding port will be removed. The SSL status (+) of the provided port is matched against as well (ie, 7000 is not the same as +7000). + + Returns + nothing + - Returns: nothing + Module + ``server`` - Module: server + + .. admonition:: Example — Remove a server + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + server remove irc.example.net +6697 + +---- + +.. _tcl-server-list: ^^^^^^^^^^^ server list ^^^^^^^^^^^ - Description: lists all servers currently added to the bots internal server list + Description + Lists all servers currently added to the bots internal server list. + + Returns + A list of lists in the format ``{{hostname} {port} {password}}`` + + + Module + ``server`` - Returns: A list of lists in the format {{hostname} {port} {password}} - Module: server + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set servers [server list] User Record Manipulation Commands --------------------------------- +.. _tcl-countusers: + ^^^^^^^^^^ countusers ^^^^^^^^^^ - Returns: number of users in the bot's database - - Module: core - -^^^^^^^^^^^^^^^^^^ -validuser -^^^^^^^^^^^^^^^^^^ + Description + Returns the number of users in the bot's user database. - Returns: 1 if a user by that name exists; 0 otherwise - Module: core + Returns + number of users in the bot's database -^^^^^^^^^^^^^^^^^^^^^^^^^^^ -finduser [-account] -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Description: finds the internal user record which most closely matches the given value. When used with the -account flag, value is a services account name, otherwise by default value is a string in the hostmask format of nick!user\@host. + Module + ``core`` - Returns: the handle found, or "*" if none - Module: core + .. admonition:: Example + :collapsible: closed + :class: tcl-example -^^^^^^^^^^^^^^^^ -userlist [flags] -^^^^^^^^^^^^^^^^ + .. code-block:: tcl - Returns: a list of users on the bot. You can use the flag matching system here ([global]{&/\|}[chan]{&/\|}[bot]). '&' specifies "and"; '|' specifies "or". + set usercount [countusers] + putlog "LamestBot has $usercount users." - Module: core +---- -^^^^^^^^^^^^^^^^^^^^^^^^ -passwdok -^^^^^^^^^^^^^^^^^^^^^^^^ +.. _tcl-validuser: - Description: checks the password given against the user's password. Check against the password "-" to find out if a user has no password set. +^^^^^^^^^^^^^^^^^^ +validuser +^^^^^^^^^^^^^^^^^^ - Returns: 1 if the password matches for that user; 0 otherwise. Or if we are checking against the password "-": 1 if the user has no password set; 0 otherwise. + Description + Checks whether a user with the specified handle exists in the bot's user database. - Module: core -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -getuser [entry-type] [extra info] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Returns + ``1`` if a user by that name exists; ``0`` otherwise - Description: an interface to the new generic userfile support. Without an entry-type, it returns a flat key/value list (dict) of all set entries. Valid entry types are: - - +----------+-------------------------------------------------------------------------------------+ - | ACCOUNT | returns the list of service accounts associated with the user | - +----------+-------------------------------------------------------------------------------------+ - | BOTFL | returns the current bot-specific flags for the user (bot-only) | - +----------+-------------------------------------------------------------------------------------+ - | BOTADDR | returns a list containing the bot's address, bot listen port, and user listen port | - +----------+-------------------------------------------------------------------------------------+ - | HOSTS | returns a list of hosts for the user | - +----------+-------------------------------------------------------------------------------------+ - | LASTON | returns a list containing the unixtime last seen and the last seen place. | - | | LASTON #channel returns the time last seen time for the channel or 0 if no info | - | | exists. | - +----------+-------------------------------------------------------------------------------------+ - | INFO | returns the user's global info line | - +----------+-------------------------------------------------------------------------------------+ - | XTRA | returns the user's XTRA info | - +----------+-------------------------------------------------------------------------------------+ - | COMMENT | returns the master-visible only comment for the user | - +----------+-------------------------------------------------------------------------------------+ - | HANDLE | returns the user's handle as it is saved in the userfile | - +----------+-------------------------------------------------------------------------------------+ - | PASS | returns the user's encrypted password | - +----------+-------------------------------------------------------------------------------------+ - - For additional custom user fields, to include the deprecated "EMAIL" and "URL" fields, reference scripts/userinfo.tcl. - - Returns: info specific to each entry-type - - Module: core -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -setuser [extra info] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Module + ``core`` - Description: this is the counterpart of getuser. It lets you set the various values. Other then the ones listed below, the entry-types are the same as getuser's. - - +---------+---------------------------------------------------------------------------------------+ - | Type | Extra Info | - +=========+=======================================================================================+ - | ACCOUNT | [account] | - | | If no value is specified, all accounts for the user will be cleared. Otherwise, only | - | | a single account will be added to the account list | - +---------+---------------------------------------------------------------------------------------+ - | PASS | | - | | Password string (Empty value will clear the password) | - +---------+---------------------------------------------------------------------------------------+ - | BOTADDR |
[bot listen port] [user listen port] | - | | Sets address, bot listen port and user listen port. If no listen ports are | - | | specified, only the bot address is updated. If only the bot listen port is | - | | specified, both the bot and user listen ports are set to the bot listen port. | - +---------+---------------------------------------------------------------------------------------+ - | HOSTS | [hostmask] | - | | If no value is specified, all hosts for the user will be cleared. Otherwise, only | - | | *1* hostmask is added :P | - +---------+---------------------------------------------------------------------------------------+ - | LASTON | This setting has 3 forms. | - | | | - | | | - | | sets global LASTON time. Standard values used by Eggdrop for are partyline, | - | | linked, unlinked, filearea, <#channel>, and <@remotebotname>, but can be set to | - | | anything. | - | | | - | | | - | | sets global LASTON time (leaving the place field empty) | - | | | - | | | - | | sets a user's LASTON time for a channel (if it is a valid channel) | - +---------+---------------------------------------------------------------------------------------+ - - Returns: nothing - - Module: core -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -chhandle -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + .. admonition:: Example + :collapsible: closed + :class: tcl-example - Description: changes a user's handle + .. code-block:: tcl - Returns: 1 on success; 0 if the new handle is invalid or already used, or if the user can't be found + if {[validuser foobar]} { + putlog "The handle foobar exists." + } - Module: core +---- -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -chattr [changes [channel]] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. _tcl-finduser: - Description: changes the attributes for a user record, if you include any. - Changes are of the form '+f', '-o', '+dk', '-o+d', etc. If changes are specified in the format of \| , the channel-specific flags for that channel are altered. You can now use the +o|-o #channel format here too. +^^^^^^^^^^^^^^^^^^^^^^^^^^^ +finduser [-account] +^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Returns: new flags for the user (if you made no changes, the current flags are returned). If a channel was specified, the global AND the channel-specific flags for that channel are returned in the format of globalflags|channelflags. "*" is returned if the specified user does not exist. + Description + Finds the internal user record which most closely matches the given value. When used with the -account flag, value is a services account name, otherwise by default value is a string in the hostmask format of nick!user\@host. - Module: core + Returns + the handle found, or ``*`` if none -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -botattr [changes [channel]] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Description: similar to chattr except this modifies bot flags rather than normal user attributes. + Module + ``core`` - Returns: new flags for the bot (if you made no changes, the current flags are returned). If a channel was specified, the global AND the channel-specific flags for that channel are returned in the format of globalflags|channelflags. "*" is returned if the specified bot does not exist. - Module: core + .. admonition:: Example + :collapsible: closed + :class: tcl-example -.. _matchattr: + .. code-block:: tcl -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -matchattr [channel] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + set handle [finduser "Foobar!foobar@127.0.0.1"] - Description: checks if the flags of the specified user match the flags provided. "flags" is of the form:: +---- - [+/-][&/|[&/|]] +.. _tcl-userlist: - Either | or & can be used as a separator between global, channel, and bot flags, but only one separator can be used per flag section. A '+' is used to check if a user has the subsequent flags, and a '-' is used to check if a user does NOT have the subsequent flags. Please see `Flag Masks`_ for additional information on flag usage. +^^^^^^^^^^^^^^^^ +userlist [flags] +^^^^^^^^^^^^^^^^ - Returns: 1 if the specified user has the flags matching the provided mask; 0 otherwise + Description + Returns users from the bot's user database, optionally filtered by a flag mask. - Module: core -^^^^^^^^^^^^^^^^^^^^^^^^^^^ -adduser [hostmask] -^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Returns + a list of users on the bot. You can use the flag matching system here ([global]``{&/\|}``[chan]``{&/\|}``[bot]). '&' specifies ``and``; '|' specifies ``or``. - Description: creates a new user entry with the handle and hostmask given (with no password and the default flags) - Returns: 1 if successful; 0 if the handle already exists + Module + ``core`` - Module: core -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -addbot
[botport [userport]] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Description: adds a new bot to the userlist with the handle and botaddress given (with no password and no flags).
format is one of: + .. admonition:: Example + :collapsible: closed + :class: tcl-example - - ipaddress - - ipv4address:botport/userport [DEPRECATED] - - [ipv6address]:botport/userport [DEPRECATED] + .. code-block:: tcl -NOTE 1: The []s around the ipv6address argument are literal []s, not optional arguments. -NOTE 2: In the deprecated formats, an additional botport and/or userport given as follow-on arguments are ignored. + set users [userlist] - Returns: 1 if successful; 0 if the bot already exists or a port is invalid +---- - Module: core +.. _tcl-passwdok: -^^^^^^^^^^^^^^^^ -deluser -^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^ +passwdok +^^^^^^^^^^^^^^^^^^^^^^^^ - Description: attempts to erase the user record for a handle + Description + Checks the password given against the user's password. Check against the password ``-`` to find out if a user has no password set. - Returns: 1 if successful, 0 if no such user exists + Returns + ``1`` if the password matches for that user; ``0`` otherwise. Or if we are checking against the password ``-``: ``1`` if the user has no password set; ``0`` otherwise. - Module: core -^^^^^^^^^^^^^^^^^^^^^^^^^^^ -delhost -^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Module + ``core`` - Description: deletes a hostmask from a user's host list - Returns: 1 on success; 0 if the hostmask (or user) doesn't exist + .. admonition:: Example + :collapsible: closed + :class: tcl-example - Module: core + .. code-block:: tcl -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -addchanrec -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + set valid [passwdok foobar "example-password"] - Description: adds a channel record for a user +---- - Returns: 1 on success; 0 if the user or channel does not exist +.. _tcl-getuser: - Module: channels +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +getuser [entry-type] [extra info] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -delchanrec -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Description + An interface to the new generic userfile support. Without an entry-type, it returns a flat key/value list (dict) of all set entries. Valid entry types are: - Description: removes a channel record for a user. This includes all associated channel flags. + .. list-table:: + :widths: 11 89 + :header-rows: 1 - Returns: 1 on success; 0 if the user or channel does not exist + * - ``entry-type`` + - Description + * - ``ACCOUNT`` + - returns the list of service accounts associated with the user + * - ``BOTFL`` + - returns the current bot-specific flags for the user (bot-only) + * - ``BOTADDR`` + - returns a list containing the bot's address, bot listen port, and user listen port + * - ``HOSTS`` + - returns a list of hosts for the user + * - ``LASTON`` + - returns a list containing the unixtime last seen and the last seen place. + LASTON #channel returns the time last seen time for the channel or 0 if no info + exists. + * - ``INFO`` + - returns the user's global info line + * - ``XTRA`` + - returns the user's XTRA info + * - ``COMMENT`` + - returns the master-visible only comment for the user + * - ``HANDLE`` + - returns the user's handle as it is saved in the userfile + * - ``PASS`` + - returns the user's encrypted password - Module: channels + For additional custom user fields, to include the deprecated ``EMAIL`` and ``URL`` fields, reference ``scripts/userinfo.tcl.`` -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -haschanrec -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Returns + info specific to each entry-type - Returns: 1 if the given handle has a chanrec for the specified channel; 0 otherwise - Module: channels + Module + ``core`` -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -getchaninfo -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Returns: info line for a specific channel (behaves just like 'getinfo') + .. admonition:: Example + :collapsible: closed + :class: tcl-example - Module: channels + .. code-block:: tcl -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -setchaninfo -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + set hosts [getuser foobar HOSTS] - Description: sets the info line on a specific channel for a user. If info is "none", it will be removed. +---- - Returns: nothing +.. _tcl-setuser: - Module: channels +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +setuser [extra info] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -newchanban [lifetime] [options] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Description + This is the counterpart of getuser. It lets you set the various values. Other then the ones listed below, the entry-types are the same as getuser's. - Description: adds a ban to the ban list of a channel; creator is given credit for the ban in the ban list. lifetime is specified in minutes. If lifetime is not specified, ban-time (usually 60) is used. Setting the lifetime to 0 makes it a permanent ban. + .. list-table:: + :widths: 9 91 + :header-rows: 1 - Options: + * - ``entry-type`` + - Description + * - ``ACCOUNT`` + - [account] + If no value is specified, all accounts for the user will be cleared. Otherwise, only + a single account will be added to the account list + * - ``PASS`` + - ```` + Password string (Empty value will clear the password) + * - ``BOTADDR`` + - ``
`` [bot listen port] [user listen port] + Sets address, bot listen port and user listen port. If no listen ports are + specified, only the bot address is updated. If only the bot listen port is + specified, both the bot and user listen ports are set to the bot listen port. + * - ``HOSTS`` + - [hostmask] + If no value is specified, all hosts for the user will be cleared. Otherwise, only + *1* hostmask is added :P + * - ``LASTON`` + - This setting has 3 forms. - +-----------+-------------------------------------------------------------------------------------+ - | sticky | forces the ban to be always active on a channel, even with dynamicbans on | - +-----------+-------------------------------------------------------------------------------------+ + ```` ```` + sets global LASTON time. Standard values used by Eggdrop for ```` are partyline, + linked, unlinked, filearea, <#channel>, and <@remotebotname>, but can be set to + anything. + ```` + sets global LASTON time (leaving the place field empty) - Returns: nothing + ```` ```` + sets a user's LASTON time for a channel (if it is a valid channel) - Module: channels + Returns + nothing -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -newban [lifetime] [options] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Description: adds a ban to the global ban list (which takes effect on all channels); creator is given credit for the ban in the ban list. lifetime is specified in minutes. If lifetime is not specified, default-ban-time (usually 120) is used. Setting the lifetime to 0 makes it a permanent ban. + Module + ``core`` - Options: - +-----------+-------------------------------------------------------------------------------------+ - | sticky | forces the ban to be always active on a channel, even with dynamicbans on | - +-----------+-------------------------------------------------------------------------------------+ + .. admonition:: Example + :collapsible: closed + :class: tcl-example - Returns: nothing + .. code-block:: tcl - Module: channels + setuser foobar INFO "Example user information" -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -newchanexempt [lifetime] [options] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +---- - Description: adds a exempt to the exempt list of a channel; creator is given credit for the exempt in the exempt list. lifetime is specified in minutes. If lifetime is not specified, exempt-time (usually 60) is used. Setting the lifetime to 0 makes it a permanent exempt. The exempt will not be removed until the corresponding ban has been removed. For timed bans, once the time period has expired, the exempt will not be removed until the corresponding ban has either expired or been removed. +.. _tcl-chhandle: - Options: +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +chhandle +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - +-----------+-------------------------------------------------------------------------------------+ - | sticky | forces the exempt to be always active on a channel, even with dynamicexempts on | - +-----------+-------------------------------------------------------------------------------------+ + Description + Changes a user's handle. - Returns: nothing + Returns + ``1`` on success; ``0`` if the new handle is invalid or already used, or if the user can't be found - Module: channels -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -newexempt [lifetime] [options] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Module + ``core`` - Description: adds a exempt to the global exempt list (which takes effect on all channels); creator is given credit for the exempt in the exempt list. lifetime is specified in minutes. If lifetime is not specified, exempt-time (usually 60) is used. Setting the lifetime to 0 makes it a permanent exempt. The exempt will not be removed until the corresponding ban has been removed. - Options: + .. admonition:: Example + :collapsible: closed + :class: tcl-example - +-----------+-------------------------------------------------------------------------------------+ - | sticky | forces the exempt to be always active on a channel, even with dynamicexempts on | - +-----------+-------------------------------------------------------------------------------------+ + .. code-block:: tcl - Returns: nothing + set changed [chhandle foobar foobar2] - Module: channels +---- -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -newchaninvite [lifetime] [options] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. _tcl-chattr: - Description: adds a invite to the invite list of a channel; creator is given credit for the invite in the invite list. lifetime is specified in minutes. If lifetime is not specified, invite-time (usually 60) is used. Setting the lifetime to 0 makes it a permanent invite. The invite will not be removed until the channel has gone -i. +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +chattr [changes [channel]] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Options: + Description + Changes the attributes for a user record, if you include any. + Changes are of the form ``+f``, ``-o``, ``+dk``, ``-o+d``, etc. If changes are specified in the format of \|```` ````, the channel-specific flags for that channel are altered. You can now use the +o|-o #channel format here too. - +-----------+-------------------------------------------------------------------------------------+ - | sticky | forces the invite to be always active on a channel, even with dynamicinvites on | - +-----------+-------------------------------------------------------------------------------------+ + Returns + new flags for the user (if you made no changes, the current flags are returned). If a channel was specified, the global AND the channel-specific flags for that channel are returned in the format of globalflags|channelflags. ``*`` is returned if the specified user does not exist. - Returns: nothing - Module: channels + Module + ``core`` -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -newinvite [lifetime] [options] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Description: adds a invite to the global invite list (which takes effect on all channels); creator is given credit for the invite in the invite list. lifetime is specified in minutes. If lifetime is not specified, invite-time (usually 60) is used. Setting the lifetime to 0 makes it a permanent invite. The invite will not be removed until the channel has gone -i. + .. admonition:: Example + :collapsible: closed + :class: tcl-example - Options: + .. code-block:: tcl - +-----------+-------------------------------------------------------------------------------------+ - | sticky | forces the invite to be always active on a channel, even with dynamicinvites on | - +-----------+-------------------------------------------------------------------------------------+ + set flags [chattr foobar +o "#lamest"] - Returns: nothing +---- - Module: channels +.. _tcl-botattr: -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -stickban [channel] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +botattr [changes [channel]] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Description: makes a ban sticky, or, if a channel is specified, then it is set sticky on that channel only. + Description + Similar to chattr except this modifies bot flags rather than normal user attributes. - Returns: 1 on success; 0 otherwise + Returns + new flags for the bot (if you made no changes, the current flags are returned). If a channel was specified, the global AND the channel-specific flags for that channel are returned in the format of globalflags|channelflags. ``*`` is returned if the specified bot does not exist. - Module: channels -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -unstickban [channel] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Module + ``core`` - Description: makes a ban no longer sticky, or, if a channel is specified, then it is unstuck on that channel only. - Returns: 1 on success; 0 otherwise + .. admonition:: Example + :collapsible: closed + :class: tcl-example - Module: channels + .. code-block:: tcl -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -stickexempt [channel] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + set flags [botattr OtherBot] - Description: makes an exempt sticky, or, if a channel is specified, then it is set sticky on that channel only. +.. _matchattr: - Returns: 1 on success; 0 otherwise +---- - Module: channels +.. _tcl-matchattr: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -unstickexempt [channel] +matchattr [channel] ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Description: makes an exempt no longer sticky, or, if a channel is specified, then it is unstuck on that channel only. + Description + Checks if the flags of the specified user match the flags provided. ``flags`` is of the form:: - Returns: 1 on success; 0 otherwise + [+/-][&/|[&/|]] - Module: channels + Either | or & can be used as a separator between global, channel, and bot flags, but only one separator can be used per flag section. A ``+`` is used to check if a user has the subsequent flags, and a ``-`` is used to check if a user does NOT have the subsequent flags. Please see `Flag Masks`_ for additional information on flag usage. -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -stickinvite [channel] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Description: makes an invite sticky, or, if a channel is specified, then it is set sticky on that channel only. + Returns + ``1`` if the specified user has the flags matching the provided mask; ``0`` otherwise - Returns: 1 on success; 0 otherwise - Module: channels + Module + ``core`` -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -unstickinvite [channel] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Description: makes an invite no longer sticky, or, if a channel is specified, then it is unstuck on that channel only. + .. admonition:: Example — Check user flags + :collapsible: closed + :class: tcl-example - Returns: 1 on success; 0 otherwise + .. code-block:: tcl - Module: channels + if {[matchattr foobar o "#lamest"]} { + putlog "foobar has the requested flags." + } + +---- + +.. _tcl-adduser: ^^^^^^^^^^^^^^^^^^^^^^^^^^^ -killchanban +adduser [hostmask] ^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Description: removes a ban from the ban list for a channel + Description + Creates a new user entry with the handle and hostmask given (with no password and the default flags). - Returns: 1 on success; 0 otherwise + Returns + ``1`` if successful; ``0`` if the handle already exists - Module: channels -^^^^^^^^^^^^^ -killban -^^^^^^^^^^^^^ + Module + ``core`` - Description: removes a ban from the global ban list - Returns: 1 on success; 0 otherwise + .. admonition:: Example + :collapsible: closed + :class: tcl-example - Module: channels + .. code-block:: tcl -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -killchanexempt -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - - Description: removes an exempt from the exempt list for a channel - - Returns: 1 on success; 0 otherwise - - Module: channels - -^^^^^^^^^^^^^^^^^^^ -killexempt -^^^^^^^^^^^^^^^^^^^ - - Description: removes an exempt from the global exempt list + set added [adduser foobar "Foobar!foobar@127.0.0.1"] - Returns: 1 on success; 0 otherwise +---- - Module: channels +.. _tcl-addbot: -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -killchaninvite -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +addbot
[botport [userport]] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Description: removes an invite from the invite list for a channel + Description + Adds a new bot to the userlist with the handle and botaddress given (with no password and no flags). ``
`` format is one of: - Returns: 1 on success; 0 otherwise + - ipaddress + - ipv4address:botport/userport [DEPRECATED] + - [ipv6address]:botport/userport [DEPRECATED] - Module: channels +NOTE 1: The []s around the ipv6address argument are literal []s, not optional arguments. +NOTE 2: In the deprecated formats, an additional botport and/or userport given as follow-on arguments are ignored. -^^^^^^^^^^^^^^^^^^^ -killinvite -^^^^^^^^^^^^^^^^^^^ + Returns + ``1`` if successful; ``0`` if the bot already exists or a port is invalid - Description: removes an invite from the global invite list - Returns: 1 on success; 0 otherwise + Module + ``core`` - Module: channels -^^^^^^^^^^^^^^^^^^^^^ -ischanjuped -^^^^^^^^^^^^^^^^^^^^^ + .. admonition:: Example + :collapsible: closed + :class: tcl-example - Returns: 1 if the channel is juped, and the bot is unable to join; 0 otherwise + .. code-block:: tcl - Module: channels + set added [addbot OtherBot 127.0.0.1] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -isban [channel [-channel]] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +---- - Returns: 1 if the specified ban is in the global ban list; 0 otherwise. If a channel is specified, that channel's ban list is checked as well. If the -channel flag is used at the end of the command, \*only\* the channel bans are checked. +.. _tcl-deluser: - Module: channels +^^^^^^^^^^^^^^^^ +deluser +^^^^^^^^^^^^^^^^ -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -ispermban [channel [-channel]] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Description + Attempts to erase the user record for a handle. - Returns: 1 if the specified ban is in the global ban list AND is marked as permanent; 0 otherwise. If a channel is specified, that channel's ban list is checked as well. If the -channel flag is used at the end of the command, \*only\* the channel bans are checked. + Returns + ``1`` if successful, ``0`` if no such user exists - Module: channels -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -isexempt [channel [-channel]] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Module + ``core`` - Returns: 1 if the specified exempt is in the global exempt list; 0 otherwise. If a channel is specified, that channel's exempt list is checked as well. If the -channel flag is used at the end of the command, \*only\* the channel exempts are checked. - Module: channels + .. admonition:: Example + :collapsible: closed + :class: tcl-example -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -ispermexempt [channel [-channel]] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + .. code-block:: tcl - Returns: 1 if the specified exempt is in the global exempt list AND is marked as permanent; 0 otherwise. If a channel is specified, that channel's exempt list is checked as well. If the -channel flag is used at the end of the command, \*only\* the channel exempts are checked. + set deleted [deluser foobar] - Module: channels +---- -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -isinvite [channel [-channel]] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. _tcl-delhost: - Returns: 1 if the specified invite is in the global invite list; 0 otherwise. If a channel is specified, that channel's invite list is checked as well. If the -channel flag is used at the end of the command, \*only\* the channel invites are checked. +^^^^^^^^^^^^^^^^^^^^^^^^^^^ +delhost +^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Module: channels + Description + Deletes a hostmask from a user's host list. -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -isperminvite [channel [-channel]] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Returns + ``1`` on success; ``0`` if the hostmask (or user) doesn't exist - Returns: 1 if the specified invite is in the global invite list AND is marked as permanent; 0 otherwise. If a channel is specified, that channel's invite list is checked as well. If the -channel flag is used at the end of the command, \*only\* the channel invites are checked. - Module: channels + Module + ``core`` -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -isbansticky [channel [-channel]] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Returns: 1 if the specified ban is marked as sticky in the global ban list; 0 otherwise. If a channel is specified, that channel's ban list is checked as well. If the -channel flag is used at the end of the command, \*only\* the channel bans are checked. + .. admonition:: Example + :collapsible: closed + :class: tcl-example - Module: channels + .. code-block:: tcl -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -isexemptsticky [channel [-channel]] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + set result [delhost foobar "Foobar!foobar@127.0.0.1"] - Returns: 1 if the specified exempt is marked as sticky in the global exempt list; 0 otherwise. If a channel is specified, that channel's exempt list is checked as well. If the -channel flag is used at the end of the command, \*only\* the channel exempts are checked. +---- - Module: channels +.. _tcl-addchanrec: -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -isinvitesticky [channel [-channel]] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +addchanrec +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Returns: 1 if the specified invite is marked as sticky in the global invite list; 0 otherwise. If a channel is specified, that channel's invite list is checked as well. If the -channel flag is used at the end of the command, \*only\* the channel invites are checked. + Description + Adds a channel record for a user. - Module: channels + Returns + ``1`` on success; ``0`` if the user or channel does not exist -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -matchban [channel] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Returns: 1 if the specified nick!user\@host matches a ban in the global ban list; 0 otherwise. If a channel is specified, that channel's ban list is checked as well. + Module + ``channels`` - Module: channels -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -matchexempt [channel] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + .. admonition:: Example + :collapsible: closed + :class: tcl-example - Returns: 1 if the specified nick!user\@host matches an exempt in the global exempt list; 0 otherwise. If a channel is specified, that channel's exempt list is checked as well. + .. code-block:: tcl - Module: channels + set added [addchanrec foobar "#lamest"] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -matchinvite [channel] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +---- - Returns: 1 if the specified nick!user\@host matches an invite in the global invite list; 0 otherwise. If a channel is specified, that - channel's invite list is checked as well. +.. _tcl-delchanrec: - Module: channels +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +delchanrec +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -^^^^^^^^^^^^^^^^^ -banlist [channel] -^^^^^^^^^^^^^^^^^ + Description + Removes a channel record for a user. This includes all associated channel flags. - Returns: a list of global bans, or, if a channel is specified, a list of channel-specific bans. Each entry is a sublist containing: hostmask, comment, expiration timestamp, time added, last time active, and creator. The three timestamps are in unixtime format. + Returns + ``1`` on success; ``0`` if the user or channel does not exist - Module: channels -^^^^^^^^^^^^^^^^^^^^ -exemptlist [channel] -^^^^^^^^^^^^^^^^^^^^ + Module + ``channels`` - Returns: a list of global exempts, or, if a channel is specified, a list of channel-specific exempts. Each entry is a sublist containing: hostmask, comment, expiration timestamp, time added, last time active, and creator. The three timestamps are in unixtime format. - Module: channels + .. admonition:: Example + :collapsible: closed + :class: tcl-example -^^^^^^^^^^^^^^^^^^^^ -invitelist [channel] -^^^^^^^^^^^^^^^^^^^^ + .. code-block:: tcl - Returns: a list of global invites, or, if a channel is specified, a list of channel-specific invites. Each entry is a sublist containing: hostmask, comment, expiration timestamp, time added, last time active, and creator. The three timestamps are in unixtime format. + set deleted [delchanrec foobar "#lamest"] - Module: channels +---- -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -newignore [lifetime] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. _tcl-haschanrec: - Description: adds an entry to the ignore list; creator is given credit for the ignore. lifetime is how many minutes until the ignore expires and is removed. If lifetime is not specified, ignore-time (usually 60) is used. Setting the lifetime to 0 makes it a permanent ignore. +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +haschanrec +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Returns: nothing + Description + Checks whether a user has a channel record for the specified channel. - Module: core -^^^^^^^^^^^^^^^^^^^^^ -killignore -^^^^^^^^^^^^^^^^^^^^^ - Description: removes an entry from the ignore list + Returns + ``1`` if the given handle has a chanrec for the specified channel; ``0`` otherwise - Returns: 1 if successful; 0 otherwise - Module: core + Module + ``channels`` -^^^^^^^^^^ -ignorelist -^^^^^^^^^^ - Returns: a list of ignores. Each entry is a sublist containing: hostmask, comment, expiration timestamp, time added, and creator. The timestamps are in unixtime format. + .. admonition:: Example + :collapsible: closed + :class: tcl-example - Module: core + .. code-block:: tcl -^^^^^^^^^^^^^^^^^^^ -isignore -^^^^^^^^^^^^^^^^^^^ + set has_record [haschanrec foobar "#lamest"] - Returns: 1 if the ignore is in the list; 0 otherwise +---- - Module: core +.. _tcl-getchaninfo: -^^^^ -save -^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +getchaninfo +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Description: writes the user and channel files to disk + Description + Returns a user's info line for the specified channel. - Returns: nothing - Module: core + Returns + info line for a specific channel (behaves just like 'getinfo') -^^^^^^ -reload -^^^^^^ - Description: loads the userfile from disk, replacing whatever is in memory + Module + ``channels`` - Returns: nothing - Module: core + .. admonition:: Example + :collapsible: closed + :class: tcl-example -^^^^^^ -backup -^^^^^^ - Description: makes a simple backup of the userfile that's on disk. If the channels module is loaded, this also makes a simple backup of the channel file. + .. code-block:: tcl - Returns: nothing + set info [getchaninfo foobar "#lamest"] - Module: core +---- -^^^^^^^^^^^^^ -getting-users -^^^^^^^^^^^^^ +.. _tcl-setchaninfo: - Returns: 1 if the bot is currently downloading a userfile from a sharebot (and hence, user records are about to drastically change); 0 if not +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +setchaninfo +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Module: core + Description + Sets the info line on a specific channel for a user. If info is ``none``, it will be removed. -Channel Commands ----------------- + Returns + nothing -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -channel add [option-list] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Description: adds a channel record for the bot to monitor. The full list of possible options are given in doc/settings/mod.channels. Note that the channel options must be in a list (enclosed in {}). + Module + ``channels`` - Returns: nothing - Module: channels + .. admonition:: Example + :collapsible: closed + :class: tcl-example -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -channel set -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + .. code-block:: tcl - Description: sets options for the channel specified. `options` is a flat list of either +/-settings or key/value pairs. The full list of possible options are given in doc/settings/mod.channels. Note: Tcl code settings such as the need-* settings must be valid Tcl code as a single word, for example ``channel set #lamest need-op { putmsg ChanServ "op #lamest" }`` + setchaninfo foobar "#lamest" "Example channel information" - Returns: nothing +---- - Module: channels +.. _tcl-newchanban: -^^^^^^^^^^^^^^^^^^^ -channel info -^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +newchanban [lifetime] [options] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Returns: a list of info about the specified channel's settings. + Description + Adds a ban to the ban list of a channel; creator is given credit for the ban in the ban list. lifetime is specified in minutes. If lifetime is not specified, ban-time (usually 60) is used. Setting the lifetime to 0 makes it a permanent ban. - Module: channels + Options -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -channel get [setting] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + .. list-table:: + :widths: 11 89 + :header-rows: 1 - Returns: The value of the setting you specify. For flags, a value of 0 means it is disabled (-), and non-zero means enabled (+). If no setting is specified, a flat list of all available settings and their values will be returned. + * - ``options`` + - Description + * - ``sticky`` + - forces the ban to be always active on a channel, even with dynamicbans on - Module: channels -^^^^^^^^^^^^^^^^^^^^^ -channel remove -^^^^^^^^^^^^^^^^^^^^^ + Returns + nothing - Description: removes a channel record from the bot and makes the bot no longer monitor the channel - Returns: nothing + Module + ``channels`` - Module: channels -^^^^^^^^^^^^ -savechannels -^^^^^^^^^^^^ + .. admonition:: Example — Add a channel ban + :collapsible: closed + :class: tcl-example - Description: saves the channel settings to the channel-file if one is defined. + .. code-block:: tcl - Returns: nothing + newchanban "#lamest" "*!*@127.0.0.1" foobar "Example text" - Module: channels +---- -^^^^^^^^^^^^ -loadchannels -^^^^^^^^^^^^ - Description: reloads the channel settings from the channel-file if one is defined. +.. _tcl-newban: - Returns: nothing +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +newban [lifetime] [options] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Module: channels + Description + Adds a ban to the global ban list (which takes effect on all channels); creator is given credit for the ban in the ban list. lifetime is specified in minutes. If lifetime is not specified, default-ban-time (usually 120) is used. Setting the lifetime to 0 makes it a permanent ban. -^^^^^^^^ -channels -^^^^^^^^ + Options - Returns: a list of the channels the bot has a channel record for + .. list-table:: + :widths: 11 89 + :header-rows: 1 - Module: channels + * - ``options`` + - Description + * - ``sticky`` + - forces the ban to be always active on a channel, even with dynamicbans on -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -channame2dname -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -chandname2name -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Returns + nothing - Description: these two functions are important to correctly support !channels. The bot differentiates between channel description names (chan dnames) and real channel names (chan names). The chan dnames are what you would normally call the channel, such as "!channel". The chan names are what the IRC server uses to identify the channel. They consist of the chan dname prefixed with an ID; such as "!ABCDEchannel". - For bot functions like isop, isvoice, etc. you need to know the chan dnames. If you communicate with the server, you usually get the chan name, though. That's what you need the channame2dname function for. + Module + ``channels`` - If you only have the chan dname and want to directly send raw server commands, use the chandname2name command. - NOTE: For non-!channels, chan dname and chan name are the same. + .. admonition:: Example + :collapsible: closed + :class: tcl-example - Module: irc + .. code-block:: tcl -^^^^^^^^^^^^^^^^ -isbotnick -^^^^^^^^^^^^^^^^ + newban "*!*@127.0.0.1" foobar "Example text" - Returns: 1 if the nick matches the botnick; 0 otherwise +---- - Module: server +.. _tcl-newchanexempt: -^^^^^^^^^^^^^^^^^ -botisop [channel] -^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +newchanexempt [lifetime] [options] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Returns: 1 if the bot has ops on the specified channel (or any channel if no channel is specified); 0 otherwise + Description + Adds a exempt to the exempt list of a channel; creator is given credit for the exempt in the exempt list. lifetime is specified in minutes. If lifetime is not specified, exempt-time (usually 60) is used. Setting the lifetime to 0 makes it a permanent exempt. The exempt will not be removed until the corresponding ban has been removed. For timed bans, once the time period has expired, the exempt will not be removed until the corresponding ban has either expired or been removed. - Module: irc + Options -^^^^^^^^^^^^^^^^^^^^^ -botishalfop [channel] -^^^^^^^^^^^^^^^^^^^^^ + .. list-table:: + :widths: 11 89 + :header-rows: 1 - Returns: 1 if the bot has halfops on the specified channel (or any channel if no channel is specified); 0 otherwise + * - ``options`` + - Description + * - ``sticky`` + - forces the exempt to be always active on a channel, even with dynamicexempts on - Module: irc + Returns + nothing -^^^^^^^^^^^^^^^^^^^^ -botisvoice [channel] -^^^^^^^^^^^^^^^^^^^^ - Returns: 1 if the bot has a voice on the specified channel (or any channel if no channel is specified); 0 otherwise + Module + ``channels`` - Module: irc -^^^^^^^^^^^^^^^^^^^ -botonchan [channel] -^^^^^^^^^^^^^^^^^^^ + .. admonition:: Example + :collapsible: closed + :class: tcl-example - Returns: 1 if the bot is on the specified channel (or any channel if no channel is specified); 0 otherwise + .. code-block:: tcl - Module: irc + newchanexempt "#lamest" "*!*@127.0.0.1" foobar "Example text" -^^^^^^^^^^^^^^^^^^^^^^^^^ -isop [channel] -^^^^^^^^^^^^^^^^^^^^^^^^^ +---- - Returns: 1 if someone by the specified nickname is on the channel (or any channel if no channel name is specified) and has ops; 0 otherwise +.. _tcl-newexempt: - Module: irc +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +newexempt [lifetime] [options] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -ishalfop [channel] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Description + Adds a exempt to the global exempt list (which takes effect on all channels); creator is given credit for the exempt in the exempt list. lifetime is specified in minutes. If lifetime is not specified, exempt-time (usually 60) is used. Setting the lifetime to 0 makes it a permanent exempt. The exempt will not be removed until the corresponding ban has been removed. - Returns: 1 if someone by the specified nickname is on the channel (or any channel if no channel name is specified) and has halfops; 0 otherwise + Options - Module: irc + .. list-table:: + :widths: 11 89 + :header-rows: 1 -^^^^^^^^^^^^^^^^^^^^^^^^^^ -wasop -^^^^^^^^^^^^^^^^^^^^^^^^^^ + * - ``options`` + - Description + * - ``sticky`` + - forces the exempt to be always active on a channel, even with dynamicexempts on - Returns: 1 if someone that just got opped/deopped in the chan had op before the modechange; 0 otherwise + Returns + nothing - Module: irc -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -washalfop -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Module + ``channels`` - Returns: 1 if someone that just got halfopped/dehalfopped in the chan had halfop before the modechange; 0 otherwise - Module: irc + .. admonition:: Example + :collapsible: closed + :class: tcl-example -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -isvoice [channel] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + .. code-block:: tcl - Returns: 1 if someone by that nickname is on the channel (or any channel if no channel is specified) and has voice (+v); 0 otherwise + newexempt "*!*@127.0.0.1" foobar "Example text" - Module: irc +---- -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -isidentified [channel] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. _tcl-newchaninvite: - Description: determine if a user is identified to irc services. WARNING: this may not be accurate depending on the server and configuration. For accurate results, the server must support (and Eggdrop must have enabled via CAP) the account-notify and extended-join capabilities, and the server must understand WHOX requests (also known as raw 354 responses) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +newchaninvite [lifetime] [options] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Returns: 1 if someone by the specified nickname is on the channel (or any channel if no channel name is specified) and is logged in); 0 otherwise. + Description + Adds a invite to the invite list of a channel; creator is given credit for the invite in the invite list. lifetime is specified in minutes. If lifetime is not specified, invite-time (usually 60) is used. Setting the lifetime to 0 makes it a permanent invite. The invite will not be removed until the channel has gone -i. - Module: irc + Options -^^^^^^^^^^^^^^^^^^^^^^^^^^^ -isaway [channel] -^^^^^^^^^^^^^^^^^^^^^^^^^^^ + .. list-table:: + :widths: 11 89 + :header-rows: 1 - Description: determine if a user is marked as 'away' on a server. IMPORTANT: this command is only "mostly" reliable on its own when the IRCv3 away-notify capability is available and negotiated with the IRC server (if you didn't add this to your config file, it likely isn't enabled- you can confirm using the ``cap`` Tcl command). Additionally, there is no way for Eggdrop (or any client) to capture a user's away status when the user first joins a channel (they are assumed present by Eggdrop on join). To use this command without the away-notify capability negotiated, or to get a user's away status on join (via a JOIN bind), use ``refreshchan w`` on a channel the user is on, which will refresh the current away status stored by Eggdrop for all users on the channel. + * - ``options`` + - Description + * - ``sticky`` + - forces the invite to be always active on a channel, even with dynamicinvites on - Returns: 1 if Eggdrop is currently tracking someone by that nickname marked as 'away' (again, see disclaimer above) by an IRC server; 0 otherwise. + Returns + nothing - Module: irc -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -isircbot [channel] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Module + ``channels`` - Description: determine if a user has denoted themselves as a bot via an ircd-defined user flag (declared via BOT in a server's 005/ISUPPORT line). Due to server implementations, accurately monitoring this is incredibly fragile, as the flag can be added and removed by a user without any notification to other users. To ensure this status is current for use, it is recommended to use ``refreshchan w`` on a channel the user is on, which will refresh if the user is a bot or not for all users on the channel. If a server does not advertise BOT in its ISUPPORT line but still supports it (currently the case for unrealircd), you can manually set it by adding "BOT=B" (or whatever flag is used) to the isupport-default setting in your eggdrop.conf file. - Returns: 1 if Eggdrop is currently tracking someone by that nickname marked as a bot by an IRC server; 0 otherwise. + .. admonition:: Example + :collapsible: closed + :class: tcl-example -^^^^^^^^^^^^^^^^^^^^^^^^^^^ -onchan [channel] -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Returns: 1 if someone by that nickname is on the specified channel (or any channel if none is specified); 0 otherwise + .. code-block:: tcl - Module: irc + newchaninvite "#lamest" "*!*@127.0.0.1" foobar "Example text" -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -monitor [nickname] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Description: interacts with the list of nicknames Eggdrop has asked the IRC server to track. valid sub-commands are add, delete, list, online, offline, status, and clear. The 'add' command sends 'nickname' to the server to track. The 'delete' command removes 'nickname' from being tracked by the server (or returns an error if the nickname is not present). The 'list' command returns a list of all nicknames the IRC server is tracking on behalf of Eggdrop. The 'online' command returns a string of tracked nicknames that are currently online. The 'offline' command returns a list of tracked nicknames that are currently offline. +---- - Returns: The 'add' sub-command returns a '1' if the nick was successfully added, a '0' if the nick is already in the monitor list, and a '2' if the nick could not be added. The 'delete' sub-command returns a '1' if the nick is removed, or an error if the nick is not found. The 'status' sub-command returns a '1' if 'nickname' is online or a 0 if 'nickname' is offline. The 'clear' command removes all nicknames from the list the server is monitoring. +.. _tcl-newinvite: - Module: irc +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +newinvite [lifetime] [options] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -^^^^^^^^^^^^^^^ -accounttracking -^^^^^^^^^^^^^^^ + Description + Adds a invite to the global invite list (which takes effect on all channels); creator is given credit for the invite in the invite list. lifetime is specified in minutes. If lifetime is not specified, invite-time (usually 60) is used. Setting the lifetime to 0 makes it a permanent invite. The invite will not be removed until the channel has gone -i. - Description: checks to see if the three required functionalities to enable proper account tracking are available (and enabled) to Eggdrop. This checks if the extended-join and account-notify IRCv3 capabilities are currently enabled, and checks if the server supports WHOX (based on the type of server selected in the config file, or the use-354 variable being set to 1 when selecting an "Other" server). + Options - Returns: a '1' if all three functionalities are present, a '0' if one or more are missing. + .. list-table:: + :widths: 11 89 + :header-rows: 1 - Module: irc + * - ``options`` + - Description + * - ``sticky`` + - forces the invite to be always active on a channel, even with dynamicinvites on -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -getaccount [channel] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Returns + nothing - Returns: the services account name associated with nickname, "*" if the user is not logged into services, or "" if eggdrop does not know the account status of the user. - NOTE: the three required IRC components for account tracking are: the WHOX feature, the extended-join IRCv3 capability and the account-notify IRCv3 capability. if only some of the three feature are available, eggdrop provides best-effort account tracking. please see doc/ACCOUNTS for additional information. + Module + ``channels`` -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -nick2hand [channel] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Returns: the handle of a nickname on a channel. If a channel is not specified, the bot will check all of its channels. If the nick is not found, "" is returned. If the nick is found but does not have a handle, "*" is returned. If no channel is specified, all channels are checked. + .. admonition:: Example + :collapsible: closed + :class: tcl-example - Module: irc + .. code-block:: tcl -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -account2nicks [channel] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + newinvite "*!*@127.0.0.1" foobar "Example text" - Returns: a de-duplicated Tcl list of the nickname(s) on the specified channel (if one is specified) whose nickname matches the given account; "" is returned if no match is found. This command will only work if a server supports (and Eggdrop has enabled) the account-notify and extended-join capabilities, and the server understands WHOX requests (also known as raw 354 responses). If no channel is specified, all channels are checked. +---- - Module: irc +.. _tcl-stickban: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -hand2nick [channel] +stickban [channel] ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Returns: nickname of the first person on the specified channel (if one is specified) whose nick!user\@host matches the given handle; "" is returned if no match is found. If no channel is specified, all channels are checked. + Description + Makes a ban sticky, or, if a channel is specified, then it is set sticky on that channel only. - Module: irc + Returns + ``1`` on success; ``0`` otherwise -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -hand2nicks [channel] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Returns: a de-duplicated Tcl list of the nickname(s) on the specified channel (if one is specified) whose nick!user\@host matches the given handle; "" is returned if no match is found. If no channel is specified, all channels are checked. + Module + ``channels`` - Module: irc -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -handonchan [channel] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + .. admonition:: Example + :collapsible: closed + :class: tcl-example - Returns: 1 if the the nick!user\@host for someone on the channel (or any channel if no channel name is specified) matches for the handle given; 0 otherwise + .. code-block:: tcl - Module: irc + set result [stickban "*!*@127.0.0.1"] -^^^^^^^^^^^^^^^^^^^^^^^^^ -ischanban -^^^^^^^^^^^^^^^^^^^^^^^^^ +---- - Returns: 1 if the specified ban is on the given channel's ban list (not the bot's banlist for the channel) +.. _tcl-unstickban: - Module: irc +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +unstickban [channel] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -ischanexempt -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Description + Makes a ban no longer sticky, or, if a channel is specified, then it is unstuck on that channel only. - Returns: 1 if the specified exempt is on the given channel's exempt list (not the bot's exemptlist for the channel) + Returns + ``1`` on success; ``0`` otherwise - Module: irc -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -ischaninvite -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Module + ``channels`` - Returns: 1 if the specified invite is on the given channel's invite list (not the bot's invitelist for the channel) - Module: irc + .. admonition:: Example + :collapsible: closed + :class: tcl-example -^^^^^^^^^^^^^^^^^^ -chanbans -^^^^^^^^^^^^^^^^^^ + .. code-block:: tcl - Returns: a list of the current bans on the channel. Each element is a sublist of the form { }. age is seconds from the bot's point of view + set result [unstickban "*!*@127.0.0.1"] - Module: irc +---- -^^^^^^^^^^^^^^^^^^^^^ -chanexempts -^^^^^^^^^^^^^^^^^^^^^ +.. _tcl-stickexempt: - Returns: a list of the current exempts on the channel. Each element is a sublist of the form { }. age is seconds from the bot's point of view +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +stickexempt [channel] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Module: irc + Description + Makes an exempt sticky, or, if a channel is specified, then it is set sticky on that channel only. -^^^^^^^^^^^^^^^^^^^^^ -chaninvites -^^^^^^^^^^^^^^^^^^^^^ + Returns + ``1`` on success; ``0`` otherwise - Returns: a list of the current invites on the channel. Each element is a sublist of the form { }. age is seconds from the bot's point of view - Module: irc + Module + ``channels`` -^^^^^^^^^^^^^^^^^^^ -resetbans -^^^^^^^^^^^^^^^^^^^ - Description: removes all bans on the channel that aren't in the bot's ban list and refreshes any bans that should be on the channel but aren't + .. admonition:: Example + :collapsible: closed + :class: tcl-example - Returns: nothing + .. code-block:: tcl - Module: irc + set result [stickexempt "*!*@127.0.0.1"] -^^^^^^^^^^^^^^^^^^^^^^ -resetexempts -^^^^^^^^^^^^^^^^^^^^^^ +---- - Description: removes all exempt on the channel that aren't in the bot's exempt list and refreshes any exempts that should be on the channel but aren't +.. _tcl-unstickexempt: - Returns: nothing +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +unstickexempt [channel] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Module: irc + Description + Makes an exempt no longer sticky, or, if a channel is specified, then it is unstuck on that channel only. -^^^^^^^^^^^^^^^^^^^^^^ -resetinvites -^^^^^^^^^^^^^^^^^^^^^^ + Returns + ``1`` on success; ``0`` otherwise - Description: removes all invites on the channel that aren't in the bot's invite list and refreshes any invites that should be on the channel but aren't - Returns: nothing + Module + ``channels`` - Module: irc -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -resetchanidle [nick] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + .. admonition:: Example + :collapsible: closed + :class: tcl-example - Description: resets the channel idle time for the given nick or for all nicks on the channel if no nick is specified. + .. code-block:: tcl - Returns: nothing + set result [unstickexempt "*!*@127.0.0.1"] - Module: irc +---- -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -resetchanjoin [nick] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Description: resets the channel join time for the given nick or for all nicks on the channel if no nick is specified. +.. _tcl-stickinvite: - Returns: nothing +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +stickinvite [channel] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Module: irc + Description + Makes an invite sticky, or, if a channel is specified, then it is set sticky on that channel only. -^^^^^^^^^^^^^^^^^^^^^^^^^^^ -resetchan [flags] -^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Returns + ``1`` on success; ``0`` otherwise - Description: clears the channel info Eggdrop is currently storing for a channel, then rereads the channel info from the server. Useful if Eggdrop gets into a bad state on a server with respect to a channel userlist, for example. If flags are specified, only the required information will be reset, according to the given flags. Available flags: - +-----+------------------------------+ - | b | channel bans | - +-----+------------------------------+ - | e | channel exempts | - +-----+------------------------------+ - | I | channel invites | - +-----+------------------------------+ - | m | channel modes | - +-----+------------------------------+ - | w | memberlist (who & away info) | - +-----+------------------------------+ + Module + ``channels`` - Returns: nothing - Module: irc + .. admonition:: Example + :collapsible: closed + :class: tcl-example -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -refreshchan [flags] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + .. code-block:: tcl - Description: An alternative to resetchan, refresh rereads the channel info from the server without first clearing out the previously stored information. Useful for updating a user's away status without resetting their idle time, for example. If flags are specified, only the required information will be refreshed, according to the given flags. Available flags: + set result [stickinvite "*!*@127.0.0.1"] - +-----+------------------------------+ - | b | channel bans | - +-----+------------------------------+ - | e | channel exempts | - +-----+------------------------------+ - | I | channel invites | - +-----+------------------------------+ - | m | channel modes | - +-----+------------------------------+ - | t | channel topic | - +-----+------------------------------+ - | w | memberlist (who & away info) | - +-----+------------------------------+ +---- - Returns: nothing +.. _tcl-unstickinvite: - Module: irc +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +unstickinvite [channel] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -getchanhost [channel] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Description + Makes an invite no longer sticky, or, if a channel is specified, then it is unstuck on that channel only. - Returns: user\@host of the specified nickname (the nickname is not included in the returned host). If a channel is not specified, bot will check all of its channels. If the nickname is not on the channel(s), "" is returned. + Returns + ``1`` on success; ``0`` otherwise - Module: irc -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -getchanjoin -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Module + ``channels`` - Returns: timestamp (unixtime format) of when the specified nickname joined the channel if available, 0 otherwise. Note that after a channel reset this information will be lost, even if previously available. - Module: irc + .. admonition:: Example + :collapsible: closed + :class: tcl-example -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -onchansplit [channel] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + .. code-block:: tcl - Returns: 1 if that nick is split from the channel (or any channel if no channel is specified); 0 otherwise + set result [unstickinvite "*!*@127.0.0.1"] - Module: irc +---- -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -chanlist [flags][<&|>chanflags] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. _tcl-killchanban: - Description: lists all users on a channel Eggdrop has joined. flags are any global flags; the '&' or '\|' denotes to look for channel specific flags, where '&' will return users having ALL chanflags and '|' returns users having ANY of the chanflags (See `Flag Masks`_ for additional information). +^^^^^^^^^^^^^^^^^^^^^^^^^^^ +killchanban +^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Returns: Searching for flags optionally preceded with a '+' will return a list of nicknames that have all the flags listed. Searching for flags preceded with a '-' will return a list of nicknames that do not have have any of the flags (differently said, '-' will hide users that have all flags listed). If no flags are given, all of the nicknames on the channel are returned. + Description + Removes a ban from the ban list for a channel. - Please note that if you're executing chanlist after a part or sign bind, the gone user will still be listed, so you can check for wasop, isop, etc. + Returns + ``1`` on success; ``0`` otherwise - Module: irc -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -getchanidle -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Module + ``channels`` - Returns: number of minutes that person has been idle; -1 if the specified user isn't on the channel - Module: irc + .. admonition:: Example + :collapsible: closed + :class: tcl-example -^^^^^^^^^^^^^^^^^^^^^ -getchanmode -^^^^^^^^^^^^^^^^^^^^^ + .. code-block:: tcl - Returns: string of the type "+ntik key" for the channel specified + set result [killchanban "#lamest" "*!*@127.0.0.1"] - Module: irc +---- -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -jump [server [[+]port [password]]] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. _tcl-killban: - Description: jumps to the server specified, or (if none is specified) the next server in the bot's serverlist. If you prefix the port with a plus sign (e.g. +6697), SSL connection will be attempted. +^^^^^^^^^^^^^ +killban +^^^^^^^^^^^^^ - Returns: nothing + Description + Removes a ban from the global ban list. - Module: server + Returns + ``1`` on success; ``0`` otherwise -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -pushmode [arg] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Description: sends out a channel mode change (ex: pushmode #lame +o goober) through the bot's queuing system. All the mode changes will be sent out at once (combined into one line as much as possible) after the script finishes, or when 'flushmode' is called. + Module + ``channels`` - Returns: nothing - Module: irc + .. admonition:: Example + :collapsible: closed + :class: tcl-example -^^^^^^^^^^^^^^^^^^^ -flushmode -^^^^^^^^^^^^^^^^^^^ + .. code-block:: tcl - Description: forces all previously pushed channel mode changes to be sent to the server, instead of when the script is finished (just for the channel specified) + set result [killban "*!*@127.0.0.1"] - Returns: nothing +---- - Module: irc +.. _tcl-killchanexempt: -^^^^^^^^^^^^^^^ -topic -^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +killchanexempt +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Removes an exempt from the exempt list for a channel. + + Returns + ``1`` on success; ``0`` otherwise + + + Module + ``channels`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example - Returns: string containing the current topic of the specified channel + .. code-block:: tcl - Module: irc + set result [killchanexempt "#lamest" "*!*@127.0.0.1"] + +---- + +.. _tcl-killexempt: ^^^^^^^^^^^^^^^^^^^ -validchan +killexempt ^^^^^^^^^^^^^^^^^^^ - Description: checks if the bot has a channel record for the specified channel. Note that this does not necessarily mean that the bot is ON the channel. + Description + Removes an exempt from the global exempt list. + + Returns + ``1`` on success; ``0`` otherwise + + + Module + ``channels`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set result [killexempt "*!*@127.0.0.1"] + +---- + +.. _tcl-killchaninvite: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +killchaninvite +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Removes an invite from the invite list for a channel. + + Returns + ``1`` on success; ``0`` otherwise + + + Module + ``channels`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl - Returns: 1 if the channel exists, 0 if not + set result [killchaninvite "#lamest" "*!*@127.0.0.1"] - Module: channels +---- + +.. _tcl-killinvite: ^^^^^^^^^^^^^^^^^^^ -isdynamic +killinvite ^^^^^^^^^^^^^^^^^^^ - Returns: 1 if the channel is a dynamic channel; 0 otherwise + Description + Removes an invite from the global invite list. - Module: channels + Returns + ``1`` on success; ``0`` otherwise -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -setudef -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Description: initializes a user defined channel flag, string or integer setting. You can use it like any other flag/setting. IMPORTANT: Don't forget to reinitialize your flags/settings after a restart, or it'll be lost. + Module + ``channels`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set result [killinvite "*!*@127.0.0.1"] + +---- + +.. _tcl-ischanjuped: + +^^^^^^^^^^^^^^^^^^^^^ +ischanjuped +^^^^^^^^^^^^^^^^^^^^^ + + Description + Returns ``1`` if the channel is juped, and the bot is unable to join; 0 otherwise. + + Returns + ``1`` if the channel is juped, and the bot is unable to join; ``0`` otherwise + + + Module + ``channels`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set juped [ischanjuped "#lamest"] + +---- + +.. _tcl-isban: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +isban [channel [-channel]] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Returns ``1`` if the specified ban is in the global ban list; 0 otherwise. If a channel is specified, that channel's ban list is checked as well. If the -channel flag is used at the end of the command, \*only\* the channel bans are checked. + + Returns + ``1`` if the specified ban is in the global ban list; ``0`` otherwise. If a channel is specified, that channel's ban list is checked as well. If the -channel flag is used at the end of the command, \*only\* the channel bans are checked. - Returns: nothing - Module: channels + Module + ``channels`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set result [isban "*!*@127.0.0.1"] + +---- + +.. _tcl-ispermban: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +ispermban [channel [-channel]] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Returns ``1`` if the specified ban is in the global ban list AND is marked as permanent; 0 otherwise. If a channel is specified, that channel's ban list is checked as well. If the -channel flag is used at the end of the command, \*only\* the channel bans are checked. + + Returns + ``1`` if the specified ban is in the global ban list AND is marked as permanent; ``0`` otherwise. If a channel is specified, that channel's ban list is checked as well. If the -channel flag is used at the end of the command, \*only\* the channel bans are checked. + + + Module + ``channels`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set result [ispermban "*!*@127.0.0.1"] + +---- + +.. _tcl-isexempt: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +isexempt [channel [-channel]] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Returns ``1`` if the specified exempt is in the global exempt list; 0 otherwise. If a channel is specified, that channel's exempt list is checked as well. If the -channel flag is used at the end of the command, \*only\* the channel exempts are checked. + + Returns + ``1`` if the specified exempt is in the global exempt list; ``0`` otherwise. If a channel is specified, that channel's exempt list is checked as well. If the -channel flag is used at the end of the command, \*only\* the channel exempts are checked. + + + Module + ``channels`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set result [isexempt "*!*@127.0.0.1"] + +---- + +.. _tcl-ispermexempt: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -renudef +ispermexempt [channel [-channel]] ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Description: renames a user defined channel flag, string, or integer setting. + Description + Returns ``1`` if the specified exempt is in the global exempt list AND is marked as permanent; 0 otherwise. If a channel is specified, that channel's exempt list is checked as well. If the -channel flag is used at the end of the command, \*only\* the channel exempts are checked. - Returns: nothing + Returns + ``1`` if the specified exempt is in the global exempt list AND is marked as permanent; ``0`` otherwise. If a channel is specified, that channel's exempt list is checked as well. If the -channel flag is used at the end of the command, \*only\* the channel exempts are checked. - Module: channels -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -deludef -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Module + ``channels`` - Description: deletes a user defined channel flag, string, or integer setting. - Returns: nothing + .. admonition:: Example + :collapsible: closed + :class: tcl-example - Module: channels + .. code-block:: tcl -^^^^^^^^^^^^^^^^^^^^^^^ -getudefs [flag/int/str] -^^^^^^^^^^^^^^^^^^^^^^^ + set result [ispermexempt "*!*@127.0.0.1"] - Returns: a list of user defined channel settings of the given type, or all of them if no type is given. +---- - Module: channels +.. _tcl-isinvite: -^^^^^^^^^^^^^^^^^^^^^ -chansettype -^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +isinvite [channel [-channel]] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Returns: The type of the setting you specify. The possible types are flag, int, str, pair. A flag type references a channel flag setting that can be set to either + or -. An int type is a channel setting that is set to a number, such as ban-time. A str type is a channel setting that stores a string, such as need-op. A pair type is a setting that holds a value couple, such as the flood settings. + Description + Returns ``1`` if the specified invite is in the global invite list; 0 otherwise. If a channel is specified, that channel's invite list is checked as well. If the -channel flag is used at the end of the command, \*only\* the channel invites are checked. - Module: channels + Returns + ``1`` if the specified invite is in the global invite list; ``0`` otherwise. If a channel is specified, that channel's invite list is checked as well. If the -channel flag is used at the end of the command, \*only\* the channel invites are checked. -^^^^^^^^^^^^^^^^^^^^^^^^^ -isupport get [key] -^^^^^^^^^^^^^^^^^^^^^^^^^ - Description: - - isupport get: Returns a flat key/value list (dict) of settings. - - isupport get : Returns the setting's value as a string. Throws an error if the key is not set. + Module + ``channels`` - Returns: string or dict, see description above - Module: server + .. admonition:: Example + :collapsible: closed + :class: tcl-example -^^^^^^^^^^^^^^^^^^^^^^^^^^^ -isupport isset -^^^^^^^^^^^^^^^^^^^^^^^^^^^ + .. code-block:: tcl - Description: Returns 0/1 depending on whether the key has a value. + set result [isinvite "*!*@127.0.0.1"] - Returns: 0 or 1 +---- - Module: server +.. _tcl-isperminvite: +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +isperminvite [channel [-channel]] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -DCC Commands ------------- + Description + Returns ``1`` if the specified invite is in the global invite list AND is marked as permanent; 0 otherwise. If a channel is specified, that channel's invite list is checked as well. If the -channel flag is used at the end of the command, \*only\* the channel invites are checked. -.. _putdcc: + Returns + ``1`` if the specified invite is in the global invite list AND is marked as permanent; ``0`` otherwise. If a channel is specified, that channel's invite list is checked as well. If the -channel flag is used at the end of the command, \*only\* the channel invites are checked. -^^^^^^^^^^^^^^^^^^^^^^^^^^ -putdcc [-raw] -^^^^^^^^^^^^^^^^^^^^^^^^^^ - Description: sends text to the idx specified. If -raw is specified, the text will be sent as is, without forced new lines or limits to line length. + Module + ``channels`` - Returns: nothing - Module: core + .. admonition:: Example + :collapsible: closed + :class: tcl-example -^^^^^^^^^^^^^^^^^^^^^^^^^^ -putidx -[raw] -^^^^^^^^^^^^^^^^^^^^^^^^^^ + .. code-block:: tcl - Description. Alias for the putdcc_ command. + set result [isperminvite "*!*@127.0.0.1"] - Returns: nothing +---- - Module: core +.. _tcl-isbansticky: -^^^^^^^^^^^^^^^^^^^^^^ -dccbroadcast -^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +isbansticky [channel [-channel]] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Description: sends a message to everyone on the party line across the botnet, in the form of "\*\*\* " for local users, "\*\*\* (Bot) " for users on other bots with version below 1.8.4, and "(Bot) " for users on other bots with version 1.8.4+ and console log mode 'l' enabled + Description + Returns ``1`` if the specified ban is marked as sticky in the global ban list; 0 otherwise. If a channel is specified, that channel's ban list is checked as well. If the -channel flag is used at the end of the command, \*only\* the channel bans are checked. - Returns: nothing + Returns + ``1`` if the specified ban is marked as sticky in the global ban list; ``0`` otherwise. If a channel is specified, that channel's ban list is checked as well. If the -channel flag is used at the end of the command, \*only\* the channel bans are checked. - Module: core -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -dccputchan -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Module + ``channels`` - Description: sends your message to everyone on a certain channel on the botnet, in a form exactly like dccbroadcast does. Valid channels are 0 through 99999. - Returns: nothing + .. admonition:: Example + :collapsible: closed + :class: tcl-example - Module: core + .. code-block:: tcl -^^^^^^^^^^^^^^^^^^^^^^^^ -boot [reason] -^^^^^^^^^^^^^^^^^^^^^^^^ - Description: boots a user from the partyline + set result [isbansticky "*!*@127.0.0.1"] - Returns: nothing +---- - Module: core +.. _tcl-isexemptsticky: -^^^^^^^^^^^^^^^^^^^^^ -dccsimul -^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +isexemptsticky [channel [-channel]] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Description: simulates text typed in by the dcc user specified. Note that in v0.9, this only simulated commands; now a command must be preceded by a '.' to be simulated. + Description + Returns ``1`` if the specified exempt is marked as sticky in the global exempt list; 0 otherwise. If a channel is specified, that channel's exempt list is checked as well. If the -channel flag is used at the end of the command, \*only\* the channel exempts are checked. - Returns: nothing + Returns + ``1`` if the specified exempt is marked as sticky in the global exempt list; ``0`` otherwise. If a channel is specified, that channel's exempt list is checked as well. If the -channel flag is used at the end of the command, \*only\* the channel exempts are checked. - Module: core -^^^^^^^^^^^^^^^^^ -hand2idx -^^^^^^^^^^^^^^^^^ + Module + ``channels`` - Returns: the idx (a number greater than or equal to zero) for the user given if the user is on the party line in chat mode (even if she is currently on a channel or in chat off), the file area, or in the control of a script. -1 is returned if no idx is found. If the user is on multiple times, the oldest idx is returned. - Module: core + .. admonition:: Example + :collapsible: closed + :class: tcl-example -^^^^^^^^^^^^^^ -idx2hand -^^^^^^^^^^^^^^ + .. code-block:: tcl - Returns: handle of the user with the given idx + set result [isexemptsticky "*!*@127.0.0.1"] - Module: core +---- -^^^^^^^^^^^^^^ -valididx -^^^^^^^^^^^^^^ +.. _tcl-isinvitesticky: - Returns: 1 if the idx currently exists; 0 otherwise +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +isinvitesticky [channel [-channel]] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Module: core + Description + Returns ``1`` if the specified invite is marked as sticky in the global invite list; 0 otherwise. If a channel is specified, that channel's invite list is checked as well. If the -channel flag is used at the end of the command, \*only\* the channel invites are checked. -^^^^^^^^^^^^^ -getchan -^^^^^^^^^^^^^ + Returns + ``1`` if the specified invite is marked as sticky in the global invite list; ``0`` otherwise. If a channel is specified, that channel's invite list is checked as well. If the -channel flag is used at the end of the command, \*only\* the channel invites are checked. - Returns: the current party line channel for a user on the party line; "0" indicates he's on the group party line, "-1" means he has chat off, and a value from 1 to 99999 is a private channel - Module: core + Module + ``channels`` -^^^^^^^^^^^^^^^^^^^^^^^ -setchan -^^^^^^^^^^^^^^^^^^^^^^^ - Description: sets a party line user's channel. The party line user is not notified that she is now on a new channel. A channel name can be used (provided it exists). + .. admonition:: Example + :collapsible: closed + :class: tcl-example - Returns: nothing + .. code-block:: tcl - Module: core + set result [isinvitesticky "*!*@127.0.0.1"] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -console [channel] [console-modes] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +---- - Description: changes a dcc user's console mode, either to an absolute mode (like "mpj") or just adding/removing flags (like "+pj" or "-moc" or "+mp-c"). The user's console channel view can be changed also (as long as the new channel is a valid channel). +.. _tcl-matchban: - Returns: a list containing the user's (new) channel view and (new) console modes, or nothing if that user isn't currently on the partyline +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +matchban [channel] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Module: core + Description + Returns ``1`` if the specified nick!user\@host matches a ban in the global ban list; 0 otherwise. If a channel is specified, that channel's ban list is checked as well. -^^^^^^^^^^^^^^^^^^ -resetconsole -^^^^^^^^^^^^^^^^^^ + Returns + ``1`` if the specified nick!user\@host matches a ban in the global ban list; ``0`` otherwise. If a channel is specified, that channel's ban list is checked as well. - Description: changes a dcc user's console mode to the default setting in the configfile. - Returns: a list containing the user's channel view and (new) console modes, or nothing if that user isn't currently on the partyline + Module + ``channels`` - Module: core -^^^^^^^^^^^^^^^^^^^ -echo [status] -^^^^^^^^^^^^^^^^^^^ + .. admonition:: Example + :collapsible: closed + :class: tcl-example - Description: turns a user's echo on or off; the status has to be a 1 or 0 + .. code-block:: tcl - Returns: new value of echo for that user (or the current value, if status was omitted) + set banned [matchban "Foobar!foobar@127.0.0.1" "#lamest"] - Module: core +---- -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -strip [+/-strip-flags] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. _tcl-matchexempt: - Description: modifies the strip-flags for a user. The supported strip-flags are: - - +------+-------------------------------------------------------------+ - | c | remove all color codes | - +------+-------------------------------------------------------------+ - | b | remove all boldface codes | - +------+-------------------------------------------------------------+ - | r | remove all reverse video codes | - +------+-------------------------------------------------------------+ - | u | remove all underline codes | - +------+-------------------------------------------------------------+ - | a | remove all ANSI codes | - +------+-------------------------------------------------------------+ - | g | remove all ctrl-g (bell) codes | - +------+-------------------------------------------------------------+ - | o | remove all ordinary codes (ctrl+o, terminates bold/color/..)| - +------+-------------------------------------------------------------+ - | i | remove all italics codes | - +------+-------------------------------------------------------------+ - | \* | remove all of the above | - +------+-------------------------------------------------------------+ - - Returns: new strip-flags for the specified user (or the current flags, if strip-flags was omitted) - - Module: core +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +matchexempt [channel] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -^^^^^^^^^^^^^^^^^^^ -page [number] -^^^^^^^^^^^^^^^^^^^ + Description + Returns ``1`` if the specified nick!user\@host matches an exempt in the global exempt list; 0 otherwise. If a channel is specified, that channel's exempt list is checked as well. - Description: This allows you to slow down the number of lines the bot sends + Returns + ``1`` if the specified nick!user\@host matches an exempt in the global exempt list; ``0`` otherwise. If a channel is specified, that channel's exempt list is checked as well. - to a user at once via the partyline. When enabled, any commands that send - greater than the specified number of lines will stop when that number is + Module + ``channels`` - reached and wait for the user to type another command (or press enter) to - continue. If the user has too many pending lines, he may be booted off the + .. admonition:: Example + :collapsible: closed + :class: tcl-example - bot. + .. code-block:: tcl - Returns: new value of page lines for that user (or the current value, if + set exempt [matchexempt "Foobar!foobar@127.0.0.1" "#lamest"] - status was omitted) +---- - Module: core +.. _tcl-matchinvite: -^^^^^^^^^^^^^^^^^^^^^^^^^^^ -putbot -^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +matchinvite [channel] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Returns ``1`` if the specified nick!user\@host matches an invite in the global invite list; 0 otherwise. If a channel is specified, that. + + Returns + ``1`` if the specified nick!user\@host matches an invite in the global invite list; ``0`` otherwise. If a channel is specified, that + channel's invite list is checked as well. + + + Module + ``channels`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set invited [matchinvite "Foobar!foobar@127.0.0.1" "#lamest"] + +---- + +.. _tcl-banlist: + +^^^^^^^^^^^^^^^^^ +banlist [channel] +^^^^^^^^^^^^^^^^^ + + Description + Returns a list of global bans, or, if a channel is specified, a list of channel-specific bans. Each entry is a sublist containing: hostmask, comment, expiration timestamp, time added, last time active, and creator. The three timestamps are in unixtime format. + + Returns + a list of global bans, or, if a channel is specified, a list of channel-specific bans. Each entry is a sublist containing: hostmask, comment, expiration timestamp, time added, last time active, and creator. The three timestamps are in unixtime format. + + + Module + ``channels`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set bans [banlist "#lamest"] + +---- + +.. _tcl-exemptlist: + +^^^^^^^^^^^^^^^^^^^^ +exemptlist [channel] +^^^^^^^^^^^^^^^^^^^^ + + Description + Returns a list of global exempts, or, if a channel is specified, a list of channel-specific exempts. Each entry is a sublist containing: hostmask, comment, expiration timestamp, time added, last time active, and creator. The three timestamps are in unixtime format. + + Returns + a list of global exempts, or, if a channel is specified, a list of channel-specific exempts. Each entry is a sublist containing: hostmask, comment, expiration timestamp, time added, last time active, and creator. The three timestamps are in unixtime format. + + + Module + ``channels`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set exempts [exemptlist "#lamest"] + +---- + +.. _tcl-invitelist: + +^^^^^^^^^^^^^^^^^^^^ +invitelist [channel] +^^^^^^^^^^^^^^^^^^^^ + + Description + Returns a list of global invites, or, if a channel is specified, a list of channel-specific invites. Each entry is a sublist containing: hostmask, comment, expiration timestamp, time added, last time active, and creator. The three timestamps are in unixtime format. + + Returns + a list of global invites, or, if a channel is specified, a list of channel-specific invites. Each entry is a sublist containing: hostmask, comment, expiration timestamp, time added, last time active, and creator. The three timestamps are in unixtime format. + + + Module + ``channels`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set invites [invitelist "#lamest"] + +---- + +.. _tcl-newignore: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +newignore [lifetime] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Adds an entry to the ignore list; creator is given credit for the ignore. lifetime is how many minutes until the ignore expires and is removed. If lifetime is not specified, ignore-time (usually 60) is used. Setting the lifetime to 0 makes it a permanent ignore. + + Returns + nothing + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + newignore "*!*@127.0.0.1" foobar "Example ignore" 60 + +---- + +.. _tcl-killignore: + +^^^^^^^^^^^^^^^^^^^^^ +killignore +^^^^^^^^^^^^^^^^^^^^^ + + Description + Removes an entry from the ignore list. + + Returns + ``1`` if successful; ``0`` otherwise + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set removed [killignore "*!*@127.0.0.1"] + +---- + +.. _tcl-ignorelist: + +^^^^^^^^^^ +ignorelist +^^^^^^^^^^ + + Description + Returns a list of ignores. Each entry is a sublist containing: hostmask, comment, expiration timestamp, time added, and creator. The timestamps are in unixtime format. + + Returns + a list of ignores. Each entry is a sublist containing: hostmask, comment, expiration timestamp, time added, and creator. The timestamps are in unixtime format. + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set ignores [ignorelist] + +---- + +.. _tcl-isignore: + +^^^^^^^^^^^^^^^^^^^ +isignore +^^^^^^^^^^^^^^^^^^^ + + Description + Returns ``1`` if the ignore is in the list; 0 otherwise. + + Returns + ``1`` if the ignore is in the list; ``0`` otherwise + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set ignored [isignore "*!*@127.0.0.1"] + +---- + +.. _tcl-save: + +^^^^ +save +^^^^ + + Description + Writes the user and channel files to disk. + + Returns + nothing + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + save + +---- + +.. _tcl-reload: + +^^^^^^ +reload +^^^^^^ + + Description + Loads the userfile from disk, replacing whatever is in memory. + + Returns + nothing + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + reload + +---- + +.. _tcl-backup: + +^^^^^^ +backup +^^^^^^ + + Description + Makes a simple backup of the userfile that's on disk. If the channels module is loaded, this also makes a simple backup of the channel file. + + Returns + nothing + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + backup + +---- + +.. _tcl-getting-users: + +^^^^^^^^^^^^^ +getting-users +^^^^^^^^^^^^^ + + Description + Returns ``1`` if the bot is currently downloading a userfile from a sharebot (and hence, user records are about to drastically change); 0 if not. + + Returns + ``1`` if the bot is currently downloading a userfile from a sharebot (and hence, user records are about to drastically change); ``0`` if not + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set result [getting-users] + +Channel Commands +---------------- + +.. _tcl-channel-add: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +channel add [option-list] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Adds a channel record for the bot to monitor. The full list of possible options are given in ``doc/settings/mod.channels.`` Note that the channel options must be in a list (enclosed in {}). + + Returns + nothing + + + Module + ``channels`` + + + .. admonition:: Example — Add a channel + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + channel add "#lamest" + +---- + +.. _tcl-channel-set: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +channel set +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Sets options for the channel specified. `options` is a flat list of either +/-settings or key/value pairs. The full list of possible options are given in ``doc/settings/mod.channels.`` Note: Tcl code settings such as the need-* settings must be valid Tcl code as a single word, for example ``channel set #lamestst need-op { putmsg ChanServ "op #lamestst" }``. + + Returns + nothing + + + Module + ``channels`` + + + .. admonition:: Example — Change a channel setting + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + channel set "#lamest" +autoop + +---- + +.. _tcl-channel-info: + +^^^^^^^^^^^^^^^^^^^ +channel info +^^^^^^^^^^^^^^^^^^^ + + Description + Returns the settings currently stored for the specified channel. + + + Returns + a list of info about the specified channel's settings. + + + Module + ``channels`` + + + .. admonition:: Example — Inspect channel settings + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set info [channel info "#lamest"] + +---- + +.. _tcl-channel-get: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +channel get [setting] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Returns a channel setting, or all channel settings when no setting is specified. + + + Returns + The value of the setting you specify. For flags, a value of ``0`` means it is disabled (-), and non-zero means enabled (+). If no setting is specified, a flat list of all available settings and their values will be returned. + + + Module + ``channels`` + + + .. admonition:: Example — Read a channel setting + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set autoop [channel get "#lamest" autoop] + +---- + +.. _tcl-channel-remove: + +^^^^^^^^^^^^^^^^^^^^^ +channel remove +^^^^^^^^^^^^^^^^^^^^^ + + Description + Removes a channel record from the bot and makes the bot no longer monitor the channel. + + Returns + nothing + + + Module + ``channels`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + channel remove "#lamest" + +---- + +.. _tcl-savechannels: + +^^^^^^^^^^^^ +savechannels +^^^^^^^^^^^^ + + Description + Saves the channel settings to the channel-file if one is defined. + + Returns + nothing + + + Module + ``channels`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + savechannels + +---- + +.. _tcl-loadchannels: + +^^^^^^^^^^^^ +loadchannels +^^^^^^^^^^^^ + + Description + Reloads the channel settings from the channel-file if one is defined. + + Returns + nothing + + + Module + ``channels`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + loadchannels + +---- + +.. _tcl-channels: + +^^^^^^^^ +channels +^^^^^^^^ + + Description + Returns the channels for which the bot has channel records. + + + Returns + a list of the channels the bot has a channel record for + + + Module + ``channels`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set channel_list [channels] + +---- + +.. _tcl-channame2dname: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +channame2dname +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Converts a real IRC channel name to the channel description name Eggdrop uses internally. This is primarily relevant to !channels; for other channels, the two names are the same. + + Returns + the channel description name corresponding to + + See also + :ref:`chandname2name ` + + + Module + ``irc`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set dname [channame2dname "#lamest"] + +---- + +.. _tcl-chandname2name: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +chandname2name +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Converts an Eggdrop channel description name to the real IRC channel name used by the server. This is primarily relevant to !channels; for other channels, the two names are the same. + + Returns + the real IRC channel name corresponding to + + See also + :ref:`channame2dname ` + + + Module + ``irc`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set channel_name [chandname2name "#lamest"] + +---- + +.. _tcl-isbotnick: + +^^^^^^^^^^^^^^^^ +isbotnick +^^^^^^^^^^^^^^^^ + + Description + Checks whether the specified nickname is the bot's current nickname. + + + Returns + ``1`` if the nick matches the botnick; ``0`` otherwise + + + Module + ``server`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set is_bot [isbotnick LamestBot] + +---- + +.. _tcl-botisop: + +^^^^^^^^^^^^^^^^^ +botisop [channel] +^^^^^^^^^^^^^^^^^ + + Description + Returns ``1`` if the bot has ops on the specified channel (or any channel if no channel is specified); 0 otherwise. + + Returns + ``1`` if the bot has ops on the specified channel (or any channel if no channel is specified); ``0`` otherwise + + + Module + ``irc`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set opped [botisop "#lamest"] + +---- + +.. _tcl-botishalfop: + +^^^^^^^^^^^^^^^^^^^^^ +botishalfop [channel] +^^^^^^^^^^^^^^^^^^^^^ + + Description + Returns ``1`` if the bot has halfops on the specified channel (or any channel if no channel is specified); 0 otherwise. + + Returns + ``1`` if the bot has halfops on the specified channel (or any channel if no channel is specified); ``0`` otherwise + + + Module + ``irc`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set halfopped [botishalfop "#lamest"] + +---- + +.. _tcl-botisvoice: + +^^^^^^^^^^^^^^^^^^^^ +botisvoice [channel] +^^^^^^^^^^^^^^^^^^^^ + + Description + Returns ``1`` if the bot has a voice on the specified channel (or any channel if no channel is specified); 0 otherwise. + + Returns + ``1`` if the bot has a voice on the specified channel (or any channel if no channel is specified); ``0`` otherwise + + + Module + ``irc`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set voiced [botisvoice "#lamest"] + +---- + +.. _tcl-botonchan: + +^^^^^^^^^^^^^^^^^^^ +botonchan [channel] +^^^^^^^^^^^^^^^^^^^ + + Description + Returns ``1`` if the bot is on the specified channel (or any channel if no channel is specified); 0 otherwise. + + Returns + ``1`` if the bot is on the specified channel (or any channel if no channel is specified); ``0`` otherwise + + + Module + ``irc`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set present [botonchan "#lamest"] + +---- + +.. _tcl-isop: + +^^^^^^^^^^^^^^^^^^^^^^^^^ +isop [channel] +^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Returns ``1`` if someone by the specified nickname is on the channel (or any channel if no channel name is specified) and has ops; 0 otherwise. + + Returns + ``1`` if someone by the specified nickname is on the channel (or any channel if no channel name is specified) and has ops; ``0`` otherwise + + + Module + ``irc`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set opped [isop Foobar "#lamest"] + +---- + +.. _tcl-ishalfop: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +ishalfop [channel] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Returns ``1`` if someone by the specified nickname is on the channel (or any channel if no channel name is specified) and has halfops; 0 otherwise. + + Returns + ``1`` if someone by the specified nickname is on the channel (or any channel if no channel name is specified) and has halfops; ``0`` otherwise + + + Module + ``irc`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set halfopped [ishalfop Foobar "#lamest"] + +---- + +.. _tcl-wasop: + +^^^^^^^^^^^^^^^^^^^^^^^^^^ +wasop +^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Returns ``1`` if someone that just got opped/deopped in the chan had op before the modechange; 0 otherwise. + + Returns + ``1`` if someone that just got opped/deopped in the chan had op before the modechange; ``0`` otherwise + + + Module + ``irc`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set previously_opped [wasop Foobar "#lamest"] + +---- + +.. _tcl-washalfop: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +washalfop +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Returns ``1`` if someone that just got halfopped/dehalfopped in the chan had halfop before the modechange; 0 otherwise. + + Returns + ``1`` if someone that just got halfopped/dehalfopped in the chan had halfop before the modechange; ``0`` otherwise + + + Module + ``irc`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set previously_halfopped [washalfop Foobar "#lamest"] + +---- + +.. _tcl-isvoice: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +isvoice [channel] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Returns ``1`` if someone by that nickname is on the channel (or any channel if no channel is specified) and has voice (+v); 0 otherwise. + + Returns + ``1`` if someone by that nickname is on the channel (or any channel if no channel is specified) and has voice (+v); ``0`` otherwise + + + Module + ``irc`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set voiced [isvoice Foobar "#lamest"] + +---- + +.. _tcl-isidentified: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +isidentified [channel] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Determine if a user is identified to irc services. WARNING: this may not be accurate depending on the server and configuration. For accurate results, the server must support (and Eggdrop must have enabled via CAP) the account-notify and extended-join capabilities, and the server must understand WHOX requests (also known as raw 354 responses). + + Returns + ``1`` if someone by the specified nickname is on the channel (or any channel if no channel name is specified) and is logged in); ``0`` otherwise. + + + Module + ``irc`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set identified [isidentified Foobar "#lamest"] + +---- + +.. _tcl-isaway: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^ +isaway [channel] +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Determine if a user is marked as ``away`` on a server. IMPORTANT: this command is only ``mostly`` reliable on its own when the IRCv3 away-notify capability is available and negotiated with the IRC server (if you didn't add this to your config file, it likely isn't enabled- you can confirm using the ``cap`` Tcl command). Additionally, there is no way for Eggdrop (or any client) to capture a user's away status when the user first joins a channel (they are assumed present by Eggdrop on join). To use this command without the away-notify capability negotiated, or to get a user's away status on join (via a JOIN bind), use ``refreshchan w`` on a channel the user is on, which will refresh the current away status stored by Eggdrop for all users on the channel. + + Returns + ``1`` if Eggdrop is currently tracking someone by that nickname marked as 'away' (again, see disclaimer above) by an IRC server; ``0`` otherwise. + + + Module + ``irc`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set away [isaway Foobar "#lamest"] + +---- + +.. _tcl-isircbot: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +isircbot [channel] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Determine if a user has denoted themselves as a bot via an ircd-defined user flag (declared via BOT in a server's 005/ISUPPORT line). Due to server implementations, accurately monitoring this is incredibly fragile, as the flag can be added and removed by a user without any notification to other users. To ensure this status is current for use, it is recommended to use ``refreshchan w`` on a channel the user is on, which will refresh if the user is a bot or not for all users on the channel. If a server does not advertise BOT in its ISUPPORT line but still supports it (currently the case for unrealircd), you can manually set it by adding ``BOT=B`` (or whatever flag is used) to the isupport-default setting in your eggdrop.conf file. + + Returns + ``1`` if Eggdrop is currently tracking someone by that nickname marked as a bot by an IRC server; ``0`` otherwise. + + + Module + ``irc`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set is_bot [isircbot Foobar "#lamest"] + +---- + +.. _tcl-onchan: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^ +onchan [channel] +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Returns ``1`` if someone by that nickname is on the specified channel (or any channel if none is specified); 0 otherwise. + Returns + ``1`` if someone by that nickname is on the specified channel (or any channel if none is specified); ``0`` otherwise + + + Module + ``irc`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set present [onchan Foobar "#lamest"] + +---- + +.. _tcl-monitor: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +monitor [nickname] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Interacts with the list of nicknames Eggdrop has asked the IRC server to track. valid sub-commands are add, delete, list, online, offline, status, and clear. The ``add`` command sends ``nickname`` to the server to track. The ``delete`` command removes ``nickname`` from being tracked by the server (or returns an error if the nickname is not present). The ``list`` command returns a list of all nicknames the IRC server is tracking on behalf of Eggdrop. The ``online`` command returns a string of tracked nicknames that are currently online. The ``offline`` command returns a list of tracked nicknames that are currently offline. + + Returns + The ``add`` sub-command returns a ``1`` if the nick was successfully added, a ``0`` if the nick is already in the monitor list, and a ``2`` if the nick could not be added. The ``delete`` sub-command returns a ``1`` if the nick is removed, or an error if the nick is not found. The ``status`` sub-command returns a ``1`` if ``nickname`` is online or a ``0`` if ``nickname`` is offline. The ``clear`` command removes all nicknames from the list the server is monitoring. + + + Module + ``irc`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set added [monitor add Foobar] + +---- + +.. _tcl-accounttracking: + +^^^^^^^^^^^^^^^ +accounttracking +^^^^^^^^^^^^^^^ + + Description + Checks to see if the three required functionalities to enable proper account tracking are available (and enabled) to Eggdrop. This checks if the extended-join and account-notify IRCv3 capabilities are currently enabled, and checks if the server supports WHOX (based on the type of server selected in the config file, or the use-354 variable being set to 1 when selecting an "Other" server). + + Returns + a ``1`` if all three functionalities are present, a ``0`` if one or more are missing. + + + Module + ``irc`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set result [accounttracking] + +---- + +.. _tcl-getaccount: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +getaccount [channel] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Returns the services account name associated with nickname, ``*`` if the user is not logged into services, or ``""`` if eggdrop does not know the account status of the user. + + Returns + the services account name associated with nickname, ``*`` if the user is not logged into services, or ``""`` if eggdrop does not know the account status of the user. + + NOTE: the three required IRC components for account tracking are: the WHOX feature, the extended-join IRCv3 capability and the account-notify IRCv3 capability. if only some of the three feature are available, eggdrop provides best-effort account tracking. please see doc/ACCOUNTS for additional information. + + + Module + ``irc`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set account [getaccount Foobar "#lamest"] + +---- + +.. _tcl-nick2hand: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +nick2hand [channel] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Returns the handle of a nickname on a channel. If a channel is not specified, the bot will check all of its channels. If the nick is not found, ``""`` is returned. If the nick is found but does not have a handle, ``*`` is returned. If no channel is specified, all channels are checked. + + Returns + the handle of a nickname on a channel. If a channel is not specified, the bot will check all of its channels. If the nick is not found, ``""`` is returned. If the nick is found but does not have a handle, ``*`` is returned. If no channel is specified, all channels are checked. + + + Module + ``irc`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set handle [nick2hand Foobar "#lamest"] + +---- + +.. _tcl-account2nicks: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +account2nicks [channel] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Returns a de-duplicated Tcl list of the nickname(s) on the specified channel (if one is specified) whose nickname matches the given account; ``""`` is returned if no match is found. This command will only work if a server supports (and Eggdrop has enabled) the account-notify and extended-join capabilities, and the server understands WHOX requests (also known as raw 354 responses). If no channel is specified, all channels are checked. + + Returns + a de-duplicated Tcl list of the nickname(s) on the specified channel (if one is specified) whose nickname matches the given account; ``""`` is returned if no match is found. This command will only work if a server supports (and Eggdrop has enabled) the account-notify and extended-join capabilities, and the server understands WHOX requests (also known as raw 354 responses). If no channel is specified, all channels are checked. + + + Module + ``irc`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set nicks [account2nicks foobar "#lamest"] + +---- + +.. _tcl-hand2nick: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +hand2nick [channel] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Returns nickname of the first person on the specified channel (if one is specified) whose nick!user\@host matches the given handle; ``""`` is returned if no match is found. If no channel is specified, all channels are checked. + + Returns + nickname of the first person on the specified channel (if one is specified) whose nick!user\@host matches the given handle; ``""`` is returned if no match is found. If no channel is specified, all channels are checked. + + + Module + ``irc`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set nick [hand2nick foobar "#lamest"] + +---- + +.. _tcl-hand2nicks: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +hand2nicks [channel] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Returns a de-duplicated Tcl list of the nickname(s) on the specified channel (if one is specified) whose nick!user\@host matches the given handle; ``""`` is returned if no match is found. If no channel is specified, all channels are checked. + + Returns + a de-duplicated Tcl list of the nickname(s) on the specified channel (if one is specified) whose nick!user\@host matches the given handle; ``""`` is returned if no match is found. If no channel is specified, all channels are checked. + + + Module + ``irc`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set nicks [hand2nicks foobar "#lamest"] + +---- + +.. _tcl-handonchan: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +handonchan [channel] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Returns ``1`` if the the nick!user\@host for someone on the channel (or any channel if no channel name is specified) matches for the handle given; 0 otherwise. + + Returns + ``1`` if the the nick!user\@host for someone on the channel (or any channel if no channel name is specified) matches for the handle given; ``0`` otherwise + + + Module + ``irc`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set present [handonchan foobar "#lamest"] + +---- + +.. _tcl-ischanban: + +^^^^^^^^^^^^^^^^^^^^^^^^^ +ischanban +^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Returns ``1`` if the specified ban is on the given channel's ban list (not the bot's banlist for the channel). + + Returns + ``1`` if the specified ban is on the given channel's ban list (not the bot's banlist for the channel) + + + Module + ``irc`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set result [ischanban "*!*@127.0.0.1" "#lamest"] + +---- + +.. _tcl-ischanexempt: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +ischanexempt +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Returns ``1`` if the specified exempt is on the given channel's exempt list (not the bot's exemptlist for the channel). + + Returns + ``1`` if the specified exempt is on the given channel's exempt list (not the bot's exemptlist for the channel) + + + Module + ``irc`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set result [ischanexempt "*!*@127.0.0.1" "#lamest"] + +---- + +.. _tcl-ischaninvite: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +ischaninvite +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Returns ``1`` if the specified invite is on the given channel's invite list (not the bot's invitelist for the channel). + + Returns + ``1`` if the specified invite is on the given channel's invite list (not the bot's invitelist for the channel) + + + Module + ``irc`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set result [ischaninvite "*!*@127.0.0.1" "#lamest"] + +---- + +.. _tcl-chanbans: + +^^^^^^^^^^^^^^^^^^ +chanbans +^^^^^^^^^^^^^^^^^^ + + Description + Returns a list of the current bans on the channel. Each element is a sublist of the form {```` ```` ````}. age is seconds from the bot's point of view. + + Returns + a list of the current bans on the channel. Each element is a sublist of the form ``{ }``. age is seconds from the bot's point of view + + + Module + ``irc`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set bans [chanbans "#lamest"] + +---- + +.. _tcl-chanexempts: + +^^^^^^^^^^^^^^^^^^^^^ +chanexempts +^^^^^^^^^^^^^^^^^^^^^ + + Description + Returns a list of the current exempts on the channel. Each element is a sublist of the form {```` ```` ````}. age is seconds from the bot's point of view. + + Returns + a list of the current exempts on the channel. Each element is a sublist of the form ``{ }``. age is seconds from the bot's point of view + + + Module + ``irc`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set exempts [chanexempts "#lamest"] + +---- + +.. _tcl-chaninvites: + +^^^^^^^^^^^^^^^^^^^^^ +chaninvites +^^^^^^^^^^^^^^^^^^^^^ + + Description + Returns a list of the current invites on the channel. Each element is a sublist of the form {```` ```` ````}. age is seconds from the bot's point of view. + + Returns + a list of the current invites on the channel. Each element is a sublist of the form ``{ }``. age is seconds from the bot's point of view + + + Module + ``irc`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set invites [chaninvites "#lamest"] + +---- + +.. _tcl-resetbans: + +^^^^^^^^^^^^^^^^^^^ +resetbans +^^^^^^^^^^^^^^^^^^^ + + Description + Removes all bans on the channel that aren't in the bot's ban list and refreshes any bans that should be on the channel but aren't. + + Returns + nothing + + + Module + ``irc`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + resetbans "#lamest" + +---- + +.. _tcl-resetexempts: + +^^^^^^^^^^^^^^^^^^^^^^ +resetexempts +^^^^^^^^^^^^^^^^^^^^^^ + + Description + Removes all exempt on the channel that aren't in the bot's exempt list and refreshes any exempts that should be on the channel but aren't. + + Returns + nothing + + + Module + ``irc`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + resetexempts "#lamest" + +---- + +.. _tcl-resetinvites: + +^^^^^^^^^^^^^^^^^^^^^^ +resetinvites +^^^^^^^^^^^^^^^^^^^^^^ + + Description + Removes all invites on the channel that aren't in the bot's invite list and refreshes any invites that should be on the channel but aren't. + + Returns + nothing + + + Module + ``irc`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + resetinvites "#lamest" + +---- + +.. _tcl-resetchanidle: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +resetchanidle [nick] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Resets the channel idle time for the given nick or for all nicks on the channel if no nick is specified. + + Returns + nothing + + + Module + ``irc`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + resetchanidle Foobar "#lamest" + +---- + +.. _tcl-resetchanjoin: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +resetchanjoin [nick] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Resets the channel join time for the given nick or for all nicks on the channel if no nick is specified. + + Returns + nothing + + + Module + ``irc`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + resetchanjoin Foobar "#lamest" + +---- + +.. _tcl-resetchan: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^ +resetchan [flags] +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Clears the channel info Eggdrop is currently storing for a channel, then rereads the channel info from the server. Useful if Eggdrop gets into a bad state on a server with respect to a channel userlist, for example. If flags are specified, only the required information will be reset, according to the given flags. Available flags: + + .. list-table:: + :widths: 14 86 + :header-rows: 1 + + * - ``flags`` + - Description + * - ``b`` + - channel bans + * - ``e`` + - channel exempts + * - ``I`` + - channel invites + * - ``m`` + - channel modes + * - ``w`` + - memberlist (who & away info) + + Returns + nothing + + + Module + ``irc`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + resetchan "#lamest" w + +---- + +.. _tcl-refreshchan: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +refreshchan [flags] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + An alternative to resetchan, refresh rereads the channel info from the server without first clearing out the previously stored information. Useful for updating a user's away status without resetting their idle time, for example. If flags are specified, only the required information will be refreshed, according to the given flags. Available flags: + + .. list-table:: + :widths: 14 86 + :header-rows: 1 + + * - ``flags`` + - Description + * - ``b`` + - channel bans + * - ``e`` + - channel exempts + * - ``I`` + - channel invites + * - ``m`` + - channel modes + * - ``t`` + - channel topic + * - ``w`` + - memberlist (who & away info) + + Returns + nothing + + + Module + ``irc`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + refreshchan "#lamest" w + +---- + +.. _tcl-getchanhost: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +getchanhost [channel] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Returns user\@host of the specified nickname (the nickname is not included in the returned host). If a channel is not specified, bot will check all of its channels. If the nickname is not on the channel(s), ``""`` is returned. + + Returns + user\@host of the specified nickname (the nickname is not included in the returned host). If a channel is not specified, bot will check all of its channels. If the nickname is not on the channel(s), ``""`` is returned. + + + Module + ``irc`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set host [getchanhost Foobar "#lamest"] + +---- + +.. _tcl-getchanjoin: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +getchanjoin +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Returns timestamp (unixtime format) of when the specified nickname joined the channel if available, 0 otherwise. Note that after a channel reset this information will be lost, even if previously available. + + Returns + timestamp (unixtime format) of when the specified nickname joined the channel if available, ``0`` otherwise. Note that after a channel reset this information will be lost, even if previously available. + + + Module + ``irc`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set joined [getchanjoin Foobar "#lamest"] + +---- + +.. _tcl-onchansplit: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +onchansplit [channel] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Returns ``1`` if that nick is split from the channel (or any channel if no channel is specified); 0 otherwise. + + Returns + ``1`` if that nick is split from the channel (or any channel if no channel is specified); ``0`` otherwise + + + Module + ``irc`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set split [onchansplit Foobar "#lamest"] + +---- + +.. _tcl-chanlist: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +chanlist [flags][<&|>chanflags] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Lists all users on a channel Eggdrop has joined. flags are any global flags; the ``&`` or ``\|`` denotes to look for channel specific flags, where ``&`` will return users having ALL chanflags and ``|`` returns users having ANY of the chanflags (See `Flag Masks`_ for additional information). + + Returns + Searching for flags optionally preceded with a '+' will return a list of nicknames that have all the flags listed. Searching for flags preceded with a '-' will return a list of nicknames that do not have have any of the flags (differently said, '-' will hide users that have all flags listed). If no flags are given, all of the nicknames on the channel are returned. + + Please note that if you're executing chanlist after a part or sign bind, the gone user will still be listed, so you can check for wasop, isop, etc. + + + Module + ``irc`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set nicks [chanlist "#lamest"] + +---- + +.. _tcl-getchanidle: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +getchanidle +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Returns number of minutes that person has been idle; -1 if the specified user isn't on the channel. + + Returns + number of minutes that person has been idle; ``-1`` if the specified user isn't on the channel + + + Module + ``irc`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set idle [getchanidle Foobar "#lamest"] + +---- + +.. _tcl-getchanmode: + +^^^^^^^^^^^^^^^^^^^^^ +getchanmode +^^^^^^^^^^^^^^^^^^^^^ + + Description + Returns string of the type ``+ntik key`` for the channel specified. + + Returns + string of the type ``+ntik key`` for the channel specified + + + Module + ``irc`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set modes [getchanmode "#lamest"] + +---- + +.. _tcl-jump: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +jump [server [[+]port [password]]] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Jumps to the server specified, or (if none is specified) the next server in the bot's serverlist. If you prefix the port with a plus sign (e.g. +6697), SSL connection will be attempted. + + Returns + nothing + + + Module + ``server`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + jump irc.example.net +6697 + +---- + +.. _tcl-pushmode: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +pushmode [arg] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Sends out a channel mode change (ex: pushmode #lamest +o Foobar) through the bot's queuing system. All the mode changes will be sent out at once (combined into one line as much as possible) after the script finishes, or when ``flushmode`` is called. + + Returns + nothing + + + Module + ``irc`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + pushmode "#lamest" +o Foobar + +---- + +.. _tcl-flushmode: + +^^^^^^^^^^^^^^^^^^^ +flushmode +^^^^^^^^^^^^^^^^^^^ + + Description + Forces all previously pushed channel mode changes to be sent to the server, instead of when the script is finished (just for the channel specified). + + Returns + nothing + + + Module + ``irc`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + flushmode "#lamest" + +---- + +.. _tcl-topic: + +^^^^^^^^^^^^^^^ +topic +^^^^^^^^^^^^^^^ + + Description + Returns string containing the current topic of the specified channel. + + Returns + string containing the current topic of the specified channel + + + Module + ``irc`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set current_topic [topic "#lamest"] + +---- + +.. _tcl-validchan: + +^^^^^^^^^^^^^^^^^^^ +validchan +^^^^^^^^^^^^^^^^^^^ + + Description + Checks if the bot has a channel record for the specified channel. Note that this does not necessarily mean that the bot is ON the channel. + + Returns + ``1`` if the channel exists, ``0`` if not + + + Module + ``channels`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set known [validchan "#lamest"] + +---- + +.. _tcl-isdynamic: + +^^^^^^^^^^^^^^^^^^^ +isdynamic +^^^^^^^^^^^^^^^^^^^ + + Description + Returns ``1`` if the channel is a dynamic channel; 0 otherwise. + + Returns + ``1`` if the channel is a dynamic channel; ``0`` otherwise + + + Module + ``channels`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set dynamic [isdynamic "#lamest"] + +---- + +.. _tcl-setudef: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +setudef +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Initializes a user defined channel flag, string or integer setting. You can use it like any other flag/setting. IMPORTANT: Don't forget to reinitialize your flags/settings after a restart, or it'll be lost. + + Returns + nothing + + + Module + ``channels`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + setudef flag example-setting + +---- + +.. _tcl-renudef: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +renudef +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Renames a user defined channel flag, string, or integer setting. + + Returns + nothing + + + Module + ``channels`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + renudef flag example-setting renamed-setting + +---- + +.. _tcl-deludef: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +deludef +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Deletes a user defined channel flag, string, or integer setting. + + Returns + nothing + + + Module + ``channels`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + deludef flag example-setting + +---- + +.. _tcl-getudefs: + +^^^^^^^^^^^^^^^^^^^^^^^ +getudefs [flag/int/str] +^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Returns a list of user defined channel settings of the given type, or all of them if no type is given. + + Returns + a list of user defined channel settings of the given type, or all of them if no type is given. + + + Module + ``channels`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set flags [getudefs flag] + +---- + +.. _tcl-chansettype: + +^^^^^^^^^^^^^^^^^^^^^ +chansettype +^^^^^^^^^^^^^^^^^^^^^ + + Description + Returns the type of the setting you specify. The possible types are flag, int, str, pair. A flag type references a channel flag setting that can be set to either + or -. An int type is a channel setting that is set to a number, such as ban-time. A str type is a channel setting that stores a string, such as need-op. A pair type is a setting that holds a value couple, such as the flood settings. + + Returns + The type of the setting you specify. The possible types are ``flag``, ``int``, ``str``, ``pair``. A flag type references a channel flag setting that can be set to either + or -. An int type is a channel setting that is set to a number, such as ban-time. A str type is a channel setting that stores a string, such as need-op. A pair type is a setting that holds a value couple, such as the flood settings. + + + Module + ``channels`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set type [chansettype autoop] + +---- + +.. _tcl-isupport-get: + +^^^^^^^^^^^^^^^^^^^^^^^^^ +isupport get [key] +^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + - isupport get: Returns a flat key/value list (dict) of settings. + - isupport get : Returns the setting's value as a string. Throws an error if the key is not set. + + Returns + string or dict, see description above + + + Module + ``server`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set chantypes [isupport get CHANTYPES] + +---- + +.. _tcl-isupport-isset: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^ +isupport isset +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Returns ``0``/1 depending on whether the key has a value. + + Returns + ``0`` or ``1`` + + + Module + ``server`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set supported [isupport isset CHANTYPES] + +DCC Commands +------------ + +.. _putdcc: + +.. _tcl-putdcc: + +^^^^^^^^^^^^^^^^^^^^^^^^^^ +putdcc [-raw] +^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Sends text to the idx specified. If -raw is specified, the text will be sent as is, without forced new lines or limits to line length. + + Returns + nothing + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + putdcc 0 "Hello, foobar." + +---- + +.. _tcl-putidx: + +^^^^^^^^^^^^^^^^^^^^^^^^^^ +putidx -[raw] +^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Alias for the putdcc_ command. + + Returns + nothing + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + putidx 0 "Hello, foobar." + +---- + +.. _tcl-dccbroadcast: + +^^^^^^^^^^^^^^^^^^^^^^ +dccbroadcast +^^^^^^^^^^^^^^^^^^^^^^ + + Description + Sends a message to everyone on the party line across the botnet, in the form of ``\*\*\* `` for local users, ``\*\*\* (Bot) `` for users on other bots with version below 1.8.4, and ``(Bot) `` for users on other bots with version 1.8.4+ and console log mode ``l`` enabled. + + Returns + nothing + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + dccbroadcast "Example botnet announcement" + +---- + +.. _tcl-dccputchan: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +dccputchan +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Sends your message to everyone on a certain channel on the botnet, in a form exactly like dccbroadcast does. Valid channels are 0 through 99999. + + Returns + nothing + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + dccputchan 0 "Hello from LamestBot" + +---- + +.. _tcl-boot: + +^^^^^^^^^^^^^^^^^^^^^^^^ +boot [reason] +^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Boots a user from the partyline. + + Returns + nothing + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + boot foobar@LamestBot "Requested disconnect" + +---- + +.. _tcl-dccsimul: + +^^^^^^^^^^^^^^^^^^^^^ +dccsimul +^^^^^^^^^^^^^^^^^^^^^ + + Description + Simulates text typed in by the dcc user specified. Note that in v0.9, this only simulated commands; now a command must be preceded by a ``.`` to be simulated. + + Returns + nothing + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + dccsimul 0 ".who" + +---- + +.. _tcl-hand2idx: + +^^^^^^^^^^^^^^^^^ +hand2idx +^^^^^^^^^^^^^^^^^ + + Description + Returns the idx (a number greater than or equal to zero) for the user given if the user is on the party line in chat mode (even if she is currently on a channel or in chat off), the file area, or in the control of a script. -1 is returned if no idx is found. If the user is on multiple times, the oldest idx is returned. + + Returns + the idx (a number greater than or equal to zero) for the user given if the user is on the party line in chat mode (even if she is currently on a channel or in chat off), the file area, or in the control of a script. ``-1`` is returned if no idx is found. If the user is on multiple times, the oldest idx is returned. + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set idx [hand2idx foobar] + +---- + +.. _tcl-idx2hand: + +^^^^^^^^^^^^^^ +idx2hand +^^^^^^^^^^^^^^ + + Description + Returns handle of the user with the given idx. + + Returns + handle of the user with the given idx + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set handle [idx2hand 0] + +---- + +.. _tcl-valididx: + +^^^^^^^^^^^^^^ +valididx +^^^^^^^^^^^^^^ + + Description + Returns ``1`` if the idx currently exists; 0 otherwise. + + Returns + ``1`` if the idx currently exists; ``0`` otherwise + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set valid [valididx 0] + +---- + +.. _tcl-getchan: + +^^^^^^^^^^^^^ +getchan +^^^^^^^^^^^^^ + + Description + Returns the current party line channel for a user on the party line; ``0`` indicates he's on the group party line, ``-1`` means he has chat off, and a value from 1 to 99999 is a private channel. + + Returns + the current party line channel for a user on the party line; ``0`` indicates he's on the group party line, ``-1`` means he has chat off, and a value from ``1`` to ``99999`` is a private channel + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set partyline_channel [getchan 0] + +---- + +.. _tcl-setchan: + +^^^^^^^^^^^^^^^^^^^^^^^ +setchan +^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Sets a party line user's channel. The party line user is not notified that she is now on a new channel. A channel name can be used (provided it exists). + + Returns + nothing + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + setchan 0 0 + +---- + +.. _tcl-console: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +console [channel] [console-modes] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Changes a dcc user's console mode, either to an absolute mode (like ``mpj``) or just adding/removing flags (like ``+pj`` or ``-moc`` or ``+mp-c``). The user's console channel view can be changed also (as long as the new channel is a valid channel). + + Returns + a list containing the user's (new) channel view and (new) console modes, or nothing if that user isn't currently on the partyline + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set settings [console 0 "#lamest" +mp] + +---- + +.. _tcl-resetconsole: + +^^^^^^^^^^^^^^^^^^ +resetconsole +^^^^^^^^^^^^^^^^^^ + + Description + Changes a dcc user's console mode to the default setting in the configfile. + + Returns + a list containing the user's channel view and (new) console modes, or nothing if that user isn't currently on the partyline + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set settings [resetconsole 0] + +---- + +.. _tcl-echo: + +^^^^^^^^^^^^^^^^^^^ +echo [status] +^^^^^^^^^^^^^^^^^^^ + + Description + Turns a user's echo on or off; the status has to be a 1 or 0. + + Returns + new value of echo for that user (or the current value, if status was omitted) + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set echo_enabled [echo 0] + +---- + +.. _tcl-strip: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +strip [+/-strip-flags] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Modifies the strip-flags for a user. The supported strip-flags are: + + .. list-table:: + :widths: 9 91 + :header-rows: 1 + + * - ``strip-flags`` + - Description + * - ``c`` + - remove all color codes + * - ``b`` + - remove all boldface codes + * - ``r`` + - remove all reverse video codes + * - ``u`` + - remove all underline codes + * - ``a`` + - remove all ANSI codes + * - ``g`` + - remove all ctrl-g (bell) codes + * - ``o`` + - remove all ordinary codes (ctrl+o, terminates bold/color/..) + * - ``i`` + - remove all italics codes + * - ``\*`` + - remove all of the above + + Returns + new strip-flags for the specified user (or the current flags, if strip-flags was omitted) + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set strip_flags [strip 0 +c] + +---- + +.. _tcl-page: + +^^^^^^^^^^^^^^^^^^^ +page [number] +^^^^^^^^^^^^^^^^^^^ + + Description + This allows you to slow down the number of lines the bot sends. + + to a user at once via the partyline. When enabled, any commands that send + + greater than the specified number of lines will stop when that number is + + reached and wait for the user to type another command (or press enter) to + + continue. If the user has too many pending lines, he may be booted off the + + bot. + + Returns + new value of page lines for that user (or the current value, if + + status was omitted) + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set page_lines [page 0 20] + +---- + +.. _tcl-putbot: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^ +putbot +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Sends a message across the botnet to another bot. If no script intercepts the message on the other end, the message is ignored. + + Returns + nothing + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + putbot OtherBot "Hello from LamestBot" + +---- + +.. _tcl-putallbots: + +^^^^^^^^^^^^^^^^^^^^ +putallbots +^^^^^^^^^^^^^^^^^^^^ + + Description + Sends a message across the botnet to all bots. If no script intercepts the message on the other end, the message is ignored. + + Returns + nothing + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + putallbots "example-message Hello" + +---- + +.. _tcl-killdcc: + +^^^^^^^^^^^^^ +killdcc +^^^^^^^^^^^^^ + + Description + Kills a partyline or file area connection. + + Returns + nothing + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + killdcc 0 + +---- + +.. _tcl-bots: + +^^^^ +bots +^^^^ + + Description + Returns list of the bots currently connected to the botnet. + + Returns + list of the bots currently connected to the botnet + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set linked_bots [bots] + +---- + +.. _tcl-botlist: + +^^^^^^^ +botlist +^^^^^^^ + + Description + Returns a list of bots currently on the botnet. Each item in the list is a sublist with four elements: bot, uplink, version, and sharing status: + + Returns + a list of bots currently on the botnet. Each item in the list is a sublist with four elements: ``bot``, ``uplink``, ``version``, and ``sharing status``: + + .. list-table:: + :widths: 18 82 + :header-rows: 1 + + * - Element + - Description + * - ``bot`` + - the bot's botnetnick + * - ``uplink`` + - the bot the bot is connected to + * - ``version`` + - it's current numeric version + * - ``sharing`` + - a ``+`` if the bot is a sharebot; ``-`` otherwise + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set botnet [botlist] + +---- + +.. _tcl-islinked: + +^^^^^^^^^^^^^^ +islinked +^^^^^^^^^^^^^^ + + Description + Returns ``1`` if the bot is currently linked; 0 otherwise. + + Returns + ``1`` if the bot is currently linked; ``0`` otherwise + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set linked [islinked OtherBot] + +---- + +.. _tcl-dccused: + +^^^^^^^ +dccused +^^^^^^^ + + Description + Returns number of dcc connections currently in use. + + Returns + number of dcc connections currently in use + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set connections [dccused] + +---- + +.. _tcl-dcclist: + +^^^^^^^^^^^^^^ +dcclist [type] +^^^^^^^^^^^^^^ + + Description + Returns a list of active connections, each item in the list is a sublist containing seven elements: + + Returns + a list of active connections, each item in the list is a sublist containing seven elements: + ``{ <[+]port> {} }``. + + The types are: ``chat``, ``bot``, ``files``, ``file_receiving``, ``file_sending``, ``file_send_pending``, ``script``, ``socket`` (these are connections that have not yet been put under 'control'), ``telnet``, and ``server``. The timestamp is in unixtime format. + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set connections [dcclist chat] + +---- + +.. _tcl-socklist: + +^^^^^^^^^^^^^^^ +socklist [type] +^^^^^^^^^^^^^^^ + + Description + Returns a list of active connections, each item in the list is a sublist containing eight elements (in dict-readable format). The order of items returned should not be considered static or permanent, so it is recommended to access the items as key/value pairs with the dict command, as opposed to something like lindex, to extract values. The possible keys returned are: + + Returns + a list of active connections, each item in the list is a sublist containing eight elements (in dict-readable format). The order of items returned should not be considered static or permanent, so it is recommended to access the items as key/value pairs with the dict command, as opposed to something like lindex, to extract values. The possible keys returned are: + + .. list-table:: + :widths: 15 85 + :header-rows: 1 + + * - Key + - Description + * - ``idx`` + - integer value assigned to Eggdrop connections + * - ``handle`` + - possible values are (telnet), (bots), (users), + (script) for a listening socket, or the handle of the + connected user for an established connection + * - ``host`` + - the hostname of the connection, if it is known; + otherwise a * + * - ``ip`` + - the ip of the connection + * - ``port`` + - the port number associated with the connection (local + port for listening connections, remote port for server + connections. + * - ``secure`` + - 1 if SSL/TLS is used for the connect; 0 otherwise + * - ``type`` + - the type of connection (TELNET, CHAT, SERVER, etc) + * - ``info`` + - extra information associated with the connection + * - ``time`` + - timestamp of when the socket was established + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set sockets [socklist] + + + Module: core + +---- + +.. _tcl-whom: + +^^^^^^^^^^^ +whom +^^^^^^^^^^^ + + Description + Returns list of people on the botnet who are on that channel. 0 is the default party line. Each item in the list is a sublist with six elements: nickname, bot, hostname, access flag (``-``, ``@``, ``+``, or ``*``), minutes idle, and away message (blank if the user is not away). If you specify * for channel, every user on the botnet is returned with an extra argument indicating the channel the user is on. + + Returns + list of people on the botnet who are on that channel. ``0`` is the default party line. Each item in the list is a sublist with six elements: ``nickname``, ``bot``, ``hostname``, ``access flag`` ('-', '@', '+', or '*'), minutes idle, and away message (blank if the user is not away). If you specify ``*`` for channel, every user on the botnet is returned with an extra argument indicating the channel the user is on. + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set users [whom 0] + +---- + +.. _tcl-getdccidle: + +^^^^^^^^^^^^^^^^ +getdccidle +^^^^^^^^^^^^^^^^ + + Description + Returns number of seconds the dcc chat/file system/script user has been idle. + + Returns + number of seconds the dcc chat/file system/script user has been idle + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set idle_seconds [getdccidle 0] + +---- + +.. _tcl-getdccaway: + +^^^^^^^^^^^^^^^^ +getdccaway +^^^^^^^^^^^^^^^^ + + Description + Returns away message for a dcc chat user (or ``""`` if the user is not set away). + + Returns + away message for a dcc chat user (or ``""`` if the user is not set away) + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set away_message [getdccaway 0] + +---- + +.. _tcl-setdccaway: + +^^^^^^^^^^^^^^^^^^^^^^^^^^ +setdccaway +^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Sets a party line user's away message and marks them away. If set to ``""``, the user is marked as no longer away. + + Returns + nothing + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + setdccaway 0 "Away for a moment" + +---- + +.. _tcl-connect: + +^^^^^^^^^^^^^^^^^^^^^^^^ +connect <[+]port> +^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Makes a non-blocking outgoing connection attempt and creates a DCC entry for it. The returned idx identifies that DCC entry; it does **not** mean the remote TCP connection has completed successfully. A ``control`` command should be attached to the new idx immediately so input and connection-status events are not missed. If hostname resolution succeeds but the subsequent connection attempt fails, the failure is delivered asynchronously to the control callback as an EOF. If the port is prefixed with a plus sign, an SSL-encrypted connection will be attempted. + + Returns + idx of the new DCC entry after the connection attempt is started. The returned idx is not confirmation that the remote connection has been established. + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set idx [connect 127.0.0.1 9000] + +---- + +.. _tcl-listen: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +listen [ip] [options [flag]] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Opens a listening port to accept incoming telnets; type must be one of ``bots``, ``all``, ``users``, ``script``, or ``off``. Prefixing the port with a plus sign will make eggdrop accept SSL connections on it. An IP may optionally be listed before the mandatory port argument. If no IP is specified, all available interfaces are used. + + ``listen [ip] bots [mask]`` + + **Description:** accepts connections from bots only; the optional mask is used to identify permitted bot names. If the mask begins with '@', it is interpreted to be a mask of permitted hosts to accept connections from. + + **Returns:** port number or error message + + ``listen [ip] users [mask]`` + + **Description:** accepts connections from users only (no bots); the optional mask is used to identify permitted nicknames. If the mask begins with '@', it is interpreted to be a mask of permitted hosts to accept connections from. + + **Returns:** port number or error message + + ``listen [ip] all [mask]`` + + **Description:** accepts connections from anyone; the optional mask is used to identify permitted nicknames/botnames. If the mask begins with '@', it is interpreted to be a mask of permitted hosts to accept connections from. + + **Returns:** port number or error message + + ``listen [ip] script [flag]`` + + **Description:** accepts connections which are immediately routed to a proc. The proc is called with one parameter: the idx of the new connection. The optional flag parameter currently only accepts 'pub' as a value. By specifying 'pub' as a flag, Eggdrop will skip the ident check for the user regardless of settings in the config file. This will allow any user to attempt a connection, and result in Eggdrop using "-telnet!telnet@host" instead of "-telnet!@host" as a hostmask to match against the user. + + **Returns:** port number or error message + + ``listen [ip] off`` + + **Description:** stop listening on a port + + **Returns:** nothing + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set port [listen 127.0.0.1 3333 users] + +---- + +.. _tcl-dccdumpfile: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +dccdumpfile +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Dumps out a file from the text directory to a dcc chat user. The flag matching that's used everywhere else works here, too. + + Returns + nothing + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + dccdumpfile 0 help.txt + +Notes Module +------------ + +.. _tcl-notes: + +^^^^^^^^^^^^^^^^^^^^^^^^^ +notes [numberlist] +^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Returns -1 if no such user, -2 if notefile failure. If a numberlist is not specified, the number of notes stored for the user is returned. Otherwise, a list of sublists containing information about notes stored for the user is returned. Each sublist is in the format of: + + Returns + ``-1`` if no such user, ``-2`` if notefile failure. If a numberlist is not specified, the number of notes stored for the user is returned. Otherwise, a list of sublists containing information about notes stored for the user is returned. Each sublist is in the format of:: + + ``{ }`` + + + Module + ``notes`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set note_count [notes foobar] + +---- + +.. _tcl-erasenotes: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +erasenotes +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Erases some or all stored notes for a user. Use ``-`` to erase all notes. + + Returns + ``-1`` if no such user, ``-2`` if notefile failure, ``0`` if no such note, or number of erased notes. + + + Module + ``notes`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set erased [erasenotes foobar "1-3"] + +---- + +.. _tcl-listnotes: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +listnotes +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Lists existing notes according to the numberlist (ex: ``2-4;8;16-``). + + Returns + ``-1`` if no such user, ``-2`` if notefile failure, ``0`` if no such note, list of existing notes. + + + Module + ``notes`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set notes [listnotes foobar "1-3"] + +---- + +.. _tcl-storenote: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +storenote +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Stores a note for later reading, notifies idx of any results (use idx -1 for no notify). + + Returns + ``0`` on success; non-``0`` on failure + + + Module + ``notes`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set status [storenote foobar foobar "Remember the meeting." -1] + +Assoc Module +------------ + +.. _tcl-assoc: + +^^^^^^^^^^^^^^^^^^^ +assoc [name] +^^^^^^^^^^^^^^^^^^^ + + Description + Sets the name associated with a botnet channel, if you specify one. + + Returns + current name for that channel, if any + + + Module + ``assoc`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set name [assoc 1 lamest] + +---- + +.. _tcl-killassoc: + +^^^^^^^^^^^^^^^^ +killassoc +^^^^^^^^^^^^^^^^ + + Description + Removes the name associated with a botnet channel, if any exists. Use ``killassoc &`` to kill all assocs. + + Returns + nothing + + + Module + ``assoc`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + killassoc 1 + +Compress Module +--------------- + +.. _tcl-compressfile: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +compressfile [-level ] [target-file] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Compresses a file. The optional level specifies the compression mode from 0 (minimum CPU usage and compression) through 9 (maximum CPU usage and compression). If target-file is omitted, src-file is overwritten. + + Returns + nothing + + See also + :ref:`uncompressfile `, :ref:`iscompressed ` + + + Module + ``compress`` + + + .. admonition:: Example — Compress a file + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + compressfile -level 6 example.txt example.txt.gz + +---- + +.. _tcl-uncompressfile: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +uncompressfile [target-file] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Uncompresses a file. If target-file is omitted, src-file is overwritten. + + Returns + nothing + + See also + :ref:`compressfile `, :ref:`iscompressed ` + + + Module + ``compress`` + + + .. admonition:: Example — Uncompress a file + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + uncompressfile example.txt.gz example.txt + +---- + +.. _tcl-iscompressed: + +^^^^^^^^^^^^^^^^^^^^^^^ +iscompressed +^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Determines whether ```` is gzip compressed. . + + Returns + ``1`` if it is, ``0`` if it isn't, and ``2`` if some kind of error prevented the checks from succeeding. + + + Module + ``compress`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set compressed [iscompressed example.gz] + +Filesys Module +-------------- + +.. _tcl-setpwd: + +^^^^^^^^^^^^^^^^^^ +setpwd +^^^^^^^^^^^^^^^^^^ + + Description + Changes the directory of a file system user, in exactly the same way as a ``cd`` command would. The directory can be specified relative or absolute. + + Returns + nothing + + + Module + ``filesys`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + setpwd 0 / + +---- + +.. _tcl-getpwd: + +^^^^^^^^^^^^ +getpwd +^^^^^^^^^^^^ + + Description + Returns the current directory of a file system user. + + Returns + the current directory of a file system user + + + Module + ``filesys`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set directory [getpwd 0] + +---- + +.. _tcl-getfiles: + +^^^^^^^^^^^^^^ +getfiles +^^^^^^^^^^^^^^ + + Description + Returns a list of files in the directory given; the directory is relative to dcc-path. + Returns + a list of files in the directory given; the directory is relative to dcc-path + + + Module + ``filesys`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set files [getfiles /] + +---- + +.. _tcl-getdirs: + +^^^^^^^^^^^^^ +getdirs +^^^^^^^^^^^^^ + + Description + Returns a list of subdirectories in the directory given; the directory is relative to dcc-path. + + Returns + a list of subdirectories in the directory given; the directory is relative to dcc-path + + + Module + ``filesys`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set directories [getdirs /] + +---- + +.. _tcl-dccsend: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +dccsend +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Attempts to start a dcc file transfer to the given nick; the filename must be specified either by full pathname or in relation to the bot's startup directory. + + Returns + + .. list-table:: + :widths: 9 91 + :header-rows: 1 + + * - Return value + - Description + * - ``0`` + - success + * - ``1`` + - the dcc table is full (too many connections) + * - ``2`` + - can't open a socket for the transfer + * - ``3`` + - the file doesn't exist + * - ``4`` + - the file was queued for later transfer, which means that person has + too many file transfers going right now + * - ``5`` + - the file could not be opened or temporary file could not be created + + + Module + ``transfer`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set result [dccsend example.txt Foobar] + +---- + +.. _tcl-filesend: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +filesend [ircnick] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Like dccsend, except it operates for a current filesystem user, and the filename is assumed to be a relative path from that user's current directory. + + Returns + ``0`` on failure; ``1`` on success (either an immediate send or a queued send) + + + Module + ``filesys`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set result [filesend 0 example.txt Foobar] + +---- + +.. _tcl-fileresend: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +fileresend [ircnick] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Functions like filesend, only that it sends a DCC RESEND instead of a DCC SEND, which allows people to resume aborted file transfers if their client supports that protocol. ircII/BitchX/etc. support it; mIRC does not. + + Returns + ``0`` on failure; ``1`` on success (either an immediate send or a queued send) + + + Module + ``filesys`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set result [fileresend 0 example.txt Foobar] + +---- + +.. _tcl-setdesc: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^ +setdesc +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Sets the description for a file in a file system directory; the directory is relative to dcc-path. + + Returns + nothing + + + Module + ``filesys`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + setdesc / example.txt "Example file" + +---- + +.. _tcl-getdesc: + +^^^^^^^^^^^^^^^^^^^^ +getdesc +^^^^^^^^^^^^^^^^^^^^ + + Description + Returns the description for a file in the file system, if one exists. + + Returns + the description for a file in the file system, if one exists + + + Module + ``filesys`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set description [getdesc / example.txt] + +---- + +.. _tcl-setowner: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +setowner +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Changes the owner for a file in the file system; the directory is relative to dcc-path. + + Returns + nothing + + + Module + ``filesys`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + setowner / example.txt foobar + +---- + +.. _tcl-getowner: + +^^^^^^^^^^^^^^^^^^^^^ +getowner +^^^^^^^^^^^^^^^^^^^^^ + + Description + Returns the owner of a file in the file system. + + Returns + the owner of a file in the file system + + + Module + ``filesys`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set owner [getowner / example.txt] + +---- + +.. _tcl-setlink: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^ +setlink +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Creates or changes a linked file (a file that actually exists on another bot); the directory is relative to dcc-path. + + Returns + nothing + + + Module + ``filesys`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + setlink / example.txt OtherBot:/example.txt + +---- + +.. _tcl-getlink: + +^^^^^^^^^^^^^^^^^^^^ +getlink +^^^^^^^^^^^^^^^^^^^^ + + Description + Returns the link for a linked file, if it exists. + + Returns + the link for a linked file, if it exists + + + Module + ``filesys`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set link [getlink / example.txt] + +---- + +.. _tcl-getfileq: + +^^^^^^^^^^^^^^^^^ +getfileq +^^^^^^^^^^^^^^^^^ + + Description + Returns list of files queued by someone; each item in the list will be a sublist with two elements: nickname the file is being sent to and the filename. + + Returns + list of files queued by someone; each item in the list will be a sublist with two elements: nickname the file is being sent to and the filename + + + Module + ``transfer`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set queued_files [getfileq foobar] + +---- + +.. _tcl-getfilesendtime: + +^^^^^^^^^^^^^^^^^^^^^ +getfilesendtime +^^^^^^^^^^^^^^^^^^^^^ + + Description + Returns the unixtime value from when a file transfer started, or a negative number: + + Returns + the unixtime value from when a file transfer started, or a negative number: + + .. list-table:: + :widths: 8 92 + :header-rows: 1 + + * - Return value + - Description + * - ``-1`` + - no matching transfer with the specified idx was found + * - ``-2`` + - the idx matches an entry which is not a file transfer + + + Module + ``transfer`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set result [getfilesendtime 0] + +---- + +.. _tcl-mkdir: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +mkdir [ [channel]] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Creates a directory in the file system. Only users with the required flags may access it. + + Returns + + .. list-table:: + :widths: 8 92 + :header-rows: 1 + + * - Return value + - Description + * - ``0`` + - success + * - ``1`` + - can't create directory + * - ``2`` + - directory exists but is not a directory + * - ``-3`` + - could not open filedb + + + Module + ``filesys`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set result [mkdir /examples] + +---- + +.. _tcl-rmdir: + +^^^^^^^^^^^^^^^^^ +rmdir +^^^^^^^^^^^^^^^^^ + + Description + Removes a directory from the file system. + + Returns + ``0`` on success; ``1`` on failure + + + Module + ``filesys`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set result [rmdir /examples] + +---- + +.. _tcl-mv: + +^^^^^^^^^^^^^^^^^^^^^^^ +mv +^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Moves a file from its source to the given destination. The file can also be a mask, such as ``/incoming``/\*, provided the destination is a directory. + + Returns + If the command was successful, the number of files moved will be returned. Otherwise, a negative number will be returned: + + .. list-table:: + :widths: 8 92 + :header-rows: 1 + + * - Return value + - Description + * - ``-1`` + - invalid source file + * - ``-2`` + - invalid destination + * - ``-3`` + - destination file exists + * - ``-4`` + - no matches found + + + Module + ``filesys`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set moved [mv /incoming/example.txt /files/example.txt] + +---- + +.. _tcl-cp: + +^^^^^^^^^^^^^^^^^^^^^^^ +cp +^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Copies a file from its source to the given destination. The file can also be a mask, such as ``/incoming``/\*, provided the destination is a directory. + + Returns + If the command was successful, the number of files copied will be returned. Otherwise, a negative number will be returned: + + .. list-table:: + :widths: 8 92 + :header-rows: 1 + + * - Return value + - Description + * - ``-1`` + - invalid source file + * - ``-2`` + - invalid destination + * - ``-3`` + - destination file exists + * - ``-4`` + - no matches found + + + Module + ``filesys`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set copied [cp /incoming/example.txt /files/example.txt] + +---- + +.. _tcl-getflags: + +^^^^^^^^^^^^^^ +getflags +^^^^^^^^^^^^^^ + + Description + Returns the flags required to access a directory. + + Returns + the flags required to access a directory + + + Module + ``filesys`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set required_flags [getflags /] + +---- + +.. _tcl-setflags: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +setflags [ [channel]] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Sets the flags required to access a directory. + + Returns + ``0`` on success; ``-1`` or ``-3`` on failure + + + Module + ``filesys`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + setflags /examples +o "#lamest" + +PBKDF2 Module +------------- + +.. _tcl-encpass2: + +^^^^^^^^^^^^^^^ +encpass2 +^^^^^^^^^^^^^^^ + + Description + Returns a hash in the format of ``$pbkdf2-$rounds=$$`` where digest is the digest set in the config variable pbkdf2-method, rounds is the number of rounds set in the config variable pbkdf2-rounds, salt is the base64 salt used to generate the hash, and hash is the generated base64 hash. + + + Returns + a hash in the format of ``$pbkdf2-$rounds=$$`` where digest is the digest set in the config variable pbkdf2-method, rounds is the number of rounds set in the config variable pbkdf2-rounds, salt is the base64 salt used to generate the hash, and hash is the generated base64 hash. + + + Module + ``pbkdf2`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set hash [encpass2 "example-password"] + +---- + +.. _tcl-pbkdf2: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +pbkdf2 [-bin] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Returns a derived key from the provided ``pass`` string using ``salt`` and ``rounds`` count as specified in RFC 2898 as a hexadecimal string. Using the optional -bin flag will return the result as binary data. + + Returns + a derived key from the provided ``pass`` string using ``salt`` and ``rounds`` count as specified in RFC 2898 as a hexadecimal string. Using the optional -bin flag will return the result as binary data. + + + Module + ``pbkdf2`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set key [pbkdf2 "example-password" "example-salt" 10000 sha256] + +Miscellaneous Commands +---------------------- + +.. _tcl-bind: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +bind [proc-name] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + You can use the ``bind`` command to attach Tcl procedures to certain events. flags are the flags the user must have to trigger the event (if applicable). proc-name is the name of the Tcl procedure to call for this command (see below for the format of the procedure call). If the proc-name is omitted, no binding is added. Instead, the current binding is returned (if it's stackable, a list of the current bindings is returned). + + Returns + name of the command that was added, or (if proc-name was omitted), a list of the current bindings for this command + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + bind pub - !hello example_hello + +---- + +.. _tcl-unbind: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +unbind +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Removes a previously created bind. + + Returns + name of the command that was removed + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + unbind pub - !hello example_hello + +---- + +.. _tcl-binds: + +^^^^^^^^^^^^^^^^^ +binds [type/mask] +^^^^^^^^^^^^^^^^^ + + Description + By default, lists Tcl binds registered with the Eggdrop. You can specify ``all`` to view all binds, ``tcl`` to view Tcl binds, and ``python`` to view Python binds. Alternately, you can specify a bind type (pub, msg, etc) to view all binds that match that type of bind, or a mask that is matched against the command associated with the bind. + + Returns + a list of Tcl binds, each item in the list is a sublist of five elements: + ``{ }`` + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set public_binds [binds pub] + +---- + +.. _tcl-logfile: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +logfile [ ] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Creates a new logfile, which will log the modes given for the channel listed. If no logfile is specified, a list of existing logfiles will be returned. ``*`` indicates all channels. You can also change the modes and channel of an existing logfile with this command. Entering a blank mode and channel (``""``) makes the bot stop logging there. + + Logfile flags: + + .. list-table:: + :widths: 7 93 + :header-rows: 1 + + * - ``modes`` + - Description + * - ``b`` + - information about bot linking and userfile sharing + * - ``c`` + - commands + * - ``d`` + - misc debug information + * - ``g`` + - raw outgoing share traffic + * - ``h`` + - raw incoming share traffic + * - ``j`` + - joins, parts, quits, topic changes, and netsplits on the channel + * - ``k`` + - kicks, bans, and mode changes on the channel + * - ``l`` + - linked bot messages + * - ``m`` + - private msgs, notices and ctcps to the bot + * - ``o`` + - misc info, errors, etc (IMPORTANT STUFF) + * - ``p`` + - public text on the channel + * - ``r`` + - raw incoming server traffic + * - ``s`` + - server connects, disconnects, and notices + * - ``t`` + - raw incoming botnet traffic + * - ``u`` + - raw outgoing botnet traffic + * - ``v`` + - raw outgoing server traffic + * - ``w`` + - wallops (make sure the bot sets +w in init-server) + * - ``x`` + - file transfers and file-area commands + + Returns + filename of logfile created, or, if no logfile is specified, a list of logfiles such as: ``{mco * eggdrop.log}`` ``{jp #lamest lame.log}`` + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set logfiles [logfile] + +---- + +.. _tcl-maskhost: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +maskhost [masktype] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Returns masked hostmask for the string given according to the masktype (the default is 3). + + Returns + masked hostmask for the string given according to the masktype (the default is 3). + + Available types are: + + .. list-table:: + :widths: 8 92 + :header-rows: 1 + + * - ``masktype`` + - Description + * - ``0`` + - \*!user\@host + * - ``1`` + - \*!*user\@host + * - ``2`` + - \*!*\@host + * - ``3`` + - \*!*user\@*.host + * - ``4`` + - \*!*\@*.host + * - ``5`` + - nick!user\@host + * - ``6`` + - nick!*user\@host + * - ``7`` + - nick!*\@host + * - ``8`` + - nick!*user\@*.host + * - ``9`` + - nick!*\@*.host + + You can also specify types from 10 to 19 which correspond to types + 0 to 9, but instead of using a * wildcard to replace portions of the + host, only numbers in hostnames are replaced with the '?' wildcard. + Same is valid for types 20-29, but instead of '?', the '\*' wildcard + will be used. Types 30-39 set the host to '\*'. + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set mask [maskhost "Foobar!foobar@127.0.0.1"] + +---- + +.. _tcl-timer: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +timer [count [timerName]] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Executes the given Tcl command after a certain number of minutes have passed, at the top of the minute (ie, if a timer is started at 10:03:34 with 1 minute specified, it will execute at 10:04:00. If a timer is started at 10:06:34 with 2 minutes specified, it will execute at 10:08:00). If count is specified, the command will be executed count times with the given interval in between. If you specify a count of 0, the timer will repeat until it's removed with killtimer or until the bot is restarted. If timerName is specified, it will become the unique identifier for the timer. If no timerName is specified, Eggdrop will assign a timerName in the format of ``timer``. + + Returns + a ``timerName`` + + + Module + ``core`` + + + .. admonition:: Example — Schedule a timer + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set id [timer 5 {putlog "Example timer fired."}] + +---- + +.. _tcl-utimer: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +utimer [count [timerName]] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Executes the given Tcl command after a certain number of seconds have passed. If count is specified, the command will be executed count times with the given interval in between. If you specify a count of 0, the utimer will repeat until it's removed with killutimer or until the bot is restarted. If timerName is specified, it will become the unique identifier for the timer. If timerName is not specified, Eggdrop will assign a timerName in the format of ``timer``. + + Returns + a ``timerName`` + + + Module + ``core`` + + + .. admonition:: Example — Schedule a short timer + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set id [utimer 30 {putlog "Example timer fired."}] + +---- + +.. _tcl-timers: + +^^^^^^ +timers +^^^^^^ + + Description + Lists all active minutely timers. + + Returns + a list of active minutely timers, with each timer sub-list containing the number of minutes left until activation, the command that will be executed, the timerName, and the remaining number of repeats. + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set active_timers [timers] + +---- + +.. _tcl-utimers: + +^^^^^^^ +utimers +^^^^^^^ + + Description + Lists all active secondly timers. + + Returns + a list of active secondly timers, with each timer sub-list containing the number of seconds left until activation, the command that will be executed, the timerName, and the remaining number of repeats. + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set active_timers [utimers] + +---- + +.. _tcl-killtimer: + +^^^^^^^^^^^^^^^^^^^^^ +killtimer +^^^^^^^^^^^^^^^^^^^^^ + + Description + Removes the timerName minutely timer from the timer list. + + Returns + nothing + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set timer_id [timer 5 {putlog "Example timer fired."}] + killtimer $timer_id + +---- + +.. _tcl-killutimer: + +^^^^^^^^^^^^^^^^^^^^^^ +killutimer +^^^^^^^^^^^^^^^^^^^^^^ + + Description + Removes the timerName secondly timer from the timer list. + + Returns + nothing + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set timer_id [utimer 30 {putlog "Example timer fired."}] + killutimer $timer_id + +---- + +.. _tcl-unixtime: + +^^^^^^^^ +unixtime +^^^^^^^^ + + Description + Returns the current Unix timestamp. + + + Returns + a long integer which represents the number of seconds that have passed since 00:00 Jan 1, 1970 (GMT). + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set now [unixtime] + +---- + +.. _tcl-duration: + +^^^^^^^^^^^^^^^^^^ +duration +^^^^^^^^^^^^^^^^^^ + + Description + Returns the number of seconds converted into years, weeks, days, hours, minutes, and seconds. 804600 seconds is turned into 1 week 2 days 7 hours 30 minutes. + + Returns + the number of seconds converted into years, weeks, days, hours, minutes, and seconds. 804600 seconds is turned into 1 week 2 days 7 hours 30 minutes. + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set readable [duration 3600] + +---- + +.. _tcl-strftime: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +strftime [time] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Returns a formatted string of time using standard strftime format. If time is specified, the value of the specified time is used. Otherwise, the current time is used. Note: The implementation of strftime varies from platform to platform, so the user should only use POSIX-compliant format specifiers to ensure fully portable code. + + Returns + a formatted string of time using standard strftime format. If time is specified, the value of the specified time is used. Otherwise, the current time is used. Note: The implementation of strftime varies from platform to platform, so the user should only use POSIX-compliant format specifiers to ensure fully portable code. + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set date [strftime "%Y-%m-%d"] + +---- + +.. _tcl-ctime: + +^^^^^^^^^^^^^^^^ +ctime +^^^^^^^^^^^^^^^^ + + Description + Returns a formatted date/time string based on the current locale settings from the unixtime string given; for example ``Fri Aug 3 11:34:55 1973``. + + Returns + a formatted date/time string based on the current locale settings from the unixtime string given; for example ``Fri Aug 3 11:34:55 1973`` + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set date [ctime [unixtime]] + +---- + +.. _tcl-myip: + +^^^^ +myip +^^^^ + + Description + Returns a long number representing the bot's IP address, as it might appear in (for example) a DCC request. + + Returns + a long number representing the bot's IP address, as it might appear in (for example) a DCC request + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set result [myip] + +---- + +.. _tcl-rand: + +^^^^^^^^^^^^ +rand +^^^^^^^^^^^^ + + Description + Returns a random integer between 0 and limit-1. Limit must be greater than 0 and equal to or less than RAND_MAX, which is generally 2147483647. The underlying pseudo-random number generator is not cryptographically secure. + + Returns + a random integer between ``0`` and ``limit-1``. Limit must be greater than ``0`` and equal to or less than ``RAND_MAX``, which is generally 2147483647. The underlying pseudo-random number generator is not cryptographically secure. + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set value [rand 100] + +---- + +.. _tcl-control: + +^^^^^^^^^^^^^^^^^^^^^^^ +control +^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Removes an idx from the party line and sends all future input to the Tcl command given. The command will be called with two parameters: the idx and the input text. The command should return ``0`` to indicate success and 1 to indicate that it relinquishes control of the user back to the bot. If the input text is blank (``""``), it indicates that the connection has been dropped. Also, if the input text is blank, never call killdcc on it, as it will fail with "invalid idx". + + Returns + nothing + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + control 0 example_proc + +---- + +.. _tcl-sendnote: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +sendnote +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Simulates what happens when one user sends a note to another. + + Returns + + .. list-table:: + :widths: 8 92 + :header-rows: 1 + + * - Return value + - Description + * - ``0`` + - the send failed + * - ``1`` + - the note was delivered locally or sent to another bot + * - ``2`` + - the note was stored locally + * - ``3`` + - the user's notebox is too full to store a note + * - ``4`` + - a Tcl binding caught the note + * - ``5`` + - the note was stored because the user is away + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set result [sendnote foobar foobar "Example note"] + +---- + +.. _tcl-link: + +^^^^^^^^^^^^^^^^^^^^ +link [via-bot] +^^^^^^^^^^^^^^^^^^^^ + + Description + Attempts to link to another bot directly. If you specify a via-bot, it tells the via-bot to attempt the link. + + Returns + ``1`` if the link will be attempted; ``0`` otherwise + + + Module + ``core`` + + + .. admonition:: Example — Link a bot + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set started [link OtherBot] + +---- + +.. _tcl-unlink: + +^^^^^^^^^^^^^^^^^^^^^^ +unlink [comment] +^^^^^^^^^^^^^^^^^^^^^^ + + Description + Attempts to unlink a bot from the botnet. If you specify a comment, it will appear with the unlink message on the botnet. + + Returns + ``1`` on success; ``0`` otherwise + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set removed [unlink OtherBot "Maintenance"] + +---- + +.. _tcl-encrypt: + +^^^^^^^^^^^^^^^^^^^^^^ +encrypt +^^^^^^^^^^^^^^^^^^^^^^ + + Description + Returns encrypted string (using the currently loaded encryption module), encoded into ASCII using base-64. As of v1.8.4, the default blowfish encryption module can use either the older ECB mode (currently used by default for compatibility reasons), or the more recent and more-secure CBC mode. You can explicitly request which encryption mode to use by prefixing the encryption key with either ``ecb:`` or ``cbc:``, or by using the blowfish-use-mode setting in the config file. Note: the default encryption mode for this function is planned to transition from ECB to CBC in v1.9.0. + + Returns + encrypted string (using the currently loaded encryption module), encoded into ASCII using base-64. As of v1.8.4, the default blowfish encryption module can use either the older ECB mode (currently used by default for compatibility reasons), or the more recent and more-secure CBC mode. You can explicitly request which encryption mode to use by prefixing the encryption key with either ``ecb:`` or ``cbc:``, or by using the blowfish-use-mode setting in the config file. Note: the default encryption mode for this function is planned to transition from ECB to CBC in v1.9.0. + + + Module + ``encryption`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set result [encrypt "example-password" "Example text"] + +---- + +.. _tcl-decrypt: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +decrypt +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Returns decrypted string (using the currently loaded encryption module). If the default blowfish encryption module is used, this automatically picks the right decryption mode. You may still prefix the key with ``ecb:`` or ``cbc:`` or use the blowfish-use-mode setting in the config file (see the encrypt command for more detailed information). + + Returns + decrypted string (using the currently loaded encryption module). If the default blowfish encryption module is used, this automatically picks the right decryption mode. You may still prefix the key with ``ecb:`` or ``cbc:`` or use the blowfish-use-mode setting in the config file (see the encrypt command for more detailed information). + + + Module + ``encryption`` + + + .. admonition:: Example — Encrypt and decrypt text + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set encrypted [encrypt "example-password" "Example text"] + set plain [decrypt "example-password" $encrypted] + +---- + +.. _tcl-encpass: + +^^^^^^^^^^^^^^^^^^ +encpass +^^^^^^^^^^^^^^^^^^ + + Description + Returns encrypted string (using the currently loaded encryption module). + + Returns + encrypted string (using the currently loaded encryption module) + + + Module + ``encryption`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set encrypted [encpass "example-password"] + +---- + +.. _tcl-die: + +^^^^^^^^^^^^ +die [reason] +^^^^^^^^^^^^ + + Description + Causes the bot to log a fatal error and exit completely. If no reason is given, ``EXIT`` is used. + + Returns + nothing + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + die + +---- + +.. _tcl-unames: + +^^^^^^ +unames +^^^^^^ + + Description + Returns the current operating system the bot is using. + + Returns + the current operating system the bot is using + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set result [unames] + +---- + +.. _tcl-dnslookup: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +dnslookup [[arg1] [arg2] ... [argN]] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + This issues an asynchronous dns lookup request. The command will block if dns module is not loaded; otherwise it will either return immediately or immediately call the specified proc (e.g. if the lookup is already cached). + + As soon as the request completes, the specified proc will be called as follows: + + [[arg1] [arg2] ... [argN]] + + status is ``1`` if the lookup was successful and 0 if it wasn't. All additional parameters (called arg1, arg2 and argN above) get appended to the proc's other parameters. + + Returns + nothing + + + Module + ``core`` + + + .. admonition:: Example — Resolve a hostname + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + proc example_dns_result {ip host status} { + putlog "DNS result: $host -> $ip (status $status)" + } + dnslookup irc.example.net example_dns_result + +---- + +.. _tcl-md5: + +^^^^^^^^^^^^ +md5 +^^^^^^^^^^^^ + + Description + Returns the 128 bit MD5 message-digest of the specified string. + + Returns + the 128 bit MD5 message-digest of the specified string + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set digest [md5 "example text"] + +---- + +.. _tcl-callevent: + +^^^^^^^^^^^^^^^^^ +callevent +^^^^^^^^^^^^^^^^^ + + Description + Triggers the evnt bind manually for a certain event. You can call arbitrary events here, even ones that are not pre-defined by Eggdrop. For example: callevent rehash, or callevent myownevent123. + + Returns + nothing + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + callevent example-event + +---- + +.. _tcl-traffic: + +^^^^^^^ +traffic +^^^^^^^ + + Description + Returns a list of sublists containing information about the bot's traffic usage in bytes. Each sublist contains five elements: type, in-traffic today, in-traffic total, out-traffic today, out-traffic total (in that order). + + Returns + a list of sublists containing information about the bot's traffic usage in bytes. Each sublist contains five elements: ``type``, ``in-traffic today``, ``in-traffic total``, ``out-traffic today``, ``out-traffic total`` (in that order). + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set usage [traffic] + +---- + +.. _tcl-modules: + +^^^^^^^ +modules +^^^^^^^ + + Description + Returns a list of sublists containing information about the bot's currently loaded modules. Each sublist contains three elements: module, version, and dependencies. Each dependency is also a sublist containing the module name and version. + Returns + a list of sublists containing information about the bot's currently loaded modules. Each sublist contains three elements: ``module``, ``version``, and ``dependencies``. Each dependency is also a sublist containing the module name and version. + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set loaded_modules [modules] + +---- + +.. _tcl-loadmodule: + +^^^^^^^^^^^^^^^^^^^ +loadmodule +^^^^^^^^^^^^^^^^^^^ + + Description + Attempts to load the specified module. + + Returns + ``Already loaded.`` if the module is already loaded, ``""`` if successful, or the reason the module couldn't be loaded. + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set result [loadmodule notes] + +---- + +.. _tcl-unloadmodule: + +^^^^^^^^^^^^^^^^^^^^^ +unloadmodule +^^^^^^^^^^^^^^^^^^^^^ + + Description + Attempts to unload the specified module. + + Returns + ``No such module`` if the module is not loaded, ``""`` otherwise. + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set result [unloadmodule notes] + +---- + +.. _tcl-loadhelp: + +^^^^^^^^^^^^^^^^^^^^^^^^ +loadhelp +^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Attempts to load the specified help file from the help/ directory. + + Returns + nothing + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + loadhelp example.help + +---- + +.. _tcl-unloadhelp: + +^^^^^^^^^^^^^^^^^^^^^^^^^^ +unloadhelp +^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Attempts to unload the specified help file. + + Returns + nothing + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + unloadhelp example.help + +---- + +.. _tcl-reloadhelp: + +^^^^^^^^^^ +reloadhelp +^^^^^^^^^^ + + Description + Reloads the bot's help files. + + Returns + nothing + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + reloadhelp + +---- + +.. _tcl-restart: + +^^^^^^^ +restart +^^^^^^^ + + Description + Rehashes the bot, kills all timers, reloads all modules, and reconnects the bot to the next server in its list. + + Returns + nothing + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + restart + +---- + +.. _tcl-rehash: + +^^^^^^ +rehash +^^^^^^ + + Description + Rehashes the bot. + + Returns + nothing + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + rehash + +---- + +.. _tcl-stripcodes: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +stripcodes +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Strips specified control characters from the string given. strip-flags can be any combination of the following: + + .. list-table:: + :widths: 8 92 + :header-rows: 1 + + * - ``strip-flags`` + - Description + * - ``c`` + - remove all color codes + * - ``b`` + - remove all boldface codes + * - ``r`` + - remove all reverse video codes + * - ``u`` + - remove all underline codes + * - ``a`` + - remove all ANSI codes + * - ``g`` + - remove all ctrl-g (bell) codes + * - ``o`` + - remove all ordinary codes (ctrl+o, terminates bold/color/..) + * - ``i`` + - remove all italics codes + * - ``\*`` + - remove all of the above + + Returns + the stripped string. + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set clean [stripcodes c "Example text"] + +---- + +.. _tcl-matchaddr: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +matchaddr
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Checks if the address matches the hostmask given. The address should be in the form nick!user\@host. + + Returns + ``1`` if the address matches the hostmask, ``0`` otherwise. + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set matched [matchaddr "*!*@127.0.0.1" "Foobar!foobar@127.0.0.1"] + +---- + +.. _tcl-matchcidr: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +matchcidr
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Performs a cidr match on the specified ip addresses. IPv6 is supported, if enabled at compile time. + + + Returns + ``1`` if the address matches the block prefix, ``0`` otherwise. + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set matched [matchcidr 127.0.0.0 127.0.0.1 8] + +---- + +.. _tcl-matchstr: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^ +matchstr +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Checks if pattern matches string. Only two wildcards are supported: ``*`` and '?'. Matching is case-insensitive. This command is intended as a simplified alternative to Tcl's string match. + + Returns + ``1`` if the pattern matches the string, ``0`` if it doesn't. + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set matched [matchstr "Foo*" "Foobar"] + +---- + +.. _tcl-rfcequal: + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +rfcequal +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Description + Checks if two strings are equal. Case is ignored, and this uses RFC1459 matching {}|~ == []\^, depending on the rfc_compliant setting. + + Returns + ``1`` if equal, ``0`` if not. + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set equal [rfcequal "Foobar" "foobar"] + +---- + +.. _tcl-status: + +^^^^^^^^^^^^^ +status [type] +^^^^^^^^^^^^^ + + Description + Provides eggdrop status information similar to the ``.status`` command in partyline. The available types of information are: + + .. list-table:: + :widths: 8 92 + :header-rows: 1 + + * - ``type`` + - Description + * - ``cpu`` + - total cpu time spent by eggdrop + * - ``mem`` + - dynamically allocated memory excluding the Tcl interpreter + * - ``cache`` + - user entries cache hits (in %) + * - ``ipv6`` + - shows whether IPv6 support was compiled in + + Returns + the requested information type or all information if type isn't specified. The format is a flat list of name-value pairs. + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set cpu_info [status cpu] + +---- + +.. _tcl-istls: + +^^^^^^^^^^^ +istls +^^^^^^^^^^^ + + Description + Checks if a connection is encrypted or cleartext. This command is available on TLS-enabled bots only. + + Returns + ``1`` if the idx is a TLS connection, ``0`` if it's plaintext. + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set secure [istls 0] + +---- + +.. _tcl-starttls: + +^^^^^^^^^^^^^^ +starttls +^^^^^^^^^^^^^^ + + Description + Establishes a secure (using TLS) connection over idx. The TLS connection should be first negotiated over the plaintext link, or using other means. Both parties must switch to TLS simultaneously. This command is available on TLS-enabled bots only. + + Returns + nothing + + + Module + ``core`` + + + .. admonition:: Example — Start TLS on a connection + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + starttls 0 + +---- + +.. _tcl-tlsstatus: + +^^^^^^^^^^^^^^^ +tlsstatus +^^^^^^^^^^^^^^^ + + Description + Provides information about an established TLS connection This includes certificate and cipher information as well as protocol version. This command is available on TLS-enabled bots only. + + Returns + a flat list of name-value pairs + + + Module + ``core`` + + + .. admonition:: Example + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + set details [tlsstatus 0] + +Global Variables +---------------- + +NOTE: All config file variables are also global. + +^^^^^^^ +botnick +^^^^^^^ + + Value + the current nickname the bot is using (for example: "LamestBot", "LamestBot1", etc.) + + Module + ``server`` + +^^^^^^^ +botname +^^^^^^^ + + Value + the current nick!user\@host that the server sees (for example: "LamestBot!eggdrop\@127.0.0.1") + + Module + ``server`` + +^^^^^^ +server +^^^^^^ + + Value + the current server's real name (what server calls itself) and port bot is connected to (for example: "irc.example.net:6667") Note that this does not necessarily match the servers internet address. + + Module + ``server`` + +^^^^^^^^^^^^^ +serveraddress +^^^^^^^^^^^^^ + + Value + the current server's internet address (hostname or IP) and port bot is connected to. This will correspond to the entry in server list (for example: "irc.example.net:6667"). Note that this does not necessarily match the name server calls itself. + + Module + ``server`` + +^^^^^^^ +version +^^^^^^^ + + Value + current bot version "1.1.2+pl1.10.2201"; first item is the text version, to include a patch string if present, and second item is a numerical version + + Module + ``core`` + +^^^^^^^^^^^ +numversion* +^^^^^^^^^^^ + + Value + the current numeric bot version (for example: "1.10.21"). Numerical version is in the format of "MNNRRPP", where: + + .. list-table:: + :widths: 13 87 + :header-rows: 1 + + * - MNNRRPP component + - Description + * - ``M`` + - major release number + * - ``NN`` + - minor release number + * - ``RR`` + - sub-release number + * - ``PP`` + - patch level for that sub-release + + Module + ``core`` + +^^^^^^ +uptime +^^^^^^ + + Value + the unixtime value for when the bot was started + + Module + ``core`` + +^^^^^^^^^^^^^ +server-online +^^^^^^^^^^^^^ + + Value + the unixtime value when the bot connected to its current server, or '0' if the bot is currently disconnected from a server. + + Module + ``server`` + +^^^^^^^^ +lastbind +^^^^^^^^ + + Value + the last command binding which was triggered. This allows you to identify which command triggered a Tcl proc. + + Module + ``core`` + +^^^^^^^ +isjuped +^^^^^^^ + + Value + 1 if bot's nick is juped(437); 0 otherwise + + Module + ``server`` + +^^^^^^^ +handlen +^^^^^^^ + + Value + the value of the HANDLEN define in src/eggdrop.h + + Module + ``core`` + +^^^^^^ +config +^^^^^^ + + Value + the filename of the config file Eggdrop is currently using + + Module + ``core`` + +^^^^^^^^^^^^^ +configureargs +^^^^^^^^^^^^^ + + Value + a string (not list) of configure arguments in shell expansion (single quotes) + + Module + ``core`` + +^^^^^^^^ +language +^^^^^^^^ + + Value + a string containing the language with the highest priority for use by Eggdrop. This commonly reflects what is added with addlang in the config file + + Module + ``core`` + +^^^^^^^^^^^^^^ +account-extban +^^^^^^^^^^^^^^ + + Value + a string containing the value of ACCOUNTEXTBAN provided by the 005 connection message. This is the raw value and, depending on the IRC server formatting, could be in multiple formats such as "a", or "a,account". + + Module + ``channel`` + +extban-flags +^^^^^^^^^^^^ + Value + a string containing the allowed extban flag characters advertised by EXTBAN in the 005 connection message. If EXTBAN advertises a prefix, such as "$,aUq", the prefix is omitted and this variable contains only the flags, such as "aUq". + + Module + ``channel`` + + +Binds +----- + +You can use the 'bind' command to attach Tcl procedures to certain events. For example, you can write a Tcl procedure that gets called every time a user says "danger" on the channel. When a bind is triggered, ALL of the Tcl procs that are bound to it will be called. Raw binds are triggered before builtin binds, as a builtin bind has the potential to modify args. + +^^^^^^^^^^^^^^^ +Stackable binds +^^^^^^^^^^^^^^^ + +Some bind types are marked as "stackable". That means that you can bind multiple commands to the same trigger. Normally, for example, a bind such as 'bind msg - stop msg:stop' (which makes a msg-command "stop" call the Tcl proc "msg:stop") will overwrite any previous binding you had for the msg command "stop". With stackable bindings, like 'msgm' for example, you can bind the same command to multiple procs. + +^^^^^^^^^^^^^^^ +Removing a bind +^^^^^^^^^^^^^^^ + +To remove a bind, use the 'unbind' command. For example, to remove the +bind for the "stop" msg command, use 'unbind msg - stop msg:stop'. + +.. _tcl_binds: + +^^^^^^^^^^ +Flag Masks +^^^^^^^^^^ + +In the `Bind Types`_ section (and other commands, such as `matchattr`_), you will see several references to the "flags" argument. The "flags" argument takes a flag mask, which is a value that represents the type of user that is allowed to trigger the procedure associated to that bind. The flags can be any of the standard Eggdrop flags (o, m, v, etc). Additionally, when used by itself, a "-" or "*" can be used to skip processing for a flag type. A flag mask has three sections to it- global, channel, and bot flag sections. Each section is separated by the | or & logical operators ( the | means "OR" and the & means "AND; if nothing proceeds the flag then Eggdrop assumes it to be an OR). Additionally, a '+' and '-' can be used in front of a flag to check if the user does (+) have it, or does not (-) have it. + +The easiest way to explain how to build a flag mask is by demonstration. A flag mask of "v" by itself means "has a global v flag". To also check for a channel flag, you would use the flag mask "v\|v". This checks if the user has a global "v" flag, OR a channel "v" flag (again, the | means "OR" and ties the two types of flags together). You could change this mask to be "v&v", which would check if the user has a global "v" flag AND a channel "v" flag. Lastly, to check if a user ONLY has a channel flag, you would use "\*|v" as a mask, which would not check global flags but does check if the user had a channel "v" flag. + +You will commonly see flag masks for global flags written "ov"; this is the same as "\|ov" or "\*\|ov". + +Some additional examples: + +.. list-table:: + :widths: 14 86 + :header-rows: 1 + + * - Flag Mask + - Description + * - ``m``, ``+m``, ``m|*`` + - Checks if the user has the m global flag + * - ``+mn`` + - Checks if the user has the m OR n global flag + * - ``\\|+mn`` + - Checks if the user has the m OR n channel flag + * - \\|+mn #lamest + - Checks if the user has the m OR n channel flag for #lamest + * - ``&+mn`` + - Checks if the user has the m AND n channel flag + * - ``&mn #lamest`` + - Checks if the user has the m AND n channel flag for #lamest + * - \\|+o #lamest + - Checks if the user has the o channel flag for #lamest + * - ``+o|+n #lamest`` + - Checks if the user has the o global flag OR the n channel flag for #lamest + * - ``+m&+v #lamest`` + - Checks if the user has the m global flag AND the v channel flag for #lamest + * - ``-m`` + - Checks if the user does not have the m global flag + * - \\|-n #lamest + - Checks if the user does not have the n channel flag for #lamest + * - ``+m|-n #lamest`` + - Checks if the user has the global m flag OR does not have a channel n flag for #lamest + * - ``-n&-m #lamest`` + - Checks if the user does not have the global n flag AND does not have the channel m flag for #lamest + * - ``||+b`` + - Checks if the user has the bot flag b + +As a side note, Tcl scripts historically have used a '-' to skip processing of a flag type (Example: -\|o). It is unknown where and why this practice started, but as a style tip, Eggdrop developers recommend using a '\*' to skip processing, so as not to confuse a single "-" meaning "skip processing" with a preceding "-ov" which means "not these flags". + +.. _bind_types: + +^^^^^^^^^^ +Bind Types +^^^^^^^^^^ + +The following is a list of bind types and how they work. Below each bind type is the format of the bind command, the list of arguments sent to the Tcl proc, and an explanation. + +.. _bind-msg: + +(1) MSG + + ``bind msg `` + + ``procname `` + + Description + Used for ``/msg`` commands. The first word of the user's msg is the command, and everything else becomes the text argument. + + + Module + ``server`` + + + .. admonition:: Example — MSG trigger + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + bind msg * !hello msg_proc + + proc msg_proc {nick user hand text} { + putlog "Nick is $nick, user is $user, handle is $hand, text is $text" + } + + **Trigger and output** + + .. code-block:: text + + /msg LamestBot !hello world + Nick is Foobar, user is foobar@127.0.0.1, handle is foobar, text is world + +.. _bind-dcc: + +(2) DCC + + ``bind dcc `` + + ``procname `` + + Description + Used for partyline commands; the command is the first word and everything else is the text argument. The idx is valid until the user disconnects. After that, it may be reused, so be careful about storing an idx for long periods of time. + + + Module + ``core`` + + + .. admonition:: Example — DCC trigger + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + bind dcc * hello dcc_proc + + proc dcc_proc {hand idx text} { + putlog "Handle is $hand, idx is $idx, text is $text" + } + + **Trigger and output** + + .. code-block:: text + + .hello world + Handle is foobar, idx is 3, text is world + +.. _bind-fil: + +(3) FIL + + ``bind fil `` + + ``procname `` + + Description + The same as DCC, except this is triggered if the user is in the file area instead of the party line. + + + Module + ``filesys`` + + + .. admonition:: Example — FIL trigger + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + bind fil * hello fil_proc + + proc fil_proc {hand idx text} { + putlog "Handle is $hand, idx is $idx, text is $text" + } + + **Trigger and output** + + .. code-block:: text + + .hello world + Handle is foobar, idx is 3, text is world + +.. _bind-pub: + +(4) PUB + + ``bind pub `` + + ``procname `` + + Description + Used for commands given on a channel. The first word becomes the command and everything else is the text argument. + + + Module + ``irc`` + + + .. admonition:: Example — PUB trigger + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + bind pub * !hello pub_proc + + proc pub_proc {nick user hand chan text} { + putlog "Nick is $nick, user is $user, handle is $hand, channel is $chan, text is $text" + } + + **Trigger and output** + + .. code-block:: text + + !hello world + Nick is Foobar, user is foobar@127.0.0.1, handle is foobar, channel is #lamest, text is world + +.. _bind-msgm: + +(5) MSGM (stackable) + + ``bind msgm `` + + ``procname `` + + Description + Matches the entire line of text from a ``/msg`` with the mask. This is useful for binding Tcl procs to words or phrases spoken anywhere within a line of text. If the proc returns ``1``, Eggdrop will not log the message that triggered this bind. MSGM binds are processed before MSG binds. If the exclusive-binds setting is enabled, MSG binds will not be triggered by text that a MSGM bind has already handled. + + + Module + ``server`` + + + .. admonition:: Example — MSGM trigger + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + bind msgm * "*" msgm_proc + + proc msgm_proc {nick user hand text} { + putlog "Nick is $nick, user is $user, handle is $hand, text is $text" + return 0 + } + + **Trigger and output** + + .. code-block:: text + + /msg LamestBot hello world + Nick is Foobar, user is foobar@127.0.0.1, handle is foobar, text is hello world + +.. _bind-pubm: + +(6) PUBM (stackable) + + ``bind pubm `` + + ``procname `` + + Description + Just like MSGM, except it's triggered by things said on a channel instead of things ``/msg``'d to the bot. The mask is matched against the channel name followed by the text and can contain wildcards. If the proc returns ``1``, Eggdrop will not log the message that triggered this bind. PUBM binds are processed before PUB binds. If the exclusive-binds setting is enabled, PUB binds will not be triggered by text that a PUBM bind has already handled. + + + Module + ``irc`` + + + .. admonition:: Example — PUBM trigger + :collapsible: closed + :class: tcl-example + + .. code-block:: tcl + + bind pubm * "% *" pubm_proc + + proc pubm_proc {nick user hand chan text} { + putlog "Nick is $nick, user is $user, handle is $hand, channel is $chan, text is $text" + return 0 + } + + **Trigger and output** + + .. code-block:: text + + hello world + Nick is Foobar, user is foobar@127.0.0.1, handle is foobar, channel is #lamest, text is hello world + +.. _bind-notc: + +(7) NOTC (stackable) + + ``bind notc `` - Description: sends a message across the botnet to another bot. If no script intercepts the message on the other end, the message is ignored. + ``procname `` - Returns: nothing + Description + Dest will be a nickname (the bot's nickname, obviously) or a channel name. mask is matched against the entire text of the notice and can contain wildcards. It is considered a breach of protocol to respond to a ``/notice`` on IRC, so this is intended for internal use (logging, etc.) only. Note that server notices do not trigger the NOTC bind. If the proc returns ``1``, Eggdrop will not log the message that triggered this bind. - Module: core + New Tcl procs should be declared as:: -^^^^^^^^^^^^^^^^^^^^ -putallbots -^^^^^^^^^^^^^^^^^^^^ + proc notcproc {nick uhost hand text {dest ""}} { + global botnick; if {$dest == ""} {set dest $botnick} + ... + } - Description: sends a message across the botnet to all bots. If no script intercepts the message on the other end, the message is ignored. + for compatibility. - Returns: nothing - Module: core + Module + ``server`` -^^^^^^^^^^^^^ -killdcc -^^^^^^^^^^^^^ - Description: kills a partyline or file area connection + .. admonition:: Example — NOTC trigger + :collapsible: closed + :class: tcl-example - Returns: nothing + .. code-block:: tcl - Module: core + bind notc * "*" notc_proc + + proc notc_proc {nick user hand text {dest ""}} { + putlog "Nick is $nick, user is $user, handle is $hand, text is $text, destination is $dest" + return 0 + } -^^^^ -bots -^^^^ + **Trigger and output** - Returns: list of the bots currently connected to the botnet + .. code-block:: text - Module: core + Foobar sends NOTICE LamestBot :hello world + Nick is Foobar, user is foobar@127.0.0.1, handle is foobar, text is hello world, destination is LamestBot -^^^^^^^ -botlist -^^^^^^^ +.. _bind-join: - Returns: a list of bots currently on the botnet. Each item in the list is a sublist with four elements: bot, uplink, version, and sharing status: +(8) JOIN (stackable) - +----------+-----------------------------------------------+ - | bot | the bot's botnetnick | - +----------+-----------------------------------------------+ - | uplink | the bot the bot is connected to | - +----------+-----------------------------------------------+ - | version | it's current numeric version | - +----------+-----------------------------------------------+ - | sharing | a "+" if the bot is a sharebot; "-" otherwise | - +----------+-----------------------------------------------+ + ``bind join `` - Module: core + ``procname `` -^^^^^^^^^^^^^^ -islinked -^^^^^^^^^^^^^^ + Description + Triggered by someone joining the channel. The mask in the bind is matched against ``#channel nick!user\@host`` and can contain wildcards. - Returns: 1 if the bot is currently linked; 0 otherwise - Module: core + Module + ``irc`` -^^^^^^^ -dccused -^^^^^^^ - Returns: number of dcc connections currently in use + .. admonition:: Example — JOIN trigger + :collapsible: closed + :class: tcl-example - Module: core + .. code-block:: tcl -^^^^^^^^^^^^^^ -dcclist [type] -^^^^^^^^^^^^^^ + bind join * "#lamest *" join_proc + + proc join_proc {nick user hand chan} { + putlog "Nick is $nick, user is $user, handle is $hand, channel is $chan" + } - Returns: a list of active connections, each item in the list is a sublist containing seven elements: - { <[+]port> {} }. + **Trigger and output** - The types are: chat, bot, files, file_receiving, file_sending, file_send_pending, script, socket (these are connections that have not yet been put under 'control'), telnet, and server. The timestamp is in unixtime format. + .. code-block:: text - Module: core + Foobar joins #lamest + Nick is Foobar, user is foobar@127.0.0.1, handle is foobar, channel is #lamest -^^^^^^^^^^^^^^^ -socklist [type] -^^^^^^^^^^^^^^^ +.. _bind-part: - Returns: a list of active connections, each item in the list is a sublist containing eight elements (in dict-readable format). The order of items returned should not be considered static or permanent, so it is recommended to access the items as key/value pairs with the dict command, as opposed to something like lindex, to extract values. The possible keys returned are: - - +----------+--------------------------------------------------------+ - | idx | integer value assigned to Eggdrop connections | - +----------+--------------------------------------------------------+ - | handle | possible values are (telnet), (bots), (users), | - | | (script) for a listening socket, or the handle of the | - | | connected user for an established connection | - +----------+--------------------------------------------------------+ - | host | the hostname of the connection, if it is known; | - | | otherwise a * | - +----------+--------------------------------------------------------+ - | ip | the ip of the connection | - +----------+--------------------------------------------------------+ - | port | the port number associated with the connection (local | - | | port for listening connections, remote port for server | - | | connections. | - +----------+--------------------------------------------------------+ - | secure | 1 if SSL/TLS is used for the connect; 0 otherwise | - +----------+--------------------------------------------------------+ - | type | the type of connection (TELNET, CHAT, SERVER, etc) | - +----------+--------------------------------------------------------+ - | info | extra information associated with the connection | - +----------+--------------------------------------------------------+ - | time | timestamp of when the socket was established | - +----------+--------------------------------------------------------+ +(9) PART (stackable) - Module: core + ``bind part `` -^^^^^^^^^^^ -whom -^^^^^^^^^^^ + ``procname `` - Returns: list of people on the botnet who are on that channel. 0 is the default party line. Each item in the list is a sublist with six elements: nickname, bot, hostname, access flag ('-', '@', '+', or '*'), minutes idle, and away message (blank if the user is not away). If you specify * for channel, every user on the botnet is returned with an extra argument indicating the channel the user is on. + Description + Triggered by someone leaving the channel. The mask is matched against ``#channel nick!user\@host`` and can contain wildcards. If no part message is specified, msg will be set to ``""``. - Module: core + New Tcl procs should be declared as:: -^^^^^^^^^^^^^^^^ -getdccidle -^^^^^^^^^^^^^^^^ + proc partproc {nick uhost hand chan {msg ""}} { ... } - Returns: number of seconds the dcc chat/file system/script user has been idle + for compatibility. - Module: core -^^^^^^^^^^^^^^^^ -getdccaway -^^^^^^^^^^^^^^^^ + Module + ``irc`` - Returns: away message for a dcc chat user (or "" if the user is not set away) - Module: core + .. admonition:: Example — PART trigger + :collapsible: closed + :class: tcl-example -^^^^^^^^^^^^^^^^^^^^^^^^^^ -setdccaway -^^^^^^^^^^^^^^^^^^^^^^^^^^ + .. code-block:: tcl - Description: sets a party line user's away message and marks them away. If set to "", the user is marked as no longer away. + bind part * "#lamest *" part_proc + + proc part_proc {nick user hand chan {msg ""}} { + putlog "Nick is $nick, user is $user, handle is $hand, channel is $chan, message is $msg" + } - Returns: nothing + **Trigger and output** - Module: core + .. code-block:: text -^^^^^^^^^^^^^^^^^^^^^^^^ -connect <[+]port> -^^^^^^^^^^^^^^^^^^^^^^^^ + Foobar parts #lamest with "Goodbye" + Nick is Foobar, user is foobar@127.0.0.1, handle is foobar, channel is #lamest, message is Goodbye - Description: makes an outgoing connection attempt and creates a dcc entry for it. A 'control' command should be used immediately after a successful 'connect' so no input is lost. If the port is prefixed with a plus sign, SSL encrypted connection will be attempted. +.. _bind-sign: - Returns: idx of the new connection +(10) SIGN (stackable) - Module: core + ``bind sign `` + + ``procname `` -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -listen [ip] [options [flag]] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Description + Triggered by a signoff, or possibly by someone who got netsplit and never returned. The signoff message is the last argument to the proc. Wildcards can be used in the mask, which is matched against ``#channel nick!user\@host``. If a ``*`` is used for the channel in the mask, this bind is triggered once for every channel that the user is in the bot with; in other words if the bot is in two channels with the target user, the bind will be triggered twice. To trigger a proc only once per signoff, regardless of the number of channels the Eggdrop and user share, use the RAWT bind with SIGN as the keyword. - Description: opens a listening port to accept incoming telnets; type must be one of "bots", "all", "users", "script", or "off". Prefixing the port with a plus sign will make eggdrop accept SSL connections on it. An IP may optionally be listed before the mandatory port argument. If no IP is specified, all available interfaces are used. - listen [ip] bots [mask] + Module + ``irc`` - Description: accepts connections from bots only; the optional mask is used to identify permitted bot names. If the mask begins with '@', it is interpreted to be a mask of permitted hosts to accept connections from. - Returns: port number or error message + .. admonition:: Example — SIGN trigger + :collapsible: closed + :class: tcl-example - listen [ip] users [mask] - - Description: accepts connections from users only (no bots); the optional mask is used to identify permitted nicknames. If the mask begins with '@', it is interpreted to be a mask of permitted hosts to accept connections from. + .. code-block:: tcl - Returns: port number or error message + bind sign * "#lamest *" sign_proc + + proc sign_proc {nick user hand chan reason} { + putlog "Nick is $nick, user is $user, handle is $hand, channel is $chan, reason is $reason" + } - listen [ip] all [mask] + **Trigger and output** - Description: accepts connections from anyone; the optional mask is used to identify permitted nicknames/botnames. If the mask begins with '@', it is interpreted to be a mask of permitted hosts to accept connections from. + .. code-block:: text - Returns: port number or error message + Foobar quits IRC with "Leaving" + Nick is Foobar, user is foobar@127.0.0.1, handle is foobar, channel is #lamest, reason is Leaving - listen [ip] script [flag] +.. _bind-topc: - Description: accepts connections which are immediately routed to a proc. The proc is called with one parameter: the idx of the new connection. The optional flag parameter currently only accepts 'pub' as a value. By specifying 'pub' as a flag, Eggdrop will skip the ident check for the user regardless of settings in the config file. This will allow any user to attempt a connection, and result in Eggdrop using "-telnet!telnet@host" instead of "-telnet!@host" as a hostmask to match against the user. +(11) TOPC (stackable) - Returns: port number or error message + ``bind topc `` + + ``procname `` - listen [ip] off + Description + Triggered by a topic change. mask can contain wildcards and is matched against ``#channel ``. - Description: stop listening on a port - Returns: nothing + Module + ``irc`` - Module: core -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -dccdumpfile -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + .. admonition:: Example — TOPC trigger + :collapsible: closed + :class: tcl-example - Description: dumps out a file from the text directory to a dcc chat user. The flag matching that's used everywhere else works here, too. + .. code-block:: tcl - Returns: nothing + bind topc * "#lamest *" topc_proc + + proc topc_proc {nick user hand chan topic} { + putlog "Nick is $nick, user is $user, handle is $hand, channel is $chan, topic is $topic" + } - Module: core + **Trigger and output** -Notes Module ------------- + .. code-block:: text -^^^^^^^^^^^^^^^^^^^^^^^^^ -notes [numberlist] -^^^^^^^^^^^^^^^^^^^^^^^^^ + Foobar changes the #lamest topic to "Example topic" + Nick is Foobar, user is foobar@127.0.0.1, handle is foobar, channel is #lamest, topic is Example topic - Returns: -1 if no such user, -2 if notefile failure. If a numberlist is not specified, the number of notes stored for the user is returned. Otherwise, a list of sublists containing information about notes stored for the user is returned. Each sublist is in the format of:: +.. _bind-kick: - { } +(12) KICK (stackable) - Module: notes + ``bind kick `` + + ``procname `` -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -erasenotes -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Description + Triggered when someone is kicked off the channel. The mask is matched against ``#channel target reason`` where the target is the nickname of the person who got kicked (can contain wildcards). The proc is called with the nick, user\@host, and handle of the kicker, plus the channel, the nickname of the person who was kicked, and the reason. - Description: erases some or all stored notes for a user. Use '-' to erase all notes. - Returns: -1 if no such user, -2 if notefile failure, 0 if no such note, or number of erased notes. + Module + ``irc`` - Module: notes -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -listnotes -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + .. admonition:: Example — KICK trigger + :collapsible: closed + :class: tcl-example - Description: lists existing notes according to the numberlist (ex: "2-4;8;16-") + .. code-block:: tcl - Returns: -1 if no such user, -2 if notefile failure, 0 if no such note, list of existing notes. + bind kick * "#lamest *" kick_proc + + proc kick_proc {nick user hand chan target reason} { + putlog "Nick is $nick, user is $user, handle is $hand, channel is $chan, target is $target, reason is $reason" + } - Module: notes + **Trigger and output** -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -storenote -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + .. code-block:: text - Description: stores a note for later reading, notifies idx of any results (use idx -1 for no notify). + Foobar kicks Guest from #lamest with "Example reason" + Nick is Foobar, user is foobar@127.0.0.1, handle is foobar, channel is #lamest, target is Guest, reason is Example reason - Returns: 0 on success; non-0 on failure +.. _bind-nick: - Module: notes +(13) NICK (stackable) -Assoc Module ------------- + ``bind nick `` + + ``procname `` -^^^^^^^^^^^^^^^^^^^ -assoc [name] -^^^^^^^^^^^^^^^^^^^ + Description + Triggered when someone changes nicknames. The mask is matched against ``#channel newnick`` and can contain wildcards. Channel is ``*`` if the user isn't on a channel (usually the bot not yet in a channel). If a ``*`` is used for the channel in the mask, this bind is triggered once for every channel that the user is in the bot with; in other words if the bot is in two channels with the target user, the bind will be triggered twice. To trigger a proc only once per nick change, regardless of the number of channels the Eggdrop and user share, use the RAWT bind with NICK as the keyword. - Description: sets the name associated with a botnet channel, if you specify one - Returns: current name for that channel, if any + Module + ``irc`` - Module: assoc -^^^^^^^^^^^^^^^^ -killassoc -^^^^^^^^^^^^^^^^ + .. admonition:: Example — NICK trigger + :collapsible: closed + :class: tcl-example - Description: removes the name associated with a botnet channel, if any exists. Use 'killassoc &' to kill all assocs. + .. code-block:: tcl - Returns: nothing + bind nick * "#lamest *" nick_proc + + proc nick_proc {nick user hand chan newnick} { + putlog "Nick is $nick, user is $user, handle is $hand, channel is $chan, new nick is $newnick" + } - Module: assoc + **Trigger and output** -Compress Module ---------------- + .. code-block:: text -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -compressfile [-level ] [target-file] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -and -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -uncompressfile [target-file] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Foobar changes nick to Foobar2 + Nick is Foobar, user is foobar@127.0.0.1, handle is foobar, channel is #lamest, new nick is Foobar2 - Description: compresses or un-compresses files. The level option specifies the compression mode to use when compressing. Available modes are from 0 (minimum CPU usage, minimum compression) all the way up to 9 (maximum CPU usage, maximum compression). If you don't specify the target-file, the src-file will be overwritten. +.. _bind-mode: - Returns: nothing +(14) MODE (stackable) - Module: compress + ``bind mode `` -^^^^^^^^^^^^^^^^^^^^^^^ -iscompressed -^^^^^^^^^^^^^^^^^^^^^^^ + ``procname `` - Description: determines whether is gzip compressed. + Description + Mode changes are broken down into their component parts before being sent here, so the ```` will always be a single mode, such as ``+m`` or ``-o``. target will show the argument of the mode change (for o/v/b/e/I) or ``""`` if the set mode does not take an argument. The bot's automatic response to a mode change will happen AFTER all matching Tcl procs are called. The mask will be matched against ``#channel +/-modes`` and can contain wildcards. - Returns: 1 if it is, 0 if it isn't, and 2 if some kind of error prevented the checks from succeeding. + If it is a server mode, nick will be ``""``, user\@host is the server name, and handle is \*. + + Note that ``target`` was added in 1.3.17 and that this will break Tcl scripts that were written for pre-1.3.17 Eggdrop that use the mode binding. Also, due to a typo, mode binds were broken completely in 1.3.17 but were fixed in 1.3.18. Mode bindings are not triggered at all in 1.3.17. - Module: compress + One easy example (from guppy) of how to support the ``target`` parameter in 1.3.18 and later and still remain compatible with older Eggdrop versions is: -Filesys Module --------------- + Old script looks as follows:: -^^^^^^^^^^^^^^^^^^ -setpwd -^^^^^^^^^^^^^^^^^^ + bind mode - * mode_proc + proc mode_proc {nick uhost hand chan mode} { ... } - Description: changes the directory of a file system user, in exactly the same way as a 'cd' command would. The directory can be specified relative or absolute. + To make it work with 1.3.18+ and stay compatible with older bots, do:: - Returns: nothing + bind mode - * mode_proc_fix + proc mode_proc_fix {nick uhost hand chan mode {target ""}} { + if {$target != ""} {append mode " $target"} + mode_proc $nick $uhost $hand $chan $mode + } + proc mode_proc {nick uhost hand chan mode} { ... } - Module: filesys -^^^^^^^^^^^^ -getpwd -^^^^^^^^^^^^ + Module + ``irc`` - Returns: the current directory of a file system user - Module: filesys + .. admonition:: Example — MODE trigger + :collapsible: closed + :class: tcl-example -^^^^^^^^^^^^^^ -getfiles -^^^^^^^^^^^^^^ + .. code-block:: tcl - Returns: a list of files in the directory given; the directory is relative to dcc-path + bind mode * "#lamest *" mode_proc + + proc mode_proc {nick user hand chan mode target} { + putlog "Nick is $nick, user is $user, handle is $hand, channel is $chan, mode is $mode, target is $target" + } - Module: filesys + **Trigger and output** -^^^^^^^^^^^^^ -getdirs -^^^^^^^^^^^^^ + .. code-block:: text - Returns: a list of subdirectories in the directory given; the directory is relative to dcc-path + Foobar sets +o Guest on #lamest + Nick is Foobar, user is foobar@127.0.0.1, handle is foobar, channel is #lamest, mode is +o, target is Guest - Module: filesys +.. _bind-ctcp: -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -dccsend -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +(15) CTCP (stackable) - Description: attempts to start a dcc file transfer to the given nick; the filename must be specified either by full pathname or in relation to the bot's startup directory + ``bind ctcp `` + ``procname `` - Returns: + Description + Dest will be a nickname (the bot's nickname, obviously) or channel name. keyword is the ctcp command (which can contain wildcards), and text may be empty. If the proc returns ``0``, the bot will attempt its own processing of the ctcp command. - +-------+---------------------------------------------------------------------+ - | 0 | success | - +-------+---------------------------------------------------------------------+ - | 1 | the dcc table is full (too many connections) | - +-------+---------------------------------------------------------------------+ - | 2 | can't open a socket for the transfer | - +-------+---------------------------------------------------------------------+ - | 3 | the file doesn't exist | - +-------+---------------------------------------------------------------------+ - | 4 | the file was queued for later transfer, which means that person has | - | | too many file transfers going right now | - +-------+---------------------------------------------------------------------+ - | 5 | the file could not be opened or temporary file could not be created | - +-------+---------------------------------------------------------------------+ - Module: transfer + Module + ``server`` -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -filesend [ircnick] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Description: like dccsend, except it operates for a current filesystem user, and the filename is assumed to be a relative path from that user's current directory + .. admonition:: Example — CTCP trigger + :collapsible: closed + :class: tcl-example - Returns: 0 on failure; 1 on success (either an immediate send or a queued send) + .. code-block:: tcl - Module: filesys + bind ctcp * VERSION ctcp_proc + + proc ctcp_proc {nick user hand dest keyword text} { + putlog "Nick is $nick, user is $user, handle is $hand, destination is $dest, keyword is $keyword, text is $text" + return 0 + } -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -fileresend [ircnick] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + **Trigger and output** - Description: functions like filesend, only that it sends a DCC RESEND instead of a DCC SEND, which allows people to resume aborted file transfers if their client supports that protocol. ircII/BitchX/etc. support it; mIRC does not. + .. code-block:: text - Returns: 0 on failure; 1 on success (either an immediate send or a queued send) + Foobar sends a CTCP VERSION request to LamestBot + Nick is Foobar, user is foobar@127.0.0.1, handle is foobar, destination is LamestBot, keyword is VERSION, text is - Module: filesys +.. _bind-ctcr: -^^^^^^^^^^^^^^^^^^^^^^^^^^^ -setdesc -^^^^^^^^^^^^^^^^^^^^^^^^^^^ +(16) CTCR (stackable) - Description: sets the description for a file in a file system directory; the directory is relative to dcc-path + ``bind ctcr `` - Returns: nothing + ``procname `` - Module: filesys + Description + Just like ctcp, but this is triggered for a ctcp-reply (ctcp embedded in a notice instead of a privmsg). -^^^^^^^^^^^^^^^^^^^^ -getdesc -^^^^^^^^^^^^^^^^^^^^ - Returns: the description for a file in the file system, if one exists + Module + ``server`` - Module: filesys -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -setowner -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + .. admonition:: Example — CTCR trigger + :collapsible: closed + :class: tcl-example - Description: changes the owner for a file in the file system; the directory is relative to dcc-path + .. code-block:: tcl - Returns: nothing + bind ctcr * VERSION ctcr_proc + + proc ctcr_proc {nick user hand dest keyword text} { + putlog "Nick is $nick, user is $user, handle is $hand, destination is $dest, keyword is $keyword, text is $text" + } - Module: filesys + **Trigger and output** -^^^^^^^^^^^^^^^^^^^^^ -getowner -^^^^^^^^^^^^^^^^^^^^^ + .. code-block:: text - Returns: the owner of a file in the file system + Foobar sends a CTCP VERSION reply to LamestBot + Nick is Foobar, user is foobar@127.0.0.1, handle is foobar, destination is LamestBot, keyword is VERSION, text is Example client - Module: filesys +.. _bind-raw: -^^^^^^^^^^^^^^^^^^^^^^^^^^^ -setlink -^^^^^^^^^^^^^^^^^^^^^^^^^^^ +(17) RAW (stackable) - Description: creates or changes a linked file (a file that actually exists on another bot); the directory is relative to dcc-path + ``bind raw `` - Returns: nothing + ``procname `` - Module: filesys + IMPORTANT: While not necessarily deprecated, this bind has been supplanted by the RAWT bind, which supports the IRCv3 message-tags capability, as of 1.9.0. You probably want to be using RAWT, not RAW. -^^^^^^^^^^^^^^^^^^^^ -getlink -^^^^^^^^^^^^^^^^^^^^ + Description + The mask can contain wildcards and is matched against the keyword, which is either a numeric, like ``368``, or a keyword, such as ``PRIVMSG``. ``from`` will be the server name or the source nick!ident@host (depending on the keyword); flags are ignored. If the proc returns ``1``, Eggdrop will not process the line any further (this could cause unexpected behavior in some cases), although RAWT binds are processed before RAW binds (and thus, a RAW bind cannot block a RAWT bind). - Returns: the link for a linked file, if it exists - Module: filesys + Module + ``server`` -^^^^^^^^^^^^^^^^^ -getfileq -^^^^^^^^^^^^^^^^^ - Returns: list of files queued by someone; each item in the list will be a sublist with two elements: nickname the file is being sent to and the filename + .. admonition:: Example — RAW trigger + :collapsible: closed + :class: tcl-example - Module: transfer + .. code-block:: tcl -^^^^^^^^^^^^^^^^^^^^^ -getfilesendtime -^^^^^^^^^^^^^^^^^^^^^ + bind raw - PRIVMSG raw_proc + + proc raw_proc {from keyword text} { + putlog "From is $from, keyword is $keyword, text is $text" + return 0 + } - Returns: the unixtime value from when a file transfer started, or a negative number: + **Trigger and output** - +-----+------------------------------------------------------+ - | -1 | no matching transfer with the specified idx was found| - +-----+------------------------------------------------------+ - | -2 | the idx matches an entry which is not a file transfer| - +-----+------------------------------------------------------+ + .. code-block:: text - Module: transfer + Foobar sends PRIVMSG LamestBot :hello world + From is foobar@127.0.0.1, keyword is PRIVMSG, text is LamestBot :hello world -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -mkdir [ [channel]] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. _bind-bot: - Description: creates a directory in the file system. Only users with the required flags may access it. +(18) BOT - Returns: + ``bind bot `` - +-----+------------------------------------------------------+ - | 0 | success | - +-----+------------------------------------------------------+ - | 1 | can't create directory | - +-----+------------------------------------------------------+ - | 2 | directory exists but is not a directory | - +-----+------------------------------------------------------+ - | -3 | could not open filedb | - +-----+------------------------------------------------------+ + ``procname `` - Module: filesys + Description + Triggered by a message coming from another bot in the botnet. The first word is the command and the rest becomes the text argument; flags are ignored. -^^^^^^^^^^^^^^^^^ -rmdir -^^^^^^^^^^^^^^^^^ - Description: removes a directory from the file system. + Module + ``core`` - Returns: 0 on success; 1 on failure - Module: filesys + .. admonition:: Example — BOT trigger + :collapsible: closed + :class: tcl-example -^^^^^^^^^^^^^^^^^^^^^^^ -mv -^^^^^^^^^^^^^^^^^^^^^^^ + .. code-block:: tcl - Description: moves a file from its source to the given destination. The file can also be a mask, such as /incoming/\*, provided the destination is a directory. + bind bot - HELLO bot_proc + + proc bot_proc {from command text} { + putlog "From bot is $from, command is $command, text is $text" + } - Returns: If the command was successful, the number of files moved will be returned. Otherwise, a negative number will be returned: + **Trigger and output** - +-----+------------------------------------------------------+ - | -1 | invalid source file | - +-----+------------------------------------------------------+ - | -2 | invalid destination | - +-----+------------------------------------------------------+ - | -3 | destination file exists | - +-----+------------------------------------------------------+ - | -4 | no matches found | - +-----+------------------------------------------------------+ + .. code-block:: text - Module: filesys + RemoteBot sends botnet message "HELLO hello world" + From bot is RemoteBot, command is HELLO, text is hello world -^^^^^^^^^^^^^^^^^^^^^^^ -cp -^^^^^^^^^^^^^^^^^^^^^^^ +.. _bind-chon: - Description: copies a file from its source to the given destination. The file can also be a mask, such as /incoming/\*, provided the destination is a directory. +(19) CHON (stackable) - Returns: If the command was successful, the number of files copied will be returned. Otherwise, a negative number will be returned: + ``bind chon `` - +-----+------------------------------------------------------+ - | -1 | invalid source file | - +-----+------------------------------------------------------+ - | -2 | invalid destination | - +-----+------------------------------------------------------+ - | -3 | destination file exists | - +-----+------------------------------------------------------+ - | -4 | no matches found | - +-----+------------------------------------------------------+ + ``procname `` - Module: filesys + Description + When someone first enters the party-line area of the bot via dcc chat or telnet, this is triggered before they are connected to a chat channel (so, yes, you can change the channel in a ``chon`` proc). mask is matched against the handle and supports wildcards. This is NOT triggered when someone returns from the file area, etc. -^^^^^^^^^^^^^^ -getflags -^^^^^^^^^^^^^^ - Returns: the flags required to access a directory + Module + ``core`` - Module: filesys -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -setflags [ [channel]] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + .. admonition:: Example — CHON trigger + :collapsible: closed + :class: tcl-example - Description: sets the flags required to access a directory + .. code-block:: tcl - Returns: 0 on success; -1 or -3 on failure + bind chon * "*" chon_proc + + proc chon_proc {hand idx} { + putlog "Handle is $hand, idx is $idx" + } - Module: filesys + **Trigger and output** -PBKDF2 Module -------------- + .. code-block:: text -^^^^^^^^^^^^^^^ -encpass2 -^^^^^^^^^^^^^^^ + foobar enters the party line + Handle is foobar, idx is 3 +.. _bind-chof: - Returns: a hash in the format of "$pbkdf2-$rounds=$$" where digest is the digest set in the config variable pbkdf2-method, rounds is the number of rounds set in the config variable pbkdf2-rounds, salt is the base64 salt used to generate the hash, and hash is the generated base64 hash. +(20) CHOF (stackable) - Module: pbkdf2 + ``bind chof `` -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -pbkdf2 [-bin] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + ``procname `` - Returns: a derived key from the provided "pass" string using "salt" and "rounds" count as specified in RFC 2898 as a hexadecimal string. Using the optional -bin flag will return the result as binary data. + Description + Triggered when someone leaves the party line to disconnect from the bot. mask is matched against the handle and can contain wildcards. Note that the connection may have already been dropped by the user, so don't send output to the idx. - Module: pbkdf2 -Miscellaneous Commands ----------------------- + Module + ``core`` -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -bind [proc-name] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Description: You can use the 'bind' command to attach Tcl procedures to certain events. flags are the flags the user must have to trigger the event (if applicable). proc-name is the name of the Tcl procedure to call for this command (see below for the format of the procedure call). If the proc-name is omitted, no binding is added. Instead, the current binding is returned (if it's stackable, a list of the current bindings is returned). + .. admonition:: Example — CHOF trigger + :collapsible: closed + :class: tcl-example - Returns: name of the command that was added, or (if proc-name was omitted), a list of the current bindings for this command + .. code-block:: tcl - Module: core + bind chof * "*" chof_proc + + proc chof_proc {hand idx} { + putlog "Handle is $hand, idx is $idx" + } -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -unbind -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + **Trigger and output** - Description: removes a previously created bind + .. code-block:: text - Returns: name of the command that was removed + foobar leaves the party line + Handle is foobar, idx is 3 - Module: core +.. _bind-sent: -^^^^^^^^^^^^^^^^^ -binds [type/mask] -^^^^^^^^^^^^^^^^^ +(21) SENT (stackable) - Description: By default, lists Tcl binds registered with the Eggdrop. You can specify 'all' to view all binds, 'tcl' to view Tcl binds, and 'python' to view Python binds. Alternately, you can specify a bind type (pub, msg, etc) to view all binds that match that type of bind, or a mask that is matched against the command associated with the bind. + ``bind sent `` - Returns: a list of Tcl binds, each item in the list is a sublist of five elements: - { } + ``procname `` - Module: core + Description + After a user has successfully downloaded a file from the bot, this binding is triggered. mask is matched against the handle of the user that initiated the transfer and supports wildcards. nick is the actual recipient (on IRC) of the file. The path is relative to the dcc directory (unless the file transfer was started by a script call to ``dccsend``, in which case the path is the exact path given in the call to ``dccsend``). -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -logfile [ ] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Description: creates a new logfile, which will log the modes given for the channel listed. If no logfile is specified, a list of existing logfiles will be returned. "*" indicates all channels. You can also change the modes and channel of an existing logfile with this command. Entering a blank mode and channel ("") makes the bot stop logging there. - - Logfile flags: - - +-----+---------------------------------------------------------------------+ - | b | information about bot linking and userfile sharing | - +-----+---------------------------------------------------------------------+ - | c | commands | - +-----+---------------------------------------------------------------------+ - | d | misc debug information | - +-----+---------------------------------------------------------------------+ - | g | raw outgoing share traffic | - +-----+---------------------------------------------------------------------+ - | h | raw incoming share traffic | - +-----+---------------------------------------------------------------------+ - | j | joins, parts, quits, topic changes, and netsplits on the channel | - +-----+---------------------------------------------------------------------+ - | k | kicks, bans, and mode changes on the channel | - +-----+---------------------------------------------------------------------+ - | l | linked bot messages | - +-----+---------------------------------------------------------------------+ - | m | private msgs, notices and ctcps to the bot | - +-----+---------------------------------------------------------------------+ - | o | misc info, errors, etc (IMPORTANT STUFF) | - +-----+---------------------------------------------------------------------+ - | p | public text on the channel | - +-----+---------------------------------------------------------------------+ - | r | raw incoming server traffic | - +-----+---------------------------------------------------------------------+ - | s | server connects, disconnects, and notices | - +-----+---------------------------------------------------------------------+ - | t | raw incoming botnet traffic | - +-----+---------------------------------------------------------------------+ - | u | raw outgoing botnet traffic | - +-----+---------------------------------------------------------------------+ - | v | raw outgoing server traffic | - +-----+---------------------------------------------------------------------+ - | w | wallops (make sure the bot sets +w in init-server) | - +-----+---------------------------------------------------------------------+ - | x | file transfers and file-area commands | - +-----+---------------------------------------------------------------------+ - - Returns: filename of logfile created, or, if no logfile is specified, a list of logfiles such as: {mco * eggdrop.log} {jp #lame lame.log} - - Module: core + Module + ``transfer`` -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -maskhost [masktype] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Returns: masked hostmask for the string given according to the masktype (the default is 3). - - Available types are: - - +-----+------------------------------------------------------+ - | 0 | \*!user\@host | - +-----+------------------------------------------------------+ - | 1 | \*!*user\@host | - +-----+------------------------------------------------------+ - | 2 | \*!*\@host | - +-----+------------------------------------------------------+ - | 3 | \*!*user\@*.host | - +-----+------------------------------------------------------+ - | 4 | \*!*\@*.host | - +-----+------------------------------------------------------+ - | 5 | nick!user\@host | - +-----+------------------------------------------------------+ - | 6 | nick!*user\@host | - +-----+------------------------------------------------------+ - | 7 | nick!*\@host | - +-----+------------------------------------------------------+ - | 8 | nick!*user\@*.host | - +-----+------------------------------------------------------+ - | 9 | nick!*\@*.host | - +-----+------------------------------------------------------+ - - You can also specify types from 10 to 19 which correspond to types - 0 to 9, but instead of using a * wildcard to replace portions of the - host, only numbers in hostnames are replaced with the '?' wildcard. - Same is valid for types 20-29, but instead of '?', the '\*' wildcard - will be used. Types 30-39 set the host to '\*'. - - Module: core + .. admonition:: Example — SENT trigger + :collapsible: closed + :class: tcl-example -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -timer [count [timerName]] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + .. code-block:: tcl - Description: executes the given Tcl command after a certain number of minutes have passed, at the top of the minute (ie, if a timer is started at 10:03:34 with 1 minute specified, it will execute at 10:04:00. If a timer is started at 10:06:34 with 2 minutes specified, it will execute at 10:08:00). If count is specified, the command will be executed count times with the given interval in between. If you specify a count of 0, the timer will repeat until it's removed with killtimer or until the bot is restarted. If timerName is specified, it will become the unique identifier for the timer. If no timerName is specified, Eggdrop will assign a timerName in the format of "timer". + bind sent * "*" sent_proc + + proc sent_proc {hand nick path} { + putlog "Handle is $hand, nick is $nick, path is $path" + } - Returns: a timerName + **Trigger and output** - Module: core + .. code-block:: text -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -utimer [count [timerName]] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Foobar successfully downloads example.txt + Handle is foobar, nick is Foobar, path is example.txt - Description: executes the given Tcl command after a certain number of seconds have passed. If count is specified, the command will be executed count times with the given interval in between. If you specify a count of 0, the utimer will repeat until it's removed with killutimer or until the bot is restarted. If timerName is specified, it will become the unique identifier for the timer. If timerName is not specified, Eggdrop will assign a timerName in the format of "timer". +.. _bind-rcvd: - Returns: a timerName +(22) RCVD (stackable) - Module: core + ``bind rcvd `` -^^^^^^ -timers -^^^^^^ + ``procname `` - Description: lists all active minutely timers. + Description + Triggered after a user uploads a file successfully. mask is matched against the user's handle. nick is the IRC nickname that the file transfer originated from. The path is where the file ended up, relative to the dcc directory (usually this is your incoming dir). - Returns: a list of active minutely timers, with each timer sub-list containing the number of minutes left until activation, the command that will be executed, the timerName, and the remaining number of repeats. - Module: core + Module + ``transfer`` -^^^^^^^ -utimers -^^^^^^^ - Description: lists all active secondly timers. + .. admonition:: Example — RCVD trigger + :collapsible: closed + :class: tcl-example - Returns: a list of active secondly timers, with each timer sub-list containing the number of seconds left until activation, the command that will be executed, the timerName, and the remaining number of repeats. + .. code-block:: tcl - Module: core + bind rcvd * "*" rcvd_proc + + proc rcvd_proc {hand nick path} { + putlog "Handle is $hand, nick is $nick, path is $path" + } -^^^^^^^^^^^^^^^^^^^^^ -killtimer -^^^^^^^^^^^^^^^^^^^^^ + **Trigger and output** - Description: removes the timerName minutely timer from the timer list. + .. code-block:: text - Returns: nothing + Foobar successfully uploads example.txt + Handle is foobar, nick is Foobar, path is incoming/example.txt - Module: core +.. _bind-chat: -^^^^^^^^^^^^^^^^^^^^^^ -killutimer -^^^^^^^^^^^^^^^^^^^^^^ +(23) CHAT (stackable) - Description: removes the timerName secondly timer from the timer list. + ``bind chat `` - Returns: nothing + ``procname `` - Module: core + Description + When a user says something on the botnet, it invokes this binding. Flags are ignored; handle could be a user on this bot ("DronePup") or on another bot (``Eden\@Wilde``) and therefore you can't rely on a local user record. The mask is checked against the entire line of text and supports wildcards. Eggdrop passes the partyline channel number the user spoke on to the proc in ``channel#``. -^^^^^^^^ -unixtime -^^^^^^^^ + NOTE: If a BOT says something on the botnet, the BCST bind is invoked instead. - Returns: a long integer which represents the number of seconds that have passed since 00:00 Jan 1, 1970 (GMT). - Module: core + Module + ``core`` -^^^^^^^^^^^^^^^^^^ -duration -^^^^^^^^^^^^^^^^^^ - Returns: the number of seconds converted into years, weeks, days, hours, minutes, and seconds. 804600 seconds is turned into 1 week 2 days 7 hours 30 minutes. + .. admonition:: Example — CHAT trigger + :collapsible: closed + :class: tcl-example - Module: core + .. code-block:: tcl -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -strftime [time] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + bind chat - "*" chat_proc + + proc chat_proc {hand chan text} { + putlog "Handle is $hand, channel is $chan, text is $text" + } - Returns: a formatted string of time using standard strftime format. If time is specified, the value of the specified time is used. Otherwise, the current time is used. Note: The implementation of strftime varies from platform to platform, so the user should only use POSIX-compliant format specifiers to ensure fully portable code. + **Trigger and output** - Module: core + .. code-block:: text -^^^^^^^^^^^^^^^^ -ctime -^^^^^^^^^^^^^^^^ + hello world + Handle is foobar, channel is 0, text is hello world - Returns: a formatted date/time string based on the current locale settings from the unixtime string given; for example "Fri Aug 3 11:34:55 1973" +.. _bind-link: - Module: core +(24) LINK (stackable) -^^^^ -myip -^^^^ + ``bind link `` - Returns: a long number representing the bot's IP address, as it might appear in (for example) a DCC request + ``procname `` - Module: core + Description + Triggered when a bot links into the botnet. botname is the botnetnick of the bot that just linked in; via is the bot it linked through. The mask is checked against the botnetnick of the bot that linked and supports wildcards. flags are ignored. -^^^^^^^^^^^^ -rand -^^^^^^^^^^^^ - Returns: a random integer between 0 and limit-1. Limit must be greater than 0 and equal to or less than RAND_MAX, which is generally 2147483647. The underlying pseudo-random number generator is not cryptographically secure. + Module + ``core`` - Module: core -^^^^^^^^^^^^^^^^^^^^^^^ -control -^^^^^^^^^^^^^^^^^^^^^^^ + .. admonition:: Example — LINK trigger + :collapsible: closed + :class: tcl-example - Description: removes an idx from the party line and sends all future input to the Tcl command given. The command will be called with two parameters: the idx and the input text. The command should return 0 to indicate success and 1 to indicate that it relinquishes control of the user back to the bot. If the input text is blank (""), it indicates that the connection has been dropped. Also, if the input text is blank, never call killdcc on it, as it will fail with "invalid idx". + .. code-block:: tcl - Returns: nothing + bind link - "*" link_proc + + proc link_proc {bot via} { + putlog "Bot is $bot, via is $via" + } - Module: core + **Trigger and output** -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -sendnote -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + .. code-block:: text - Description: simulates what happens when one user sends a note to another + RemoteBot links to the botnet through LamestBot + Bot is RemoteBot, via is LamestBot - Returns: +.. _bind-disc: - +-----+----------------------------------------------------------+ - | 0 | the send failed | - +-----+----------------------------------------------------------+ - | 1 | the note was delivered locally or sent to another bot | - +-----+----------------------------------------------------------+ - | 2 | the note was stored locally | - +-----+----------------------------------------------------------+ - | 3 | the user's notebox is too full to store a note | - +-----+----------------------------------------------------------+ - | 4 | a Tcl binding caught the note | - +-----+----------------------------------------------------------+ - | 5 | the note was stored because the user is away | - +-----+----------------------------------------------------------+ +(25) DISC (stackable) - Module: core + ``bind disc `` -^^^^^^^^^^^^^^^^^^^^ -link [via-bot] -^^^^^^^^^^^^^^^^^^^^ + ``procname `` - Description: attempts to link to another bot directly. If you specify a via-bot, it tells the via-bot to attempt the link. + Description + Triggered when a bot disconnects from the botnet for whatever reason. Just like the link bind, flags are ignored; mask is matched against the botnetnick of the bot that unlinked. Wildcards are supported in mask. - Returns: 1 if the link will be attempted; 0 otherwise - Module: core + Module + ``core`` -^^^^^^^^^^^^^^^^^^^^^^ -unlink [comment] -^^^^^^^^^^^^^^^^^^^^^^ - Description: attempts to unlink a bot from the botnet. If you specify a comment, it will appear with the unlink message on the botnet. + .. admonition:: Example — DISC trigger + :collapsible: closed + :class: tcl-example - Returns: 1 on success; 0 otherwise + .. code-block:: tcl - Module: core + bind disc - "*" disc_proc + + proc disc_proc {bot} { + putlog "Bot is $bot" + } -^^^^^^^^^^^^^^^^^^^^^^ -encrypt -^^^^^^^^^^^^^^^^^^^^^^ + **Trigger and output** - Returns: encrypted string (using the currently loaded encryption module), encoded into ASCII using base-64. As of v1.8.4, the default blowfish encryption module can use either the older ECB mode (currently used by default for compatibility reasons), or the more recent and more-secure CBC mode. You can explicitly request which encryption mode to use by prefixing the encryption key with either "ecb:" or "cbc:", or by using the blowfish-use-mode setting in the config file. Note: the default encryption mode for this function is planned to transition from ECB to CBC in v1.9.0. + .. code-block:: text - Module: encryption + RemoteBot disconnects from the botnet + Bot is RemoteBot -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -decrypt -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. _bind-splt: - Returns: decrypted string (using the currently loaded encryption module). If the default blowfish encryption module is used, this automatically picks the right decryption mode. You may still prefix the key with "ecb:" or "cbc:" or use the blowfish-use-mode setting in the config file (see the encrypt command for more detailed information). +(26) SPLT (stackable) - Module: encryption + ``bind splt `` -^^^^^^^^^^^^^^^^^^ -encpass -^^^^^^^^^^^^^^^^^^ + ``procname `` - Returns: encrypted string (using the currently loaded encryption module) + Description + Triggered when someone gets netsplit on the channel. Be aware that this may be a false alarm (it's easy to fake a netsplit signoff message on some networks); mask may contain wildcards and is matched against ``#channel nick!user\@host``. Anyone who is SPLT will trigger a REJN or SIGN within the next wait-split (defined in the config file) seconds. - Module: encryption -^^^^^^^^^^^^ -die [reason] -^^^^^^^^^^^^ + Module + ``irc`` - Description: causes the bot to log a fatal error and exit completely. If no reason is given, "EXIT" is used. - Returns: none + .. admonition:: Example — SPLT trigger + :collapsible: closed + :class: tcl-example - Module: core + .. code-block:: tcl -^^^^^^ -unames -^^^^^^ + bind splt * "#lamest *" splt_proc + + proc splt_proc {nick user hand chan} { + putlog "Nick is $nick, user is $user, handle is $hand, channel is $chan" + } - Returns: the current operating system the bot is using + **Trigger and output** - Module: core + .. code-block:: text -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -dnslookup [[arg1] [arg2] ... [argN]] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Foobar is detected as split from #lamest + Nick is Foobar, user is foobar@127.0.0.1, handle is foobar, channel is #lamest - Description: This issues an asynchronous dns lookup request. The command will block if dns module is not loaded; otherwise it will either return immediately or immediately call the specified proc (e.g. if the lookup is already cached). +.. _bind-rejn: - As soon as the request completes, the specified proc will be called as follows: +(27) REJN (stackable) - [[arg1] [arg2] ... [argN]] + ``bind rejn `` - status is 1 if the lookup was successful and 0 if it wasn't. All additional parameters (called arg1, arg2 and argN above) get appended to the proc's other parameters. + ``procname `` - Returns: nothing + Description + Someone who was split has rejoined. mask can contain wildcards, and is matched against ``#channel nick!user\@host``. - Module: core -^^^^^^^^^^^^ -md5 -^^^^^^^^^^^^ + Module + ``irc`` - Returns: the 128 bit MD5 message-digest of the specified string - Module: core + .. admonition:: Example — REJN trigger + :collapsible: closed + :class: tcl-example -^^^^^^^^^^^^^^^^^ -callevent -^^^^^^^^^^^^^^^^^ + .. code-block:: tcl - Description: triggers the evnt bind manually for a certain event. You can call arbitrary events here, even ones that are not pre-defined by Eggdrop. For example: callevent rehash, or callevent myownevent123. + bind rejn * "#lamest *" rejn_proc + + proc rejn_proc {nick user hand chan} { + putlog "Nick is $nick, user is $user, handle is $hand, channel is $chan" + } - Returns: nothing + **Trigger and output** - Module: core + .. code-block:: text -^^^^^^^ -traffic -^^^^^^^ + Foobar rejoins #lamest after a split + Nick is Foobar, user is foobar@127.0.0.1, handle is foobar, channel is #lamest - Returns: a list of sublists containing information about the bot's traffic usage in bytes. Each sublist contains five elements: type, in-traffic today, in-traffic total, out-traffic today, out-traffic total (in that order). +.. _bind-filt: - Module: core +(28) FILT (stackable) -^^^^^^^ -modules -^^^^^^^ - Returns: a list of sublists containing information about the bot's currently loaded modules. Each sublist contains three elements: module, version, and dependencies. Each dependency is also a sublist containing the module name and version. + ``bind filt `` - Module: core + ``procname `` -^^^^^^^^^^^^^^^^^^^ -loadmodule -^^^^^^^^^^^^^^^^^^^ + Description + Party line and file system users have their text sent through filt before being processed. ``mask`` is a text mask that can contain wildcards and is used for matching text sent on the partyline. If the proc returns a blank string, the partyline texr is continued to be parsed as-is. Otherwise, the bot will instead use the text returned from the proc for continued parsing. - Description: attempts to load the specified module. - Returns: "Already loaded." if the module is already loaded, "" if successful, or the reason the module couldn't be loaded. + Module + ``core`` - Module: core -^^^^^^^^^^^^^^^^^^^^^ -unloadmodule -^^^^^^^^^^^^^^^^^^^^^ + .. admonition:: Example — FILT trigger + :collapsible: closed + :class: tcl-example - Description: attempts to unload the specified module. + .. code-block:: tcl - Returns: "No such module" if the module is not loaded, "" otherwise. + bind filt - "*" filt_proc + + proc filt_proc {idx text} { + putlog "Idx is $idx, text is $text" + return $text + } - Module: core + **Trigger and output** -^^^^^^^^^^^^^^^^^^^^^^^^ -loadhelp -^^^^^^^^^^^^^^^^^^^^^^^^ + .. code-block:: text - Description: attempts to load the specified help file from the help/ directory. + .who + Idx is 3, text is .who - Returns: nothing +.. _bind-need: - Module: core +(29) NEED (stackable) -^^^^^^^^^^^^^^^^^^^^^^^^^^ -unloadhelp -^^^^^^^^^^^^^^^^^^^^^^^^^^ + ``bind need `` - Description: attempts to unload the specified help file. + ``procname `` - Returns: nothing + Description + This bind is triggered on certain events, like when the bot needs operator status or the key for a channel. The types are: op, unban, invite, limit, and key; the mask is matched against ``#channel type`` and can contain wildcards. flags are ignored. - Module: core -^^^^^^^^^^ -reloadhelp -^^^^^^^^^^ + Module + ``irc`` - Description: reloads the bot's help files. - Returns: nothing + .. admonition:: Example — NEED trigger + :collapsible: closed + :class: tcl-example - Module: core + .. code-block:: tcl -^^^^^^^ -restart -^^^^^^^ + bind need - "% op" need_proc + + proc need_proc {chan type} { + putlog "Channel is $chan, type is $type" + } - Description: rehashes the bot, kills all timers, reloads all modules, and reconnects the bot to the next server in its list. + **Trigger and output** - Returns: nothing + .. code-block:: text - Module: core + LamestBot determines it needs operator status on #lamest + Channel is #lamest, type is op -^^^^^^ -rehash -^^^^^^ +.. _bind-flud: - Description: rehashes the bot +(30) FLUD (stackable) - Returns: nothing + ``bind flud `` - Module: core + ``procname `` -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -stripcodes -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Description + Any floods detected through the flood control settings (like ``flood-ctcp``) are sent here before processing. If the proc returns ``1``, no further action is taken on the flood; if the proc returns ``0``, the bot will do its normal ``punishment`` for the flood. The flood types are: pub, msg, join, or ctcp (and can be masked to ``*`` for the bind); flags are ignored. - Description: strips specified control characters from the string given. strip-flags can be any combination of the following: - - +-----+-------------------------------------------------------------+ - | c | remove all color codes | - +-----+-------------------------------------------------------------+ - | b | remove all boldface codes | - +-----+-------------------------------------------------------------+ - | r | remove all reverse video codes | - +-----+-------------------------------------------------------------+ - | u | remove all underline codes | - +-----+-------------------------------------------------------------+ - | a | remove all ANSI codes | - +-----+-------------------------------------------------------------+ - | g | remove all ctrl-g (bell) codes | - +-----+-------------------------------------------------------------+ - | o | remove all ordinary codes (ctrl+o, terminates bold/color/..)| - +-----+-------------------------------------------------------------+ - | i | remove all italics codes | - +-----+-------------------------------------------------------------+ - | \* | remove all of the above | - +-----+-------------------------------------------------------------+ - - Returns: the stripped string. - - Module: core -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -matchaddr
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Module + ``server`` - Description: checks if the address matches the hostmask given. The address should be in the form nick!user\@host. - Returns: 1 if the address matches the hostmask, 0 otherwise. + .. admonition:: Example — FLUD trigger + :collapsible: closed + :class: tcl-example - Module: core + .. code-block:: tcl -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -matchcidr
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + bind flud - pub flud_proc + + proc flud_proc {nick user hand type chan} { + putlog "Nick is $nick, user is $user, handle is $hand, type is $type, channel is $chan" + return 0 + } - Description: performs a cidr match on the specified ip addresses. IPv6 is supported, if enabled at compile time. + **Trigger and output** - Example: matchcidr 192.168.0.0 192.168.1.17 16 + .. code-block:: text - Returns: 1 if the address matches the block prefix, 0 otherwise. + Foobar triggers the configured public-message flood threshold on #lamest + Nick is Foobar, user is foobar@127.0.0.1, handle is foobar, type is pub, channel is #lamest - Module: core +.. _bind-note: -^^^^^^^^^^^^^^^^^^^^^^^^^^^ -matchstr -^^^^^^^^^^^^^^^^^^^^^^^^^^^ +(31) NOTE (stackable) - Description: checks if pattern matches string. Only two wildcards are supported: '*' and '?'. Matching is case-insensitive. This command is intended as a simplified alternative to Tcl's string match. + ``bind note `` - Returns: 1 if the pattern matches the string, 0 if it doesn't. + ``procname `` - Module: core + Description + Incoming notes (either from the party line, someone on IRC, or someone on another bot on the botnet) are checked against these binds before being processed. The mask is matched against the receiving handle and supports wildcards. If the proc returns ``1``, Eggdrop will not process the note any further. Flags are ignored. -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -rfcequal -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Description: Checks if two strings are equal. Case is ignored, and this uses RFC1459 matching {}|~ == []\^, depending on the rfc_compliant setting. + Module + ``core`` - Returns: 1 if equal, 0 if not. - Module: core + .. admonition:: Example — NOTE trigger + :collapsible: closed + :class: tcl-example -^^^^^^^^^^^^^ -status [type] -^^^^^^^^^^^^^ + .. code-block:: tcl - Description: provides eggdrop status information similar to the .status command in partyline. The available types of information are: + bind note - foobar note_proc + + proc note_proc {from to text} { + putlog "From is $from, to is $to, text is $text" + return 0 + } - +------+---------------------------------------------------------------------+ - | cpu | total cpu time spent by eggdrop | - +------+---------------------------------------------------------------------+ - | mem | dynamically allocated memory excluding the Tcl interpreter | - +------+---------------------------------------------------------------------+ - | cache| user entries cache hits (in %) | - +------+---------------------------------------------------------------------+ - | ipv6 | shows whether IPv6 support was compiled in | - +------+---------------------------------------------------------------------+ + **Trigger and output** - Returns: the requested information type or all information if type isn't specified. The format is a flat list of name-value pairs. + .. code-block:: text - Module: core + OtherUser sends the note "hello world" to foobar + From is OtherUser, to is foobar, text is hello world -^^^^^^^^^^^ -istls -^^^^^^^^^^^ +.. _bind-act: - Description: checks if a connection is encrypted or cleartext. This command is available on TLS-enabled bots only. +(32) ACT (stackable) - Returns: 1 if the idx is a TLS connection, 0 if it's plaintext. + ``bind act `` - Module: core + ``procname `` -^^^^^^^^^^^^^^ -starttls -^^^^^^^^^^^^^^ + Description + When someone does an action on the botnet, it invokes this binding. flags are ignored; the mask is matched against the text of the action and can support wildcards. - Description: establishes a secure (using TLS) connection over idx. The TLS connection should be first negotiated over the plaintext link, or using other means. Both parties must switch to TLS simultaneously. This command is available on TLS-enabled bots only. - Returns: nothing + Module + ``core`` - Module: core -^^^^^^^^^^^^^^^ -tlsstatus -^^^^^^^^^^^^^^^ + .. admonition:: Example — ACT trigger + :collapsible: closed + :class: tcl-example - Description: provides information about an established TLS connection This includes certificate and cipher information as well as protocol version. This command is available on TLS-enabled bots only. + .. code-block:: tcl - Returns: a flat list of name-value pairs + bind act - "*" act_proc + + proc act_proc {hand chan action} { + putlog "Handle is $hand, channel is $chan, action is $action" + } - Module: core + **Trigger and output** -Global Variables ----------------- + .. code-block:: text -NOTE: All config file variables are also global. + foobar performs the partyline action "waves" + Handle is foobar, channel is 0, action is waves -^^^^^^^ -botnick -^^^^^^^ +.. _bind-wall: - Value: the current nickname the bot is using (for example: "Valis", "Valis0", etc.) +(33) WALL (stackable) - Module: server + ``bind wall `` -^^^^^^^ -botname -^^^^^^^ + ``procname `` - Value: the current nick!user\@host that the server sees (for example: "Valis!valis\@crappy.com") + Description + When the bot receives a wallops, it invokes this binding. flags are ignored; the mask is matched against the text of the wallops msg. Note that RFC shows the server name as a source of the message, whereas many IRCds send the nick!user\@host of the actual sender, thus, Eggdrop will not parse it at all, but simply pass it to bind in its original form. If the proc returns ``1``, Eggdrop will not log the message that triggered this bind. - Module: server -^^^^^^ -server -^^^^^^ + Module + ``server`` - Value: the current server's real name (what server calls itself) and port bot is connected to (for example: "irc.math.ufl.edu:6667") Note that this does not necessarily match the servers internet address. - Module: server + .. admonition:: Example — WALL trigger + :collapsible: closed + :class: tcl-example -^^^^^^^^^^^^^ -serveraddress -^^^^^^^^^^^^^ - Value: the current server's internet address (hostname or IP) and port bot is connected to. This will correspond to the entry in server list (for example: "eu.undernet.org:6667"). Note that this does not necessarily match the name server calls itself. + .. code-block:: tcl - Module: server + bind wall - "*" wall_proc + + proc wall_proc {from msg} { + putlog "From is $from, message is $msg" + return 0 + } -^^^^^^^ -version -^^^^^^^ - Value: current bot version "1.1.2+pl1.10.2201"; first item is the text version, to include a patch string if present, and second item is a numerical version + **Trigger and output** - Module: core + .. code-block:: text -^^^^^^^^^^^ -numversion* -^^^^^^^^^^^ - Value: the current numeric bot version (for example: "1.10.21"). Numerical version is in the format of "MNNRRPP", where: + irc.example.net sends WALLOPS :Example maintenance notice + From is irc.example.net, message is Example maintenance notice - +------+---------------------------------------+ - | M | major release number | - +------+---------------------------------------+ - | NN | minor release number | - +------+---------------------------------------+ - | RR | sub-release number | - +------+---------------------------------------+ - | PP | patch level for that sub-release | - +------+---------------------------------------+ +.. _bind-bcst: - Module: core +(34) BCST (stackable) -^^^^^^ -uptime -^^^^^^ - Value: the unixtime value for when the bot was started + ``bind bcst `` + ``procname `` + + Description + When a bot broadcasts something on the botnet (see ``dccbroadcast`` above), it invokes this binding. flags are ignored; the mask is matched against the message text and can contain wildcards. ``channel`` argument will always be ``-1`` since broadcasts are not directed to any partyline channel. + + It is also invoked when a BOT (not a person, as with the CHAT bind) ``says`` something on a channel. In this case, the ``channel`` argument will be a valid channel, and not ``-1``. - Module: core -^^^^^^^^^^^^^ -server-online -^^^^^^^^^^^^^ - Value: the unixtime value when the bot connected to its current server, or '0' if the bot is currently disconnected from a server. + Module + ``core`` - Module: server -^^^^^^^^ -lastbind -^^^^^^^^ - Value: the last command binding which was triggered. This allows you to identify which command triggered a Tcl proc. + .. admonition:: Example — BCST trigger + :collapsible: closed + :class: tcl-example - Module: core + .. code-block:: tcl -^^^^^^^ -isjuped -^^^^^^^ - Value: 1 if bot's nick is juped(437); 0 otherwise + bind bcst - "*" bcst_proc + + proc bcst_proc {bot chan text} { + putlog "Bot is $bot, channel is $chan, text is $text" + } - Module: server + **Trigger and output** -^^^^^^^ -handlen -^^^^^^^ - Value: the value of the HANDLEN define in src/eggdrop.h + .. code-block:: text - Module: core + RemoteBot broadcasts "hello botnet" + Bot is RemoteBot, channel is -1, text is hello botnet -^^^^^^ -config -^^^^^^ - Value: the filename of the config file Eggdrop is currently using +.. _bind-chjn: - Module: core +(35) CHJN (stackable) -^^^^^^^^^^^^^ -configureargs -^^^^^^^^^^^^^ - Value: a string (not list) of configure arguments in shell expansion (single quotes) + ``bind chjn `` - Module: core + ``procname `` -^^^^^^^^ -language -^^^^^^^^ - Value: a string containing the language with the highest priority for use by Eggdrop. This commonly reflects what is added with addlang in the config file + Description + When someone joins a botnet channel, it invokes this binding. The mask is matched against the channel and can contain wildcards. flag is one of: * (owner), + (master), @ (op), or % (botnet master). Flags are ignored. - Module: core -^^^^^^^^^^^^^^ -account-extban -^^^^^^^^^^^^^^ - Value: a string containing the value of ACCOUNTEXTBAN provided by the 005 connection message. This is the raw value and, depending on the IRC server formatting, could be in multiple formats such as "a", or "a,account". + Module + ``core`` - Module: channel -extban-flags -^^^^^^^^^^^^ - Value: a string containing the allowed extban flag characters advertised by EXTBAN in the 005 connection message. If EXTBAN advertises a prefix, such as "$,aUq", the prefix is omitted and this variable contains only the flags, such as "aUq". + .. admonition:: Example — CHJN trigger + :collapsible: closed + :class: tcl-example - Module: channel + .. code-block:: tcl + bind chjn - "*" chjn_proc + + proc chjn_proc {bot hand chan flag idx user} { + putlog "Bot is $bot, handle is $hand, channel is $chan, flag is $flag, idx is $idx, user is $user" + } -Binds ------ + **Trigger and output** -You can use the 'bind' command to attach Tcl procedures to certain events. For example, you can write a Tcl procedure that gets called every time a user says "danger" on the channel. When a bind is triggered, ALL of the Tcl procs that are bound to it will be called. Raw binds are triggered before builtin binds, as a builtin bind has the potential to modify args. + .. code-block:: text -^^^^^^^^^^^^^^^ -Stackable binds -^^^^^^^^^^^^^^^ -Some bind types are marked as "stackable". That means that you can bind multiple commands to the same trigger. Normally, for example, a bind such as 'bind msg - stop msg:stop' (which makes a msg-command "stop" call the Tcl proc "msg:stop") will overwrite any previous binding you had for the msg command "stop". With stackable bindings, like 'msgm' for example, you can bind the same command to multiple procs. + foobar joins botnet channel 0 on LamestBot + Bot is LamestBot, handle is foobar, channel is 0, flag is @, idx is 3, user is foobar@127.0.0.1 -^^^^^^^^^^^^^^^ -Removing a bind -^^^^^^^^^^^^^^^ -To remove a bind, use the 'unbind' command. For example, to remove the -bind for the "stop" msg command, use 'unbind msg - stop msg:stop'. +.. _bind-chpt: -.. _tcl_binds: +(36) CHPT (stackable) -^^^^^^^^^^ -Flag Masks -^^^^^^^^^^ -In the `Bind Types`_ section (and other commands, such as `matchattr`_), you will see several references to the "flags" argument. The "flags" argument takes a flag mask, which is a value that represents the type of user that is allowed to trigger the procedure associated to that bind. The flags can be any of the standard Eggdrop flags (o, m, v, etc). Additionally, when used by itself, a "-" or "*" can be used to skip processing for a flag type. A flag mask has three sections to it- global, channel, and bot flag sections. Each section is separated by the | or & logical operators ( the | means "OR" and the & means "AND; if nothing proceeds the flag then Eggdrop assumes it to be an OR). Additionally, a '+' and '-' can be used in front of a flag to check if the user does (+) have it, or does not (-) have it. + ``bind chpt `` -The easiest way to explain how to build a flag mask is by demonstration. A flag mask of "v" by itself means "has a global v flag". To also check for a channel flag, you would use the flag mask "v\|v". This checks if the user has a global "v" flag, OR a channel "v" flag (again, the | means "OR" and ties the two types of flags together). You could change this mask to be "v&v", which would check if the user has a global "v" flag AND a channel "v" flag. Lastly, to check if a user ONLY has a channel flag, you would use "\*|v" as a mask, which would not check global flags but does check if the user had a channel "v" flag. + ``procname `` -You will commonly see flag masks for global flags written "ov"; this is the same as "\|ov" or "\*\|ov". + Description + When someone parts a botnet channel, it invokes this binding. The mask is matched against the channel and can contain wildcards. Flags are ignored. -Some additional examples: -+------------+-----------------------------------------------------------------+ -| Flag Mask | Action | -+============+=================================================================+ -| m, +m, m|* | Checks if the user has the m global flag | -+------------+-----------------------------------------------------------------+ -| +mn | Checks if the user has the m OR n global flag | -+------------+-----------------------------------------------------------------+ -| \|+mn | Checks if the user has the m OR n channel flag | -+------------+-----------------------------------------------------------------+ -| \|+mn #foo | Checks if the user has the m OR n channel flag for #foo | -+------------+-----------------------------------------------------------------+ -| &+mn | Checks if the user has the m AND n channel flag | -+------------+-----------------------------------------------------------------+ -| &mn #foo | Checks if the user has the m AND n channel flag for #foo | -+------------+-----------------------------------------------------------------+ -| \|+o #foo | Checks if the user has the o channel flag for #foo | -+------------+-----------------------------------------------------------------+ -| +o|+n #foo | Checks if the user has the o global flag OR the n channel flag | -| | for #foo | -+------------+-----------------------------------------------------------------+ -| +m&+v #foo | Checks if the user has the m global flag AND the v channel flag | -| | for #foo | -+------------+-----------------------------------------------------------------+ -| -m | Checks if the user does not have the m global flag | -+------------+-----------------------------------------------------------------+ -| \|-n #foo | Checks if the user does not have the n channel flag for #foo | -+------------+-----------------------------------------------------------------+ -| +m|-n #foo | Checks if the user has the global m flag OR does not have a | -| | channel n flag for #foo | -+------------+-----------------------------------------------------------------+ -| -n&-m #foo | Checks if the user does not have the global n flag AND does | -| | not have the channel m flag for #foo | -+------------+-----------------------------------------------------------------+ -| ||+b | Checks if the user has the bot flag b | -+------------+-----------------------------------------------------------------+ + Module + ``core`` -As a side note, Tcl scripts historically have used a '-' to skip processing of a flag type (Example: -\|o). It is unknown where and why this practice started, but as a style tip, Eggdrop developers recommend using a '\*' to skip processing, so as not to confuse a single "-" meaning "skip processing" with a preceding "-ov" which means "not these flags". -.. _bind_types: + .. admonition:: Example — CHPT trigger + :collapsible: closed + :class: tcl-example -^^^^^^^^^^ -Bind Types -^^^^^^^^^^ + .. code-block:: tcl -The following is a list of bind types and how they work. Below each bind type is the format of the bind command, the list of arguments sent to the Tcl proc, and an explanation. + bind chpt - "*" chpt_proc + + proc chpt_proc {bot hand idx chan} { + putlog "Bot is $bot, handle is $hand, idx is $idx, channel is $chan" + } -(1) MSG + **Trigger and output** - bind msg + .. code-block:: text - procname + foobar leaves botnet channel 0 on LamestBot + Bot is LamestBot, handle is foobar, idx is 3, channel is 0 - Description: used for /msg commands. The first word of the user's msg is the command, and everything else becomes the text argument. +.. _bind-time: - Module: server +(37) TIME (stackable) -(2) DCC + ``bind time `` - bind dcc + ``procname `` - procname + Description + Allows you to schedule procedure calls at certain times. mask matches 5 space separated integers of the form: "minute hour day month year". The month var starts at 00 (Jan) and ends at 11 (Dec). Minute, hour, day, month have a zero padding so they are exactly two characters long; year is four characters. Flags are ignored. - Description: used for partyline commands; the command is the first word and everything else becomes the text argument. The idx is valid until the user disconnects. After that, it may be reused, so be careful about storing an idx for long periods of time. - Module: core + Module + ``core`` -(3) FIL - bind fil + .. admonition:: Example — TIME trigger + :collapsible: closed + :class: tcl-example - procname + .. code-block:: tcl - Description: the same as DCC, except this is triggered if the user is in the file area instead of the party line + bind time - "* * * * *" time_proc + + proc time_proc {minute hour day month year} { + putlog "Minute is $minute, hour is $hour, day is $day, month is $month, year is $year" + } - Module: filesys + **Trigger and output** -(4) PUB + .. code-block:: text - bind pub + The clock reaches 12:34 on September 13, 2026 + Minute is 34, hour is 12, day is 13, month is 08, year is 2026 - procname +.. _bind-away: - Description: used for commands given on a channel. The first word becomes the command and everything else is the text argument. +(38) AWAY (stackable) - Module: irc + ``bind away `` -(5) MSGM (stackable) + ``procname `` - bind msgm + Description + Triggers when a user goes away or comes back on the botnet. text is the reason that has been specified (text is ``""`` when returning). mask is matched against the botnet-nick of the bot the user is connected to and supports wildcards. flags are ignored. - procname - Description: matches the entire line of text from a /msg with the mask. This is useful for binding Tcl procs to words or phrases spoken anywhere within a line of text. If the proc returns 1, Eggdrop will not log the message that triggered this bind. MSGM binds are processed before MSG binds. If the exclusive-binds setting is enabled, MSG binds will not be triggered by text that a MSGM bind has already handled. + Module + ``core`` - Module: server -(6) PUBM (stackable) + .. admonition:: Example — AWAY trigger + :collapsible: closed + :class: tcl-example - bind pubm + .. code-block:: tcl - procname + bind away - "*" away_proc + + proc away_proc {bot idx text} { + putlog "Bot is $bot, idx is $idx, text is $text" + } - Description: just like MSGM, except it's triggered by things said on a channel instead of things /msg'd to the bot. The mask is matched against the channel name followed by the text and can contain wildcards. If the proc returns 1, Eggdrop will not log the message that triggered this bind. PUBM binds are processed before PUB binds. If the exclusive-binds setting is enabled, PUB binds will not be triggered by text that a PUBM bind has already handled. + **Trigger and output** - Examples: - bind pubm * "#eggdrop Hello*" myProc - Listens on #eggdrop for any line that begins with "Hello" - bind pubm * "% Hello*" myProc - Listens on any channel for any line that begins with "Hello" - bind pubm * "% !command" myProc - Listens on any channel for a line that ONLY contains "!command" - - Module: irc + .. code-block:: text -(7) NOTC (stackable) + foobar sets the partyline away message to "Lunch" + Bot is LamestBot, idx is 3, text is Lunch - bind notc +.. _bind-load: - procname +(39) LOAD (stackable) - Description: dest will be a nickname (the bot's nickname, obviously) or a channel name. mask is matched against the entire text of the notice and can contain wildcards. It is considered a breach of protocol to respond to a /notice on IRC, so this is intended for internal use (logging, etc.) only. Note that server notices do not trigger the NOTC bind. If the proc returns 1, Eggdrop will not log the message that triggered this bind. + ``bind load `` - New Tcl procs should be declared as:: + ``procname `` - proc notcproc {nick uhost hand text {dest ""}} { - global botnick; if {$dest == ""} {set dest $botnick} - ... - } + Description + Triggers when a module is loaded. mask is matched against the name of the loaded module and supports wildcards; flags are ignored. - for compatibility. - Module: server + Module + ``core`` -(8) JOIN (stackable) - bind join + .. admonition:: Example — LOAD trigger + :collapsible: closed + :class: tcl-example - procname + .. code-block:: tcl - Description: triggered by someone joining the channel. The mask in the bind is matched against "#channel nick!user\@host" and can contain wildcards. + bind load - "*" load_proc + + proc load_proc {module} { + putlog "Module is $module" + } - Module: irc + **Trigger and output** -(9) PART (stackable) + .. code-block:: text - bind part + The irc module is loaded + Module is irc - procname +.. _bind-unld: - Description: triggered by someone leaving the channel. The mask is matched against "#channel nick!user\@host" and can contain wildcards. If no part message is specified, msg will be set to "". +(40) UNLD (stackable) - New Tcl procs should be declared as:: + ``bind unld `` - proc partproc {nick uhost hand chan {msg ""}} { ... } + ``procname `` - for compatibility. + Description + Triggers when a module is unloaded. mask is matched against the name of the unloaded module and supports wildcards;. + flags are ignored. - Module: irc -(10) SIGN (stackable) + Module + ``core`` - bind sign - - procname - Description: triggered by a signoff, or possibly by someone who got netsplit and never returned. The signoff message is the last argument to the proc. Wildcards can be used in the mask, which is matched against '#channel nick!user\@host'. If a "*" is used for the channel in the mask, this bind is triggered once for every channel that the user is in the bot with; in other words if the bot is in two channels with the target user, the bind will be triggered twice. To trigger a proc only once per signoff, regardless of the number of channels the Eggdrop and user share, use the RAWT bind with SIGN as the keyword. + .. admonition:: Example — UNLD trigger + :collapsible: closed + :class: tcl-example - Module: irc + .. code-block:: tcl -(11) TOPC (stackable) + bind unld - "*" unld_proc + + proc unld_proc {module} { + putlog "Module is $module" + } - bind topc - - procname + **Trigger and output** - Description: triggered by a topic change. mask can contain wildcards and is matched against '#channel '. + .. code-block:: text - Module: irc + The irc module is unloaded + Module is irc -(12) KICK (stackable) +.. _bind-nkch: - bind kick - - procname +(41) NKCH (stackable) - Description: triggered when someone is kicked off the channel. The mask is matched against '#channel target reason' where the target is the nickname of the person who got kicked (can contain wildcards). The proc is called with the nick, user\@host, and handle of the kicker, plus the channel, the nickname of the person who was kicked, and the reason. + ``bind nkch `` + ``procname `` - Module: irc + Description + Triggered whenever a local user's handle is changed (in the userfile). mask is matched against the user's old handle and can contain wildcards; flags are ignored. -(13) NICK (stackable) - bind nick - - procname + Module + ``core`` - Description: triggered when someone changes nicknames. The mask is matched against '#channel newnick' and can contain wildcards. Channel is "*" if the user isn't on a channel (usually the bot not yet in a channel). If a "*" is used for the channel in the mask, this bind is triggered once for every channel that the user is in the bot with; in other words if the bot is in two channels with the target user, the bind will be triggered twice. To trigger a proc only once per nick change, regardless of the number of channels the Eggdrop and user share, use the RAWT bind with NICK as the keyword. - Module: irc + .. admonition:: Example — NKCH trigger + :collapsible: closed + :class: tcl-example -(14) MODE (stackable) + .. code-block:: tcl - bind mode + bind nkch - "*" nkch_proc + + proc nkch_proc {oldhand newhand} { + putlog "Old handle is $oldhand, new handle is $newhand" + } - procname + **Trigger and output** - Description: mode changes are broken down into their component parts before being sent here, so the will always be a single mode, such as "+m" or "-o". target will show the argument of the mode change (for o/v/b/e/I) or "" if the set mode does not take an argument. The bot's automatic response to a mode change will happen AFTER all matching Tcl procs are called. The mask will be matched against '#channel +/-modes' and can contain wildcards. + .. code-block:: text - If it is a server mode, nick will be "", user\@host is the server name, and handle is \*. - - Note that "target" was added in 1.3.17 and that this will break Tcl scripts that were written for pre-1.3.17 Eggdrop that use the mode binding. Also, due to a typo, mode binds were broken completely in 1.3.17 but were fixed in 1.3.18. Mode bindings are not triggered at all in 1.3.17. + The local handle foobar is changed to foobar2 + Old handle is foobar, new handle is foobar2 - One easy example (from guppy) of how to support the "target" parameter in 1.3.18 and later and still remain compatible with older Eggdrop versions is: +.. _bind-evnt: - Old script looks as follows:: +(42) EVNT (stackable) - bind mode - * mode_proc - proc mode_proc {nick uhost hand chan mode} { ... } + ``bind evnt `` - To make it work with 1.3.18+ and stay compatible with older bots, do:: + ``procname [arg]`` - bind mode - * mode_proc_fix - proc mode_proc_fix {nick uhost hand chan mode {target ""}} { - if {$target != ""} {append mode " $target"} - mode_proc $nick $uhost $hand $chan $mode - } - proc mode_proc {nick uhost hand chan mode} { ... } + Description + Triggered whenever one of these events happen. flags are ignored. Pre-defined events triggered by Eggdrop are:: - Module: irc + sighup - called on a kill -HUP + sigterm - called on a kill -TERM + sigill - called on a kill -ILL + sigquit - called on a kill -QUIT + save - called when the userfile is saved + rehash - called just after a rehash + prerehash - called just before a rehash + prerestart - called just before a restart + logfile - called when the logs are switched daily + loaded - called when the bot is done loading + userfile-loaded - called after userfile has been loaded + connect-server - called just before we connect to an IRC server + preinit-server - called immediately when we connect to the server + init-server - called when we actually get on our IRC server + disconnect-server - called when we disconnect from our IRC server + fail-server - called when an IRC server fails to respond + hidden-host - called after the bot's host is hidden by the server + got-chanlist - called after Eggdrop receives the channel userlist from the server. Passes a second [arg] value to the Tcl proc -(15) CTCP (stackable) + Note that Tcl scripts can trigger arbitrary events, including ones that are not pre-defined or used by Eggdrop. - bind ctcp - procname + Module + ``core`` - Description: dest will be a nickname (the bot's nickname, obviously) or channel name. keyword is the ctcp command (which can contain wildcards), and text may be empty. If the proc returns 0, the bot will attempt its own processing of the ctcp command. - Module: server + .. admonition:: Example — EVNT trigger + :collapsible: closed + :class: tcl-example -(16) CTCR (stackable) + .. code-block:: tcl - bind ctcr + bind evnt - rehash evnt_proc + + proc evnt_proc {type {arg ""}} { + putlog "Type is $type, arg is $arg" + } - procname + **Trigger and output** - Description: just like ctcp, but this is triggered for a ctcp-reply (ctcp embedded in a notice instead of a privmsg) + .. code-block:: text - Module: server + A rehash event occurs + Type is rehash, arg is -(17) RAW (stackable) +.. _bind-lost: - bind raw +(43) LOST (stackable) - procname + ``bind lost `` - IMPORTANT: While not necessarily deprecated, this bind has been supplanted by the RAWT bind, which supports the IRCv3 message-tags capability, as of 1.9.0. You probably want to be using RAWT, not RAW. + ``procname `` - Description: The mask can contain wildcards and is matched against the keyword, which is either a numeric, like "368", or a keyword, such as "PRIVMSG". "from" will be the server name or the source nick!ident@host (depending on the keyword); flags are ignored. If the proc returns 1, Eggdrop will not process the line any further (this could cause unexpected behavior in some cases), although RAWT binds are processed before RAW binds (and thus, a RAW bind cannot block a RAWT bind). + Description + Triggered when a DCC SEND transfer gets lost, such as when the connection is terminated before all data was successfully sent/received. This is typically caused by a user abort. - Module: server -(18) BOT + Module + ``transfer`` - bind bot - procname + .. admonition:: Example — LOST trigger + :collapsible: closed + :class: tcl-example - Description: triggered by a message coming from another bot in the botnet. The first word is the command and the rest becomes the text argument; flags are ignored. + .. code-block:: tcl - Module: core + bind lost - "*" lost_proc + + proc lost_proc {hand nick path bytes length} { + putlog "Handle is $hand, nick is $nick, path is $path, bytes transferred is $bytes, file length is $length" + } -(19) CHON (stackable) + **Trigger and output** - bind chon + .. code-block:: text - procname + Foobar aborts example.txt after 1024 of 4096 bytes + Handle is foobar, nick is Foobar, path is example.txt, bytes transferred is 1024, file length is 4096 - Description: when someone first enters the party-line area of the bot via dcc chat or telnet, this is triggered before they are connected to a chat channel (so, yes, you can change the channel in a 'chon' proc). mask is matched against the handle and supports wildcards. This is NOT triggered when someone returns from the file area, etc. +.. _bind-tout: - Module: core +(44) TOUT (stackable) -(20) CHOF (stackable) + ``bind tout `` - bind chof + ``procname `` - procname + Description + Triggered when a DCC SEND transfer times out. This may either happen because the DCC connection was not accepted or because the data transfer stalled for some reason. - Description: triggered when someone leaves the party line to disconnect from the bot. mask is matched against the handle and can contain wildcards. Note that the connection may have already been dropped by the user, so don't send output to the idx. - Module: core + Module + ``transfer`` -(21) SENT (stackable) - bind sent + .. admonition:: Example — TOUT trigger + :collapsible: closed + :class: tcl-example - procname + .. code-block:: tcl - Description: after a user has successfully downloaded a file from the bot, this binding is triggered. mask is matched against the handle of the user that initiated the transfer and supports wildcards. nick is the actual recipient (on IRC) of the file. The path is relative to the dcc directory (unless the file transfer was started by a script call to 'dccsend', in which case the path is the exact path given in the call to 'dccsend'). + bind tout - "*" tout_proc - Module: transfer + proc tout_proc {hand nick path bytes length} { + putlog "Handle is $hand, nick is $nick, path is $path, bytes transferred is $bytes, file length is $length" + } -(22) RCVD (stackable) + **Trigger and output** - bind rcvd + .. code-block:: text - procname + A DCC SEND of example.txt to Foobar times out after 1024 of 4096 bytes + Handle is foobar, nick is Foobar, path is example.txt, bytes transferred is 1024, file length is 4096 - Description: triggered after a user uploads a file successfully. mask is matched against the user's handle. nick is the IRC nickname that the file transfer originated from. The path is where the file ended up, relative to the dcc directory (usually this is your incoming dir). +.. _bind-out: - Module: transfer +(45) OUT (stackable) -(23) CHAT (stackable) + ``bind out `` - bind chat + ``procname `` - procname + Description + Triggered whenever output is sent to the server. Normally the event will occur twice for each line sent: once before entering a server queue and once after the message is actually sent. This allows for more flexible logging of server output and introduces the ability to cancel the message. Mask is matched against "queue status", where status is either ``queued`` or ``sent``. Queues are: mode, server, help, noqueue. noqueue is only used by the putnow Tcl command. - Description: when a user says something on the botnet, it invokes this binding. Flags are ignored; handle could be a user on this bot ("DronePup") or on another bot ("Eden\@Wilde") and therefore you can't rely on a local user record. The mask is checked against the entire line of text and supports wildcards. Eggdrop passes the partyline channel number the user spoke on to the proc in "channel#". - NOTE: If a BOT says something on the botnet, the BCST bind is invoked instead. + Module + ``server`` - Module: core -(24) LINK (stackable) + .. admonition:: Example — OUT trigger + :collapsible: closed + :class: tcl-example - bind link + .. code-block:: tcl - procname + bind out - "server *" out_proc - Description: triggered when a bot links into the botnet. botname is the botnetnick of the bot that just linked in; via is the bot it linked through. The mask is checked against the botnetnick of the bot that linked and supports wildcards. flags are ignored. + proc out_proc {queue message status} { + putlog "Queue is $queue, message is $message, status is $status" + } - Module: core + **Trigger and output** -(25) DISC (stackable) + .. code-block:: text - bind disc + putserv "PRIVMSG #lamest :Hello, Foobar!" + Queue is server, message is PRIVMSG #lamest :Hello, Foobar!, status is queued + Queue is server, message is PRIVMSG #lamest :Hello, Foobar!, status is sent - procname +.. _bind-cron: - Description: triggered when a bot disconnects from the botnet for whatever reason. Just like the link bind, flags are ignored; mask is matched against the botnetnick of the bot that unlinked. Wildcards are supported in mask. +(46) CRON (stackable) - Module: core + ``bind cron `` -(26) SPLT (stackable) + ``procname `` - bind splt + Description + Similar to bind TIME, but the mask is evaluated as a cron expression, e.g. ``16/2 */2 5-15 7,8,9 4``. It can contain up to five fields: minute, hour, day, month, weekday; delimited by whitespace. Week days are represented as 0-6, where Sunday can be either 0 or 7. Symbolic names are not supported. The bind will be triggered if the mask matches all of the fields, except that if both day and weekday are not ``*``, only one of them is required to match. If any number of fields are omitted at the end, the match will proceed as if they were ``*``. All cron operators are supported. Please refer to the crontab manual for their meanings. Flags are ignored. - procname - Description: triggered when someone gets netsplit on the channel. Be aware that this may be a false alarm (it's easy to fake a netsplit signoff message on some networks); mask may contain wildcards and is matched against '#channel nick!user\@host'. Anyone who is SPLT will trigger a REJN or SIGN within the next wait-split (defined in the config file) seconds. + Module + ``core`` - Module: irc -(27) REJN (stackable) + .. admonition:: Example — CRON trigger + :collapsible: closed + :class: tcl-example - bind rejn + .. code-block:: tcl - procname + bind cron - "0 12 * * *" cron_proc - Description: someone who was split has rejoined. mask can contain wildcards, and is matched against '#channel nick!user\@host'. + proc cron_proc {minute hour day month weekday} { + putlog "Minute is $minute, hour is $hour, day is $day, month is $month, weekday is $weekday" + } - Module: irc + **Trigger and output** -(28) FILT (stackable) + .. code-block:: text - bind filt + The clock reaches 12:00 on September 13, 2026 + Minute is 0, hour is 12, day is 13, month is 9, weekday is 0 - procname +.. _bind-log: - Description: party line and file system users have their text sent through filt before being processed. 'mask' is a text mask that can contain wildcards and is used for matching text sent on the partyline. If the proc returns a blank string, the partyline texr is continued to be parsed as-is. Otherwise, the bot will instead use the text returned from the proc for continued parsing. +(47) LOG (stackable) - Module: core + ``bind log `` -(29) NEED (stackable) + ``procname `` - bind need + Description + Triggered whenever a message is sent to a log. The mask is matched against "channel text". The level argument to the proc will contain the level(s) the message is sent to, or ``*`` if the message is sent to all log levels at once. If the message wasn't sent to a specific channel, channel will be set to ``*``. - procname - Description: this bind is triggered on certain events, like when the bot needs operator status or the key for a channel. The types are: op, unban, invite, limit, and key; the mask is matched against '#channel type' and can contain wildcards. flags are ignored. + Module + ``core`` - Example:: - bind need - "% op" needop < handles only need op - bind need - "*" needall < handles all needs + .. admonition:: Example — LOG trigger + :collapsible: closed + :class: tcl-example - Module: irc + .. code-block:: tcl -(30) FLUD (stackable) + bind log - "#lamest *" log_proc - bind flud + proc log_proc {level channel message} { + putlog "Level is $level, channel is $channel, message is $message" + } - procname + **Trigger and output** - Description: any floods detected through the flood control settings (like 'flood-ctcp') are sent here before processing. If the proc returns 1, no further action is taken on the flood; if the proc returns 0, the bot will do its normal "punishment" for the flood. The flood types are: pub, msg, join, or ctcp (and can be masked to "*" for the bind); flags are ignored. + .. code-block:: text - Module: server + A public message from Foobar is logged for #lamest + Level is p, channel is #lamest, message is Hello! -(31) NOTE (stackable) +.. _bind-tls: - bind note +(48) TLS (stackable) - procname + ``bind tls `` - Description: incoming notes (either from the party line, someone on IRC, or someone on another bot on the botnet) are checked against these binds before being processed. The mask is matched against the receiving handle and supports wildcards. If the proc returns 1, Eggdrop will not process the note any further. Flags are ignored. + ``procname `` - Module: core + Description + Triggered for TCP connections when an SSL/TLS handshake has completed and the connection is secured. The mask is matched against the idx of the connection. -(32) ACT (stackable) - bind act + Module + ``core`` - procname - Description: when someone does an action on the botnet, it invokes this binding. flags are ignored; the mask is matched against the text of the action and can support wildcards. + .. admonition:: Example — TLS trigger + :collapsible: closed + :class: tcl-example - Module: core + .. code-block:: tcl -(33) WALL (stackable) + bind tls - "*" tls_proc - bind wall + proc tls_proc {idx} { + putlog "Idx is $idx" + } - procname + **Trigger and output** - Description: when the bot receives a wallops, it invokes this binding. flags are ignored; the mask is matched against the text of the wallops msg. Note that RFC shows the server name as a source of the message, whereas many IRCds send the nick!user\@host of the actual sender, thus, Eggdrop will not parse it at all, but simply pass it to bind in its original form. If the proc returns 1, Eggdrop will not log the message that triggered this bind. + .. code-block:: text - Module: server + TLS negotiation completes for connection idx 3 + Idx is 3 -(34) BCST (stackable) +.. _bind-die: - bind bcst +(49) DIE (stackable) - procname - - Description: when a bot broadcasts something on the botnet (see 'dccbroadcast' above), it invokes this binding. flags are ignored; the mask is matched against the message text and can contain wildcards. 'channel' argument will always be '-1' since broadcasts are not directed to any partyline channel. - - It is also invoked when a BOT (not a person, as with the CHAT bind) 'says' something on a channel. In this case, the 'channel' argument will be a valid channel, and not '-1'. + ``bind die `` - Module: core + ``procname `` -(35) CHJN (stackable) + Description + Triggered when Eggdrop is about to die. The mask is matched against the shutdown reason. The bind won't be triggered if the bot crashes or is being terminated by SIGKILL. - bind chjn - procname + Module + ``core`` - Description: when someone joins a botnet channel, it invokes this binding. The mask is matched against the channel and can contain wildcards. flag is one of: * (owner), + (master), @ (op), or % (botnet master). Flags are ignored. - Module: core + .. admonition:: Example — DIE trigger + :collapsible: closed + :class: tcl-example -(36) CHPT (stackable) + .. code-block:: tcl - bind chpt + bind die - "*" die_proc - procname + proc die_proc {reason} { + putlog "Shutdown reason is $reason" + } - Description: when someone parts a botnet channel, it invokes this binding. The mask is matched against the channel and can contain wildcards. Flags are ignored. + **Trigger and output** - Module: core + .. code-block:: text -(37) TIME (stackable) + Eggdrop shuts down with the reason "Maintenance" + Shutdown reason is Maintenance - bind time +.. _bind-ircaway: - procname +(50) IRCAWAY (stackable) - Description: allows you to schedule procedure calls at certain times. mask matches 5 space separated integers of the form: "minute hour day month year". The month var starts at 00 (Jan) and ends at 11 (Dec). Minute, hour, day, month have a zero padding so they are exactly two characters long; year is four characters. Flags are ignored. + ``bind ircaway `` - Module: core + ``procname `` -(38) AWAY (stackable) + Description + Triggered when Eggdrop receives an AWAY message for a user from an IRC server, ONLY if the away-notify capability is enabled via CAP (the server must support this capability; see the ``cap`` Tcl command for more information on requesting capabilities). "Normal" away messages (301 messages) will not trigger this bind; for those you should instead use a RAWT bind. The mask for the bind is in the format ``#channel nick!user@hostname`` (* to catch all nicknames). nick is the nickname of the user that triggered the bind, user is the nick!user@host of the user, handle is the handle of the user on the bot (- if the user is not added to the bot), channel is the channel the user was found on, and msg is the contents of the away message, if any. If a ``*`` is used for the channel in the mask, this bind is triggered once for every channel that the user is in with the bot. To trigger a proc only once per away change, regardless of the number of channels the Eggdrop and user share, use the RAWT bind with AWAY as the keyword. - bind away - procname + Module + ``irc`` - Description: triggers when a user goes away or comes back on the botnet. text is the reason that has been specified (text is "" when returning). mask is matched against the botnet-nick of the bot the user is connected to and supports wildcards. flags are ignored. - Module: core + .. admonition:: Example — IRCAWAY trigger + :collapsible: closed + :class: tcl-example -(39) LOAD (stackable) + .. code-block:: tcl - bind load + bind ircaway - "#lamest *" ircaway_proc - procname + proc ircaway_proc {nick user hand channel msg} { + putlog "Nick is $nick, user is $user, handle is $hand, channel is $channel, message is $msg" + } - Description: triggers when a module is loaded. mask is matched against the name of the loaded module and supports wildcards; flags are ignored. + **Trigger and output** - Module: core + .. code-block:: text -(40) UNLD (stackable) + Foobar sets an away message of "Lunch" while on #lamest + Nick is Foobar, user is foobar@127.0.0.1, handle is foobar, channel is #lamest, message is Lunch - bind unld +.. _bind-invt: - procname +(51) INVT (stackable) - Description: triggers when a module is unloaded. mask is matched against the name of the unloaded module and supports wildcards; - flags are ignored. + ``bind invt `` - Module: core + ``procname `` -(41) NKCH (stackable) + Description + Triggered when Eggdrop receives an INVITE message. The mask for the bind is in the format ``#channel nickname``, where nickname (not a hostmask) is that of the invitee. For the proc, nick is the nickname of the person sending the invite request, user@host is the user@host of the person sending the invite, channel is the channel the invitee is being invited to, and invitee is the target (nickname only) of the invite. The invitee argument was added to support the IRCv3 invite-notify capability, where Eggdrop may be able to see invite messages for other people that are not the Eggdrop. - bind nkch - procname + Module + ``irc`` - Description: triggered whenever a local user's handle is changed (in the userfile). mask is matched against the user's old handle and can contain wildcards; flags are ignored. - Module: core + .. admonition:: Example — INVT trigger + :collapsible: closed + :class: tcl-example -(42) EVNT (stackable) + .. code-block:: tcl - bind evnt + bind invt - "#lamest *" invt_proc - procname [arg] + proc invt_proc {nick userhost channel invitee} { + putlog "Nick is $nick, user@host is $userhost, channel is $channel, invitee is $invitee" + } - Description: triggered whenever one of these events happen. flags are ignored. Pre-defined events triggered by Eggdrop are:: + **Trigger and output** - sighup - called on a kill -HUP - sigterm - called on a kill -TERM - sigill - called on a kill -ILL - sigquit - called on a kill -QUIT - save - called when the userfile is saved - rehash - called just after a rehash - prerehash - called just before a rehash - prerestart - called just before a restart - logfile - called when the logs are switched daily - loaded - called when the bot is done loading - userfile-loaded - called after userfile has been loaded - connect-server - called just before we connect to an IRC server - preinit-server - called immediately when we connect to the server - init-server - called when we actually get on our IRC server - disconnect-server - called when we disconnect from our IRC server - fail-server - called when an IRC server fails to respond - hidden-host - called after the bot's host is hidden by the server - got-chanlist - called after Eggdrop receives the channel userlist from the server. Passes a second [arg] value to the Tcl proc + .. code-block:: text - Note that Tcl scripts can trigger arbitrary events, including ones that are not pre-defined or used by Eggdrop. + Foobar invites LamestBot to #lamest + Nick is Foobar, user@host is foobar@127.0.0.1, channel is #lamest, invitee is LamestBot - Module: core +.. _bind-rawt: -(43) LOST (stackable) +(52) RAWT (stackable) - bind lost + ``bind rawt `` - procname + ``procname `` - Description: triggered when a DCC SEND transfer gets lost, such as when the connection is terminated before all data was successfully sent/received. This is typically caused by a user abort. + Description + Similar to the RAW bind, but allows an extra field for the IRCv3 message-tags capability. The mask can contain wildcards and is matched against the keyword which is either a numeric, like ``368``, or a keyword, such as ``PRIVMSG`` or ``TAGMSG``. from will be the server name or the source nick!ident@host (depending on the keyword); flags are ignored. tags is a dictionary (flat key/value list) of the message tags with ``""`` for empty values (e.g. "account eggdrop realname LamestBot"). If the proc returns ``1``, Eggdrop will not process the line any further, including processing by a RAW bind (this could cause unexpected behavior in some cases). As of 1.9.0, it is recommended to use the RAWT bind instead of the RAW bind. - Module: transfer -(44) TOUT (stackable) + Module + ``server`` - bind tout - procname + .. admonition:: Example — RAWT trigger + :collapsible: closed + :class: tcl-example - Description: triggered when a DCC SEND transfer times out. This may either happen because the dcc connection was not accepted or because the data transfer stalled for some reason. + .. code-block:: tcl - Module: transfer + bind rawt - "PRIVMSG" rawt_proc -(45) OUT (stackable) + proc rawt_proc {from keyword text tags} { + putlog "From is $from, keyword is $keyword, text is $text, tags are $tags" + } - bind out + **Trigger and output** - procname + .. code-block:: text - Description: triggered whenever output is sent to the server. Normally the event will occur twice for each line sent: once before entering a server queue and once after the message is actually sent. This allows for more flexible logging of server output and introduces the ability to cancel the message. Mask is matched against "queue status", where status is either 'queued' or 'sent'. Queues are: mode, server, help, noqueue. noqueue is only used by the putnow tcl command. + @account=foobar :foobar@127.0.0.1 PRIVMSG #lamest :Hello! + From is foobar@127.0.0.1, keyword is PRIVMSG, text is #lamest :Hello!, tags are account foobar - Module: server +.. _bind-account: -(46) CRON (stackable) +(53) ACCOUNT (stackable) - bind cron + ``bind account `` - procname + ``procname `` - Description: similar to bind TIME, but the mask is evaluated as a cron expression, e.g. "16/2 \*/2 5-15 7,8,9 4". It can contain up to five fields: minute, hour, day, month, weekday; delimited by whitespace. Week days are represented as 0-6, where Sunday can be either 0 or 7. Symbolic names are not supported. The bind will be triggered if the mask matches all of the fields, except that if both day and weekday are not '\*', only one of them is required to match. If any number of fields are omitted at the end, the match will proceed as if they were '\*'. All cron operators are supported. Please refer to the crontab manual for their meanings. Flags are ignored. + Description + This bind will trigger when Eggdrop detects a change in the authentication status of a user's services account. The mask for the bind is in the format ``#channel nick!user@hostname.com account`` and accepts wildcards. account is either the account name the user is logging in to or ``*`` if the user is not logged in to an account. - Module: core + NOTE: The three required IRC components for account tracking are the WHOX feature, the extended-join IRCv3 capability, and the account-notify IRCv3 capability. If only some of the three features are available, Eggdrop provides best-effort account tracking but this bind could be triggered late or never on account changes. Please see ``doc/ACCOUNTS`` for additional information. -(47) LOG (stackable) - bind log + Module + ``irc`` - procname - Description: triggered whenever a message is sent to a log. The mask is matched against "channel text". The level argument to the proc will contain the level(s) the message is sent to, or '\*' if the message is sent to all log levels at once. If the message wasn't sent to a specific channel, channel will be set to '\*'. + .. admonition:: Example — ACCOUNT trigger + :collapsible: closed + :class: tcl-example - Module: core + .. code-block:: tcl -(48) TLS (stackable) + bind account - "#lamest *" account_proc - bind tls + proc account_proc {nick user hand chan account} { + putlog "Nick is $nick, user is $user, handle is $hand, channel is $chan, account is $account" + } - procname - - Description: triggered for tcp connections when a ssl handshake has completed and the connection is secured. The mask is matched against the idx of the connection. + **Trigger and output** - Module: core + .. code-block:: text -(49) DIE (stackable) + Foobar identifies to services as foobar while on #lamest + Nick is Foobar, user is foobar@127.0.0.1, handle is foobar, channel is #lamest, account is foobar - bind die +.. _bind-isupport: - procname - - Description: triggered when eggdrop is about to die. The mask is matched against the shutdown reason. The bind won't be triggered if the bot crashes or is being terminated by SIGKILL. +(54) ISUPPORT (stackable) - Module: core + ``bind isupport `` -(50) IRCAWAY (stackable) + ``procname `` - bind ircaway + Description + Triggered when the value of an ISUPPORT key changes. The mask is matched against the ISUPPORT key. If the value is not set, isset is ``0`` and the value is the empty string. Because the empty string is a valid value, use isset to distinguish empty string values from a key being unset. The bind is called before the change is processed, so [isupport isset]/[isupport get] return the old value. A return value other than 0 makes Eggdrop ignore the change and revert to the old value. After a disconnect from the server, all ISUPPORT values are reset to default, but $::server will be empty, so that case can be caught and ignored. - procname - - Description: triggered when Eggdrop receives an AWAY message for a user from an IRC server, ONLY if the away-notify capability is enabled via CAP (the server must supports this capability, see the 'cap' Tcl command for more info on requesting capabilities). "Normal" away messages (301 messages) will not trigger this bind, for those you should instead use a RAWT bind. The mask for the bind is in the format "#channel nick!user@hostname" (* to catch all nicknames). nick is the nickname of the user that triggered the bind, user is the nick!user@host of the user, handle is the handle of the user on the bot (- if the user is not added to the bot), channel is the channel the user was found on (read on for more info on this) and msg is the contents of the away message, if any. If a "*" is used for the channel in the mask, this bind is triggered once for every channel that the user is in the bot with; in other words if the bot is in two channels with the target user, the bind will be triggered twice. To trigger a proc only once per nick change, regardless of the number of channels the Eggdrop and user share, use the RAWT bind with AWAY as the keyword. - Module: irc + Module + ``server`` -(51) INVT (stackable) - bind invt + .. admonition:: Example — ISUPPORT trigger + :collapsible: closed + :class: tcl-example - procname + .. code-block:: tcl - Description: triggered when eggdrop received an INVITE message. The mask for the bind is in the format "#channel nickname", where nickname (not a hostmask) is that of the invitee. For the proc, nick is the nickname of the person sending the invite request, user@host is the user@host of the person sending the invite, channel is the channel the invitee is being invited to, and invitee is the target (nickname only) of the invite. The invitee argument was added to support the IRCv3 invite-notify capability, where the eggdrop may be able to see invite messages for other people that are not the eggdrop. + bind isupport - "CHANTYPES" isupport_proc -(52) RAWT (stackable) + proc isupport_proc {key isset value} { + putlog "Key is $key, isset is $isset, value is $value" + } - bind rawt + **Trigger and output** - procname + .. code-block:: text - Description: similar to the RAW bind, but allows an extra field for the IRCv3 message-tags capability. The mask can contain wildcards and is matched against the keyword which is either a numeric, like "368", or a keyword, such as "PRIVMSG" or "TAGMSG". "from" will be the server name or the source nick!ident@host (depending on the keyword); flags are ignored. "tag" is a dictionary (flat key/value list) of the message tags with "" for empty values (e.g. "account eggdrop realname LamestBot"). If the proc returns 1, Eggdrop will not process the line any further, to include not being processed by a RAW bind (this could cause unexpected behavior in some cases). As of 1.9.0, it is recommended to use the RAWT bind instead of the RAW bind. + The server advertises CHANTYPES=#& + Key is CHANTYPES, isset is 1, value is #& -(53) ACCOUNT (stackable) +.. _bind-monitor: - bind account +(55) MONITOR (stackable) - procname + ``bind monitor `` - Description: this bind will trigger when eggdrop detects a change in the authentication status of a user's service account. The mask for the bind is in the format "#channel nick!user@hostname.com account" and accepts wildcards_. account is either the account name the user is logging in to or "*" if the user is not logged in to an account. + ``procname `` - NOTE: the three required IRC components for account tracking are: the WHOX feature, the extended-join IRCv3 capability and the account-notify IRCv3 capability. if only some of the three feature are available, eggdrop provides best-effort account tracking but this bind could be triggered late or never on account changes. Please see doc/ACCOUNTS for additional information. + Description + Triggered when a server sends a MONITOR status change of a target either coming online or disconnecting (not all servers support MONITOR). flags are ignored, nick is the nickname of the intended MONITOR target and can be used with wildcards. For the proc, nick is the nickname connecting or disconnecting, and online is ``0`` if the nickname disconnected, or ``1`` if the nickname connected. -(54) ISUPPORT (stackable) - bind isupport + Module + ``irc`` - procname - - Description: triggered when the value of an isupport key changes. The mask is matched against the isupport key. If the value is not set, isset is 0 and the value is the empty string. Because the empty string is valid value, use isset to distinguish empty string values from a key being unset. The bind is called before the change is processed, so [isupport isset]/[isupport get] return the old value. A return value other than 0 makes Eggdrop ignore the change and revert to the old value. After a disconnect from the server, all isupport values are reset to default, but $::server will be empty, so that case can be caught and ignored. - Module: server + .. admonition:: Example — MONITOR trigger + :collapsible: closed + :class: tcl-example -(55) MONITOR (stackable) + .. code-block:: tcl - bind monitor + bind monitor - "Foobar" monitor_proc - procname + proc monitor_proc {nick online} { + putlog "Nick is $nick, online is $online" + } - Description: triggered when a server sends a MONITOR status change of a target either coming online or disconnecting (not all servers support MONITOR). flags are ignored, nick is the nickname of the intended MONITOR target and can be used with wildcards. For the proc, nick is the nickname connecting or disconnecting, and online is '0' if the nickname disconnected, or '1' if the nickname connected. + **Trigger and output** - Module: irc + .. code-block:: text + + Foobar connects to the IRC network + Nick is Foobar, online is 1 + +.. _bind-chghost: (56) CHGHOST - bind chghost + ``bind chghost `` - procname + ``procname `` - Description: triggered when a server sends an IRCv3 spec CHGHOST message to change a user's hostmask. The new host is matched against mask in the form of "#channel nick!user\@host" and can contain wildcards. The specified proc will be called with the nick of the user whose hostmask changed; the hostmask the affected user had before the change, the handle of the affected user (or * if no handle is present), the channel the user was on when the bind triggered, and the new hostmask of the affected user. This bind will trigger once for each channel the user is on. + Description + Triggered when a server sends an IRCv3 CHGHOST message to change a user's hostmask. The new host is matched against mask in the form of ``#channel nick!user@host`` and can contain wildcards. The specified proc will be called with the nick of the user whose hostmask changed, the hostmask the affected user had before the change, the handle of the affected user (or * if no handle is present), the channel the user was on when the bind triggered, and the new hostmask of the affected user. This bind will trigger once for each channel the user is on. -(57) CHANSET - bind chanset + Module + ``irc`` - procname - Description: triggered when a channel setting is set via the partyline. flags is ignored, mask is the name of channel setting (not including any +/- prefix) and can contain wildcards. The proc will be called with the channel that the setting was set on, the text name of the setting that was changed, and the value it was set to (0/1 for -/+, string, or X:Y formatted value). + .. admonition:: Example — CHGHOST trigger + :collapsible: closed + :class: tcl-example -^^^^^^^^^^^^^ -Return Values -^^^^^^^^^^^^^ + .. code-block:: tcl -Several bindings pay attention to the value you return from the proc(using 'return '). Usually, they expect a 0 or 1, and returning an empty return is interpreted as a 0. Be aware if you omit the return statement, the result of the last Tcl command executed will be returned by the proc. This will not likely produce the results you intended (this is a "feature" of Tcl). + bind chghost - "#lamest *" chghost_proc -Here's a list of the bindings that use the return value from procs they trigger: - -(1) MSG Return 1 to make Eggdrop log the command as:: + proc chghost_proc {nick oldhost hand channel newhost} { + putlog "Nick is $nick, old user@host is $oldhost, handle is $hand, channel is $channel, new user@host is $newhost" + } - (nick!user@host) !handle! command + **Trigger and output** -(2) DCC Return 1 to make Eggdrop log the command as:: + .. code-block:: text - #handle# command + Foobar changes host from foobar@127.0.0.1 to foobar@example.net on #lamest + Nick is Foobar, old user@host is foobar@127.0.0.1, handle is foobar, channel is #lamest, new user@host is foobar@example.net -(3) FIL Return 1 to make Eggdrop log the command as:: +.. _bind-chanset: - #handle# files: command +(57) CHANSET -(4) PUB Return 1 to make Eggdrop log the command as:: + ``bind chanset `` - <> !handle! command + ``procname `` -(5) CTCP Return 1 to ask the bot not to process the CTCP command on its own. Otherwise, it would send its own response to the CTCP (possibly an error message if it doesn't know how to deal with it). - -(6) FILT Return "" to indicate the text has been processed, and the bot should just ignore it. Otherwise, it will treat the text like any other. + Description + Triggered when a channel setting is set via the partyline. flags is ignored, mask is the name of channel setting (not including any +/- prefix) and can contain wildcards. The proc will be called with the channel that the setting was set on, the text name of the setting that was changed, and the value it was set to (0/1 for -/+, string, or X:Y formatted value). -(7) FLUD Return 1 to ask the bot not to take action on the flood. Otherwise it will do its normal punishment. -(8) RAW Return 1 to ask the bot not to process the server text. This can affect the bot's performance by causing it to miss things that it would normally act on -- you have been warned. + Module + ``channels`` -(9) CHON Return 1 to ask the bot not to process the partyline join event. -(10) CHOF Return 1 to ask the bot not to process the partyline part event. + .. admonition:: Example — CHANSET trigger + :collapsible: closed + :class: tcl-example -(11) WALL Return 1 to make Eggdrop not log the message that triggered this bind. + .. code-block:: tcl -(12) NOTE Return 1 to make Eggdrop not process the note any further. This includes stacked note bindings that would be processed after this one, as well as the built-in eggdrop note handling routines. + bind chanset - "autoop" chanset_proc -(13) MSGM Return 1 to make Eggdrop not log the message that triggered this bind. + proc chanset_proc {chan setting value} { + putlog "Channel is $chan, setting is $setting, value is $value" + } -(14) PUBM Return 1 to make Eggdrop not log the message that triggered this bind. + **Trigger and output** -(15) NOTC Return 1 to make Eggdrop not log the message that triggered this bind. + .. code-block:: text -(16) OUT Return 1 to make Eggdrop drop the message instead of sending it. Only meaningful for messages with status "queued". + .chanset #lamest +autoop + Channel is #lamest, setting is autoop, value is 1 -(17) EVNT Return 1 to make Eggdrop not to take the default action for the event. Used for signal type events, ignored for others. +.. _wildcards: -(18) TLS Return 1 to disable verbose ssl information for the handshake. +Match Characters +---------------- -(19) RAWT Return 1 to ask the bot not to process the server text. This can affet the bot's performance by causing it to miss things that it would normally act on -- you have been warned. Again. +Many bind types allow special match characters in their mask arguments. The +following characters have special meaning: + +.. list-table:: + :widths: 15 85 + :header-rows: 1 + + * - Match character + - Description + * - ``?`` + - Matches any single character. + * - ``*`` + - Matches zero or more characters of any type. + * - ``%`` + - Matches zero or more non-space characters and can be used to match a + single word. This character works only in binds, not in regular + matching. + * - ``~`` + - Matches one or more space characters and can be used for whitespace + between words. This character works only in binds, not in regular + matching. + * - ``\*`` + - Matches a literal ``*``. Tcl also requires escaping, so a bind mask + must use ``"\\*"`` or ``{\*}``. -(20) CHANSET Return 1 to prevent the channel setting from being changed. +^^^^^^^^^^^^^ +Return Values +^^^^^^^^^^^^^ -Control Procedures ------------------- +Several bind types pay attention to the value returned by the Tcl proc using +``return ``. Unless otherwise noted, these binds generally expect +``0`` or ``1``, and an empty return is interpreted as ``0``. If a proc omits +an explicit ``return`` statement, Tcl returns the result of the last command +executed, which may cause unintended bind behavior. -Using the 'control' command, you can put a DCC connection (or outgoing -TCP connection) in control of a script. All text received from the -connection is sent to the proc you specify. All outgoing text should -be sent with 'putdcc'. +The following bind types use their proc's return value: -The control procedure is called with these parameters:: +#. ``MSG`` — Return ``1`` to make Eggdrop log the command as: - procname + .. code-block:: text -This allows you to use the same proc for several connections. The -idx will stay the same until the connection is dropped. After that, -it will probably get reused for a later connection. + (nick!user@host) !handle! command -To indicate that the connection has closed, your control procedure -will be called with blank text (the input-text will be ""). This -is the only time it will ever be called with "" as the text, and it -is the last time your proc will be called for that connection. Don't -call killdcc on the idx when text is blank, it will always fail with -"invalid idx". +#. ``DCC`` — Return ``1`` to make Eggdrop log the command as: -If you want to hand control of your connection back to Eggdrop, your -proc should return 1. Otherwise, return 0 to retain control. + .. code-block:: text -TCP Connections ---------------- + #handle# command -Eggdrop allows you to make two types of TCP ("telnet") connections: -outgoing and incoming. For an outgoing connection, you specify the -remote host and port to connect to. For an incoming connection, you -specify a port to listen on. +#. ``FIL`` — Return ``1`` to make Eggdrop log the command as: -All of the connections are *event driven*. This means that the bot will -trigger your procs when something happens on the connection, and your -proc is expected to return as soon as possible. Waiting in a proc for -more input is a no-no. + .. code-block:: text -To initiate an outgoing connection, use:: + #handle# files: command - set idx [connect <[+]port>] - -For SSL connections, prefix the port with a plus sign. +#. ``PUB`` — Return ``1`` to make Eggdrop log the command as: -$idx now contains a new DCC entry for the outgoing connection. + .. code-block:: text -All connections use non-blocking (commonly called "asynchronous", -which is a misnomer) I/O. Without going into a big song and dance -about asynchronous I/O, what this means to you is: + <> !handle! command - * assume the connection succeeded immediately - * if the connection failed, an EOF will arrive for that idx +#. ``CTCP`` — Return ``1`` to ask the bot not to process the CTCP command on + its own. Otherwise, it may send its own response to the CTCP, including an + error response for an unrecognized CTCP command. -The only time a 'connect' will return an error is if you give it a -hostname that can't be resolved (this is considered a "DNS error"). -Otherwise, it will appear to have succeeded. If the connection failed, -you will immediately get an EOF. +#. ``FILT`` — Return ``""`` to indicate the text has been processed and should + be ignored by the bot. Otherwise, the bot treats the returned text normally. -Right after doing a 'connect' call, you should set up a 'control' for -the new idx (see the section above). From then on, the connection will -act just like a normal DCC connection that has been put under the control -of a script. If you ever return "1" from the control proc (indicating -that you want control to return to Eggdrop), the bot will just close the -connection and dispose of it. Other commands that work on normal DCC -connections, like 'killdcc' and 'putdcc', will work on this idx, too. -The 'killdcc' command will fail with "invalid idx" if you attempt to use -it on a closed socket. +#. ``FLUD`` — Return ``1`` to ask the bot not to take action on the flood. + Otherwise, it performs its normal flood punishment. -To create a listen port, use:: +#. ``RAW`` — Return ``1`` to ask the bot not to process the server text. This + can cause Eggdrop to miss events it would normally act on. - listen <[+]port> script +#. ``CHON`` — Return ``1`` to ask the bot not to process the partyline join + event. -By default, a listen port will allow both plaintext and SSL connections. -To restrict a port to allow only SSL connections, prefix the port with a -plus sign. - -Procs should be declared as:: +#. ``CHOF`` — Return ``1`` to ask the bot not to process the partyline part + event. - +#. ``WALL`` — Return ``1`` to make Eggdrop not log the message that triggered + this bind. -For example:: +#. ``NOTE`` — Return ``1`` to make Eggdrop stop processing the note. This + includes stacked note bindings that would otherwise run afterward, as well + as Eggdrop's built-in note handling routines. - listen 6687 script listen:grab +#. ``MSGM`` — Return ``1`` to make Eggdrop not log the message that triggered + this bind. - proc listen:grab {newidx} { - control $newidx listen:control - } +#. ``PUBM`` — Return ``1`` to make Eggdrop not log the message that triggered + this bind. -When a new connection arrives in port 6687, Eggdrop will create a new idx for the connection. That idx is sent to 'listen:grab'. The proc immediately puts this idx under control. Once 'listen:grab' has been called, the idx behaves exactly like an outgoing connection would. +#. ``NOTC`` — Return ``1`` to make Eggdrop not log the message that triggered + this bind. -Secure connection can be also established after a connection is active. You can connect/listen normally and switch later using the 'starttls' command. Your script should first inform the other side of the connection that it wants to switch to SSL. How to do this is application specific. +#. ``OUT`` — Return ``1`` to make Eggdrop drop the message instead of sending + it. This is only meaningful for messages whose status is ``queued``. -The best way to learn how to use these commands is to find a script that uses them and follow it carefully. However, hopefully this has given you a good start. +#. ``EVNT`` — Return ``1`` to make Eggdrop skip its default action for the + event. This is used for signal-type events and ignored for other events. -.. _wildcards: +#. ``TLS`` — Return ``1`` to disable verbose SSL information for the + handshake. -Match Characters ----------------- +#. ``RAWT`` — Return ``1`` to ask the bot not to process the server text. + This can cause Eggdrop to miss events it would normally act on. -Many of the bindings allow match characters in the arguments. Here -are the four special characters: - -+-----+--------------------------------------------------------------------------+ -| ? | matches any single character | -+-----+--------------------------------------------------------------------------+ -| \* | matches 0 or more characters of any type | -+-----+--------------------------------------------------------------------------+ -| % | matches 0 or more non-space characters (can be used to match a single | -| | word) (This character only works in binds, not in regular matching) | -+-----+--------------------------------------------------------------------------+ -| ~ | matches 1 or more space characters (can be used for whitespace between | -| | words) (This char only works in binds, not in regular matching) | -+-----+--------------------------------------------------------------------------+ -| \\* | matches a literal \*, but please note that Tcl needs escaping as well, | -| | so a bind would have to use "\\*" or {\*} for a mask argument | -+-----+--------------------------------------------------------------------------+ - - Copyright (C) 1999 - 2025 Eggheads Development Team +#. ``CHANSET`` — Return ``1`` to prevent the channel setting from being + changed.