Merged from silc_1_0_branch.
[silc.git] / doc / silc.yo
index 968a632cd38ab8bb40e89a88c0b510f46787d40f..726b0a70eafeb8d5ee8cce7bda70a8164b92e039 100644 (file)
@@ -1,4 +1,4 @@
-manpage(SILC) (1) (October 31 2002) (silc-client-0.9.7) (silc-client)
+manpage(SILC) (1) (December 7 2002) (silc-client) (silc-client)
 
 
 manpagename(silc) (client for SILC, a secure and flexible conferencing network)
@@ -16,18 +16,20 @@ the SILC network.  The silc client resembles IRC clients to make the
 using easier for new users.
 
 bf(Silc) supports sending of practically any kind of messages in addition
-of normal text messages in the SILC network.  The session to SILC server
+of normal text messages in the SILC network.  This includes multimedia
+messages like images, video and audio stream.  The session to SILC server
 is secured with session key, channel messages are protected with channel
 key and private messages with session keys.  It is also possible to use
-private channel keys and private message keys in addition of server
-generated keys.
+private channel keys and private message keys in addition to server
+generated keys.  It is also possible to digitally sign all messages.
 
-bf(Silc) supports em(passphrase) and public key authentication based on
-em(digital signatures), when connecting to SILC server.  bf(Silc) also supports
-key exchange (key agreement) between other bf(Silc) users in the SILC
-network to negotiate secret key material.  This key material then can be
-used to secure for example private messages.  It is also possible to exchange
-public keys and certificates in the SILC network between clients and servers.
+bf(Silc) supports em(passphrase) authentication and public key authentication
+based on em(digital signatures), when connecting to SILC server.  bf(Silc)
+also supports key exchange (key agreement) between other bf(Silc) users in
+the SILC network to negotiate secret key material.  This key material then
+can be used to secure for example private messages.  It is also possible to
+exchange public keys and certificates in the SILC network between clients
+and servers.
 
 The bf(silc) also supports em(detaching) from the SILC network by closing
 the connection to the server but without quitting from the network.  Next
@@ -40,24 +42,24 @@ same nickname than before detaching and remains on all channels, and it
 seems like user never left the network.
 
 The bf(silc) also supports creation of em(friends) list, which is kind of
-buddy list familiar from IM (Instant Messaging) clients.  By using the
-bf(WHOIS) SILC command with em(-details) option it possible to fetch the
+buddy list familiar from IM (Instant Messaging) clients.  By using the
+bf(WHOIS) SILC command with em(-details) option it is possible to fetch the
 user's information such as their public keys and certificates, business
 card, pictures, and other information and save them to the friends list.
 The friends list is located at bf(~/.silc/friends/) directory.
 
 The SILC public key and private key pair is used to authenticate the user
 to the SILC server when connecting a server.  This key pair is created
-automatically when the bf(silc) is run for the first time.  It also can
+automatically when the bf(silc) is run for the first time.  It can also
 be created with bf(-C) option.
 
 When connecting for the first time to SILC server, user will be asked to
 accept the server's public key.  When key is accepted the bf(silc) saves
 the public key for future into bf(~/.silc/serverkeys/) directory.  The
 next time user connects to same server the public key is verified against
-the saved public key.  The purposeof this public key saving is to avoid
+the saved public key.  The purpose of this public key saving is to avoid
 man-in-the-middle attacks which could be possible if the key would have
-to be verified everytime user connects to the server.
+to be verified every time user connects to the server.
 
 manpageoptions()
 bf(-c) em(host)      Connect to given host
@@ -135,6 +137,29 @@ bf(--pkcs)=em(PKCS)       Set the public key algorithm of key pair.  For example
 bf(--bits)=em(VALUE)       Set the length of public key pair, in bits.
 
 
+manpagesection(CONFIGURATION FILE)
+The bf(silc) configuration file is bf(~/.silc/silc.conf) and can be used
+to configure the behaviour of the client.  The configuration file format
+is equivalent to Irssi IRC client's configuration file.  See the 
+documentation for the configuration file at bf(http://irssi.org).
+
+There are a few bf(silc) configuration settings in em(silc.conf) which
+can be configured in em(settings) section under em("server") block.
+They can be set also with the bf(/SET) command in the bf(silc) client.
+
+bf(crypto_default_cipher)
+quote(The default cipher to use to secure the session to the server.
+Values can be for example bf(aes-256-cbc), bf(aes-192-cbc), bf(aes-128-cbc),
+bf(twofish-256-cbc), bf(twofish-192-cbc), bf(twofish-128-cbc).)
+
+bf(crypto_default_hash)
+quote(The default hash function to use in session with the server. Values
+can be bf(sha1) or bf(md5).)
+
+bf(crypto_default_hmac)
+quote(The default HMAC to be use in session with the server.  Value can
+be bf(hmac-sha1-96), bf(hmac-md5-96), bf(hmac-sha1) or bf(hmac-md5).)
+
 
 manpagefiles()
 bf(~/.silc/silc.conf)
@@ -147,12 +172,12 @@ bf(~/.silc/private_key.pub)
 quote(The SILC private key of the user)
 
 bf(~/.silc/clientkeys/)
-quote(The directory holding the public keys of other users the user have
+quote(The directory holding the public keys of other users the user has
 accepted and trusted in the SILC network.  The public keys can be received
 with bf(GETKEY) SILC command or during key agreement between two users.)
 
-bf(~/.silc/clientkeys/)
-quote(The directory holding the public keys of servers the user have accepted
+bf(~/.silc/serverkeys/)
+quote(The directory holding the public keys of servers the user has accepted
 and trusted when connecting to a server.)
 
 bf(~/.silc/friends/)
@@ -163,7 +188,7 @@ other information.)
 
 
 manpageseealso()
-bf(silcd(8)) bf(silc(1))
+bf(silcd(8)) bf(silcd.conf(5))
 
 
 manpagesection(NETWORK RESOURCES)