summary refs log tree commit diff
path: root/man
diff options
context:
space:
mode:
authorAlexander Barton <alex@barton.de>2018-11-28 14:13:09 +0100
committerGitHub <noreply@github.com>2018-11-28 14:13:09 +0100
commit456eea6f1896528dad344ed2c254fd07bdc3a4b1 (patch)
tree9472c73017f8afc7817f84519076a79c4eb43d02 /man
parent7690716e4fa8ac3ae9b513f4adba685f9e2c0e1f (diff)
downloadngircd-456eea6f1896528dad344ed2c254fd07bdc3a4b1.tar.gz
ngircd-456eea6f1896528dad344ed2c254fd07bdc3a4b1.zip
Implement new configuration option "MaxPenaltyTime" (#251)
This option configures the maximum penalty time increase in seconds, per
penalty event. Set to -1 for no limit (the default), 0 to disable
penalties altogether. ngIRCd doesn't use penalty increases higher than 2
seconds during normal operation, so values higher than 1 rarely make
sense.

Disabling (or reducing) penalties can greatly speed up "make check" runs
for example, see below, but are mostly a debugging feature and normally
not meant to be used on production systems!

Some example timings running "make check" from my macOS workstation:

- MaxPenaltyTime not set: 4:41,79s
- "MaxPenaltyTime = 1":   3:14,71s
- "MaxPenaltyTime = 0":     25,46s

Closes #249.
Diffstat (limited to 'man')
-rw-r--r--man/ngircd.conf.5.tmpl6
1 files changed, 6 insertions, 0 deletions
diff --git a/man/ngircd.conf.5.tmpl b/man/ngircd.conf.5.tmpl
index b8d4ddd9..0c0cd349 100644
--- a/man/ngircd.conf.5.tmpl
+++ b/man/ngircd.conf.5.tmpl
@@ -201,6 +201,12 @@ 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
+\fBMaxPenaltyTime\fR (number)
+Maximum penalty time increase in seconds, per penalty event. Set to -1 for no
+limit (the default), 0 to disable penalties altogether. ngIRCd doesn't use
+penalty increases higher than 2 seconds during normal operation, so values
+greater than 1 rarely make sense.
+.TP
 \fBMaxListSize\fR (number)
 Maximum number of channels returned in response to a LIST command. Default: 100.
 .TP