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/6_Functions/idle

@@ -0,0 +1,19 @@
+Synopsis:
+   $idle()
+
+Technical:
+   Returns your idle time.  Synonymous with $E.  Present for compatibility
+   with the standard ircII 2.8.2 client.
+
+Practical:
+   This function is used to get your client's idle time.  It should be used
+   in lieu of $E if you intend your script to be compatible with the stock
+   ircII client.  Note that the client's concept of "idle time" is not
+   necessarily the same as your server's (and in fact usually isn't).
+
+Returns:
+   number of seconds since last keypress
+
+See Also:
+   Special_Vars(7)
+