Merged silc_1_0_branch to trunk.
[silc.git] / apps / irssi / docs / help / in / cmode.in
1
2 @SYNTAX:cmode@
3
4 This command is used to manage the modes of the channel.  Most
5 of the modes require special privileges, such as channel operator
6 or channel founder privileges to work.  The mode is added by
7 adding + before the option(s) and removed by adding - before the
8 option(s).  The (*) mark below means that only founder may set/unset
9 that mode.  Other modes both channel operator and founder may manage.
10
11 The following modes are available:
12
13     p               Set/unset channel as private channel
14     s               Set/unset channel as secret channel
15     k               Enable/disable channel private key usage (*)
16     i               Set/unset channel as invite only channel
17     t               Set/unset that only channel operator or
18                     founder may set channel topic
19     m               Set/unset user silencing.  Normal users
20                     are not able to talk on channel. (*)
21     M               Set/unset operator silencing.  Operators
22                     are not able to talk on channel. (*)
23     l <limit>       Set/unset channel's user limit
24     a <passphrase>  Set/unset passphrase for channel that must
25                     be provided when joining to the channel. (*)
26     c <cipher>      Set/unset channel's cipher (*)
27     h <hmac>        Set/unset channel's hmac (*)
28     f [<pubkeyfile> <privkeyfile> [<privkey passphrase>]]
29                     Set/unset channel founder authentication. (*)
30                     Channel founder may set this mode so that
31                     if the client leaves the channel it can
32                     claim the founder rights when it returns
33                     to the channel, and to set the channel to
34                     be permanent channel.  You can claim the
35                     founder rights using CUMODE or JOIN commands.
36
37                     If the <pubkeyfile> and <privkeyfile> is
38                     provided then the <pubkeyfile> will the used
39                     as founder public key, and the private key
40                     is used to compute a signature for the SILC
41                     server.  If these are omitted then the default
42                     SILC keypair is used.  Normally you do not need
43                     to provide these arguments.
44     C [{[+|-]<pubkeyfile> }]                                (*)
45                     Set/unset channel public key mode, and add/remove
46                     channel publics key from the channel public key
47                     list.  When this mode is set only those users
48                     whose public keys has been added to the list are
49                     able to join the channel.  Channel founder may set
50                     this mode and operate on the channel public key
51                     list.
52
53                     To add public key to the list give command:
54                     CMODE +C +/path/to/the/public_key_file.pub
55
56                     To remove one public key from the list give
57                     command:
58                     CMODE +C -/path/to/the/public_key_file.pub
59
60                     To add or remove more than one public keys add as
61                     many public key file paths as necessary.
62
63                     When this mode is unset (-C), all public keys are
64                     removed from the list.  If +C is given without
65                     arguments the current channel public key list is
66                     displayed.
67
68 Multiple modes can be set/unset at once if the modes does not
69 require any arguments.  If mode requires an argument then only
70 one mode can be set at once.
71
72 When the +k (channel private key mode) mode is set the channel's
73 default cipher and HMAC are not used.  The private key (see /HELP KEY
74 for help how to set the private key) defines the cipher and HMAC for
75 the channel while +k mode is set.  Also the +c and +h modes are ignored
76 when channel private key is set.
77
78 See also: CUMODE, UMODE, JOIN, KEY