~ubuntu-branches/ubuntu/oneiric/eggdrop/oneiric

« back to all changes in this revision

Viewing changes to doc/html/mod-server.html

  • Committer: Bazaar Package Importer
  • Author(s): Guilherme de S. Pastore
  • Date: 2004-06-17 09:15:28 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20040617091528-64rrw1sa33lkfhmh
Tags: 1.6.16-2
* Fixed typo on README.Debian
* Fixed hyphens in manual page
* Converted debian/rules to CDBS
* Set path to binary on example config file
* Changed LANGDIR on src/eggdrop.h (Closes: #254824)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
2
 
<!-- $Id: mod-server.html,v 1.17 2002/01/03 01:05:43 guppy Exp $ -->
 
2
<!-- $Id: mod-server.html,v 1.31 2004/01/09 05:56:36 wcc Exp $ -->
3
3
 
4
4
<html>
5
5
  <head>
17
17
    <blockquote>
18
18
      <ol>
19
19
        <li><a href="#config">Config file settings</a></li>
20
 
 
21
 
        <li><a href="#tclcmds">Tcl commands</a></li>
22
 
 
23
 
        <li><a href="#tclvars">Tcl variables</a></li>
24
20
      </ol>
25
21
    </blockquote>
26
22
    <hr>
28
24
    <p><a name="config"></a>1. <strong>Config file settings</strong></p>
29
25
 
30
26
    <blockquote>
31
 
      <p>Lines in <strong>bold</strong> are the lines that need to be
32
 
      included in the Eggdrop config file if you want to use the share
33
 
      module. Lines in <strong><em>bold italics</em></strong> are optional
34
 
      and only required if you wish to change the default behaviour for 
35
 
      that particular feature.</p>
36
 
 
37
27
      <p>This module provides the core server support. You have to load this
38
 
      if you want your bot to come on irc.<br>
 
28
      if you want your bot to come on IRC.<br>
39
29
      </p>
40
30
 
41
31
      <p>Put this line into your Eggdrop configuration file to load the
54
44
        <dd>
55
45
          <p>What is your network?</p>
56
46
 
57
 
          <p>0 = Efnet (non +e/+I hybrid)<br>
 
47
          <p>0 = Efnet<br>
58
48
           1 = IRCnet<br>
59
49
           2 = Undernet<br>
60
50
           3 = Dalnet<br>
61
 
           4 = Efnet +e/+I hybrid<br>
 
51
           4 = +e/+I/max-bans 20 Hybrid<br>
62
52
           5 = Others</p>
63
53
        </dd>
64
54
 
65
55
        <dt><strong>set nick &quot;LamestBot&quot;</strong></dt>
66
56
 
67
57
        <dd>
68
 
          <p>Set the nick the bot uses on IRC, and on the botnet unless 
 
58
          <p>Set the nick the bot uses on IRC, and on the botnet unless
69
59
          you specify a separate botnet-nick, here.</p>
70
60
        </dd>
71
61
 
72
62
        <dt><strong>set altnick &quot;LamestBot&quot;</strong></dt>
73
63
 
74
64
        <dd>
75
 
          <p>Set the alternative nick which the bot uses on IRC if the nick 
76
 
          specified by &#39;set nick&#39; is unavailable. All &#39;?&#39; 
 
65
          <p>Set the alternative nick which the bot uses on IRC if the nick
 
66
          specified by &#39;set nick&#39; is unavailable. All &#39;?&#39;
77
67
          characters will be replaced by random numbers.</p>
78
68
        </dd>
79
69
 
80
 
        <dt><strong><em>set keep-nick 1</em></strong></dt>
 
70
        <dt><strong>set keep-nick 1</strong></dt>
81
71
 
82
72
        <dd>
83
73
          <p>This setting makes the bot try to get his original nickname back
84
74
          if its primary nickname is already in use.</p>
85
75
        </dd>
86
76
 
87
 
        <dt><strong>set realname &quot;/msg LamestBot
88
 
        hello&quot;</strong></dt>
 
77
        <dt><strong>set realname &quot;/msg LamestBot hello&quot;</strong></dt>
89
78
 
90
79
        <dd>
91
80
          <p>Set here what to display in the real-name field for the bot.</p>
92
81
        </dd>
93
82
 
 
83
        <dt>
 
84
          <p>
 
85
            <strong>bind evnt - init-server evnt:init_server</strong><br>
 
86
            <strong>proc evnt:init_server {type} {</strong><br>
 
87
            <strong>&nbsp;&nbsp;&nbsp;global botnick</strong><br>
 
88
            <strong>&nbsp;&nbsp;&nbsp;putquick &quot;MODE $botnick +i-ws&quot;</strong><br>
 
89
            <strong>}</strong>
 
90
          </p>
 
91
        </dt>
 
92
 
 
93
        <dd>
 
94
          <p>This is a Tcl script to be run immediately after connecting to a
 
95
          server.</p>
 
96
        </dd>
 
97
 
94
98
        <dt><strong>set init-server { putserv &quot;MODE $botnick +i-ws&quot;
95
99
        }</strong></dt>
96
100
 
97
101
        <dd>
98
 
          <p>Set here a script to run (if any) when first connecting to a 
99
 
          server.</p>
100
 
        </dd>
101
 
 
102
 
        <dt><strong>set servers { irc.change.this:6667 irc.example.com:7000 }
103
 
        </strong></dt>
 
102
          <p>This is a Tcl script to be run immediately after connecting to a
 
103
          server. It is limited to 120 characters, and is depriciated due to
 
104
          the EVNT bind (see <a href="tcl-commands.html">Tcl Commands</a>).</p>
 
105
        </dd>
 
106
 
 
107
        <dt><strong>set connect-server { putlog &quot;Connecting to
 
108
        server.&quot; }</strong></dt>
 
109
 
 
110
        <dd>
 
111
          <p>This is a Tcl script to be run immediately before connecting to a
 
112
          server. It is limited to 120 characters, and is depriciated due to
 
113
          the EVNT bind (see <a href="tcl-commands.html">Tcl Commands</a>).</p>
 
114
        </dd>
 
115
 
 
116
        <dt><strong>set disconnect-server { putlog &quot;Disconnected from
 
117
        server.&quot; }</strong></dt>
 
118
 
 
119
        <dd>
 
120
          <p>This is a Tcl script to be run immediately after disconnecting
 
121
          from a server. It is limited to 120 characters, and is depriciated
 
122
          due to the EVNT bind (see <a href="tcl-commands.html">Tcl
 
123
          Commands</a>).</p>
 
124
        </dd>
 
125
 
 
126
        <dt><strong>set servers {</strong></dt>
 
127
<pre>
 
128
        you.need.to.change.this:6667
 
129
        another.example.com:7000:password
 
130
</pre>
 
131
        <p><strong>}</strong></p>
 
132
 
104
133
 
105
134
        <dd>
106
135
          <p>This is the bot&#39;s server list. The bot will start at the first
115
144
           }</p>
