Replace most usages of "GECOS" with "real" or "real name".

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

diff --git a/docs/conf/inspircd.conf.example b/docs/conf/inspircd.conf.example
index e28319a694bb984464c50148188326447a73134c..12fc613aaebf9ce127f967be17111f98ffb7d65a 100644 (file)
--- a/docs/conf/inspircd.conf.example
+++ b/docs/conf/inspircd.conf.example
@@ -185,6 +185,9 @@
 # module).
 #<bind address="" port="7002" type="clients" hook="websocket">
 
+# EXPERIMENTAL: Listener that binds on a UNIX endpoint instead of a TCP/IP endpoint:
+#<bind path="/tmp/inspircd.sock" type="clients">
+
 # You can define a custom <sslprofile> tag which defines the SSL configuration
 # for this listener. See the wiki page for the SSL module you are using for
 # more details.
@@ -313,6 +316,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)
@@ -767,7 +782,8 @@
 
           # restrictbannedusers: If this is set to yes, InspIRCd will not allow users
           # banned on a channel to change nickname or message channels they are
-          # banned on.
+          # banned on. This can also be set to silent to restrict the user but not
+          # notify them.
           restrictbannedusers="yes"
 
           # genericoper: Setting this value to yes makes all opers on this server
@@ -820,8 +836,8 @@
         # maxkick: Maximum length of a kick message.
         maxkick="255"
 
-        # maxgecos: Maximum length of a real name (gecos).
-        maxgecos="128"
+        # maxreal: Maximum length of a real name.
+        maxreal="128"
 
         # maxaway: Maximum length of an away message.
         maxaway="200">
@@ -852,7 +868,6 @@
 #  - USERS - information relating to user connection and disconnection
 #  - OPER - succesful and failed oper attempts
 #  - KILL - kill related messages
-#  - snomask - server notices (*all* snomasks will be logged)
 #  - FILTER - messages related to filter matches (filter module)
 #  - CONFIG - configuration related messages
 #  - COMMAND - die and restart messages, and messages related to unknown user types