[Tcldrop/CVS] tcldrop/doc tcl-commands.txt

[Philip Moore]

CVSROOT:        /cvsroot/tcldrop
Module name:    tcldrop
Branch:         
Changes by:     Philip Moore <address@hidden>   03/11/13 20:13:41

Modified files:
        doc            : tcl-commands.txt 

Log message:
        Updated to reflect the currently implemented commands and binds.

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/tcldrop/tcldrop/doc/tcl-commands.txt.diff?tr1=1.3&tr2=1.4&r1=text&r2=text

Patches:
Index: tcldrop/doc/tcl-commands.txt
diff -u tcldrop/doc/tcl-commands.txt:1.3 tcldrop/doc/tcl-commands.txt:1.4
--- tcldrop/doc/tcl-commands.txt:1.3    Thu May 22 14:01:57 2003
+++ tcldrop/doc/tcl-commands.txt        Thu Nov 13 20:13:40 2003
@@ -164,18 +164,18 @@
 #      or if the user can't be found
 #    Module: core
 
-#  chattr <handle> [changes [channel]]
-#    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 |<changes> <channel>, the channel-specific
-#      flags for that channel are altered. You can now use the +o|-o #channel
-#      format here too.
-#    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.
-#    Module: core
+  chattr <handle> [changes [channel]]
+    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 |<changes> <channel>, the channel-specific
+      flags for that channel are altered. You can now use the +o|-o #channel
+      format here too.
+    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.
+    Module: core
 
 #  botattr <handle> [changes [channel]]
 #    Description: similar to chattr except this modifies bot flags rather
@@ -506,10 +506,10 @@
 #    Returns: 1 if the ignore is in the list; 0 otherwise
 #    Module: core
 #
-#  save
-#    Description: writes the user and channel files to disk
-#    Returns: nothing
-#    Module: core
+  save
+    Description: writes the user and channel files to disk
+    Returns: nothing
+    Module: core
 
   reload
     Description: loads the userfile from disk, replacing whatever is in
@@ -872,9 +872,9 @@
 #    Returns: handle of the user with the given idx
 #    Module: core
 
-#  valididx <idx>
-#    Returns: 1 if the idx currently exists; 0 otherwise
-#    Module: core
+  valididx <idx>
+    Returns: 1 if the idx currently exists; 0 otherwise
+    Module: core
 
 #  getchan <idx>
 #    Returns: the current party line channel for a user on the party line;
@@ -924,10 +924,10 @@
 #    Returns: nothing
 #    Module: core
 
-#  killdcc <idx>
-#    Description: kills a partyline or file area connection
-#    Returns: nothing
-#    Module: core
+  killdcc <idx>
+    Description: kills a partyline or file area connection
+    Returns: nothing
+    Module: core
 
 #  bots
 #    Returns: list of the bots currently connected to the botnet
@@ -988,12 +988,12 @@
 #    Returns: nothing
 #    Module: core
 
-#  connect <host> <port>
-#    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.
-#    Returns: idx of the new connection
-#    Module: core
+  connect <host> <port>
+    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.
+    Returns: idx of the new connection
+    Module: core
 
   listen <port> <type> [options] [flag]
     Description: opens a listening port to accept incoming telnets; type
@@ -1308,50 +1308,50 @@
       "address@hidden" -> "address@hidden", "address@hidden" -> 
"address@hidden")
     Module: core
 
-#  timer <minutes> <tcl-command>
-#    Description: executes the given Tcl command after a certain number of
-#      minutes have passed
-#    Returns: a timerID
-#    Module: core
+  timer <minutes> <tcl-command>
+    Description: executes the given Tcl command after a certain number of
+      minutes have passed
+    Returns: a timerID
+    Module: core
 
-#  utimer <seconds> <tcl-command>
-#    Description: executes the given Tcl command after a certain number of
-#      seconds have passed
-#    Returns: a timerID
-#    Module: core
+  utimer <seconds> <tcl-command>
+    Description: executes the given Tcl command after a certain number of
+      seconds have passed
+    Returns: a timerID
+    Module: core
 
-#  timers
-#    Returns: a list of active minutely timers. Each entry in the list contains
-#      the number of minutes left till activation, the command that will be
-#      executed, and the timerID.
-#    Module: core
+  timers
+    Returns: a list of active minutely timers. Each entry in the list contains
+      the number of minutes left till activation, the command that will be
+      executed, and the timerID.
+    Module: core
 
-#  utimers
-#    Returns: a list of active secondly timers. Each entry in the list contains
-#      the number of minutes left till activation, the command that will be
-#      executed, and the timerID.
-#    Module: core
+  utimers
+    Returns: a list of active secondly timers. Each entry in the list contains
+      the number of minutes left till activation, the command that will be
+      executed, and the timerID.
+    Module: core
 
-#  killtimer <timerID>
-#    Description: removes a minutely timer from the list
-#    Returns: nothing
-#    Module: core
+  killtimer <timerID>
+    Description: removes a minutely timer from the list
+    Returns: nothing
+    Module: core
 