116
145
 
117
146
           <p>The format is: server[:port[:password]]</p>
118
 
    
 
147
 
119
148
           <p>Both the port and password fields are optional; however, if you
120
149
           want to set a password you must also set a port. If a port isn&#39;t
121
150
           specified it will default to  your default-port setting..</p>
128
157
          with &#39;.jump&#39; or in &#39;set servers&#39;.</p>
129
158
        </dd>
130
159
 
131
 
        <dt><strong><em>set strict-servernames 0</em></strong></dt>
132
 
 
133
 
        <dd>
134
 
          <p>Often, IRC servers call themselves a name other than their
135
 
          actual hostname. If you want Eggdrop to replace your entry in the
136
 
          config file with this name, set this to 1. If you set this setting
137
 
          to 0, Eggdrop will keep a separate list of what IRC servers call
138
 
          themselves.</p>
139
 
        </dd>
140
 
 
141
160
        <dt><strong>set server-cycle-wait 60</strong></dt>
142
161
 
143
162
        <dd>
144
163
          <p>This setting defines how long Eggdrop should wait before moving
145
 
          from one server to another on disconnect. If you set 0 here, 
 
164
          from one server to another on disconnect. If you set 0 here,
146
165
          Eggdrop will not wait at all and will connect instantly. Setting
147
166
          this too low could result in your bot being K:Lined.</p>
148
167
        </dd>
157
176
        <dt><strong>set server-timeout 60</strong></dt>
158
177
 
159
178
        <dd>
160
 
          <p>Set here how long Eggdrop should wait for a response when 
 
179
          <p>Set here how long Eggdrop should wait for a response when
161
180
          connecting to a server before giving up and moving on to next
162
181
          server.</p>
163
182
        </dd>
172
191
          be turned off.</p>
173
192
        </dd>
174
193
 
175
 
        <dt><strong><em>set check-stoned 1</em></strong></dt>
 
194
        <dt><strong>set check-stoned 1</strong></dt>
176
195
 
177
196
        <dd>
178
197
          <p>Set this to 1 if Eggdrop should check for stoned servers? (where
180
199
          yet).</p>
181
200
        </dd>
182
201
 
183
 
        <dt><strong><em>set serverror-quit 1</em></strong></dt>
 
202
        <dt><strong>set serverror-quit 1</strong></dt>
184
203
 
185
204
        <dd>
186
 
          <p>If you want your bot to exit the server if it receives an 
 
205
          <p>If you want your bot to exit the server if it receives an
187
206
          ERROR message, set this to 1.</p>
188
207
        </dd>
189
208
 
196
215
          though.</p>
197
216
        </dd>
