summaryrefslogtreecommitdiff
path: root/docs/conf/modules.conf.example
diff options
context:
space:
mode:
authorSadie Powell <sadie@witchery.services>2021-01-11 10:07:11 +0000
committerSadie Powell <sadie@witchery.services>2021-01-11 10:07:11 +0000
commit5a19ff00aca5d979bf9ca45a2b0d6e85acdc9fc3 (patch)
tree3e5c31e168342671b38b77cab5eafe9b797bcc37 /docs/conf/modules.conf.example
parent8d6b550e0b30983886dc240fd3261fae786d5693 (diff)
Add a user mode which allows disabling receiving channel history.
Closes #1830.
Diffstat (limited to 'docs/conf/modules.conf.example')
-rw-r--r--docs/conf/modules.conf.example26
1 files changed, 19 insertions, 7 deletions
diff --git a/docs/conf/modules.conf.example b/docs/conf/modules.conf.example
index 4fab166d2..1faec808c 100644
--- a/docs/conf/modules.conf.example
+++ b/docs/conf/modules.conf.example
@@ -450,13 +450,25 @@
# the current topic of conversation is when joining the channel.
#<module name="chanhistory">
#
-# Set the maximum number of lines allowed to be stored per channel below.
-# This is the hard limit for 'X'.
-# If prefixmsg is set to yes, joining users without batch support will get
-# a NOTICE before playback telling them about the following lines being
-# the pre-join history.
-# If bots is set to yes, it will also send to users marked with +B
-#<chanhistory maxlines="50" prefixmsg="yes" bots="yes">
+#-#-#-#-#-#-#-#-#-#-#- CHANHISTORY CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
+# #
+# bots - Whether to send channel history to bots. Defaults to yes. #
+# #
+# enableumode - Whether to enable the +N user mode which allows users #
+# to opt-out of receiving channel history. Defaults to #
+# no. #
+# #
+# maxlines - The maximum number of lines of chat history to send to a #
+# joining users. Defaults to 50. #
+# #
+# prefixmsg - Whether to send an explanatory message to clients that #
+# don't support the chathistory batch type. Defaults to #
+# yes. #
+# #
+#<chanhistory bots="yes"
+# enableumode="yes"
+# maxlines="50"
+# prefixmsg="yes">
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# Channel logging module: Used to send snotice output to channels, to