docs/conf/filter.conf.example

   1 # Configuration file for m_filter.so
   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 length of gline">
  10 #
  11 # Valid actions for 'action' are:
  12 #
  13 # block         This blocks the line, sends out a notice to all opers with
  14 #               +s and informs the user that their message was blocked.
  15 #
  16 # silent        This blocks the line only, and informs the user their message
  17 #               was blocked, but does not notify opers.
  18 #
  19 # none          This action causes nothing to be done except logging. This
  20 #               is the default action if none is specified.
  21 #
  22 # kill          This disconnects the user, with the 'reason' parameter as
  23 #               the kill reason.
  24 #
  25 # gline         G-LINE the user for 'duration' length of time. Durations may
  26 #               be specified using the notation 1y2d3h4m6s in a similar way to
  27 #               other glines, omitting the duration or setting it to 0 makes
  28 #               any glines set by this filter be permanent.
  29 #
  30 # You can add filters from IRC using the /FILTER command. If you do this, they
  31 # will be set globally to your entire network.
  32 #
  33 # Valid characters for 'flags' are one or more of:
  34 #
  35 # p: Block private and channel messages
  36 # n: Block private and channel notices
  37 # P: Block part messages
  38 # q: Block quit messages
  39 # o: Don't match against opers
  40 # c: Strip color codes from text before trying to match
  41 # *: Represents all of the above flags
  42 # -: Does nothing, a no-op for when you do not want to specify any flags
  43 #
  44 # IMPORTANT NOTE: Because the InspIRCd config reader places special meaning on the
  45 # '\' character, you must use '\\' if you wish to specify a '\' character in a regular
  46 # expression. For example, to indicate numbers, use \\d and not \d. This does not
  47 # apply when adding a regular expression over irc with the /FILTER command.
  48
  49 # Example filters for m_filter:
  50 #
  51 # <keyword pattern="*qwerty*" reason="You qwertied!" action="block" flags="pn">
  52 # <keyword pattern="*killmenow*" reason="As you request." action="kill" flags="*">
  53 # <keyword pattern="*blah*" reason="Dont blah!" action="gline" duration="1d6h" flags="-">
  54
  55 # An example regexp filter for m_filter_pcre:
  56 #
  57 # <keyword pattern="^blah.*?$" reason="Dont blah!" action="gline" duration="1d6h" flags="pnPq">
  58
  59 # You may specify specific channels that are exempt from being filtered:
  60 #<exemptfromfilter target="#opers">
  61 #<exemptfromfilter target="#help">
  62
  63 # You can also exempt messages from being filtered if they are sent to
  64 # specific nicks.
  65 # Example that exempts all messages sent *to* NickServ:
  66 #<exemptfromfilter target="NickServ">
  67
  68 # Note that messages *from* services are never subject to filtering;
  69 # <exemptfromfilter> tags are only for exempting messages sent *to* the
  70 # configured targets.