1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
2 |
<html> |
3 |
<head> |
4 |
<meta http-equiv=Content-Type content="text/html; charset=iso-8859-1"> |
5 |
<title>IRC Services Manual - Appendix B. XML data format description</title> |
6 |
</head> |
7 |
|
8 |
<body> |
9 |
<a name=top></a> |
10 |
<h1 align=center>IRC Services Manual</h1> |
11 |
|
12 |
<h2 align=center>Appendix B. XML data format description</h2> |
13 |
|
14 |
<p>B-1. <a href="#1">Data file structure</a> |
15 |
<br>B-2. <a href="#2">Tag index</a> |
16 |
|
17 |
<p align=right><font size=-1><a href="index.html">Table of Contents</a></font> |
18 |
|
19 |
<!------------------------------------------------------------------------> |
20 |
<p><hr> |
21 |
|
22 |
<a name=1></a> |
23 |
<h3>B-1. Data file structure</h3> |
24 |
|
25 |
<p>The example data below shows the structure of the XML data used by |
26 |
Services; click on a tag for information about that tag (from the |
27 |
<a href="#2">tag index</a> below). An ellipsis (<tt>...</tt>) indicates |
28 |
where data is entered. |
29 |
|
30 |
<p> |
31 |
<pre> |
32 |
<<a href="#ircservices-db">ircservices-db</a>> |
33 |
<<a href="#constants">constants</a>> |
34 |
<<A HREF="#LANG_DEFAULT">LANG_DEFAULT</A>>...</<A HREF="#LANG_DEFAULT">LANG_DEFAULT</A>> |
35 |
<<A HREF="#CHANMAX_UNLIMITED">CHANMAX_UNLIMITED</A>>...</<A HREF="#CHANMAX_UNLIMITED">CHANMAX_UNLIMITED</A>> |
36 |
<<A HREF="#CHANMAX_DEFAULT">CHANMAX_DEFAULT</A>>...</<A HREF="#CHANMAX_DEFAULT">CHANMAX_DEFAULT</A>> |
37 |
<<A HREF="#TIMEZONE_DEFAULT">TIMEZONE_DEFAULT</A>>...</<A HREF="#TIMEZONE_DEFAULT">TIMEZONE_DEFAULT</A>> |
38 |
<<A HREF="#ACCLEV_FOUNDER">ACCLEV_FOUNDER</A>>...</<A HREF="#ACCLEV_FOUNDER">ACCLEV_FOUNDER</A>> |
39 |
<<A HREF="#ACCLEV_INVALID">ACCLEV_INVALID</A>>...</<A HREF="#ACCLEV_INVALID">ACCLEV_INVALID</A>> |
40 |
<<A HREF="#ACCLEV_SOP">ACCLEV_SOP</A>>...</<A HREF="#ACCLEV_SOP">ACCLEV_SOP</A>> |
41 |
<<A HREF="#ACCLEV_AOP">ACCLEV_AOP</A>>...</<A HREF="#ACCLEV_AOP">ACCLEV_AOP</A>> |
42 |
<<A HREF="#ACCLEV_HOP">ACCLEV_HOP</A>>...</<A HREF="#ACCLEV_HOP">ACCLEV_HOP</A>> |
43 |
<<A HREF="#ACCLEV_VOP">ACCLEV_VOP</A>>...</<A HREF="#ACCLEV_VOP">ACCLEV_VOP</A>> |
44 |
<<A HREF="#ACCLEV_NOP">ACCLEV_NOP</A>>...</<A HREF="#ACCLEV_NOP">ACCLEV_NOP</A>> |
45 |
<<A HREF="#MEMOMAX_UNLIMITED">MEMOMAX_UNLIMITED</A>>...</<A HREF="#MEMOMAX_UNLIMITED">MEMOMAX_UNLIMITED</A>> |
46 |
<<A HREF="#MEMOMAX_DEFAULT">MEMOMAX_DEFAULT</A>>...</<A HREF="#MEMOMAX_DEFAULT">MEMOMAX_DEFAULT</A>> |
47 |
<<A HREF="#NEWS_LOGON">NEWS_LOGON</A>>...</<A HREF="#NEWS_LOGON">NEWS_LOGON</A>> |
48 |
<<A HREF="#NEWS_OPER">NEWS_OPER</A>>...</<A HREF="#NEWS_OPER">NEWS_OPER</A>> |
49 |
<<A HREF="#MD_AKILL">MD_AKILL</A>>...</<A HREF="#MD_AKILL">MD_AKILL</A>> |
50 |
<<A HREF="#MD_EXCLUSION">MD_EXCLUDE</A>>...</<A HREF="#MD_EXCLUDE">MD_EXCLUDE</A>> |
51 |
<<A HREF="#MD_EXCEPTION">MD_EXCEPTION</A>>...</<A HREF="#MD_EXCEPTION">MD_EXCEPTION</A>> |
52 |
<<A HREF="#MD_SGLINE">MD_SGLINE</A>>...</<A HREF="#MD_SGLINE">MD_SGLINE</A>> |
53 |
<<A HREF="#MD_SQLINE">MD_SQLINE</A>>...</<A HREF="#MD_SQLINE">MD_SQLINE</A>> |
54 |
<<A HREF="#MD_SZLINE">MD_SZLINE</A>>...</<A HREF="#MD_SZLINE">MD_SZLINE</A>> |
55 |
</<a href="#constants">constants</a>> |
56 |
<<a href="#maxusercnt">maxusercnt</a>>...</<a href="#maxusercnt">maxusercnt</a>> |
57 |
<<a href="#maxusertime">maxusertime</a>>...</<a href="#maxusertime">maxusertime</a>> |
58 |
<<a href="#supass">supass</a> [cipher="..."]>...</<a href="#supass">supass</a>> |
59 |
<<a href="#nickgroupinfo">nickgroupinfo</a>> |
60 |
<<a href="#id">id</a>>...</<a href="#id">id</a>> |
61 |
<<a href="#nicks">nicks</a> count='...'> |
62 |
<<a href="#array-element">array-element</a>>...</<a href="#array-element">array-element</a>> |
63 |
</<a href="#nicks">nicks</a>> |
64 |
<<a href="#mainnick">mainnick</a>>...</<a href="#mainnick">mainnick</a>> |
65 |
<<a href="#pass">pass</a> [cipher="..."]>...</<a href="#pass">pass</a>> |
66 |
<<a href="#url">url</a>>...</<a href="#url">url</a>> |
67 |
<<a href="#email">email</a>>...</<a href="#email">email</a>> |
68 |
<<a href="#last_email">last_email</a>>...</<a href="#last_email">last_email</a>> |
69 |
<<a href="#info">info</a>>...</<a href="#info">info</a>> |
70 |
<<a href="#flags">flags</a>>...</<a href="#flags">flags</a>> |
71 |
<<a href="#os_priv">os_priv</a>>...</<a href="#os_priv">os_priv</a>> |
72 |
<<a href="#authcode">authcode</a>>...</<a href="#authcode">authcode</a>> |
73 |
<<a href="#authset">authset</a>>...</<a href="#authset">authset</a>> |
74 |
<<a href="#authreason">authreason</a>>...</<a href="#authreason">authreason</a>> |
75 |
<<a href="#suspend_who">suspend_who</a>>...</<a href="#suspend_who">suspend_who</a>> |
76 |
<<a href="#suspend_reason">suspend_reason</a>>...</<a href="#suspend_reason">suspend_reason</a>> |
77 |
<<a href="#suspend_time">suspend_time</a>>...</<a href="#suspend_time">suspend_time</a>> |
78 |
<<a href="#suspend_expires">suspend_expires</a>>...</<a href="#suspend_expires">suspend_expires</a>> |
79 |
<<a href="#language">language</a>>...</<a href="#language">language</a>> |
80 |
<<a href="#timezone">timezone</a>>...</<a href="#timezone">timezone</a>> |
81 |
<<a href="#channelmax">channelmax</a>>...</<a href="#channelmax">channelmax</a>> |
82 |
<<a href="#access">access</a> count='...'> |
83 |
<<a href="#array-element">array-element</a>>...</<a href="#array-element">array-element</a>> |
84 |
</<a href="#access">access</a>> |
85 |
<<a href="#ajoin">ajoin</a> count='...'> |
86 |
<<a href="#array-element">array-element</a>>...</<a href="#array-element">array-element</a>> |
87 |
</<a href="#ajoin">ajoin</a>> |
88 |
<<a href="#memoinfo">memoinfo</a>> |
89 |
<<a href="#memos">memos</a> count='...'> |
90 |
<<a href="#memo">memo</a>> |
91 |
<<a href="#number">number</a>>...</<a href="#number">number</a>> |
92 |
<<a href="#flags">flags</a>>...</<a href="#flags">flags</a>> |
93 |
<<a href="#time">time</a>>...</<a href="#time">time</a>> |
94 |
<<a href="#sender">sender</a>>...</<a href="#sender">sender</a>> |
95 |
<<a href="#channel">channel</a>>...</<a href="#channel">channel</a>> |
96 |
<<a href="#text">text</a>>...</<a href="#text">text</a>> |
97 |
</<a href="#memo">memo</a>> |
98 |
</<a href="#memos">memos</a>> |
99 |
<<a href="#memomax">memomax</a>>...</<a href="#memomax">memomax</a>> |
100 |
</<a href="#memoinfo">memoinfo</a>> |
101 |
<<a href="#ignore">ignore</a> count='...'> |
102 |
<<a href="#array-element">array-element</a>>...</<a href="#array-element">array-element</a>> |
103 |
</<a href="#ignore">ignore</a>> |
104 |
</<a href="#nickgroupinfo">nickgroupinfo</a>> |
105 |
<<a href="#nickinfo">nickinfo</a>> |
106 |
<<a href="#nick">nick</a>>...</<a href="#nick">nick</a>> |
107 |
<<a href="#status">status</a>>...</<a href="#status">status</a>> |
108 |
<<a href="#last_usermask">last_usermask</a>>...</<a href="#last_usermask">last_usermask</a>> |
109 |
<<a href="#last_realmask">last_realmask</a>>...</<a href="#last_realmask">last_realmask</a>> |
110 |
<<a href="#last_realname">last_realname</a>>...</<a href="#last_realname">last_realname</a>> |
111 |
<<a href="#last_quit">last_quit</a>>...</<a href="#last_quit">last_quit</a>> |
112 |
<<a href="#time_registered">time_registered</a>>...</<a href="#time_registered">time_registered</a>> |
113 |
<<a href="#last_seen">last_seen</a>>...</<a href="#last_seen">last_seen</a>> |
114 |
<<a href="#nickgroup">nickgroup</a>>...</<a href="#nickgroup">nickgroup</a>> |
115 |
</<a href="#nickinfo">nickinfo</a>> |
116 |
<<a href="#channelinfo">channelinfo</a>> |
117 |
<<a href="#name">name</a>>...</<a href="#name">name</a>> |
118 |
<<a href="#founder">founder</a>>...</<a href="#founder">founder</a>> |
119 |
<<a href="#successor">successor</a>>...</<a href="#successor">successor</a>> |
120 |
<<a href="#founderpass">founderpass</a> [cipher="..."]>...</<a href="#founderpass">founderpass</a>> |
121 |
<<a href="#desc">desc</a>>...</<a href="#desc">desc</a>> |
122 |
<<a href="#url">url</a>>...</<a href="#url">url</a>> |
123 |
<<a href="#email">email</a>>...</<a href="#email">email</a>> |
124 |
<<a href="#time_registered">time_registered</a>>...</<a href="#time_registered">time_registered</a>> |
125 |
<<a href="#last_used">last_used</a>>...</<a href="#last_used">last_used</a>> |
126 |
<<a href="#last_topic">last_topic</a>>...</<a href="#last_topic">last_topic</a>> |
127 |
<<a href="#last_topic_setter">last_topic_setter</a>>...</<a href="#last_topic_setter">last_topic_setter</a>> |
128 |
<<a href="#last_topic_time">last_topic_time</a>>...</<a href="#last_topic_time">last_topic_time</a>> |
129 |
<<a href="#flags">flags</a>>...</<a href="#flags">flags</a>> |
130 |
<<a href="#suspend_who">suspend_who</a>>...</<a href="#suspend_who">suspend_who</a>> |
131 |
<<a href="#suspend_reason">suspend_reason</a>>...</<a href="#suspend_reason">suspend_reason</a>> |
132 |
<<a href="#suspend_time">suspend_time</a>>...</<a href="#suspend_time">suspend_time</a>> |
133 |
<<a href="#suspend_expires">suspend_expires</a>>...</<a href="#suspend_expires">suspend_expires</a>> |
134 |
<<a href="#levels">levels</a>> |
135 |
<<A HREF="#CA_INVITE">CA_INVITE</A>>...</<A HREF="#CA_INVITE">CA_INVITE</A>> |
136 |
<<A HREF="#CA_AKICK">CA_AKICK</A>>...</<A HREF="#CA_AKICK">CA_AKICK</A>> |
137 |
<<A HREF="#CA_SET">CA_SET</A>>...</<A HREF="#CA_SET">CA_SET</A>> |
138 |
<<A HREF="#CA_UNBAN">CA_UNBAN</A>>...</<A HREF="#CA_UNBAN">CA_UNBAN</A>> |
139 |
<<A HREF="#CA_AUTOOP">CA_AUTOOP</A>>...</<A HREF="#CA_AUTOOP">CA_AUTOOP</A>> |
140 |
<<A HREF="#CA_AUTODEOP">CA_AUTODEOP</A>>...</<A HREF="#CA_AUTODEOP">CA_AUTODEOP</A>> |
141 |
<<A HREF="#CA_AUTOVOICE">CA_AUTOVOICE</A>>...</<A HREF="#CA_AUTOVOICE">CA_AUTOVOICE</A>> |
142 |
<<A HREF="#CA_OPDEOP">CA_OPDEOP</A>>...</<A HREF="#CA_OPDEOP">CA_OPDEOP</A>> |
143 |
<<A HREF="#CA_ACCESS_LIST">CA_ACCESS_LIST</A>>...</<A HREF="#CA_ACCESS_LIST">CA_ACCESS_LIST</A>> |
144 |
<<A HREF="#CA_CLEAR">CA_CLEAR</A>>...</<A HREF="#CA_CLEAR">CA_CLEAR</A>> |
145 |
<<A HREF="#CA_NOJOIN">CA_NOJOIN</A>>...</<A HREF="#CA_NOJOIN">CA_NOJOIN</A>> |
146 |
<<A HREF="#CA_ACCESS_CHANGE">CA_ACCESS_CHANGE</A>>...</<A HREF="#CA_ACCESS_CHANGE">CA_ACCESS_CHANGE</A>> |
147 |
<<A HREF="#CA_MEMO">CA_MEMO</A>>...</<A HREF="#CA_MEMO">CA_MEMO</A>> |
148 |
<<A HREF="#CA_VOICE">CA_VOICE</A>>...</<A HREF="#CA_VOICE">CA_VOICE</A>> |
149 |
<<A HREF="#CA_AUTOHALFOP">CA_AUTOHALFOP</A>>...</<A HREF="#CA_AUTOHALFOP">CA_AUTOHALFOP</A>> |
150 |
<<A HREF="#CA_HALFOP">CA_HALFOP</A>>...</<A HREF="#CA_HALFOP">CA_HALFOP</A>> |
151 |
<<A HREF="#CA_AUTOPROTECT">CA_AUTOPROTECT</A>>...</<A HREF="#CA_AUTOPROTECT">CA_AUTOPROTECT</A>> |
152 |
<<A HREF="#CA_PROTECT">CA_PROTECT</A>>...</<A HREF="#CA_PROTECT">CA_PROTECT</A>> |
153 |
</<a href="#levels">levels</a>> |
154 |
<<a href="#chanaccesslist">chanaccesslist</a> count='...'> |
155 |
<<a href="#chanaccess">chanaccess</a>> |
156 |
<<a href="#nickgroup">nickgroup</a>>...</<a href="#nickgroup">nickgroup</a>> |
157 |
<<a href="#level">level</a>>...</<a href="#level">level</a>> |
158 |
</<a href="#chanaccess">chanaccess</a>> |
159 |
</<a href="#chanaccesslist">chanaccesslist</a>> |
160 |
<<a href="#akicklist">akicklist</a> count='...'> |
161 |
<<a href="#akick">akick</a>> |
162 |
<<a href="#mask">mask</a>>...</<a href="#mask">mask</a>> |
163 |
<<a href="#reason">reason</a>>...</<a href="#reason">reason</a>> |
164 |
<<a href="#who">who</a>>...</<a href="#who">who</a>> |
165 |
<<a href="#set">set</a>>...</<a href="#set">set</a>> |
166 |
<<a href="#lastused">lastused</a>>...</<a href="#lastused">lastused</a>> |
167 |
</<a href="#akick">akick</a>> |
168 |
</<a href="#akicklist">akicklist</a>> |
169 |
<<a href="#mlock">mlock</a>> |
170 |
<<a href="#mlock.on">mlock.on</a>>...</<a href="#mlock.on">mlock.on</a>> |
171 |
<<a href="#mlock.off">mlock.off</a>>...</<a href="#mlock.off">mlock.off</a>> |
172 |
<<a href="#mlock.limit">mlock.limit</a>>...</<a href="#mlock.limit">mlock.limit</a>> |
173 |
<<a href="#mlock.key">mlock.key</a>>...</<a href="#mlock.key">mlock.key</a>> |
174 |
<<a href="#mlock.link">mlock.link</a>>...</<a href="#mlock.link">mlock.link</a>> |
175 |
<<a href="#mlock.flood">mlock.flood</a>>...</<a href="#mlock.flood">mlock.flood</a>> |
176 |
<<a href="#mlock.joindelay">mlock.joindelay</a>>...</<a href="#mlock.joindelay">mlock.joindelay</a>> |
177 |
<<a href="#mlock.joinrate1">mlock.joinrate1</a>>...</<a href="#mlock.joinrate1">mlock.joinrate1</a>> |
178 |
<<a href="#mlock.joinrate2">mlock.joinrate2</a>>...</<a href="#mlock.joinrate2">mlock.joinrate2</a>> |
179 |
</<a href="#mlock">mlock</a>> |
180 |
<<a href="#entry_message">entry_message</a>>...</<a href="#entry_message">entry_message</a>> |
181 |
</<a href="#channelinfo">channelinfo</a>> |
182 |
<<a href="#news">news</a>> |
183 |
<<a href="#type">type</a>>...</<a href="#type">type</a>> |
184 |
<<a href="#num">num</a>>...</<a href="#num">num</a>> |
185 |
<<a href="#text">text</a>>...</<a href="#text">text</a>> |
186 |
<<a href="#who">who</a>>...</<a href="#who">who</a>> |
187 |
<<a href="#time">time</a>>...</<a href="#time">time</a>> |
188 |
</<a href="#news">news</a>> |
189 |
<<a href="#maskdata">maskdata</a> type='...'> |
190 |
<<a href="#num">num</a>>...</<a href="#num">num</a>> |
191 |
<<a href="#mask">mask</a>>...</<a href="#mask">mask</a>> |
192 |
<<a href="#limit">limit</a>>...</<a href="#limit">limit</a>> |
193 |
<<a href="#reason">reason</a>>...</<a href="#reason">reason</a>> |
194 |
<<a href="#who">who</a>>...</<a href="#who">who</a>> |
195 |
<<a href="#time">time</a>>...</<a href="#time">time</a>> |
196 |
<<a href="#expires">expires</a>>...</<a href="#expires">expires</a>> |
197 |
<<a href="#lastused">lastused</a>>...</<a href="#lastused">lastused</a>> |
198 |
</<a href="#maskdata">maskdata</a>> |
199 |
<<a href="#serverstats">serverstats</a>> |
200 |
<<a href="#name">name</a>>...</<a href="#name">name</a>> |
201 |
<<a href="#t_join">t_join</a>>...</<a href="#t_join">t_join</a>> |
202 |
<<a href="#t_quit">t_quit</a>>...</<a href="#t_quit">t_quit</a>> |
203 |
<<a href="#quit_message">quit_message</a>>...</<a href="#quit_message">quit_message</a>> |
204 |
</<a href="#serverstats">serverstats</a>> |
205 |
</<a href="#ircservices-db">ircservices-db</a>> |
206 |
</pre> |
207 |
|
208 |
<p align=right><font size="-1"><a href="#top">Back to top</a></font> |
209 |
|
210 |
<!------------------------------------------------------------------------> |
211 |
<p><hr> |
212 |
|
213 |
<a name=2></a> |
214 |
<h3>B-2. Tag index</h3> |
215 |
|
216 |
<dl> |
217 |
|
218 |
<dt><a name="ircservices-db"></a><b><tt>ircservices-db</tt></b> |
219 |
<dd>The enclosing tag for the entire database. |
220 |
|
221 |
<dt><a name="constants"></a><b><tt>constants</tt></b> |
222 |
<dd>Contains the various constant values used in this data set. |
223 |
|
224 |
<dt><a name="LANG_DEFAULT"></a><b><tt>LANG_DEFAULT</tt></b> |
225 |
<dd>Contains the value of the <tt>LANG_DEFAULT</tt> constant as a |
226 |
decimal integer. |
227 |
|
228 |
<dt><a name="CHANMAX_UNLIMITED"></a><b><tt>CHANMAX_UNLIMITED</tt></b> |
229 |
<dd>Contains the value of the <tt>CHANMAX_UNLIMITED</tt> constant as a |
230 |
decimal integer. |
231 |
|
232 |
<dt><a name="CHANMAX_DEFAULT"></a><b><tt>CHANMAX_DEFAULT</tt></b> |
233 |
<dd>Contains the value of the <tt>CHANMAX_DEFAULT</tt> constant as a |
234 |
decimal integer. |
235 |
|
236 |
<dt><a name="TIMEZONE_DEFAULT"></a><b><tt>TIMEZONE_DEFAULT</tt></b> |
237 |
<dd>Contains the value of the <tt>TIMEZONE_DEFAULT</tt> constant as a |
238 |
decimal integer. |
239 |
|
240 |
<dt><a name="ACCLEV_FOUNDER"></a><b><tt>ACCLEV_FOUNDER</tt></b> |
241 |
<dd>Contains the value of the <tt>ACCLEV_FOUNDER</tt> constant as a |
242 |
decimal integer. |
243 |
|
244 |
<dt><a name="ACCLEV_INVALID"></a><b><tt>ACCLEV_INVALID</tt></b> |
245 |
<dd>Contains the value of the <tt>ACCLEV_INVALID</tt> constant as a |
246 |
decimal integer. |
247 |
|
248 |
<dt><a name="ACCLEV_SOP"></a><b><tt>ACCLEV_SOP</tt></b> |
249 |
<dd>Contains the value of the <tt>ACCLEV_SOP</tt> constant as a |
250 |
decimal integer. |
251 |
|
252 |
<dt><a name="ACCLEV_AOP"></a><b><tt>ACCLEV_AOP</tt></b> |
253 |
<dd>Contains the value of the <tt>ACCLEV_AOP</tt> constant as a |
254 |
decimal integer. |
255 |
|
256 |
<dt><a name="ACCLEV_HOP"></a><b><tt>ACCLEV_HOP</tt></b> |
257 |
<dd>Contains the value of the <tt>ACCLEV_HOP</tt> constant as a |
258 |
decimal integer. |
259 |
|
260 |
<dt><a name="ACCLEV_VOP"></a><b><tt>ACCLEV_VOP</tt></b> |
261 |
<dd>Contains the value of the <tt>ACCLEV_VOP</tt> constant as a |
262 |
decimal integer. |
263 |
|
264 |
<dt><a name="ACCLEV_NOP"></a><b><tt>ACCLEV_NOP</tt></b> |
265 |
<dd>Contains the value of the <tt>ACCLEV_NOP</tt> constant as a |
266 |
decimal integer. |
267 |
|
268 |
<dt><a name="MEMOMAX_UNLIMITED"></a><b><tt>MEMOMAX_UNLIMITED</tt></b> |
269 |
<dd>Contains the value of the <tt>MEMOMAX_UNLIMITED</tt> constant as a |
270 |
decimal integer. |
271 |
|
272 |
<dt><a name="MEMOMAX_DEFAULT"></a><b><tt>MEMOMAX_DEFAULT</tt></b> |
273 |
<dd>Contains the value of the <tt>MEMOMAX_DEFAULT</tt> constant as a |
274 |
decimal integer. |
275 |
|
276 |
<dt><a name="NEWS_LOGON"></a><b><tt>NEWS_LOGON</tt></b> |
277 |
<dd>Contains the value of the <tt>NEWS_LOGON</tt> constant as a |
278 |
decimal integer. |
279 |
|
280 |
<dt><a name="NEWS_OPER"></a><b><tt>NEWS_OPER</tt></b> |
281 |
<dd>Contains the value of the <tt>NEWS_OPER</tt> constant as a |
282 |
decimal integer. |
283 |
|
284 |
<dt><a name="MD_AKILL"></a><b><tt>MD_AKILL</tt></b> |
285 |
<dd>Contains the value of the <tt>MD_AKILL</tt> constant as a |
286 |
decimal integer. |
287 |
|
288 |
<dt><a name="MD_EXCLUDE"></a><b><tt>MD_EXCLUDE</tt></b> |
289 |
<dd>Contains the value of the <tt>MD_EXCLUDE</tt> constant as a |
290 |
decimal integer. |
291 |
|
292 |
<dt><a name="MD_EXCEPTION"></a><b><tt>MD_EXCEPTION</tt></b> |
293 |
<dd>Contains the value of the <tt>MD_EXCEPTION</tt> constant as a |
294 |
decimal integer. |
295 |
|
296 |
<dt><a name="MD_SGLINE"></a><b><tt>MD_SGLINE</tt></b> |
297 |
<dd>Contains the value of the <tt>MD_SGLINE</tt> constant as a |
298 |
decimal integer. |
299 |
|
300 |
<dt><a name="MD_SQLINE"></a><b><tt>MD_SQLINE</tt></b> |
301 |
<dd>Contains the value of the <tt>MD_SQLINE</tt> constant as a |
302 |
decimal integer. |
303 |
|
304 |
<dt><a name="MD_SZLINE"></a><b><tt>MD_SZLINE</tt></b> |
305 |
<dd>Contains the value of the <tt>MD_SZLINE</tt> constant as a |
306 |
decimal integer. |
307 |
|
308 |
<dt><a name="maxusercnt"></a><b><tt>maxusercnt</tt></b> |
309 |
<dd>Contains the maximum number of users seen on the network as a |
310 |
decimal integer. |
311 |
|
312 |
<dt><a name="maxusertime"></a><b><tt>maxusertime</tt></b> |
313 |
<dd>Contains the timestamp of the time when the maximum number of users |
314 |
on the network was recorded as a decimal integer. |
315 |
|
316 |
<dt><a name="supass"></a><b><tt>supass</tt></b> |
317 |
<dd>Contains the password for the OperServ |
318 |
<a href="4.html#oper.su"><tt>SU</tt></a> command. If the "cipher" |
319 |
attribute is given, it specifies the name of the algorithm used to |
320 |
encrypt the password; if not given, the password is not encrypted. |
321 |
|
322 |
<dt><a name="nickgroupinfo"></a><b><tt>nickgroupinfo</tt></b> |
323 |
<dd>Contains data related to a single nickname group. |
324 |
|
325 |
<dt><a name="id"></a><b><tt>id</tt></b> |
326 |
<dd>Contains the ID value for this nickname group as a decimal integer. |
327 |
The ID value is a positive integer unique across all nickname groups. |
328 |
|
329 |
<dt><a name="nicks"></a><b><tt>nicks count='<i>n</i>'</tt></b> |
330 |
<dd>Contains <tt><i>n</i></tt> |
331 |
<tt><<a href="#array-element">array-element</a>></tt> tags |
332 |
which contain the nicknames associated with this nickname group. |
333 |
|
334 |
<dt><a name="array-element"></a><b><tt>array-element</tt></b> |
335 |
<dd>Contains a text string used as an array element. |
336 |
|
337 |
<dt><a name="mainnick"></a><b><tt>mainnick</tt></b> |
338 |
<dd>Contains the index number in the <tt>nicks</tt> array of the main |
339 |
nick for the nick group as a decimal integer. |
340 |
|
341 |
<dt><a name="pass"></a><b><tt>pass</tt></b> |
342 |
<dd>Contains a nickname group password. If the "cipher" attribute is |
343 |
given, it specifies the name of the algorithm used to encrypt the |
344 |
password; if not given, the password is not encrypted. |
345 |
|
346 |
<dt><a name="url"></a><b><tt>url</tt></b> |
347 |
<dd>Contains a URL for a nickname group or channel. |
348 |
|
349 |
<dt><a name="email"></a><b><tt>email</tt></b> |
350 |
<dd>Contains an E-mail address for a nickname group or channel. |
351 |
|
352 |
<dt><a name="last_email"></a><b><tt>last_email</tt></b> |
353 |
<dd>Contains the last authenticated E-mail address for a nickname |
354 |
group, if the E-mail address has been changed and not yet been |
355 |
authenticated. |
356 |
|
357 |
<dt><a name="info"></a><b><tt>info</tt></b> |
358 |
<dd>Contains the information text for a nickname group. |
359 |
|
360 |
<dt><a name="authcode"></a><b><tt>authcode</tt></b> |
361 |
<dd>Contains the authentication code for a nickname group as a decimal |
362 |
integer. If no authentication code is set, contains the number 0 |
363 |
(zero). |
364 |
|
365 |
<dt><a name="authset"></a><b><tt>authset</tt></b> |
366 |
<dd>Contains the timestamp of the time at which the nickname group's |
367 |
authentication code was set, if an authentication code is set. |
368 |
|
369 |
<dt><a name="authreason"></a><b><tt>authreason</tt></b> |
370 |
<dd>Contains the reason code for the nickname group's authentication |
371 |
code, if an authentication code is set. |
372 |
|
373 |
<dt><a name="suspend_who"></a><b><tt>suspend_who</tt></b> |
374 |
<dd>Contains the nickname responsible for suspending a nickname or |
375 |
channel. |
376 |
|
377 |
<dt><a name="suspend_reason"></a><b><tt>suspend_reason</tt></b> |
378 |
<dd>Contains the reason for suspending a nickname or channel. |
379 |
|
380 |
<dt><a name="suspend_time"></a><b><tt>suspend_time</tt></b> |
381 |
<dd>Contains the timestamp of the time the nickname or channel was |
382 |
suspended as a decimal integer. |
383 |
|
384 |
<dt><a name="suspend_expires"></a><b><tt>suspend_expires</tt></b> |
385 |
<dd>Contains the timestamp of the time the nickname's or channel's |
386 |
suspension expires (or zero if the suspension does not expire) as |
387 |
a decimal integer. |
388 |
|
389 |
<dt><a name="flags"></a><b><tt>flags</tt></b> |
390 |
<dd>Contains flags for a nickname or channel as a decimal integer. |
391 |
|
392 |
<dt><a name="os_priv"></a><b><tt>os_priv</tt></b> |
393 |
<dd>Contains the OperServ privilege level of a nickname group as a |
394 |
decimal integer. |
395 |
|
396 |
<dt><a name="language"></a><b><tt>language</tt></b> |
397 |
<dd>Contains the language (or <tt>LANG_DEFAULT</tt>) selected for a |
398 |
nickname group as a decimal integer. |
399 |
|
400 |
<dt><a name="timezone"></a><b><tt>timezone</tt></b> |
401 |
<dd>Contains the timezone offset from UTC in minutes (or |
402 |
<tt>TIMEZONE_DEFAULT</tt>) selected for the nickname as a decimal |
403 |
integer. |
404 |
|
405 |
<dt><a name="channelmax"></a><b><tt>channelmax</tt></b> |
406 |
<dd>Contains the maximum number of channels a nickname group is |
407 |
permitted to register (or <tt>CHANMAX_UNLIMITED</tt> or |
408 |
<tt>CHANMAX_DEFAULT</tt>) as a decimal integer. |
409 |
|
410 |
<dt><a name="access"></a><b><tt>access count='<i>n</i>'</tt></b> |
411 |
<dd>Contains <tt><i>n</i></tt> |
412 |
<tt><<a href="#array-element">array-element</a>></tt> tags |
413 |
containing the nickname group's access list entries. |
414 |
|
415 |
<dt><a name="ajoin"></a><b><tt>ajoin count='<i>n</i>'</tt></b> |
416 |
<dd>Contains <tt><i>n</i></tt> |
417 |
<tt><<a href="#array-element">array-element</a>></tt> tags |
418 |
containing the nickname group's autojoin list entries. |
419 |
|
420 |
<dt><a name="memoinfo"></a><b><tt>memoinfo</tt></b> |
421 |
<dd>Contains a nickname group or channel's memo data. |
422 |
|
423 |
<dt><a name="memos"></a><b><tt>memos count='<i>n</i>'</tt></b> |
424 |
<dd>Contains <tt><i>n</i></tt> <tt><<a href="#memo">memo</a>></tt> |
425 |
tags containing memos. |
426 |
|
427 |
<dt><a name="memo"></a><b><tt>memo</tt></b> |
428 |
<dd>Contains the data for a single memo. |
429 |
|
430 |
<dt><a name="number"></a><b><tt>number</tt></b> |
431 |
<dd>Contains the number of the memo as a decimal integer. |
432 |
|
433 |
<dt><a name="time"></a><b><tt>time</tt></b> |
434 |
<dd>Contains the timestamp of the time a memo was sent or the time a |
435 |
news or mask-data entry was added as a decimal integer. |
436 |
|
437 |
<dt><a name="sender"></a><b><tt>sender</tt></b> |
438 |
<dd>Contains the nickname of the sender of the memo. |
439 |
|
440 |
<dt><a name="channel"></a><b><tt>channel</tt></b> |
441 |
<dd>If the memo is a channel memo, contains the name of the channel the |
442 |
memo was sent to. |
443 |
|
444 |
<dt><a name="text"></a><b><tt>text</tt></b> |
445 |
<dd>Contains the text of a memo or news item. |
446 |
|
447 |
<dt><a name="memomax"></a><b><tt>memomax</tt></b> |
448 |
<dd>Contains the maximum number of memos the nickname group or channel |
449 |
is allowed to store (or <tt>MEMOMAX_UNLIMITED</tt> or |
450 |
<tt>MEMOMAX_DEFAULT</tt>) as a decimal integer. |
451 |
|
452 |
<dt><a name="ignore"></a><b><tt>ignore count='<i>n</i>'</tt></b> |
453 |
<dd>Contains <tt><i>n</i></tt> |
454 |
<tt><<a href="#array-element">array-element</a>></tt> tags |
455 |
containing the nickname group's memo ignore list entries. |
456 |
|
457 |
<dt><a name="nickinfo"></a><b><tt>nickinfo</tt></b> |
458 |
<dd>Contains data for a single nickname. |
459 |
|
460 |
<dt><a name="nick"></a><b><tt>nick</tt></b> |
461 |
<dd>Contains the nickname with which the data is associated. |
462 |
|
463 |
<dt><a name="status"></a><b><tt>status</tt></b> |
464 |
<dd>Contains the nickname's "status" field as a decimal integer. |
465 |
|
466 |
<dt><a name="last_usermask"></a><b><tt>last_usermask</tt></b> |
467 |
<dd>Contains the nickname's last seen usermask (possibly including a |
468 |
fakehost). |
469 |
|
470 |
<dt><a name="last_realmask"></a><b><tt>last_realmask</tt></b> |
471 |
<dd>Contains the nickname's last seen real usermask. |
472 |
|
473 |
<dt><a name="last_realname"></a><b><tt>last_realname</tt></b> |
474 |
<dd>Contains the nickname's last seen real name. |
475 |
|
476 |
<dt><a name="last_quit"></a><b><tt>last_quit</tt></b> |
477 |
<dd>Contains the nickname's last quit message. |
478 |
|
479 |
<dt><a name="time_registered"></a><b><tt>time_registered</tt></b> |
480 |
<dd>Contains the timestamp of the time the nickname or channel was |
481 |
registered as a decimal integer. |
482 |
|
483 |
<dt><a name="last_seen"></a><b><tt>last_seen</tt></b> |
484 |
<dd>Contains the timestamp of the last time the nickname's owner was |
485 |
seen online as a decimal integer. |
486 |
|
487 |
<dt><a name="nickgroup"></a><b><tt>nickgroup</tt></b> |
488 |
<dd>Contains the ID value of the nickname group with which this |
489 |
nickname or channel access list entry is associated. |
490 |
|
491 |
<dt><a name="channelinfo"></a><b><tt>channelinfo</tt></b> |
492 |
<dd>Contains data for a channel. |
493 |
|
494 |
<dt><a name="name"></a><b><tt>name</tt></b> |
495 |
<dd>Contains the name of the channel or server with which the following |
496 |
data is associated. |
497 |
|
498 |
<dt><a name="founder"></a><b><tt>founder</tt></b> |
499 |
<dd>Contains the ID value of the founder's nickname group as a decimal |
500 |
integer. |
501 |
|
502 |
<dt><a name="successor"></a><b><tt>successor</tt></b> |
503 |
<dd>Contains the ID value of the successor's nickname group as a |
504 |
decimal integer. |
505 |
|
506 |
<dt><a name="founderpass"></a><b><tt>founderpass</tt></b> |
507 |
<dd>Contains the channel's founder password. If the "cipher" attribute |
508 |
is given, it specifies the name of the algorithm used to encrypt |
509 |
the password; if not given, the password is not encrypted. |
510 |
|
511 |
<dt><a name="desc"></a><b><tt>desc</tt></b> |
512 |
<dd>Contains the channel's description. |
513 |
|
514 |
<dt><a name="last_used"></a><b><tt>last_used</tt></b> |
515 |
<dd>Contains the timestamp of the last time a channel was used. |
516 |
|
517 |
<dt><a name="last_topic"></a><b><tt>last_topic</tt></b> |
518 |
<dd>Contains the last seen topic of the channel. |
519 |
|
520 |
<dt><a name="last_topic_setter"></a><b><tt>last_topic_setter</tt></b> |
521 |
<dd>Contains the nickname of the setter of the last seen topic of the |
522 |
channel. |
523 |
|
524 |
<dt><a name="last_topic_time"></a><b><tt>last_topic_time</tt></b> |
525 |
<dd>Contains the timestamp of the time the last seen topic of the |
526 |
channel was set. |
527 |
|
528 |
<dt><a name="levels"></a><b><tt>levels</tt></b> |
529 |
<dd>Contains tags for each channel access level. |
530 |
|
531 |
<dt><a name="CA_INVITE"></a><b><tt>CA_INVITE</tt></b> |
532 |
<dd>Contains the value of the <tt>CA_INVITE</tt> level as a |
533 |
decimal integer. |
534 |
|
535 |
<dt><a name="CA_AKICK"></a><b><tt>CA_AKICK</tt></b> |
536 |
<dd>Contains the value of the <tt>CA_AKICK</tt> level as a |
537 |
decimal integer. |
538 |
|
539 |
<dt><a name="CA_SET"></a><b><tt>CA_SET</tt></b> |
540 |
<dd>Contains the value of the <tt>CA_SET</tt> level as a |
541 |
decimal integer. |
542 |
|
543 |
<dt><a name="CA_UNBAN"></a><b><tt>CA_UNBAN</tt></b> |
544 |
<dd>Contains the value of the <tt>CA_UNBAN</tt> level as a |
545 |
decimal integer. |
546 |
|
547 |
<dt><a name="CA_AUTOOP"></a><b><tt>CA_AUTOOP</tt></b> |
548 |
<dd>Contains the value of the <tt>CA_AUTOOP</tt> level as a |
549 |
decimal integer. |
550 |
|
551 |
<dt><a name="CA_AUTODEOP"></a><b><tt>CA_AUTODEOP</tt></b> |
552 |
<dd>Contains the value of the <tt>CA_AUTODEOP</tt> level as a |
553 |
decimal integer. Always -1 in Services 5.1. |
554 |
|
555 |
<dt><a name="CA_AUTOVOICE"></a><b><tt>CA_AUTOVOICE</tt></b> |
556 |
<dd>Contains the value of the <tt>CA_AUTOVOICE</tt> level as a |
557 |
decimal integer. |
558 |
|
559 |
<dt><a name="CA_OPDEOP"></a><b><tt>CA_OPDEOP</tt></b> |
560 |
<dd>Contains the value of the <tt>CA_OPDEOP</tt> level as a |
561 |
decimal integer. |
562 |
|
563 |
<dt><a name="CA_ACCESS_LIST"></a><b><tt>CA_ACCESS_LIST</tt></b> |
564 |
<dd>Contains the value of the <tt>CA_ACCESS_LIST</tt> level as a |
565 |
decimal integer. |
566 |
|
567 |
<dt><a name="CA_CLEAR"></a><b><tt>CA_CLEAR</tt></b> |
568 |
<dd>Contains the value of the <tt>CA_CLEAR</tt> level as a |
569 |
decimal integer. |
570 |
|
571 |
<dt><a name="CA_NOJOIN"></a><b><tt>CA_NOJOIN</tt></b> |
572 |
<dd>Contains the value of the <tt>CA_NOJOIN</tt> level as a |
573 |
decimal integer. Always -100 in Services 5.1. |
574 |
|
575 |
<dt><a name="CA_ACCESS_CHANGE"></a><b><tt>CA_ACCESS_CHANGE</tt></b> |
576 |
<dd>Contains the value of the <tt>CA_ACCESS_CHANGE</tt> level as a |
577 |
decimal integer. |
578 |
|
579 |
<dt><a name="CA_MEMO"></a><b><tt>CA_MEMO</tt></b> |
580 |
<dd>Contains the value of the <tt>CA_MEMO</tt> level as a |
581 |
decimal integer. |
582 |
|
583 |
<dt><a name="CA_VOICE"></a><b><tt>CA_VOICE</tt></b> |
584 |
<dd>Contains the value of the <tt>CA_VOICE</tt> level as a |
585 |
decimal integer. |
586 |
|
587 |
<dt><a name="CA_AUTOHALFOP"></a><b><tt>CA_AUTOHALFOP</tt></b> |
588 |
<dd>Contains the value of the <tt>CA_AUTOHALFOP</tt> level as a |
589 |
decimal integer. |
590 |
|
591 |
<dt><a name="CA_HALFOP"></a><b><tt>CA_HALFOP</tt></b> |
592 |
<dd>Contains the value of the <tt>CA_HALFOP</tt> level as a |
593 |
decimal integer. |
594 |
|
595 |
<dt><a name="CA_AUTOPROTECT"></a><b><tt>CA_AUTOPROTECT</tt></b> |
596 |
<dd>Contains the value of the <tt>CA_AUTOPROTECT</tt> level as a |
597 |
decimal integer. |
598 |
|
599 |
<dt><a name="CA_PROTECT"></a><b><tt>CA_PROTECT</tt></b> |
600 |
<dd>Contains the value of the <tt>CA_PROTECT</tt> level as a |
601 |
decimal integer. |
602 |
|
603 |
<dt><a name="chanaccesslist"></a><b><tt>chanaccesslist count='<i>n</i>'</tt></b> |
604 |
<dd>Contains <tt><i>n</i></tt> |
605 |
<tt><<a href="#chanaccess">chanaccess</a>></tt> tags |
606 |
containing the entries on the channel's access list. |
607 |
|
608 |
<dt><a name="chanaccess"></a><b><tt>chanaccess</tt></b> |
609 |
<dd>Contains the data for a channel access list entry. |
610 |
|
611 |
<dt><a name="level"></a><b><tt>level</tt></b> |
612 |
<dd>Contains the level for a channel access list entry as a decimal |
613 |
integer. |
614 |
|
615 |
<dt><a name="akicklist"></a><b><tt>akicklist count='<i>n</i>'</tt></b> |
616 |
<dd>Contains <tt><i>n</i></tt> |
617 |
<tt><<a href="#akick">akick</a>></tt> tags containing the |
618 |
entries on the channel's autokick list. |
619 |
|
620 |
<dt><a name="akick"></a><b><tt>akick</tt></b> |
621 |
<dd>Contains the data for a channel autokick list entry. |
622 |
|
623 |
<dt><a name="mask"></a><b><tt>mask</tt></b> |
624 |
<dd>Contains the mask associated with a channel autokick or mask-data |
625 |
entry. |
626 |
|
627 |
<dt><a name="who"></a><b><tt>who</tt></b> |
628 |
<dd>Contains the nickname of the user who added a channel autokick or |
629 |
mask-data entry. |
630 |
|
631 |
<dt><a name="set"></a><b><tt>set</tt></b> |
632 |
<dd>Contains the timestamp of the time a channel autokick entry was added. |
633 |
|
634 |
<dt><a name="lastused"></a><b><tt>lastused</tt></b> |
635 |
<dd>Contains the timestamp of the last time a channel autokick or |
636 |
mask-data entry was added. |
637 |
|
638 |
<dt><a name="mlock"></a><b><tt>mlock</tt></b> |
639 |
<dd>Contains the data for a channel's mode lock. |
640 |
|
641 |
<dt><a name="mlock.on"></a><b><tt>mlock.on</tt></b> |
642 |
<dd>Contains the string of modes locked on for the channel. |
643 |
|
644 |
<dt><a name="mlock.off"></a><b><tt>mlock.off</tt></b> |
645 |
<dd>Contains the string of modes locked off for the channel. |
646 |
|
647 |
<dt><a name="mlock.limit"></a><b><tt>mlock.limit</tt></b> |
648 |
<dd>Contains the channel's locked limit, if any. |
649 |
|
650 |
<dt><a name="mlock.key"></a><b><tt>mlock.key</tt></b> |
651 |
<dd>Contains the channel's locked key, if any. |
652 |
|
653 |
<dt><a name="mlock.link"></a><b><tt>mlock.link</tt></b> |
654 |
<dd>Contains the channel's locked link channel, if any. |
655 |
|
656 |
<dt><a name="mlock.flood"></a><b><tt>mlock.flood</tt></b> |
657 |
<dd>Contains the channel's locked flood setting, if any. |
658 |
|
659 |
<dt><a name="mlock.joindelay"></a><b><tt>mlock.joindelay</tt></b> |
660 |
<dd>Contains the channel's locked join delay setting, if any. |
661 |
|
662 |
<dt><a name="mlock.joinrate1"></a><b><tt>mlock.joinrate1</tt></b> |
663 |
<dd>Contains the first part of the channel's locked join rate limit |
664 |
setting, if any. |
665 |
|
666 |
<dt><a name="mlock.joinrate2"></a><b><tt>mlock.joinrate2</tt></b> |
667 |
<dd>Contains the second part of the channel's locked join rate limit |
668 |
setting, if any. |
669 |
|
670 |
<dt><a name="entry_message"></a><b><tt>entry_message</tt></b> |
671 |
<dd>Contains the channel's entry message, if any. |
672 |
|
673 |
<dt><a name="news"></a><b><tt>news</tt></b> |
674 |
<dd>Contains the data for a news item. |
675 |
|
676 |
<dt><a name="type"></a><b><tt>type</tt></b> |
677 |
<dd>Contains the type of the news item (<tt>NEWS_LOGON</tt> or |
678 |
<tt>NEWS_OPER</tt>) or mask-data entry (<tt>MD_*</tt>) as a decimal |
679 |
integer. |
680 |
|
681 |
<dt><a name="num"></a><b><tt>num</tt></b> |
682 |
<dd>Contains the number of the news item as a decimal integer. |
683 |
|
684 |
<dt><a name="maskdata"></a><b><tt>maskdata</tt></b> |
685 |
<dd>Contains the data for a mask-data entry. |
686 |
|
687 |
<dt><a name="limit"></a><b><tt>limit</tt></b> |
688 |
<dd>Contains the limit for an exception list entry as a decimal integer. |
689 |
|
690 |
<dt><a name="reason"></a><b><tt>reason</tt></b> |
691 |
<dd>Contains the reason given for an autokick or mask-data entry. |
692 |
|
693 |
<dt><a name="expires"></a><b><tt>expires</tt></b> |
694 |
<dd>Contains the timestamp of the time at wich a mask-data entry |
695 |
expires (or zero if the entry does not expire) as a decimal integer. |
696 |
|
697 |
<dt><a name="serverstats"></a><b><tt>serverstats</tt></b> |
698 |
<dd>Contains the data for a StatServ server entry. |
699 |
|
700 |
<dt><a name="t_join"></a><b><tt>t_join</tt></b> |
701 |
<dd>Contains the timestamp of the last time the server joined the |
702 |
network as a decimal integer. |
703 |
|
704 |
<dt><a name="t_quit"></a><b><tt>t_quit</tt></b> |
705 |
<dd>Contains the timestamp of the last time the server disconnected |
706 |
from the network as a decimal integer. |
707 |
|
708 |
<dt><a name="quit_message"></a><b><tt>quit_message</tt></b> |
709 |
<dd>Contains the server's last quit message. |
710 |
|
711 |
</dl> |
712 |
|
713 |
<p align=right><font size="-1"><a href="#top">Back to top</a></font> |
714 |
|
715 |
<!------------------------------------------------------------------------> |
716 |
<p><hr> |
717 |
|
718 |
<p align=right><font size=-1><a href="index.html">Table of Contents</a></font> |
719 |
|
720 |
</body> |
721 |
</html> |