Fix double minus signs in manual pages

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

diff --git a/man/ngircd.conf.5.tmpl b/man/ngircd.conf.5.tmpl
index cff474965d7a33c4e48e0a13fb51caa8623a74c3..e4a5d4a139974b645eb2c86103d1c265bd628e9e 100644 (file)
--- a/man/ngircd.conf.5.tmpl
+++ b/man/ngircd.conf.5.tmpl
@@ -72,9 +72,33 @@ command.
 Ports on which the server should listen. There may be more than one port,
 separated with ','. Default: 6667.
 .TP
 Ports on which the server should listen. There may be more than one port,
 separated with ','. Default: 6667.
 .TP

+\fBSSLPorts\fR
+Same as \fBPorts\fR , except that ngircd will expect incoming connections
+to be SSL/TLS encrypted. Default: None
+.TP
+\fBSSLKeyFile\fR
+Filename of SSL Server Key to be used for SSL connections. This is required for
+SSL/TLS support.
+.TP
+\fBSSLKeyFilePassword\fR
+(OpenSSL only:) Password to decrypt private key.
+.TP
+\fBSSLCertFile\fR
+Certificate of the private key
+.TP
+\fBSSLDHFile\fR
+Name of the Diffie-Hellman Parameter file. Can be created with gnutls
+"certtool \-\-generate-dh-params" or "openssl dhparam".
+If this file is not present, it will be generated on startup when ngircd
+was compiled with gnutls support (this may take some time). If ngircd
+was compiled with OpenSSL, then (Ephemeral)-Diffie-Hellman Key Exchanges and several
+Cipher Suites will not be available.
+.TP

 \fBListen\fR
 \fBListen\fR

-The IP address on which the server should listen. Default is empty, so
-the server listens on all configured IP addresses and interfaces.
+A comma seperated list of IP address on which the server should listen.
+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
 \fBMotdFile\fR
 Text file with the "message of the day" (MOTD). This message will be shown
 .TP
 \fBMotdFile\fR
 Text file with the "message of the day" (MOTD). This message will be shown


@@ -155,19 +179,15 @@ the config file.
 Default: No.
 .TP
 \fBNoDNS\fR
 Default: No.
 .TP
 \fBNoDNS\fR

-If enabled, ngircd will not make DNS lookups when clients connect.
+If set to true, ngircd will not make DNS lookups when clients connect.

 If you configure ngircd to connect to other servers, ngircd may still
 perform a DNS lookup if required.
 If you configure ngircd to connect to other servers, ngircd may still
 perform a DNS lookup if required.

-Default: No.
+Default: false.

 .TP
 .TP

-\fBListenIPv4\fR
-Set this to no if you do not want ngircd to accept clients using the standard internet protocol, ipv4.
-This allows use of ngircd in ipv6-only setups.
-Default: Yes.
-.TP
-\fBListenIPv6\fR
-Set this to no if you do not want ngircd to accept clients using the new internet protocol, ipv6.
-Default: Yes.
+\fBNoIdent\fR
+If ngircd is compiled with IDENT support this can be used to disable IDENT
+lookups at run time.
+Default: false.

 .TP
 \fBConnectIPv4\fR
 Set this to no if you do not want ngircd to connect to other irc servers using ipv4.
 .TP
 \fBConnectIPv4\fR
 Set this to no if you do not want ngircd to connect to other irc servers using ipv4.


@@ -179,8 +199,8 @@ Set this to no if you do not want ngircd to connect to other irc servers using i
 Default: Yes.
 .TP
 \fBMaxConnections\fR
 Default: Yes.
 .TP
 \fBMaxConnections\fR

-Maximum number of simultaneous connection the server is allowed to accept
-(0: unlimited). Default: 0.
+Maximum number of simultaneous in- and outbound connections the server is
+allowed to accept (0: unlimited). Default: 0.

 .TP
 \fBMaxConnectionsIP\fR
 Maximum number of simultaneous connections from a single IP address that
 .TP
 \fBMaxConnectionsIP\fR
 Maximum number of simultaneous connections from a single IP address that


@@ -195,6 +215,8 @@ 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!

+\fBSSLConnect\fR
+Connect to the remote server using TLS/SSL (Default: false)

 .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


@@ -257,6 +279,16 @@ Group of this server (optional).
 \fBPassive\fR
 Disable automatic connection even if port value is specified. Default: false.
 You can use the IRC Operator command CONNECT later on to create the link.
 \fBPassive\fR
 Disable automatic connection even if port value is specified. Default: false.
 You can use the IRC Operator command CONNECT later on to create the link.

+.TP
+\fBServiceMask\fR
+Define a (case insensitive) mask matching nick names that sould 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).
+.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" amd "ChanServ",
+you should set this parameter to something like "*Serv".

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


@@ -285,7 +317,7 @@ Sets initial channel key (only relevant if mode k is set).
 \fBMaxUsers\fR
 Set maximum user limit for this channel (only relevant if mode l is set).
 .SH HINTS
 \fBMaxUsers\fR
 Set maximum user limit for this channel (only relevant if mode l is set).
 .SH HINTS

-It's wise to use "ngircd --configtest" to validate the configuration file
+It's wise to use "ngircd \-\-configtest" to validate the configuration file

 after changing it. See
 .BR ngircd (8)
 for details.
 after changing it. See
 .BR ngircd (8)
 for details.