summary refs log tree commit diff
diff options
context:
space:
mode:
authorAlexander Barton <alex@barton.de>2011-03-19 17:02:39 +0100
committerAlexander Barton <alex@barton.de>2011-03-19 17:04:57 +0100
commitacd7a5d6d41ca8017d3c2217b0c0bde129b4e041 (patch)
tree126fc15b48fca363654d4c891750f18e018373f8
parentae7470ceb546d87cbd366d508641276313ec9130 (diff)
downloadngircd-acd7a5d6d41ca8017d3c2217b0c0bde129b4e041.tar.gz
ngircd-acd7a5d6d41ca8017d3c2217b0c0bde129b4e041.zip
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.
-rw-r--r--doc/sample-ngircd.conf.tmpl2
-rw-r--r--man/ngircd.conf.5.tmpl6
2 files changed, 8 insertions, 0 deletions
diff --git a/doc/sample-ngircd.conf.tmpl b/doc/sample-ngircd.conf.tmpl
index a2eeee9f..e07b5205 100644
--- 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 fa77c64b..131fa29f 100644
--- 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