198
217
 
199
 
        <dt><strong><em>set use-console-r 0</em></strong></dt>
200
 
 
201
 
        <dd>
202
 
          <p>This setting allows you the logging of all information received
203
 
          from the server via console mode &#39;r&#39;. <strong>NOTE:</strong>
204
 
          This is a large security hole, allowing people to see user passwords.
205
 
          This is now restricted to +n users only. Please choose your owners
206
 
          with care.</p>
207
 
        </dd>
208
 
 
209
 
        <dt><strong><em>set debug-output 0</em></strong></dt>
210
 
 
211
 
        <dd>
212
 
          <p>This setting allows you the logging of all information sent 
213
 
          to the server via console mode &#39;v&#39;. <strong>NOTE:</strong>
214
 
          This is a large security hole, allowing people to see passwords. 
215
 
          This is now restricted to +n users only. Please choose your owners
216
 
          with care.</p>
217
 
        </dd>
218
 
 
219
 
        <dt><strong><em>set strict-host 0</em></strong></dt>
220
 
 
221
 
        <dd>
222
 
          <p>Set this to 1 if you don&#39;t want your the bot to strip a 
 
218
        <dt><strong>set raw-log 0</strong></dt>
 
219
 
 
220
        <dd>
 
221
          <p>This setting allows you the logging of raw incoming server
 
222
          traffic via console/log flag &#39;r&#39;, raw outgoing server
 
223
          traffic via console/log mode &#39;v&#39;, raw botnet traffic via
 
224
          console/log mode &#39;t&#39;, and raw share traffic via console/log
 
225
          mode &#39;h&#39;. These flags can create a large security hole,
 
226
          allowing people to see user passwords. This is now restricted to +n
 
227
          users only. Please choose your owners with care.</p>
 
228
        </dd>
 
229
 
 
230
        <dt><strong>set strict-host 0</strong></dt>
 
231
 
 
232
        <dd>
 
233
          <p>Set this to 1 if you don&#39;t want your the bot to strip a
223
234
          leading &#39;~&#39;on user@hosts.</p>
224
235
        </dd>
225
236
 
226
 
        <dt><strong><em>set quiet-reject 1</em></strong></dt>
 
237
        <dt><strong>set quiet-reject 1</strong></dt>
227
238
 
228
239
        <dd>
229
 
          <p>This setting makes the bot squelch the error message when 
230
 
          rejecting a DCC CHAT or SEND. Normally it tells the DCC user that
231
 
          the CHAT or SEND has been rejected because they don&#39;t have 
232
 
          access. Please note, sometimes IRC server operators detect bots
233
 
          that  way.</p>
 
240
          <p>This setting makes the bot squelch the error message when
 
241
          rejecting a DCC CHAT, SEND or message command. Normally,
 
242
          Eggdrop notifies the user that the command has been rejected
 
243
          because they don&#39;t have access. Note that sometimes IRC
 
244
          server operators detect bots that way.</p>
234
245
        </dd>
235
246
 
236
247
        <dt><strong>set flood-msg 5:60</strong></dt>
237
248
 
238
249
        <dd>
239
 
          <p>Set here how many msgs in how many seconds from one host 
 
250
          <p>Set here how many msgs in how many seconds from one host
240
251
          constitutes a flood. If you set this to 0:0, msg flood protection
241
252
          will be disabled.</p>
242
253
        </dd>
255
266
          <p>Set how many ctcps should be answered at once here.</p>
256
267
        </dd>
257
268
 
258
 
        <dt><strong><em>set lowercase-ctcp 0</em></strong></dt>
 
269
        <dt><strong>set lowercase-ctcp 0</strong></dt>
259
270
 
260
271
        <dd>
