Merged silc_1_0_branch to trunk.

[silc.git] / apps / irssi / docs / help / in / key.in

diff --git a/apps/irssi/docs/help/in/key.in b/apps/irssi/docs/help/in/key.in
index 9e54b7bd7daeae44477b100b5d977aeffae591f4..054904d89286aea6d15c3d34218d86197f1f58a2 100644 (file)
--- a/apps/irssi/docs/help/in/key.in
+++ b/apps/irssi/docs/help/in/key.in
@@ -15,22 +15,24 @@ Types:
   MSG        The command is performed for private messages
              affecting the <nickname>.
 
-  CHANNEL    The command is performed for channel affecting
-             the <channel>.
+  CHANNEL    The command is performed for the channel indicated
+             by <channel> (* matches current channel).
 
 Commands:
 
-  set        [<key> [<cipher>] [<hmac>]]
+  set        [<key> [<cipher>] [<hmac>]] [-responder]
 
     Set the key into use.  If the <key> is provided it is used
     as the key material.  If the <key> is not provided the
     negotiated key material is used.  If the negotiation has not
     been performed this command has no effect.
 
-    If the type is `msg' and the <key> is `*' then random key
-    will be generated automatically.  The <cipher> may be set
-    for both private message and channel private keys and the
-    <hmac> may be set only to the channel private keys.
+    If the type is MSG and the <key> is `*' then random key
+    will be generated automatically.  The -responder option
+    may be used ONLY with MSG type.  One of the clients must
+    be the responder side.  The one being the responder must
+    use this option.  The clients setting the key must agree
+    on which one is the responder.
 
   unset      [<number>]
 
@@ -44,9 +46,17 @@ Commands:
   list
 
     List all private keys that has been set.  If the type is
-    `msg' and the <nickname> is ´*' then all private message
+    MSG and the <nickname> is ´*' then all private message
     keys that you've set will be listed.
 
+  change     [<number>]
+
+    This command can be used only when type is CHANNEL.  This is
+    used to change the current channel private key.  The <number>
+    may indicate what key is changed.  If it is not provided then
+    next key is changed to current channel private key.  By default
+    this command is also bound to Meta-K (Alt+Shift+k) key.
+
   agreement  [<hostname> [<port>]]
 
     Send key agreement request to remote client.  If the
@@ -65,14 +75,14 @@ Commands:
     sender with the hostname and port of your key agreement
     server with this command.
 
-    If the hostname and port are ommitted, the irssi boolean
+    If the hostname and port are ommitted, the boolean
     variable use_auto_addr will be examined.  If it is set
     the value of auto_bind_ip will be used as the IP address
     to listen for the return reply, the value of auto_public_ip
     will be the IP address sent to the remote client, and the
     auto_bind_port will be the port value to be bound to and
     sent to the remote client.  If auto_public_ip is unset, but
-    auto_bind_ip is set, irssi will send the auto_bind_ip
+    auto_bind_ip is set, silc client will send the auto_bind_ip
     variable's value to the remote client.
 
   negotiate  [<hostname> [<port>]]
@@ -82,3 +92,16 @@ Commands:
     your key agreement request.  You will see a notify on the
     screen when the reply arrives.  The <hostname> and <port> is the
     hostname and port of the remote client's key agreement server.
+
+Examples:
+
+  Set channel private key to current channel, and list all keys:
+
+    /KEY CHANNEL * set very_secret_key_this_is
+    /KEY CHANNEL * list
+    /KEY MSG nickname set secretkey
+    /KEY MSG nick set secretkey -responder
+    /KEY MSG foo agreement 10.2.1.7 5000
+    /KEY MSG bar negotiate 10.2.1.7 5000
+
+See also: WHOIS, CHANNEL, GETKEY