ngircd.conf.5: document "ClientHost" and "ClientUserNick"

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

diff --git a/man/ngircd.conf.5.tmpl b/man/ngircd.conf.5.tmpl
index d9e6f4626c0f161f0019b2e463f07ba0680980fe..328247632685943703d6ef9e12885a2a80dd4b33 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 "Dec 2008" ngircd "ngIRCd Manual"
+.TH ngircd.conf 5 "Dec 2010" ngircd "ngIRCd Manual"

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


@@ -47,13 +47,18 @@ ports on which the server should be listening. IRC operators of this
 server are defined in
 .I [Operator]
 blocks.
 server are defined in
 .I [Operator]
 blocks.

+.I [Features]
+can be used to disable compile-time features at run time, e.g. if ngircd
+was built to support ident lookups, but you do not want ngircd to perform
+ident lookups you can disable them here.
+This section is optional.

 .I [Server]
 is the section where server links are configured. And
 .I [Channel]
 blocks are used to configure pre-defined ("persistent") IRC channels.
 .PP
 There can be more than one [Operator], [Server] and [Channel] sections
 .I [Server]
 is the section where server links are configured. And
 .I [Channel]
 blocks are used to configure pre-defined ("persistent") IRC channels.
 .PP
 There can be more than one [Operator], [Server] and [Channel] sections

-per configuration file, but only one [Global] section.
+per configuration file, but only one [Global] and one [Features] section.

 .SH [GLOBAL]
 The
 .I [Global]
 .SH [GLOBAL]
 The
 .I [Global]


@@ -69,6 +74,15 @@ IRC network and must contain at least one dot (".") character.
 Info text of the server. This will be shown by WHOIS and LINKS requests for
 example.
 .TP
 Info text of the server. This will be shown by WHOIS and LINKS requests for
 example.
 .TP

+\fBPassword\fR
+Global password for all users needed to connect to the server. The default
+is empty, so no password is required.
+.TP
+\fBWebircPassword\fR
+Password required for using the WEBIRC command used by some Web-to-IRC
+gateways. If not set or empty, the WEBIRC command can't be used.
+Default: not set.
+.TP

 \fBAdminInfo1\fR, \fBAdminInfo2\fR, \fBAdminEMail\fR
 Information about the server and the administrator, used by the ADMIN
 command.
 \fBAdminInfo1\fR, \fBAdminInfo2\fR, \fBAdminEMail\fR
 Information about the server and the administrator, used by the ADMIN
 command.


@@ -107,14 +121,20 @@ If unset, the defaults value is "0.0.0.0" or, if ngIRCd was compiled
 with IPv6 support, "::,0.0.0.0". So the server listens on all configured
 IP addresses and interfaces by default.
 .TP
 with IPv6 support, "::,0.0.0.0". So the server listens on all configured
 IP addresses and interfaces by default.
 .TP

+\fBSyslogFacility\fR
+Syslog "facility" to which ngIRCd should send log messages. Possible
+values are system dependant, but most probably "auth", "daemon", "user"
+and "local1" through "local7" are possible values; see syslog(3).
+Default is "local5" for historical reasons, you probably want to
+change this to "daemon", for example.
+.TP

 \fBMotdFile\fR
 Text file with the "message of the day" (MOTD). This message will be shown
 \fBMotdFile\fR
 Text file with the "message of the day" (MOTD). This message will be shown

-to all users connecting to the server.
+to all users connecting to the server. Changes made to this file
+take effect when ngircd is instructed to re-read its configuration file.

 .TP
 \fBMotdPhrase\fR
 A simple Phrase (<256 chars) if you don't want to use a MOTD file.
 .TP
 \fBMotdPhrase\fR
 A simple Phrase (<256 chars) if you don't want to use a MOTD file.

-If this variable is set, no \fBMotdFile\fR will be read at all which can be
-handy if the daemon should run inside a chroot directory.

 .TP
 \fBServerUID\fR
 User ID under which the server should run; you can use the name of the user
 .TP
 \fBServerUID\fR
 User ID under which the server should run; you can use the name of the user


@@ -190,17 +210,6 @@ you do not want to have channels other than those defined in
 [Channel] sections in the configuration file.
 Default: no.
 .TP
 [Channel] sections in the configuration file.
 Default: no.
 .TP

-\fBNoDNS\fR
-If set to true, ngIRCd will not make DNS lookups when clients connect.
-If you configure the daemon to connect to other servers, ngIRCd may still
-perform a DNS lookup if required.
-Default: no.
-.TP
-\fBNoIdent\fR
-If ngIRCd is compiled with IDENT support this can be used to disable IDENT
-lookups at run time.
-Default: no.
-.TP

 \fBConnectIPv4\fR
 Set this to no if you do not want ngIRCd to connect to other IRC servers using
 IPv4. This allows usage of ngIRCd in IPv6-only setups.
 \fBConnectIPv4\fR
 Set this to no if you do not want ngIRCd to connect to other IRC servers using
 IPv4. This allows usage of ngIRCd in IPv6-only setups.


@@ -227,6 +236,14 @@ Default: 10.
 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
 length!
 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
 length!

+.TP
+\fBClientHost\fR
+Set this hostname for every client instead of the real one. Default: empty,
+don't change.
+.TP
+\fBClientUserNick\fR
+Set every clients' user name to their nick name and hide the one supplied
+by the IRC client. Default: no.

 .SH [OPERATOR]
 .I [Operator]
 sections are used to define IRC Operators. There may be more than one
 .SH [OPERATOR]
 .I [Operator]
 sections are used to define IRC Operators. There may be more than one


@@ -242,6 +259,27 @@ Password of the IRC operator.
 \fBMask\fR
 Mask that is to be checked before an /OPER for this account is accepted.
 Example: nick!ident@*.example.com
 \fBMask\fR
 Mask that is to be checked before an /OPER for this account is accepted.
 Example: nick!ident@*.example.com

+.SH [FEATURES]
+An optional section that can be used to disable features at
+run-time. A feature is enabled by default if if ngircd was built with
+support for it.
+\fBDNS\fR
+If set to false, ngIRCd will not make DNS lookups when clients connect.
+If you configure the daemon to connect to other servers, ngIRCd may still
+perform a DNS lookup if required.
+Default: yes.
+.TP
+\fBIdent\fR
+If ngIRCd is compiled with IDENT support this can be used to disable IDENT
+lookups at run time.
+Default: yes.
+.TP
+\fBPAM\fR
+If ngIRCd is compiled with PAM support this can be used to disable all calls
+to the PAM library at runtime; all users connecting without password are
+allowed to connect, all passwords given will fail.
+Default: yes.
+.TP

 .SH [SERVER]
 Other servers are configured in
 .I [Server]
 .SH [SERVER]
 Other servers are configured in
 .I [Server]


@@ -379,13 +417,11 @@ after changing it. See
 .BR ngircd (8)
 for details.
 .SH AUTHOR
 .BR ngircd (8)
 for details.
 .SH AUTHOR

-Alexander Barton,
-.UR mailto:alex@barton.de
-.UE
+Alexander Barton, <alex@barton.de>

 .br
 .br

-Homepage:
-.UR http://ngircd.barton.de/
-.UE
+Florian Westphal, <fw@strlen.de>
+.PP
+Homepage: http://ngircd.barton.de/

 .SH "SEE ALSO"
 .BR ngircd (8)
 .\"
 .SH "SEE ALSO"
 .BR ngircd (8)
 .\"