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

« back to all changes in this revision

Viewing changes to doc/BANS

  • 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
$Id: BANS,v 1.5 2004/01/09 05:56:35 wcc Exp $
 
2
 
 
3
Bans, Invites and Exempts
 
4
Last revised: March 07, 2002
 
5
     _________________________________________________________________
 
6
 
 
7
                         Bans, Invites, and Exempts
 
8
 
 
9
 
 
10
    I assume that you know how bans work on IRC. Eggdrop handles bans,
 
11
    exempts and invites in various ways, and this file is intended to help
 
12
    clarify how these modes are used within the bot. From here on, 'mode'
 
13
    applies to all three modes (bans, exempts, and invites) unless otherwise
 
14
    specified. There are three types of modes:
 
15
 
 
16
      Global modes   These modes will be active on every channel the bot
 
17
                     monitors. Some will "expire" after a while (be removed
 
18
                     automatically). Others are considered "permanent" and
 
19
                     can only be removed by a master.
 
20
 
 
21
      Channel modes  These modes are active only on one channel, and are almost
 
22
                     always temporary modes that expire after an hour or so
 
23
                     (depending on how long you've specified in the config
 
24
                     file). Usually they're created by a Tcl script of some
 
25
                     sort.
 
26
 
 
27
      Non-bot modes  These are modes that were not placed by the bot. They
 
28
                     can be removed by anyone on the channel. The other two
 
29
                     types of modes are protected by the bot (unless the
 
30
                     channel settings specify otherwise), and have to be
 
31
                     removed via the bot.
 
32
 
 
33
    Bans can also be either sticky or unsticky:
 
34
 
 
35
      Sticky     These modes are usually set by a user using the ".stick"
 
36
                 command. Modes with this attribute are attempted to be kept
 
37
                 active on the channel at all times by the bot, even if the
 
38
                 channel is set to use dynamic modes. Obviously, if the channel
 
39
                 isn't set to use dynamic modes, this won't have any effect.
 
40
 
 
41
      Un-sticky  These modes are the style that Eggdrop sets by default when
 
42
                 a user uses one of the commands that result in a mode. This
 
43
                 attribute means that the ban will be removed if using dynamic
 
44
                 modes after a certain time. If a mode is "sticky" and you wish
 
45
                 to set it to be "un-sticky", use the ".unstick" command.
 
46
 
 
47
    Mode behavior:
 
48
 
 
49
      Bans     If the channel is supporting dynamic bans, then the ban is
 
50
               set when a user with a matching hostmask joins the channel;
 
51
               otherwise, the modes are permanently set. On a channel with
 
52
               dynamic bans, the ban expires after 'ban-time' minutes (which
 
53
               is specified in the config file).
 
54
 
 
55
      Exempts  If the channel is not supporting dynamic exempts, then they
 
56
               are set at all times. Otherwise, the exemption is set when a
 
57
               ban is placed whose host includes that covered by the exempt.
 
58
               The exempt will remain in place for at least 'exempt-time'
 
59
               minutes (defined in config file) or until after the
 
60
               corresponding ban has been removed, whichever happens last.
 
61
 
 
62
      Invites  If the channel does not support dynamic invites, then they
 
63
               are set at all times. Otherwise, the invite is set when the
 
64
               channel is +i and a user requests an invite into the channel.
 
65
               The invite then remains set for 'invite-time' minutes
 
66
               (defined in config file) or until the channel goes -i again,
 
67
               whichever happens last.
 
68
       _________________________________________________________________
 
69
 
 
70
   Copyright (C) 2002, 2003, 2004 Eggheads Development Team