Initial import of the ircii-pana-1.1-final source tree.

git-svn-id: svn://svn.code.sf.net/p/bitchx/code/tags/ircii-pana-1.1-final@1 13b04d17-f746-0410-82c6-800466cd88b0

bitchx-docs/5_Programming/on/dcc_list

@@ -0,0 +1,27 @@
+Synopsis:
+   on [<modes>]dcc_list [<serial#>] [-|^]<match> { <action> }
+
+Description:
+   This hook is triggered whenever a /dcc or /dcc list command is issued.
+   The 'banner' of the list can be determined when $0 is "Start", and the
+   end of the list is determined when $0 is "end".
+
+Parameters:
+   $0  - The type of DCC connection
+   $1  - "1" if encryption is on, "0" if its not  (future exp)
+   $2  - Nickname of the peer
+   $3  - Status of connection
+   $4  - $time() when connection established, 0 if not connected.
+   $5  - Size of the file transfer, 0 if not applicable
+   $6  - Number of bytes transfered, 0 if not connected
+   $7  - Description field (usually the full filename)
+
+Examples:
+   To display some extra info about dcc:
+      on -dcc_list "*" {
+         if (([$6]/[$5]*100)>90) { echo File $7 from $2 is almost done! }
+      }
+
+See Also:
+   dcc(1)
+