added basic ssl support to ircu
[ircu2.10.12-pk.git] / doc / snomask.html
1 <html>\r
2 <head>\r
3 <title>SNOMASK - Server Notice Masks</title>\r
4 </head>\r
5 <body bgcolor=#FFFFFF text=#000000 link=#700000 vlink=#404040>\r
6 <center>\r
7 <font face="arial">\r
8 <h2>SNOMASK - Server Notice Masks</h2></font>\r
9 <font face="arial" size="2">\r
10 Written by <a href="mailto:foxxe@trms.com">Ghostwolf</a> 18th June 1997<br>\r
11 Modified with permission by <a href="mailto:loki@undernet.org">loki</a> 12th November 1997\r
12 </center>\r
13 <p><hr width="80%" noshade>\r
14 \r
15 <blockquote>\r
16 This document (hopefully) gives a brief explanation of the use of server\r
17 notice masks new to ircu2.10.00. This mask allows clients to specify which\r
18 types of server notices they will receive when usermode +s. The mask may\r
19 optionally be omitted, and reasonable defaults will be used by the server.\r
20 <p>\r
21 Note: the descriptions here will be best understood by those with knowledge\r
22 of C syntax. We do not attempt to explain either this or hexadecimal values\r
23 in this document, and familiarity with these is assumed of the reader.\r
24 <p>\r
25 Usage:\r
26 </font><kbd><strong>\r
27 /mode &lt;nick&gt; +s [+/-][mask]</kbd></strong>\r
28 <font face="arial" size="2">\r
29 <p>\r
30 <center>\r
31 <table border=0 cellspacing=5 cellpadding=0 width=85%>\r
32 <tr align=center valign=middle>\r
33 <th align=left><font face="arial" size="2">Mask</th>\r
34 <th align=left>&nbsp;</th>\r
35 <th align=left><font face="arial" size="2">Hex value</th>\r
36 <th align=left><font face="arial" size="2">Description</th>\r
37 </tr>\r
38 <tr>\r
39 <td><font face="arial" size="2">1</td>\r
40 <td><font face="arial" size="2">SNO_OLDSNO</td>\r
41 <td><font face="arial" size="2">0x1</td>\r
42 <td><font face="arial" size="2">/* unsorted old messages */</td>\r
43 </tr>\r
44 <tr>\r
45 <td><font face="arial" size="2">2</td>\r
46 <td><font face="arial" size="2">SNO_SERVKILL</td>\r
47 <td><font face="arial" size="2">0x2</td>\r
48 <td><font face="arial" size="2">/* server kills (nick collisions) */</td>\r
49 </tr>\r
50 <tr>\r
51 <td><font face="arial" size="2">4</td>\r
52 <td><font face="arial" size="2">SNO_OPERKILL</td>\r
53 <td><font face="arial" size="2">0x4</td>\r
54 <td><font face="arial" size="2">/* oper kills */</td>\r
55 </tr>\r
56 <tr>\r
57 <td><font face="arial" size="2">8</td>\r
58 <td><font face="arial" size="2">SNO_HACK2</td>\r
59 <td><font face="arial" size="2">0x8</td>\r
60 <td><font face="arial" size="2">/* desyncs */</td>\r
61 </tr>\r
62 <tr>\r
63 <td><font face="arial" size="2">16</td>\r
64 <td><font face="arial" size="2">SNO_HACK3\r
65 <td><font face="arial" size="2">0x10</td>\r
66 <td><font face="arial" size="2">/* temporary desyncs */</td>\r
67 </tr>\r
68 <tr>\r
69 <td><font face="arial" size="2">32</td>\r
70 <td><font face="arial" size="2">SNO_UNAUTH</td>\r
71 <td><font face="arial" size="2">0x20</td>\r
72 <td><font face="arial" size="2">/* unauthorized connections */</td>\r
73 </tr>\r
74 <tr>\r
75 <td><font face="arial" size="2">64</td>\r
76 <td><font face="arial" size="2">SNO_TCPCOMMON</td>\r
77 <td><font face="arial" size="2">0x40</td>\r
78 <td><font face="arial" size="2">/* common TCP or socket errors */</td>\r
79 </tr>\r
80 <tr>\r
81 <td><font face="arial" size="2">128</td>\r
82 <td><font face="arial" size="2">SNO_TOOMANY</td>\r
83 <td><font face="arial" size="2">0x80</td>\r
84 <td><font face="arial" size="2">/* too many connections */</td>\r
85 </tr>\r
86 <tr>\r
87 <td><font face="arial" size="2">256</td>\r
88 <td><font face="arial" size="2">SNO_HACK4</td>\r
89 <td><font face="arial" size="2">0x100</td>\r
90 <td><font face="arial" size="2">/* Uworld actions on channels */</td>\r
91 </tr>\r
92 <tr>\r
93 <td><font face="arial" size="2">512</td>\r
94 <td><font face="arial" size="2">SNO_GLINE</td>\r
95 <td><font face="arial" size="2">0x200</td>\r
96 <td><font face="arial" size="2">/* glines */</td>\r
97 </tr>\r
98 <tr>\r
99 <td><font face="arial" size="2">1024</td>\r
100 <td><font face="arial" size="2">SNO_NETWORK</td>\r
101 <td><font face="arial" size="2">0x400</td>\r
102 <td><font face="arial" size="2">/* net join/break, etc */</td>\r
103 </tr>\r
104 <tr>\r
105 <td><font face="arial" size="2">2048</td>\r
106 <td><font face="arial" size="2">SNO_IPMISMATCH</td>\r
107 <td><font face="arial" size="2">0x800</td>\r
108 <td><font face="arial" size="2">/* IP mismatches */</td>\r
109 </tr>\r
110 <tr>\r
111 <td><font face="arial" size="2">4096</td>\r
112 <td><font face="arial" size="2">SNO_THROTTLE</td>\r
113 <td><font face="arial" size="2">0x1000</td>\r
114 <td><font face="arial" size="2">/* host throttle add/remove notices */</td>\r
115 </tr>\r
116 <tr>\r
117 <td><font face="arial" size="2">8192</td>\r
118 <td><font face="arial" size="2">SNO_OLDREALOP</td>\r
119 <td><font face="arial" size="2">0x2000</td>\r
120 <td><font face="arial" size="2">/* old oper-only messages */</td>\r
121 </tr>\r
122 <tr>\r
123 <td><font face="arial" size="2">16384</td>\r
124 <td><font face="arial" size="2">SNO_CONNEXIT</td>\r
125 <td><font face="arial" size="2">0x4000</td>\r
126 <td><font face="arial" size="2">/* client connect/exit (ugh) */</td>\r
127 </tr>\r
128 <tr>\r
129 <td><font face="arial" size="2">32768</td>\r
130 <td><font face="arial" size="2">SNO_AUTO</td>\r
131 <td><font face="arial" size="2">0x8000</td>\r
132 <td><font face="arial" size="2">/* AUTO G-Lines */</td>\r
133 </tr>\r
134 <tr>\r
135 <td><font face="arial" size="2">65536</td>\r
136 <td><font face="arial" size="2">SNO_DEBUG</td>\r
137 <td><font face="arial" size="2">0x10000</td>\r
138 <td><font face="arial" size="2">/* debugging messages (DEBUGMODE only) */</td>\r
139 </tr>\r
140 <tr>\r
141 <td><font face="arial" size="2">131072</td>\r
142 <td><font face="arial" size="2">SNO_AUTH</td>\r
143 <td><font face="arial" size="2">0x20000</td>\r
144 <td><font face="arial" size="2">/* iauth status messages */</td>\r
145 </tr>\r
146 </table>\r
147 </center>\r
148 \r
149 <p>\r
150 \r
151 <table border=0 cellpadding=0 cellspacing=5 width=90%>\r
152 <tr>\r
153 <td><font face="arial" size="2">standard +s</td>\r
154 <td><font face="arial" size="2">SNO_DEFAULT (SNO_NETWORK | SNO_OPERKILL | SNO_GLINE)</td>\r
155 </tr>\r
156 <tr>\r
157 <td><font face="arial" size="2">standard +s when +o/O</td>\r
158 <td><font face="arial" size="2">SNO_DEFAULT | SNO_HACK2 | SNO_HACK4 | SNO_THROTTLE | SNO_OLDSNO)</td>\r
159 </tr>\r
160 <tr>\r
161 <td><font face="arial" size="2">only opers may set</td>\r
162 <td><font face="arial" size="2">SNO_OPER (SNO_CONNEXIT | SNO_OLDREALOP | SNO_AUTH)</td>\r
163 </tr>\r
164 </table>\r
165 \r
166 <p><hr width="80%" noshade>\r
167 <h3 align=center>Examples of Usage</h3>\r
168 To receive only operkills, use /mode <nick> +s 4<br>\r
169 To receive operkills and glines, add the values:\r
170 </font>\r
171 <blockquote><kbd><strong>\r
172 /mode &lt;nick&gt; +s 516</kbd></strong><p>\r
173 <font face="arial" size="2">\r
174 (512+4=516)\r
175 </blockquote>\r
176 <p>\r
177 If you are already receiving some notices and you wish to add notices of\r
178 netjoins/breaks use:\r
179 </font>\r
180 <blockquote><kbd><strong>\r
181 /mode Ghostwolf +s +1024</kbd></strong><p>\r
182 </blockquote>\r
183 <font face="arial" size="2">\r
184 <p>\r
185 If you wish to stop receiving netjoin/break notices, but continue to receive\r
186 other notices, use:\r
187 </font>\r
188 <blockquote><kbd><strong>\r
189 /mode Ghostwolf +s -1024<br>\r
190  OR<br>\r
191 /mode Ghostwolf -s +1024</kbd></strong>\r
192 </blockquote>\r
193 <font face="arial" size="2">\r
194 <p>\r
195 A user typing <strong>/mode Ghostwolf +s </strong>will receive netsplits/joins, operkills, and g-lines.<p>\r
196 \r
197 Opers who are +s will additionally receive HACK notices and anything that\r
198 was originally in sendto_ops() and wasn't changed. Only opers can choose to\r
199 receive connect/exit notices and anything that originally was in\r
200 sendtoreal_ops() and hasn't been changed (connect/exit notices also require\r
201 a #define in config.h).\r
202 <p>\r
203 </font><center>\r
204 <hr width=80% noshade><font size=-1><strong>\r
205 If you have further questions about server notices (implementation, etc.),<br>\r
206 please consult the ircu source code and/or e-mail <a\r
207 href="mailto:coder-com@undernet.org">coder-com@undernet.org</a>.\r
208 </strong></font></center>\r
209 <hr width="80%" noshade><p>\r
210 \r
211 <p align="right">\r
212 <em>\r
213 <font face="times new roman" font size="-1">\r
214 Return to <a href="http://www.user-com.undernet.org/documents/" target="nfo">main Documents Project page</a><br>\r
215 </em>\r
216 </font>\r
217 \r
218 </body>\r
219 </html>\r
220 \r
221 \r