docs/conf/filter.conf.example

   1 # Configuration file for the filter module
   2
   3 # The tags for this module are formatted as follows:
   4 #
   5 # <keyword      pattern="any glob pattern here"
   6 #               reason="reason for filtering"
   7 #               action="action to take"
   8 #               flags="filter flags"
   9 #               duration="optional duration of the G-line, Z-line or shun">
  10 #
  11 # Valid actions for 'action' are:
  12 #
  13 # warn          This allows the line and sends out a notice to all opers
  14 #               with +s.
  15 #
  16 # block         This blocks the line, sends out a notice to all opers with
  17 #               +s and informs the user that their message was blocked.
  18 #
  19 # silent        This blocks the line only, and informs the user that their
  20 #               message was blocked, but does not notify opers.
  21 #
  22 # none          This action causes nothing to be done except logging. This
  23 #               is the default action if none is specified.
  24 #
  25 # kill          This disconnects the user, with the 'reason' parameter as
  26 #               the kill reason.
  27 #
  28 # gline         G-line the user for 'duration' length of time. Durations may
  29 #               be specified using the notation 1y2w3d4h5m6s in a similar way to
  30 #               other G-lines, omitting the duration or setting it to 0 makes
  31 #               any G-lines set by this filter be permanent.
  32 #
  33 # zline         Z-line the user for 'duration' length of time. Durations may
  34 #               be specified using the notation 1y2w3d4h5m6s in a similar way to
  35 #               other Z-lines, omitting the duration or setting it to 0 makes
  36 #               any Z-lines set by this filter be permanent.
  37 #
  38 # shun          Shun the user for 'duration' length of time. Durations may
  39 #               be specified using the notation 1y2w3d4h5m6s in a similar way to
  40 #               other X-lines, omitting the duration or setting it to 0 makes
  41 #               any shuns set by this filter be permanent.
  42 #               Requires the shun module to be loaded.
  43 #
  44 # You can add filters from IRC using the /FILTER command. If you do this, they
  45 # will be set globally to your entire network.
  46 #
  47 # Valid characters for 'flags' are one or more of:
  48 #
  49 # p: Block private and channel messages
  50 # n: Block private and channel notices
  51 # P: Block part messages
  52 # q: Block quit messages
  53 # o: Don't match against opers
  54 # c: Strip color codes from text before trying to match
  55 # *: Represents all of the above flags
  56 # -: Does nothing, a no-op for when you do not want to specify any flags
  57
  58 # Example filters:
  59 #
  60 # <keyword pattern="*qwerty*" reason="You qwertied!" action="block" flags="pn">
  61 # <keyword pattern="*killmenow*" reason="As you request." action="kill" flags="*">
  62 # <keyword pattern="*blah*" reason="Don't blah!" action="gline" duration="1d6h" flags="-">
  63
  64 # An example regexp filter:
  65 #
  66 # <keyword pattern="^blah.*?$" reason="Don't blah!" action="gline" duration="1d6h" flags="pnPq">
  67
  68 # You may specify specific channels that are exempt from being filtered:
  69 #<exemptfromfilter target="#opers">
  70 #<exemptfromfilter target="#help">
  71
  72 # You can also exempt messages from being filtered if they are sent to
  73 # specific nicks.
  74 # Example that exempts all messages sent *to* NickServ:
  75 #<exemptfromfilter target="NickServ">
  76
  77 # Note that messages *from* services are never subject to filtering;
  78 # <exemptfromfilter> tags are only for exempting messages sent *to* the
  79 # configured targets.