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=71aaa1e0e2e89601739a0c109724f6301e9d57e3;hp=b8aa7bda96402b0da5d3bfb23336c706e08b1740;hb=056de78e315a79edc1166649514bf8dfeb18abb1;hpb=fd9266df78e32104af3fa72eb5528b5615a2030e diff --git a/man/ngircd.conf.5.tmpl b/man/ngircd.conf.5.tmpl index b8aa7bda..71aaa1e0 100644 --- a/man/ngircd.conf.5.tmpl +++ b/man/ngircd.conf.5.tmpl @@ -69,13 +69,23 @@ 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 +\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. .TP \fBPorts\fR Ports on which the server should listen. There may be more than one port, -separated with commas (","). Default: 6667. +separated with commas (","). Default: 6667, unless \fBSSL_Ports\fR are also +specified. .TP \fBSSLPorts\fR Same as \fBPorts\fR , except that ngIRCd will expect incoming connections @@ -108,12 +118,11 @@ IP addresses and interfaces by default. .TP \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. -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 @@ -178,6 +187,11 @@ If \fBOperCanUseMode\fR is enabled, this may lead the compatibility problems wit Servers that run the ircd-irc2 Software. This Option "masks" mode requests by non-chanops as if they were coming from the server. Default: no. .TP +\fBAllowRemoteOper\fR +Are IRC operators connected to remote servers allowed to control this server, +e. g. are they allowed to use administrative commands like CONNECT, DIE, +SQUIT, ... that affect this server? Default: no. +.TP \fBPredefChannelsOnly\fR If enabled, no new channels can be created. Useful if you do not want to have channels other than those defined in @@ -195,6 +209,12 @@ If ngIRCd is compiled with IDENT support this can be used to disable IDENT lookups at run time. Default: no. .TP +\fBNoPAM\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: 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. @@ -221,9 +241,6 @@ 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! -.TP -\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 @@ -287,6 +304,9 @@ Group of this server (optional). 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 +\fBSSLConnect\fR +Connect to the remote server using TLS/SSL. Default: false. +.TP \fBServiceMask\fR 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 @@ -319,7 +339,50 @@ Topic for this channel. Initial channel modes. .TP \fBKey\fR -Sets initial channel key (only relevant if mode k is set). +Sets initial channel key (only relevant if channel mode "k" is set). +.TP +\fBKeyFile\fR +Path and file name of a "key file" containing individual channel keys for +different users. The file consists of plain text lines with the following +syntax (without spaces!): +.PP +.RS +.RS +.I user +: +.I nick +: +.I key +.RE +.PP +.I user +and +.I nick +can contain the wildcard character "*". +.br +.I key +is an arbitrary password. +.PP +Valid examples are: +.PP +.RS +*:*:KeY +.br +*:nick:123 +.br +~user:*:xyz +.RE +.PP +The key file is read on each JOIN command when this channel has a key +(channel mode +k). Access is granted, if a) the channel key set using the +MODE +k command or b) one of the lines in the key file match. +.PP +.B Please note: +.br +The file is not reopened on each access, so you can modify and overwrite it +without problems, but moving or deleting the file will have not effect until +the daemon re-reads its configuration! +.RE .TP \fBMaxUsers\fR Set maximum user limit for this channel (only relevant if channel mode "l"