Merged silc_1_0_branch to trunk.
[silc.git] / apps / irssi / docs / help / in / kill.in
index c87c8ac41037a41b468c0729b9c1673d3b6994c1..3593aaf3c1b3e47eb981fd581a87c5e30d80adfb 100644 (file)
@@ -1,12 +1,39 @@
 
 @SYNTAX:kill@
 
-Format: <nickname> [<comment>]
+This command can be used for two purpose:  SILC operator may use it to
+remove a client from the network, or user may use it to remove its own
+client entries from the network.  If you are not SILC operator you cannot
+use this command to remove anybody else except yourself from the network.
+Only SILC operator is able to kill other clients from the network.
 
-This is operator command. KILL is used to forcibly remove a client
-from the network. It works similarly to KICK expect that the client
-is removed from the entire network.  In general, KILL is useful only
-as a warning tool for abusive users and it has only temporary effects.
+Killing own client entry from network:
+
+When killing your own client entry you must provide -pubkey option to the
+command. For killing your own client from network you also must be
+connected to the same server as your own client entry (the client entry
+may be for example detached client entry).  If you are not connected to
+the same server you won't be able to kill the client.  Also, if you have
+changed or lost your old public key pair you won't be able to kill the
+client.
+
+Killing as SILC Operator:
+
+Before killing you must elevate your privileges to SILC Operator by using
+the /SILCOPER command.  After that you can kill a client.  When using this
+command as SILC operator -pubkey option has no effect and can be omitted.
+
+Examples:
+
+        /KILL myself -pubkey
+
+            Kill yourself with nickname "myself" from network.
+
+        /SILCOPER user
+        /KILL someclient You have been killed
+
+            Become SILC operator and kill client named
+            "someclient", with comment "You have been killed".
 
 See also: OPER, SILCOPER