repo: ngircd
action: commit
revision: 
path_from: 
revision_from: acd7a5d6d41ca8017d3c2217b0c0bde129b4e041:
path_to: 
revision_to: 

commit acd7a5d6d41ca8017d3c2217b0c0bde129b4e041
Author: Alexander Barton 
Date:   Sat Mar 19 17:02:39 2011 +0100

    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

--- 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

--- 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

-----END OF PAGE-----