Spelling fix: "nick name" -> "nickname"

[ngircd-alex.git] / man / ngircd.conf.5.tmpl

diff --git a/man/ngircd.conf.5.tmpl b/man/ngircd.conf.5.tmpl
index 59d31a366f0515b732f6204c8c8c9fcd468d0968..e3f62c84ceb3432a64410cf65e5f6df83961115e 100644 (file)
--- a/man/ngircd.conf.5.tmpl
+++ b/man/ngircd.conf.5.tmpl
@@ -1,7 +1,7 @@
 .\"
 .\" ngircd.conf(5) manual page template
 .\"
 .\"
 .\" ngircd.conf(5) manual page template
 .\"

-.TH ngircd.conf 5 "Jun 2011" ngircd "ngIRCd Manual"
+.TH ngircd.conf 5 "Nov 2012" ngIRCd "ngIRCd Manual"

 .SH NAME
 ngircd.conf \- configuration file of ngIRCd
 .SH SYNOPSIS
 .SH NAME
 ngircd.conf \- configuration file of ngIRCd
 .SH SYNOPSIS


@@ -132,9 +132,8 @@ the pidfile resides in must be writable by the ngIRCd user and exist in the
 chroot directory (if configured, see above).
 .TP
 \fBPorts\fR (list of numbers)
 chroot directory (if configured, see above).
 .TP
 \fBPorts\fR (list of numbers)

-Ports on which the server should listen. There may be more than one port,
-separated with commas (","). Default: 6667, unless \fBSSL_Ports\fR are also
-specified.
+Ports on which the server should listen for unencrypted connections. There
+may be more than one port, separated with commas (","). Default: 6667.

 .TP
 \fBServerGID\fR (string or number)
 Group ID under which the ngIRCd should run; you can use the name of the
 .TP
 \fBServerGID\fR (string or number)
 Group ID under which the ngIRCd should run; you can use the name of the


@@ -179,10 +178,13 @@ Maximum number of channels a user can be member of (0: no limit).
 Default: 10.
 .TP
 \fBMaxNickLength\fR (number)
 Default: 10.
 .TP
 \fBMaxNickLength\fR (number)

-Maximum length of an user nick name (Default: 9, as in RFC 2812). Please
-note that all servers in an IRC network MUST use the same maximum nick name
+Maximum length of an user nickname (Default: 9, as in RFC 2812). Please
+note that all servers in an IRC network MUST use the same maximum nickname

 length!
 .TP
 length!
 .TP

+\fBMaxListSize\fR (number)
+Maximum number of channels returned in response to a LIST command. Default: 100.
+.TP

 \fBPingTimeout\fR (number)
 After <PingTimeout> seconds of inactivity the server will send a PING to
 the peer to test whether it is alive or not. Default: 120.
 \fBPingTimeout\fR (number)
 After <PingTimeout> seconds of inactivity the server will send a PING to
 the peer to test whether it is alive or not. Default: 120.


@@ -213,16 +215,19 @@ For this to work the server must have been started with root privileges!
 .TP
 \fBCloakHost\fR (string)
 Set this hostname for every client instead of the real one. Default: empty,
 .TP
 \fBCloakHost\fR (string)
 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
+don't change. Use %x to add the hashed value of the original hostname.
+.TP
+\fBCloakHostModeX\fR (string)
+Use this hostname for hostname cloaking on clients that have the user mode
+"+x" set, instead of the name of the server. Default: empty, use the name
+of the server. Use %x to add the hashed value of the original hostname
+.TP
+\fBCloakHostSalt\fR (string)
+The Salt for cloaked hostname hashing. When undefined a random hash is
+generated after each server start.

 .TP
 \fBCloakUserToNick\fR (boolean)
 .TP
 \fBCloakUserToNick\fR (boolean)

-Set every clients' user name to their nick name and hide the one supplied
+Set every clients' user name to their nickname and hide the one supplied

 by the IRC client. Default: no.
 .TP
 \fBConnectIPv4\fR (boolean)
 by the IRC client. Default: no.
 .TP
 \fBConnectIPv4\fR (boolean)


@@ -266,6 +271,10 @@ while connecting. Default: no.
 Should IRC Operators be allowed to use the MODE command even if they are
 not(!) channel-operators? Default: no.
 .TP
 Should IRC Operators be allowed to use the MODE command even if they are
 not(!) channel-operators? Default: no.
 .TP

+\fBOperChanPAutoOp\fR (boolean)
+Should IRC Operators get AutoOp (+o) in persistent (+P) channels?
+Default: yes.
+.TP

 \fBOperServerMode\fR (boolean)
 If \fBOperCanUseMode\fR is enabled, this may lead the compatibility problems
 with Servers that run the ircd-irc2 Software. This Option "masks" mode
 \fBOperServerMode\fR (boolean)
 If \fBOperCanUseMode\fR is enabled, this may lead the compatibility problems
 with Servers that run the ircd-irc2 Software. This Option "masks" mode


@@ -360,7 +369,7 @@ sections are used to define IRC Operators. There may be more than one
 block, one for each local operator.
 .TP
 \fBName\fR (string)
 block, one for each local operator.
 .TP
 \fBName\fR (string)

-ID of the operator (may be different of the nick name).
+ID of the operator (may be different of the nickname).

 .TP
 \fBPassword\fR (string)
 Password of the IRC operator.
 .TP
 \fBPassword\fR (string)
 Password of the IRC operator.


@@ -420,14 +429,16 @@ You can use the IRC Operator command CONNECT later on to create the link.
 Connect to the remote server using TLS/SSL. Default: false.
 .TP
 \fBServiceMask\fR (string)
 Connect to the remote server using TLS/SSL. Default: false.
 .TP
 \fBServiceMask\fR (string)

-Define a (case insensitive) mask matching nick names that should be treated as
-IRC services when introduced via this remote server. REGULAR SERVERS DON'T NEED
-this parameter, so leave it empty (which is the default).
+Define a (case insensitive) list of masks matching nicknames that should be
+treated as IRC services when introduced via this remote server, separated
+by commas (","). REGULAR SERVERS DON'T NEED this parameter, so leave it empty
+(which is the default).

 .PP
 .RS
 When you are connecting IRC services which mask as a IRC server and which use
 "virtual users" to communicate with, for example "NickServ" and "ChanServ",
 .PP
 .RS
 When you are connecting IRC services which mask as a IRC server and which use
 "virtual users" to communicate with, for example "NickServ" and "ChanServ",

-you should set this parameter to something like "*Serv".
+you should set this parameter to something like "*Serv", "*Serv,OtherNick",
+or "NickServ,ChanServ,XyzServ".

 .SH [CHANNEL]
 Pre-defined channels can be configured in
 .I [Channel]
 .SH [CHANNEL]
 Pre-defined channels can be configured in
 .I [Channel]