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