-#  killutimer <timerID>
-#    Description: removes a secondly timer from the list
-#    Returns: nothing
-#    Module: core
+  killutimer <timerID>
+    Description: removes a secondly timer from the list
+    Returns: nothing
+    Module: core
 
   unixtime
     Returns: a long integer which represents the number of seconds that have
       passed since 00:00 Jan 1, 1970 (GMT).
     Module: core
 
-#  duration <seconds>
-#    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
+  duration <seconds>
+    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
 
   strftime <formatstring> [time]
     Returns: a formatted string of time using standard strftime format.
@@ -1374,17 +1374,17 @@
     Returns: a random integer between 0 and limit-1
     Module: core
 
-#  control <idx> <command>
-#    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
+  control <idx> <command>
+    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
 
 #  sendnote <from> <address@hidden> <message>
 #    Description: simulates what happens when one user sends a note to another
@@ -1397,29 +1397,29 @@
 #      5 - the note was stored because the user is away
 #    Module: core
 
-#  link [via-bot] <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
+  link [via-bot] <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
 
 #  unlink <bot>
 #    Description: attempts to unlink a bot from the botnet
 #    Returns: 1 on success; 0 otherwise
 #    Module: core
 
-#  encrypt <key> <string>
-#    Returns: encrypted string (using the currently loaded encryption module),
-#      encoded into ASCII using base-64
-#    Module: encryption
-
-#  decrypt <key> <encrypted-base64-string>
-#    Returns: decrypted string (using the currently loaded encryption module)
-#    Module: encryption
-
-#  encpass <password>
-#    Returns: encrypted string (using the currently loaded encryption module)
-#    Module: encryption (in irc module right now)
+  encrypt <key> <string>
+    Returns: encrypted string (using the currently loaded encryption module),
+      encoded into ASCII using base-64
+    Module: encryption
+
+  decrypt <key> <encrypted-base64-string>
+    Returns: decrypted string (using the currently loaded encryption module)
+    Module: encryption
+
+  encpass <password>
+    Returns: encrypted string (using the currently loaded encryption module)
+    Module: encryption (in irc module right now)
 
   die [reason]
     Description: causes the bot to log a fatal error and exit completely.
@@ -1807,14 +1807,14 @@
            your bot to behave oddly in some cases).
          Module: server
 
-#    (18) BOT
-#         bind bot <flags> <command> <proc>
-#         proc-name <from-bot> <command> <text>
-#
-#         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.
-#         Module: core
+    (18) BOT
+         bind bot <flags> <command> <proc>
+         proc-name <from-bot> <command> <text>
+
+         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.
+         Module: core
 
 #    (19) CHON (stackable)
 #         bind chon <flags> <mask> <proc>
@@ -2010,16 +2010,16 @@
 #           channel and can contain wildcards.
 #         Module: core
 
-#    (37) TIME (stackable)
-#         bind time <flags> <mask> <proc>
-#         proc-name <minute> <hour> <day> <month> <year>
-#
-#         Description: allows you to schedule procedure calls at certain
-#           times. mask matches 5 space separated integers of the form:
-#           "minute hour day month year". minute, hour, day, month have a
-#           zero padding so they are exactly two characters long; year is
-#           extended to four characters in the same way.
-#         Module: core
+    (37) TIME (stackable)
+         bind time <flags> <mask> <proc>
+         proc-name <minute> <hour> <day> <month> <year>
+
+         Description: allows you to schedule procedure calls at certain
+           times. mask matches 5 space separated integers of the form:
+           "minute hour day month year". minute, hour, day, month have a
+           zero padding so they are exactly two characters long; year is
+           extended to four characters in the same way.
+         Module: core
 
 #    (38) AWAY (stackable)
 #         bind away <flags> <mask> <proc>
@@ -2150,69 +2150,69 @@
 #    (11) WALL  Return 1 to make the command get logged like so:
 #           !nick! msg
 
-#*** CONTROL PROCEDURES ***
+*** CONTROL PROCEDURES ***
 
-#  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 control procedure is called with these parameters:
-#    procname <idx> <input-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.
-#
-#  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".
-#
-#  If you want to hand control of your connection back to Eggdrop, your
-#  proc should return 1. Otherwise, return 0 to retain control.
-#
-
-#*** TCP CONNECTIONS ***
-#
-#  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.
-#
-#  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.
-#
-#  To initiate an outgoing connection, use:
-#    set idx [connect <hostname> <port>]
-#
-#  $idx now contains a new DCC entry for the outgoing connection.
-#
-#  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:
-#
-#    * assume the connection succeeded immediately
-#    * if the connection failed, an EOF will arrive for that idx
-#
-#  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.
-#
-#  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.
+  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 control procedure is called with these parameters:
+    procname <idx> <input-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.
+
+  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".
+
+  If you want to hand control of your connection back to Eggdrop, your
+  proc should return 1. Otherwise, return 0 to retain control.
+
+
+*** TCP CONNECTIONS ***
+
+  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.
+
+  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.
+
+  To initiate an outgoing connection, use:
+    set idx [connect <hostname> <port>]
+
+  $idx now contains a new DCC entry for the outgoing connection.
+
+  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:
+
+    * assume the connection succeeded immediately
+    * if the connection failed, an EOF will arrive for that idx
+
+  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.
+
+  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.
 #
 #  To create a listen port, use:
 #    listen <port> script <proc>