X-Git-Url: http://git.silcnet.org/gitweb/?a=blobdiff_plain;f=README;fp=README;h=13e88e5ae66ab5e638a0eef252164a1cdcfbe7db;hb=01f3ed70ac686777ebfb992e062d65f2322d8998;hp=5b8b3e46138dee89ac6834ae18b23d8acd597034;hpb=8502294621066fa75975aaf1659dd0199e4282b5;p=crypto.git diff --git a/README b/README index 5b8b3e46..13e88e5a 100644 --- a/README +++ b/README @@ -29,314 +29,6 @@ server give the command: This will launch the server on to the background. -SILC Commands -============= - - - /SERVER [[:]] - - Connects to remote SILC server. - - /NICK [] - - 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 - - Joins to a channel. Channel names start with `#' - character. - - /LEAVE - - Leaves the channel. If /leave * is given the client - leaves the current channel. - - /CMODE +|- [{ }] - - 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 Set/unset channel's user limit - a Set/unset passphrase for channel that must - be provided when joining to the channel. - c Set/unset channel's cipher - h Set/unset channel's hmac - f <-pubkey| - Set/unset channel founder authentication. - Channel founder may set this mode so that - if the client leaves the channel it can - claim the founder rights when it returns - to the channel. If -pubkey is set then - the authentication will be done using the - client's public key. You can claim the - founder rights using the CUMODE command. - - 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 +|- [@] [-pubkey|] - - 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 [@] - - 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 [@] [-pubkey|] - - Set/Unset channel founder. If the -pubkey - option or is provided then the - client is claiming the founder rights by - providing the channel founder authentication - data. If the -pubkey is provided then the - authentication is performed using the - client's public key. If you are channel - founder you can set the channel founder - authentication using CMODE command. - - o [@] - - Set/unset channel operator. Requires that - you are channel operator or channel founder. - - /UMODE +|- - - Sets/unsets user mode. Note that some of the modes the - client cannot set itself. The following user modes are - available: - - a Unset all modes - s Unset server operator privileges - r Unset router operator privileges - g Set/unset to be gone (or use /AWAY command) - - - /MSG - - Sends private message to remote client. Support for - handling multiple same nicknames with /MSG command is - still missing. - - /WHOIS [@] [] - - Gives a little information about a client. Support for - handling multiple same nicknames with this command is - still missing. - - /WHOWAS [@] [] - - Gives a little history information about a client. - - /INVITE [[@server>] - [+|-[[@[![@hostname>]]]]] - - Invites client to a channel or manages the invite list of - the channel. The first argument is used if an - client is invited to the channel. The second +|- - argument is used to either add or delete invite from the - channel's invite list. Wildcards may be used with this - command. - - /BAN [+|-[[@[![@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 [@] [] - - 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 [] - - Pings server. Only locally connected server may be - pinged. - - /INFO [] - - Requests information about a server. If argument is - not specified current server is used. - - /AWAY [] - - 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. - - /OPER [] - - Obtains server operator privileges. - - /SILCOPER [] - - Obtains router operator privileges. - - /KILL [] - - Router operator can use this command to remove an client - from the SILC Network temporarily. - - /CONNECT [] - - Connects to server the remote . You must be - server operator to be able to do this. - - - /CLOSE [] - - Closes connection to the . 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 [] - - Display the MOTD of the server. If server is not specified - the current server is used. - - /LIST [] - - Lists all channels in the current server, or the channel - specified. If the channel cannot be found then all - channels are listed. - - /KEY msg|channel - set|unset|list|agreement|negotiate [] - - This command is used to set and unset private keys for - channels, set and unset private keys for private messages - with remote clients and to send key agreement requests and - negotiate the key agreement protocol with remote client. - The key agreement is supported only to negotiate private - message keys, it currently cannot be used to negotiate - private keys for channels, as it is not convenient for that - purpose. - - Types: - - msg The command is performed for private messages - affecting the . - - channel The command is performed for channel affecting - the . - - - Commands: - - set [ [] []] - - Set the key into use. If the is provided it - is used as the key material. If the 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 is `*' then - random key will be generated automatically. - - The may be set for both private message - and channel private keys and the may be set - only to the channel private keys. - - unset [] - - Unset the key. The private key is not used after - this command. The key must be set again or the key - material must be re-negotiated to be able to use - the private keys again. - - The channel may have several private keys set. The - can be used to indicate what key is being - unset. If it is not provided all keys are removed. - - - list List all private keys that has been set. - - If the type is `msg' and the is ยด*' then - all private message keys that you've set will be - listed. - - agreement [ []] - - Send key agreement request to remote client. If - the is provided it is sent in the request. - The receiver may use the hostname to start the - key agreement. If the is also provided your - key agreement protocol server is bound to that - port. Note that it cannot be privileged port (<1023). - If the and is not provided then - the receiver will never initiate the key agreement. - In this case you must start the key agreement after - receiving the reply to the request, by giving the - /KEYAGR start command. - - This command may be used to send reply to the - remote client. When receiving empty key agreement - you can reply to the sender with the hostname and - port of your key agreement server with this command. - - negotiate [ []] - - This may be called to start the key agreement with - . This command has effect only if the - has replied to your key agreement request. - You will see a notify on the screen when the reply - arrives. The and is the hostname - and port of the remote client's key agreement - server. - - /ME - - This command is used to send an action to the channel. - This equals to CTCP's ACTION (IRC's /ME) command. - - /NOTICE - - This command is used to send for example informational - notice messages to the channel. - - /GETKEY - - Fetches remote client's public key. - Features ========