Created SILC Client Libary by moving stuff from silc/ directory.

[runtime.git] / README

diff --git a/README b/README
index 1953d9423e2a46defa991fd636baf96eab0493b4..a6933329f2e3044f5a8760e6dd43bb2c04fbb612 100644 (file)
--- a/README
+++ b/README
@@ -17,13 +17,102 @@ Description
 SILC (Secure Internet Live Conferencing) is a protocol which provides
 secure conferencing services in the Internet over insecure channel.
 SILC is IRC like softwarre although internally they are very different.
-Biggest similiarity between SILC and IRC is that they both provide
+Biggest similarity between SILC and IRC is that they both provide
 conferencing services and that SILC has almost same commands as IRC.  Other
 than that they are nothing alike.  Biggest differences are that SILC is 
 secure what IRC is not in any way.  The network model is also entirely
 different compared to IRC.
 
 
+Running SILC
+============
+
+The development version is still preliminary version and requires some
+work to get it working.  You should, first of all, check the example
+configuration files in ./doc/ directory.  Change them according to your
+needs.
+
+To run SILC client:
+
+       cd silc
+       ./silc -f <config file>
+
+To run SILC server
+
+       cd silcd
+       ./silcd -f <config file>
+
+
+Working Commands
+================
+
+Following commands has been, at least partly, implemented:
+
+
+       /SERVER [<server>[:<port>]]
+
+               Connects to remote SILC server.
+
+       /NICK   [<nickname>]
+
+               Changes/sets nickname.  Note that in SILC there can be
+               multiple same nicknames.  However, the logic on working
+               with multiple nicknames on user interface is pretty much
+               still missing.  Also note that nicknames in SILC are
+               case-sensitive.
+
+       /JOIN   <channel>
+
+               Joins to a channel.  Channel names start with `#'
+               character.
+
+       /LEAVE  <channel>
+
+               Leaves the channel.  If /leave * is given the client
+               leaves the current channel.
+
+       /MSG    <nickname> <message>
+
+               Sends private message to remote client.  Support for
+               handling multiple same nicknames with /MSG command is
+               still missing.
+
+       /WHOIS  <nickname>[@<server>] [<count>]
+
+               Gives a little information about a client.  Support for
+               handling multiple same nicknames with this command is
+               still missing.
+
+       /PING   [<server>]
+
+               Pings server.  Only locally connected server may be 
+               pinged.
+
+       /INFO   [<server>]
+
+               Requests information about a server.  If argument is
+               not specified current server is used.
+
+       /AWAY   [<message>]
+
+               Sets away message.  When private message is received and
+               away message is set the client automatically replies to
+               the sender with the away message.  To remove away message
+               give the command without arguments.
+
+       /QUIT
+
+               Quits session.  Connection to remote server is closed.
+
+       /CLEAR
+
+               Clears current screen.
+
+       /VERSION
+
+               Shows client version.
+
+
 Features
 ========
 
@@ -55,6 +144,8 @@ TODO file for more information.]
 
  o Supports data compression with GZIP to improve performance.
 
+ o Supports SOCKS4 and SOCKS5 firewall traversal protocols.
+
  o SIM (SILC Module) support.  Support for loading of shared objects at 
    run-time that provides new and extended features to both SILC client
    and server.  These can provide extra ciphers and extra features to