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/key

@@ -0,0 +1,21 @@
+Synopsis:
+   $key([<channel>|* [<channel> ...]])
+
+Technical:
+   This function displays the channel key for each channel specified (if
+   any have a key assigned).  If a "*", or no channel, is specified, the
+   current is assumed.  It has no effect for channels that you aren't
+   currently on.
+
+Practical:
+   This function is used to fetch a channel's key.  Any number of channels
+   may be specified, though the output could be confusing if only some
+   actually have a key.  You must be on the channel(s) specified for the
+   function to have any effect.
+
+Returns:
+   list of channel keys for given channels, or empty string if none or error
+
+See Also:
+   chanmode(6)
+