Add a note not to use a percent sign ("%") in CloakHost variable

The percent sign is reserved for future extensions, for example to
expand some variables like %H to a hash value of the real host name ...

Idea by kaFux in #ngircd.

diff --git a/doc/sample-ngircd.conf.tmpl b/doc/sample-ngircd.conf.tmpl
index a2eeee9f9d60e32e68b82977b1a7c0d6913729db..e07b520544c5599d44ed14d04dc22de3f92e1d47 100644 (file)
--- a/doc/sample-ngircd.conf.tmpl
+++ b/doc/sample-ngircd.conf.tmpl
@@ -155,6 +155,8 @@
        ;MaxNickLength = 9
 
        # Set this hostname for every client instead of the real one.
+       # Please note: don't use the percentage sign ("%"), it is reserved for
+       # future extensions!
        ;CloakHost = irc.example.net
 
        # Set every clients' user name to their nick name

diff --git a/man/ngircd.conf.5.tmpl b/man/ngircd.conf.5.tmpl
index fa77c64bd8433870ecbb657ea33fc50d40f982df..131fa29f4f77832a5af099296a545af171c62665 100644 (file)
--- a/man/ngircd.conf.5.tmpl
+++ b/man/ngircd.conf.5.tmpl
@@ -240,6 +240,12 @@ length!
 \fBCloakHost\fR
 Set this hostname for every client instead of the real one. Default: empty,
 don't change.
+.PP
+.RS
+.B Please note:
+.br
+Don't use the percentage sign ("%"), it is reserved for future extensions!
+.RE
 .TP
 \fBCloakUserToNick\fR
 Set every clients' user name to their nick name and hide the one supplied