Added timeoutcheck directive to options block in new config.

git-svn-id: http://anope.svn.sourceforge.net/svnroot/anope/trunk@1715 5417fbe8-f217-4b02-8779-1006273d7864

1 files changed, 22 insertions, 0 deletions

diff --git a/data/example_new.conf b/data/example_new.conf
index 7eba325ee..b48963524 100644
--- a/data/example_new.conf
+++ b/data/example_new.conf
@@ -319,6 +319,28 @@ options {
 	 * WALLOPS/GLOBOPS.
 	 */
 	warningtimeout = 4h
+
+	/*
+	 * Sets the (maximum) frequency at which the timeout list is checked. This,
+	 * combined with readtimeout above, determine how accurately timed events,
+	 * such as nick kills, occur; it also determines how much CPU time Services
+	 * will use doing this. Higher values will cause less accurate timing but
+	 * less CPU usage.
+	 *
+	 * This shouldn't be set any higher than 10 seconds, and 1 second is best
+	 * if your system is powerful enough (or your network small enough) to
+	 * handle it. 0 will cause the timeout list to be checked every time
+	 * through the main loop, which will probably slow down Services too much
+	 * to be useful on most networks.
+	 *
+	 * Note that this value is not an absolute limit on the period between
+	 * checks of the timeout list; the previous may be as great as readtimeout
+	 * (above) during periods of inactivity.
+	 *
+	 * If this directive is not given, it will default to 0. See the 2nd paragraph
+	 * above for performance impacts if you do this.
+	 */
+	timeoutcheck = 3s
 }
 
 /*