Improve X-line text consistency.

[user/henk/code/inspircd.git] / docs / conf / filter.conf.example

diff --git a/docs/conf/filter.conf.example b/docs/conf/filter.conf.example
index ef7f50588258bf6d26eb918169398cff1ca579d8..29e1f530c5e382c0641cdc80616f15d5f910df65 100644 (file)
--- a/docs/conf/filter.conf.example
+++ b/docs/conf/filter.conf.example
@@ -1,4 +1,4 @@
-# Configuration file for m_filter.so
+# Configuration file for the filter module
 
 # The tags for this module are formatted as follows:
 #
@@ -6,10 +6,13 @@
 #               reason="reason for filtering"
 #               action="action to take"
 #               flags="filter flags"
-#              duration="optional length of gline">
+#               duration="optional duration of the G-line, Z-line or shun">
 #
 # Valid actions for 'action' are:
 #
+# warn          This allows the line and sends out a notice to all opers
+#               with +s.
+#
 # block         This blocks the line, sends out a notice to all opers with
 #               +s and informs the user that their message was blocked.
 #
@@ -22,10 +25,21 @@
 # kill          This disconnects the user, with the 'reason' parameter as
 #               the kill reason.
 #
-# gline         G-LINE the user for 'duration' length of time. Durations may
+# gline         G-line the user for 'duration' length of time. Durations may
+#               be specified using the notation 1y2d3h4m6s in a similar way to
+#               other G-lines, omitting the duration or setting it to 0 makes
+#               any G-lines set by this filter be permanent.
+#
+# zline         Z-line the user for 'duration' length of time. Durations may
 #               be specified using the notation 1y2d3h4m6s in a similar way to
-#               other glines, omitting the duration or setting it to 0 makes
-#               any glines set by this filter be permanent.
+#               other Z-lines, omitting the duration or setting it to 0 makes
+#               any Z-lines set by this filter be permanent.
+#
+# shun          Shun the user for 'duration' length of time. Durations may
+#               be specified using the notation 1y2d3h4m6s in a similar way to
+#               other X-lines, omitting the duration or setting it to 0 makes
+#               any shuns set by this filter be permanent.
+#               Requires the shun module to be loaded.
 #
 # You can add filters from IRC using the /FILTER command. If you do this, they
 # will be set globally to your entire network.
@@ -40,19 +54,14 @@
 # c: Strip color codes from text before trying to match
 # *: Represents all of the above flags
 # -: Does nothing, a no-op for when you do not want to specify any flags
-#
-# IMPORTANT NOTE: Because the InspIRCd config reader places special meaning on the
-# '\' character, you must use '\\' if you wish to specify a '\' character in a regular
-# expression. For example, to indicate numbers, use \\d and not \d. This does not
-# apply when adding a regular expression over irc with the /FILTER command.
 
-# Example filters for m_filter:
+# Example filters:
 #
 # <keyword pattern="*qwerty*" reason="You qwertied!" action="block" flags="pn">
 # <keyword pattern="*killmenow*" reason="As you request." action="kill" flags="*">
 # <keyword pattern="*blah*" reason="Dont blah!" action="gline" duration="1d6h" flags="-">
 
-# An example regexp filter for m_filter_pcre:
+# An example regexp filter:
 #
 # <keyword pattern="^blah.*?$" reason="Dont blah!" action="gline" duration="1d6h" flags="pnPq">