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.
This commit is contained in:
Alexander Barton 2011-03-19 17:02:39 +01:00
parent ae7470ceb5
commit acd7a5d6d4
2 changed files with 8 additions and 0 deletions

View File

@ -155,6 +155,8 @@
;MaxNickLength = 9 ;MaxNickLength = 9
# Set this hostname for every client instead of the real one. # 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 ;CloakHost = irc.example.net
# Set every clients' user name to their nick name # Set every clients' user name to their nick name

View File

@ -240,6 +240,12 @@ length!
\fBCloakHost\fR \fBCloakHost\fR
Set this hostname for every client instead of the real one. Default: empty, Set this hostname for every client instead of the real one. Default: empty,
don't change. don't change.
.PP
.RS
.B Please note:
.br
Don't use the percentage sign ("%"), it is reserved for future extensions!
.RE
.TP .TP
\fBCloakUserToNick\fR \fBCloakUserToNick\fR
Set every clients' user name to their nick name and hide the one supplied Set every clients' user name to their nick name and hide the one supplied