updates.
[runtime.git] / README
diff --git a/README b/README
index a6933329f2e3044f5a8760e6dd43bb2c04fbb612..3a339ef3ae5335c0b4f0b1b81c784acc9721cea7 100644 (file)
--- a/README
+++ b/README
@@ -43,10 +43,8 @@ To run SILC server
        ./silcd -f <config file>
 
 
-Working Commands
-================
-
-Following commands has been, at least partly, implemented:
+SILC Commands
+=============
 
 
        /SERVER [<server>[:<port>]]
@@ -71,6 +69,59 @@ Following commands has been, at least partly, implemented:
                Leaves the channel.  If /leave * is given the client
                leaves the current channel.
 
+       /CMODE  <channel> +|-<modes> [{ <arguments>}]
+
+               Changes/sets channel mode.  Most of the modes require
+               special privileges, such as channel operator or channel
+               founder privileges to work.  The mode is added by adding
+               + before the option(s) and removed by adding - before
+               the option(s).  Following modes are available:
+
+               p               Set/unset channel as private channel
+               s               Set/unset channel as secret channel
+               k               Set/unset that channel uses private channel key
+               i               Set/unset channel as invite only channel
+               t               Set/unset that only channel operator or 
+                               founder may set channel topic
+               l <limit>       Set/unset channel's user limit
+               a <passphrase>  Set/unset passphrase for channel that must
+                               be provided when joining to the channel.
+               c <cipher>      Set/unset channel's cipher
+               h <hmac>        Set/unset channel's hmac
+
+               Multiple modes can be set/unset at once if the modes does not
+               require any arguments.  If mode requires an argument then only
+               one mode can be set at once.
+
+       /CUMODE <channel> +|-<modes> <nickname>[@<server>]
+
+               Changes/set user's mode on a channel.  Most of the modes 
+               require that the client who changes some client's mode must
+               be channel founder or channel operator.  Following channel
+               user modes are available:
+
+               a <nickname>[@<server>]
+                               Set/unset all modes (cannot be used to set
+                               both founder and operator rights, can be used
+                               only to remove both modes at once).
+               f <nickname>[@<server>]
+                               Unset channel founder.  Channel founder rights
+                               cannot be set by user (only by server) so this
+                               can be used only to unset the mode.
+               o <nickname>[@<server>]
+                               Set/unset channel operator.  Requires that 
+                               you are channel operator or channel founder.
+
+       /UMODE  +|-<modes>
+
+               Sets/unsets user mode.  Currently none of the modes can
+               be set by the user so this command can be merely used to
+               unset some mode.  Following user modes are available:
+
+               a       Unset all modes
+               s       Unset server operator privileges
+               r       Unset router operator privileges
+
        /MSG    <nickname> <message>
 
                Sends private message to remote client.  Support for
@@ -83,6 +134,33 @@ Following commands has been, at least partly, implemented:
                handling multiple same nicknames with this command is
                still missing.
 
+       /WHOWAS  <nickname>[@<server>] [<count>]
+
+               Gives a little history information about a client.
+
+       /INVITE <channel> [<nickname>[@server>]
+               [+|-[<nickname>[@<server>[!<username>[@hostname>]]]]]
+
+               Invites client to a channel or manages the invite list of
+               the channel.  The first <nickname> argument is used if an
+               client is invited to the channel.  The second +|-<nickname>
+               argument is used to either add or delete invite from the
+               channel's invite list.  Wildcards may be used with this
+               command.
+
+       /BAN    <channel> [+|-[<nickname>[@<server>[!<username>[@hostname>]]]]]
+
+               Manages the ban list of the channel.  Wildcards may be used
+               with this command.  You must be channel operator to be
+               able to use this command.
+
+        /KICK   <channel> <nickname>[@<server>] [<comment>]
+
+                Kicks client from channel. You have to be at least channel
+               operator to be able to kick client from channel.  Note:
+               you cannot kick channel founder even if you are channel
+               operator.
+
        /PING   [<server>]
 
                Pings server.  Only locally connected server may be 
@@ -112,6 +190,46 @@ Following commands has been, at least partly, implemented:
 
                Shows client version.
 
+       /OPER   <username> [<public key>]
+
+               Obtains server operator privileges.
+
+       /SILCOPER <username> [<public key>]
+
+               Obtains router operator privileges.
+
+       /KILL   <nickname> [<comment>]
+
+               Router operator can use this command to remove an client
+               from the SILC Network temporarily.
+
+       /CONNECT <server> [<port>]
+
+               Connects to server the remote <server>.  You must be
+               server operator to be able to do this.
+
+
+       /CLOSE  <server> [<port>]
+
+               Closes connection to the <server>.  You must be server
+               operator to be able to do this.
+
+       /SHUTDOWN
+
+               Shutdowns the server.  You must be server operator to be
+               able to do this.
+
+       /MOTD   [<server>]
+
+               Display the MOTD of the server.  If server is not specified
+               the current server is used.
+
+       /LIST   [<channel>]
+
+               Lists all channels in the current server, or the channel
+               specified.  If the channel cannot be found then all
+               channels are listed.
+
 
 Features
 ========
@@ -215,8 +333,8 @@ Contact
 Feedback and comments are welcome.  You can reach me in the following
 Address. 
 
-[Note that generally bug reports should not be sent just yet as the 
-Developer's Version is full of them and the bug hunt has not even started 
-yet.]
+Official SILC project web site is   : http://silc.pspt.fi
+FTP archive for SILC project is     : ftp://silc.pspt.fi/pub/silc/
+Development mailing list address is : silc-devel@lists.sourceforge.net
 
                                Pekka Riikonen <priikone@poseidon.pspt.fi>