summaryrefslogtreecommitdiff
path: root/docs/conf/inspircd.conf.example
diff options
context:
space:
mode:
authorPeter Powell <petpow@saberuk.com>2018-03-29 19:04:11 +0100
committerPeter Powell <petpow@saberuk.com>2018-04-22 23:38:13 +0100
commit506344a903d3fa2fcb53f22a3a1c8174b1deb357 (patch)
treed75dba71a58ec6c4e29290ee07d8b9c55f9ab080 /docs/conf/inspircd.conf.example
parent6d1c1cb51753f986b86b408a5828373d0066624b (diff)
Improve support for MOTD escape codes.
- Implement escapes for italic, monospace, and strikethrough. - Use the escape codes in the example MOTDs to demonstrate their formatting effects. - Remove support for octal escape codes. In modern computing octal is rarely used and is confusing for users who might confuse it for decimal.
Diffstat (limited to 'docs/conf/inspircd.conf.example')
-rw-r--r--docs/conf/inspircd.conf.example12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/conf/inspircd.conf.example b/docs/conf/inspircd.conf.example
index e28319a69..b5671ee6b 100644
--- a/docs/conf/inspircd.conf.example
+++ b/docs/conf/inspircd.conf.example
@@ -313,6 +313,18 @@
# Alternate MOTD file for this connect class. The contents of this file are
# specified using <files secretmotd="filename"> or <execfiles ...>
+ #
+ # NOTE: the following escape sequences for IRC formatting characters can be
+ # used in your MOTD:
+ # Bold: \b
+ # Color: \c<fg>[,<bg>]
+ # Italic: \i
+ # Monospace: \m (not widely supported)
+ # Reset: \x
+ # Strikethrough: \s (not widely supported)
+ # Underline: \u
+ # See https://defs.ircdocs.horse/info/formatting.html for more information
+ # on client support for formatting characters.
motd="secretmotd"
# port: What port range this user is allowed to connect on. (optional)