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.  Private
  14                     channels are shown with LIST command with an
  15                     indication the channel is private.  Private
  16                     channel is not shown on user's joined channel
  17                     list (with for example WHOIS command).
  18
  19     s               Set/unset channel as secret channel.  Secret
  20                     channels are entirely invisible.  They are not
  21                     shown with LIST command and they do not appear
  22                     in user's joined channel list.
  23
  24     k               Enable/disable private channel key usage.   (*)
  25                     When enabled KEY command may be used to set
  26                     private channel key(s) on the channel.
  27
  28     i               Set/unset channel as invite only channel.  If
  29                     you are the founder of the channel you will
  30                     still be able to join the channel by giving
  31                     command /JOIN channel -founder.
  32
  33     t               Set/unset that only channel operator or
  34                     founder may set channel topic
  35
  36     m               Set/unset user silencing.  Normal users
  37                     are not able to talk on channel.            (*)
  38
  39     M               Set/unset operator silencing.  Operators
  40                     are not able to talk on channel.            (*)
  41
  42     l <limit>       Set/unset channel's user count limit
  43
  44     a <passphrase>  Set/unset passphrase for channel that must
  45                     be provided when joining to the channel.    (*)
  46
  47     c <cipher>      Set/unset channel's cipher                  (*)
  48
  49     h <hmac>        Set/unset channel's HMAC                    (*)
  50
  51     f [<pubkeyfile> <privkeyfile> [<privkey passphrase>]]
  52                     Set/unset channel founder authentication.   (*)
  53                     Channel founder may set this mode so that
  54                     when the client leaves the channel it can
  55                     claim the founder rights when it returns
  56                     to the channel, and to set the channel to
  57                     be permanent channel.  You can reclaim the
  58                     founder rights using CUMODE or JOIN commands.
  59
  60                     If the <pubkeyfile> and <privkeyfile> is
  61                     provided then the <pubkeyfile> will the used
  62                     as founder public key, and the private key
  63                     is used to compute a signature for the SILC
  64                     server.  If these are omitted then the default
  65                     SILC keypair is used.  Normally you do not need
  66                     to provide these arguments.
  67
  68     C [{[+|-]<pubkeyfile> }]                                    (*)
  69                     Set/unset channel public key mode, and add/remove
  70                     channel publics key from the channel public key
  71                     list.  When this mode is set only those users
  72                     whose public keys has been added to the list are
  73                     able to join the channel.  Channel founder may set
  74                     this mode and operate on the channel public key
  75                     list.
  76
  77                     To add public key to the list give command:
  78                     CMODE +C +/path/to/the/public_key_file.pub
  79
  80                     To remove one public key from the list give
  81                     command:
  82                     CMODE +C -/path/to/the/public_key_file.pub
  83
  84                     To add or remove more than one public keys add as
  85                     many public key file paths as necessary.
  86
  87                     When this mode is unset (-C), all public keys are
  88                     removed from the list.  If +C is given without
  89                     arguments the current channel public key list is
  90                     displayed.
  91
  92 Multiple modes can be set/unset at once if the modes does not
  93 require any arguments.  If mode requires an argument then only
  94 one mode can be set at once.
  95
  96 When the +k (private channel key mode) mode is set the channel's
  97 default cipher and HMAC are not used.  The private key (see /HELP KEY
  98 for help how to set the private channel key) defines the cipher and HMAC
  99 for the channel while +k mode is set.  Also the +c and +h modes are
 100 ignored when private channel key mode is set.
 101
 102 Examples:
 103
 104   Set the channel a permanent (persistent).  The channel won't be
 105   deleted when last user leaves the channel.  When you as the founder
 106   leave the channel you will be able to reclaim the founder rights later.
 107
 108     /CMODE * +f
 109
 110   Reclaim founder rights (and operator privileges) for you channel:
 111
 112     /CUMODE * +of mynick
 113
 114   You can do the same during joining:
 115
 116     /JOIN yourchannel -founder
 117
 118   Change channel founder keypair on your channel.  You can do this if
 119   you want to transfer founder rights to some other user or if you
 120   created new keypair.  The operation requires that you have a copy of
 121   the old keypair:
 122
 123     /CUMODE * +f mynick /path/to/old/pubkey /path/to/old/privkey
 124     /CMODE * +f /path/to/new/pubkey /path/to/new/privkey
 125
 126   or simply /CMODE * +f if you are already using the new keypair.
 127
 128   Here's how to transfer founder rights to different user using
 129   temporary keypair:
 130
 131     Create temporary keypair:
 132
 133       # silc -C
 134
 135     Become founder on your channel:
 136
 137       /CUMODE * +f mynick
 138
 139     Set the temporary keypair on the channel and then send the key
 140     pair to your friend with /FILE command or with encrypted Email:
 141
 142       /CMODE * +f /path/to/temp/pubkey /path/to/temp/privkey
 143       (/FILE send /path/to/temp/keypair.tgz yourfriend)
 144
 145     Tell your friend to give the following command to become founder:
 146
 147       /CUMODE * +f yourfriend /path/to/temp/pubkey /path/to/temp/privkey
 148
 149     Your friend then sets his own keypair on the channel:
 150
 151       /CMODE * +f
 152
 153     After this the temporary keypair can be removed and your friend has
 154     become the founder of the channel.  This way the founder rights can
 155     be transferred without ever revealing your own keypair.  When your
 156     friend becomes the founder your founder rights will be removed by
 157     the server automatically.  It is also possible to continue using the
 158     temporary keypair, thus sharing founder rights with two or more users.
 159     Note that it is possible for only one user at a time to have founder
 160     mode on the channel even if they share the keypair.
 161
 162 See also: CUMODE, UMODE, JOIN, KEY