261
 
          <p>If you want your bot to answer lower case ctcp requests (non 
 
272
          <p>If you want your bot to answer lower case ctcp requests (non
262
273
          rfc-compliant), set this setting to 1. mIRC will do this, most
263
274
          other clients will not.</p>
264
275
        </dd>
265
276
 
266
 
        <dt><strong><em>set trigger-on-ignore 0</em></strong></dt>
 
277
        <dt><strong>set trigger-on-ignore 0</strong></dt>
267
278
 
268
279
        <dd>
269
 
          <p>If you want Eggdrop to trigger binds for ignored users, set 
 
280
          <p>If you want Eggdrop to trigger binds for ignored users, set
270
281
          this to 1.</p>
271
282
        </dd>
272
283
 
295
306
        <dd>
296
307
          <p>This enables Eggdrop&#39;s penalty calculation. Every command
297
308
          Eggdrop sends to the IRC server raises it&#39;s penalty points.
298
 
          If Eggdrop reaches a server limit, it gets disconnected with 
299
 
          "excess flood" message. Eggdrop is able to count internal those 
 
309
          If Eggdrop reaches a server limit, it gets disconnected with
 
310
          "excess flood" message. Eggdrop is able to count internal those
300
311
          penalty points, too and take measures against excess flooding.
301
312
          Note: it&#39;s highly advised to turn this on!</p>
302
313
        </dd>
303
314
 
304
 
        <dt><strong><em>set optimize-kicks 1</em></strong></dt>
 
315
        <dt><strong>set optimize-kicks 1</strong></dt>
305
316
 
306
317
        <dd>
307
 
          <p>This optimizes the kick queue. It also traces nick changes 
 
318
          <p>This optimizes the kick queue. It also traces nick changes
308
319
          and parts in the channel and changes the kick queue accordingly.
309
320
          There are three different options for this setting:</p>
310
321
 
326
337
 
327
338
    <blockquote>
328
339
      <dl>
329
 
        <dt><strong><em>set check-mode-r 1</em></strong></dt>
 
340
        <dt><strong>set check-mode-r 1</strong></dt>
330
341
 
331
342
        <dd>
332
343
          <p>This settings defines how umode +r is understood by Eggdrop.
337
348
          and set to 1 for net-type 1.</p>
338
349
        </dd>
339
350
 
340
 
        <dt><strong><em>set nick-len 9</em></strong></dt>
 
351
        <dt><strong>set nick-len 9</strong></dt>
341
352
 
342
353
        <dd>
343
354
          <p>This setting allows you to specify the maximum nick-length
344
 
          supported by your network. The default setting is 9. The 
 
355
          supported by your network. The default setting is 9. The
345
356
          maximum supported length by Eggdrop is 32.</p>
346
357
        </dd>
347
358
      </dl>
348
359
    </blockquote>
349
360
    <hr>
350
361
 
351
 
    <p><a name="tclcmds"></a>2. <strong>Tcl commands</strong></p>
352
 
 
353
 
    <p>See doc/tcl-commands.doc for information on each of these 
354
 
       commands.</p>
355
 
 
356
 
    <blockquote>
357
 
      <ul>
358
 
        <li><strong>putserv &lt;text&gt;</strong></li>
359
 
 
360
 
        <li><strong>putquick &lt;text&gt;</strong></li>
361
 
 
362
 
        <li><strong>puthelp &lt;text&gt;</strong></li>
363
 
 
364
 
        <li><strong>queuesize [queue]</strong></li>
365
 
 
366
 
        <li><strong>clearqueue &lt;queue&gt;</strong></li>
367
 
 
368
 
        <li><strong>dumpfile &lt;nick&gt; &lt;filename&gt;</strong></li>
369
 
 
370
 
        <li><strong>jump [server [port [password]]]</strong></li>
371
 
      </ul>
372
 
    </blockquote>
373
 
 
374
 
    <p><a name="tclvars"></a>3. <strong>Tcl variables</strong></p>
375
 
 
376
 
    <blockquote>
377
 
      <dl>
378
 
        <dt><strong>botnick</strong></dt>
379
 
 
380
 
        <dd>
381
 
          <p>This is the current nickname the bot is using, i.e. 
382
 
          &#39;Sisko&#39; or &#39;Sisko0&#39;, etc.</p>
383
 
        </dd>
384
 
 
385
 
        <dt><strong>botname</strong></dt>
386
 
 
387
 
        <dd>
388
 
          <p>This is the current nick!user@host that the server sees, i.e.
389
 
          &#39;Sisko!ikaney@uk.defiant.org&#39;.</p>
390
 
        </dd>
391
 
 
392
 
        <dt><strong>isjuped</strong></dt>
393
 
 
394
 
        <dd>
395
 
          <p>The value of this variable is 1 if bots nick is juped(437); 0 
396
 
          otherwise.</p>
397
 
        </dd>
398
 
 
399
 
        <dt><strong>server</strong></dt>
400
 
 
401
 
        <dd>
402
 
          <p>This is the current server the bot is using, i.e.
403
 
          &#39;irc.math.ufl.edu:6667&#39;.</p>
404
 
        </dd>
405
 
 
406
 
        <dt><strong>server-online</strong></dt>
407
 
 
408
 
        <dd>
409
 
          <p>This is the uunixtime value for when the bot connected to its
410
 
          current server.</p>
411
 
        </dd>
412
 
      </dl>
413
 
    </blockquote>
414
 
    <hr>
415
 
 
416
362
    <p><em>Copyright &copy; 1997 Robey Pointer<br>
417
 
     Copyright &copy; 1999, 2000, 2001, 2002 <a href="http://www.eggheads.org/">
418
 
     Eggheads Development Team</a></em></p>
 
363
    Copyright &copy; 1999, 2000, 2001, 2002, 2003, 2004
 
364
    <a href="http://www.eggheads.org/"> Eggheads Development Team</a></em></p>
419
365
  </body>
420
366
</html>