1
0
mirror of https://github.com/osmarks/ngircd.git synced 2025-05-03 16:04:06 +00:00

Update documentation to reflect "[Channel]->Modes" changes

No longer mention "[Channel]->Key" and "[Channel]->MaxUsers".
This commit is contained in:
Alexander Barton 2020-03-29 23:17:21 +02:00
parent 61ac8be2fd
commit 9c5e42458e
3 changed files with 22 additions and 17 deletions

View File

@ -12,6 +12,16 @@ configure ngIRCd.
## Upgrade Information
Differences to version 25
- Setting modes for predefined channels in *[Channel]* sections has been
enhanced: now you can set *all* modes, like in IRC "MODE" commands, and have
this setting multiple times per *[Channel]* block. Modifying lists (ban list,
invite list, exception list) is supported, too.
Both the *Key* and *MaxUsers* settings are now deprecated and should be
replaced by `Modes = +l <limit>` and `Modes = +k <key>` respectively.
Differences to version 22.x
- The *NoticeAuth* `ngircd.conf` configuration variable has been renamed to

View File

@ -385,19 +385,16 @@
# Topic for this channel
;Topic = a great topic
# Initial channel modes
;Modes = tnk
# initial channel password (mode k)
;Key = Secret
# Initial channel modes, as used in "MODE" commands. Modifying lists
# (ban list, invite list, exception list) is supported.
# This option can be specified multiple times, evaluated top to bottom.
;Modes = +tnk mykey +l 5
;Modes = +b nick!~user@bad.host.example.com
# Key file, syntax for each line: "<user>:<nick>:<key>".
# Default: none.
;KeyFile = :ETCDIR:/#chan.key
# maximum users per channel (mode l)
;MaxUsers = 23
[Channel]
# More [Channel] sections, if you like ...

View File

@ -1,7 +1,7 @@
.\"
.\" ngircd.conf(5) manual page template
.\"
.TH ngircd.conf 5 "Jan 2020" ngIRCd "ngIRCd Manual"
.TH ngircd.conf 5 "Apr 2020" ngIRCd "ngIRCd Manual"
.SH NAME
ngircd.conf \- configuration file of ngIRCd
.SH SYNOPSIS
@ -510,10 +510,12 @@ Name of the channel, including channel prefix ("#" or "&").
Topic for this channel.
.TP
\fBModes\fR (string)
Initial channel modes.
.TP
\fBKey\fR (string)
Sets initial channel key (only relevant if channel mode "k" is set).
Initial channel modes, as used in "MODE" commands. Modifying lists (ban list,
invite list, exception list) is supported.
.PP
.RS
This option can be specified multiple times, evaluated top to bottom.
.RE
.TP
\fBKeyFile\fR (string)
Path and file name of a "key file" containing individual channel keys for
@ -557,10 +559,6 @@ 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 (number)
Set maximum user limit for this channel (only relevant if channel mode "l"
is set).
.SH HINTS
It's wise to use "ngircd \-\-configtest" to validate the configuration file
after changing it. See