fix typo in `sasl_only_client_message` (#279)

[solanum.git] / doc / reference.conf

diff --git a/doc/reference.conf b/doc/reference.conf
index 380fde7c7c14adfba9a06aaa346cef2900f1397a..368c5a70ce3d8c433b522a3718eea14013de7727 100644 (file)
--- a/doc/reference.conf
+++ b/doc/reference.conf
@@ -26,6 +26,10 @@
  *        .include "filename"
  *        .include <filename>
  *
+ * Flags variables are comma-separated sets of predefined values,
+ * specific to each block. For example in operator {} blocks:
+ *        flags = encrypted, encrypted;
+ *
  * Times/durations are written as:
  *        12 hours 30 minutes 1 second
  *
@@ -72,7 +76,6 @@
  * Far connection notices (snomask +F)               -- sno_farconnect
  * Remote oper up notices                            -- sno_globaloper
  * Global nick-change notices                        -- sno_globalnickchange
- * /whois notifications (snomask +W)                 -- sno_whois
  * Oper-override (modehacking only)                  -- override
  * Stop services kills                               -- no_kill_services
  */
@@ -105,7 +108,6 @@
 #loadmodule "extensions/sno_farconnect";
 #loadmodule "extensions/sno_globalnickchange";
 #loadmodule "extensions/sno_globaloper";
-#loadmodule "extensions/sno_whois";
 #loadmodule "extensions/override";
 #loadmodule "extensions/no_kill_services";
 
@@ -546,14 +548,21 @@ operator "god" {
        privset = "admin";
 };
 
-/* connect {}: controls servers we connect to (OLD C:, N:, H:, L:) */
+/* connect {}: controls servers we connect with (OLD C:, N:, H:, L:).
+ *
+ * This configuration is used whether connections are incoming or
+ * outgoing.
+ */
 connect "irc.uplink.com" {
        /* the name of the other server must go above. It should match the
         * other server's name in its serverinfo {} block, and does not
-        * need to be an actual hostname. */
+        * need to be an actual hostname.
+        */
 
-       /* host: the host or IP to connect to.  If a hostname is used it
-        * must match the reverse dns of the server.
+       /* host: the host or IP to connect to.
+        *
+        * It is also used to validate incoming connections. If a hostname
+        * is used, it must match the reverse dns of the server.
         */
        host = "203.0.113.3";
 
@@ -1148,6 +1157,52 @@ general {
         */
        kline_reason = "Connection closed";
 
+       /* SASL access only client message: give users a message that
+        * informs them
+        */
+       sasl_only_client_message = "You need to identify via SASL to use this server.";
+
+       /* Identd access only client message: give users a message that
+        * informs them
+        */
+       identd_only_client_message = "You need to install identd to use this server.";
+
+       /* SCTP forbidden client message: give users a message that
+        * informs them
+        */
+       sctp_forbidden_client_message = "You are not allowed to use SCTP on this server.";
+
+       /* SSL/TLS access only client message: give users a message that
+        * informs them
+        */
+       ssltls_only_client_message = "You need to use SSL/TLS to use this server.";
+
+       /* Not authorised client message: tell users that they are not
+        * authorised
+        */
+       not_authorised_client_message = "You are not authorised to access this server.";
+
+       /* Illegal hostname client message: tell users that they have illegal
+        * chars in their hostname
+        */
+       illegal_hostname_client_message = "You have an illegal character in your hostname.";
+
+       /* Server full client message: tell users that the server they're connecting
+        * to is full
+        */
+       server_full_client_message = "Sorry, server is full - try later";
+
+       /* illegal name long client message: long-form explanation that their username
+        * contains illegal characters
+        */
+       illegal_name_long_client_message = "Your username is invalid. Please make sure that your username contains "
+                                                                          "only alphanumeric characters.";
+
+       /* illegal name short client message: short-form notification that their username
+        * contains illegal characters; will be followed by ": their_username"
+        */
+       illegal_name_short_client_message = "Invalid username";
+
        /* identify to services via server password
         * if auth{} block had no password but the user specified a
         * server password anyway, send a PRIVMSG to <identify_service>