X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?p=ngircd-alex.git;a=blobdiff_plain;f=man%2Fngircd.conf.5.tmpl;h=e3f62c84ceb3432a64410cf65e5f6df83961115e;hp=ccf3d948165f4d87c3100ab51b3796288b111995;hb=48326e061aacd954e24f76c53ded10448cbc28eb;hpb=bd118c65fdb1428daf4775205b0f40918b3f22fb diff --git a/man/ngircd.conf.5.tmpl b/man/ngircd.conf.5.tmpl index ccf3d948..e3f62c84 100644 --- a/man/ngircd.conf.5.tmpl +++ b/man/ngircd.conf.5.tmpl @@ -1,7 +1,7 @@ .\" .\" 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 @@ -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) -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 @@ -179,10 +178,13 @@ Maximum number of channels a user can be member of (0: no limit). 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 +\fBMaxListSize\fR (number) +Maximum number of channels returned in response to a LIST command. Default: 100. +.TP \fBPingTimeout\fR (number) After 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, -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) -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) @@ -244,6 +249,8 @@ Default: yes. \fBIdent\fR (boolean) If ngIRCd is compiled with IDENT support this can be used to disable IDENT lookups at run time. +Users identified using IDENT are registered without the "~" character +prepended to their user name. Default: yes. .TP \fBMorePrivacy\fR (boolean) @@ -264,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 +\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 @@ -274,8 +285,23 @@ only enable it if you have ircd-irc2 servers in your IRC network. 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. +Users identified using PAM are registered without the "~" character +prepended to their user name. Default: yes. .TP +\fBPAMIsOptional\fR (boolean) +When PAM is enabled, all clients are required to be authenticated using PAM; +connecting to the server without successful PAM authentication isn't possible. +If this option is set, clients not sending a password are still allowed to +connect: they won't become "identified" and keep the "~" character prepended +to their supplied user name. +Please note: +To make some use of this behavior, it most probably isn't useful to enable +"Ident", "PAM" and "PAMIsOptional" at the same time, because you wouldn't be +able to distinguish between Ident'ified and PAM-authenticated users: both +don't have a "~" character prepended to their respective user names! +Default: no. +.TP \fBPredefChannelsOnly\fR (boolean) If enabled, no new channels can be created. Useful if you do not want to have other channels than those defined in [Channel] sections in the configuration @@ -314,10 +340,10 @@ All SSL-related configuration variables are located in the section. Please note that this whole section is only recognized by ngIRCd when it is compiled with support for SSL using OpenSSL or GnuTLS! .TP -\fBSSLCertFile\fR (string) +\fBCertFile\fR (string) SSL Certificate file of the private server key. .TP -\fBSSLDHFile\fR (string) +\fBDHFile\fR (string) 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 @@ -325,14 +351,14 @@ 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 -\fBSSLKeyFile\fR (string) +\fBKeyFile\fR (string) Filename of SSL Server Key to be used for SSL connections. This is required for SSL/TLS support. .TP -\fBSSLKeyFilePassword\fR (string) +\fBKeyFilePassword\fR (string) OpenSSL only: Password to decrypt the private key file. .TP -\fBSSLPorts\fR (list of numbers) +\fBPorts\fR (list of numbers) Same as \fBPorts\fR , except that ngIRCd will expect incoming connections to be SSL/TLS encrypted. Common port numbers for SSL-encrypted IRC are 6669 and 6697. Default: none. @@ -343,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) -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. @@ -403,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) -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", -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]