doc/Services.txt: explain which IRC Services versions are compatible

1 files changed, 16 insertions, 5 deletions

diff --git a/doc/Services.txt b/doc/Services.txt
index a16cfc89..67053b16 100644
--- a/doc/Services.txt
+++ b/doc/Services.txt
@@ -14,7 +14,7 @@ At the moment, ngIRCd doesn't implement a "special IRC services interface".
 But services acting as a "regular server" are supported, either using the IRC
 protocol defined in RFC 1459 or RFC 2812.
 
-Services have been tested using "IRC Services" version 5.x of Andrew Church,
+Services have been tested using "IRC Services" version 5.x by Andrew Church,
 homepage: <http://www.ircservices.za.net/>. This document describes setting up
 ngIRCd and these services.
 
@@ -25,7 +25,7 @@ Setting up ngIRCd
 The "pseudo server" handling the IRC services is configured as a regular
 remote server in the ngircd.conf(5). In addition the variable "ServiceMask"
 should be set, enabling this ngIRCd to recognize the "pseudo users" as IRC
-services insted of regular IRC users.
+services instead of regular IRC users.
 
 Example:
 
@@ -39,9 +39,17 @@ Example:
 Setting up IRC Services 5.1.x
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-IRC Services 5.1.x can be used with ngIRCd using the "rfc1459" protocol
-module. At least the following settings have to be tweaked, in addition to all
-the settings marked as required by IRC Services:
+IRC Services 5.1.3 and above can be used with ngIRCd using the "rfc1459"
+protocol module.
+
+Please note that versions up to and including 5.1.3 contain a bug that
+sometimes causes IRC Services to hang on startup. There are two workarounds:
+ a) send the services process a HUP signal ("killall -HUP ircservices")
+ b) apply this patch to the IRC Services source tree:
+    <ftp://ngircd.barton.de/ngircd/contrib/IRCServices513-FlushBuffer.patch>
+
+At least the following settings have to be tweaked, in addition to all the
+settings marked as required by IRC Services:
 
 In ircservices.conf:
 
@@ -57,3 +65,6 @@ In modules.conf:
 
 The documentation of IRC Services can be found here:
 <http://www.ircservices.za.net/docs/>
+
+Please let us know if you are successfully using other IRC service packages or
+which problems you encounter, thanks!