Add doc/Contributing.txt to distribution archive
[ngircd-alex.git] / doc / Modes.txt
1
2                      ngIRCd - Next Generation IRC Server
3                            http://ngircd.barton.de/
4
5                (c)2001-2012 Alexander Barton and Contributors.
6                ngIRCd is free software and published under the
7                    terms of the GNU General Public License.
8
9                                -- Modes.txt --
10
11
12 This document lists the different user modes, channel modes, and channel
13 user modes that ngIRCd supports.
14
15
16 I. User Modes
17 ~~~~~~~~~~~~~
18
19 User modes are attributes a user has in the network, regardless of the
20 channels he is using at the moment.
21
22   mode  since   description
23
24   a     0.3.0   User is away.
25   B     20      User is flagged as a "bot".
26   c     17      IRC operator wants to receive connect/disconnect NOTICEs.
27   C     19      Only users that share a channel are allowed to send messages.
28   i     0.0.1   User is "invisible".
29   o     0.0.1   User is IRC operator.
30   r     0.0.1   User is restricted.
31   R (1) 19      User is registered (e.g. by NickServ).
32   s     0.4.0   User wants to receive server notices.
33   w     0.11.0  User wants to receive WALLOPS messages.
34   x     17      Hostname of this user is "cloaked".
35
36 II. Channel Modes
37 ~~~~~~~~~~~~~~~~~
38
39 Channel modes are attributes of specific channels which are valid for all
40 users joined (or trying to join) to this channel. Some modes add and remove
41 users to lists (e.g. "invite list", "ban list"), others have parameters
42 (like "channel key"), most are simple flags (like "moderated").
43
44   mode  since   description
45
46   b     0.5.0   Add/remove a host mask to the ban list.
47   e     19      Add/remove a host mask to the exception list.
48   i     0.5.0   Channel is "invite only".
49   I     0.5.0   Add/remove a host mask to the invite list.
50   k     0.6.0   Channel has a "key" (a password).
51   l     0.6.0   Channel has a user limit.
52   m     0.3.0   Channel is moderated, only "voiced" users can send messages.
53   M     20      Only registered users (and IRC Ops) can send messages.
54   n     0.3.0   Channel doesn't allow messages of users not being members.
55   O     18      Only IRC operators are allowed to join this channel.
56   P     0.5.0   Channel is "persistent".
57   r (1) 19      Channel is "registered" (e.g. by ChanServ).
58   R     19      Only registered users are allowed to join this channel.
59   s     0.9.0   Channel is "secret".
60   t     0.3.0   Only ChanOps are allowed to modify the channel topic.
61   z     16      Only users connected via SSL are allowed to join the channel.
62
63 III. Channel User Modes
64 ~~~~~~~~~~~~~~~~~~~~~~~
65
66 Channel user modes are attributes that a particular user has in a specific
67 channel of which he is a member.
68
69   mode  since   description
70
71   q     20      User is channel owner can only be set by a service, other
72                 owner and irc op. Can promote other users to q, a, o, h, v.
73   a     20      User is channel admin and can promote other users to v, h, o
74   o     0.2.0   User is channel operator and can op/kick/... other members.
75   h     20      User is half op and can set channel modes imntvIbek and kick
76                 voiced and normal users.
77   v     0.2.0   User is "voiced" and can speak even if channel is moderated.
78
79
80 Notes
81 ~~~~~
82
83 (1) This mode is not set by ngIRCd itself but by services. ngIRCd handles
84     the mode transparently and possibly adjusts its behaviour.