Moved src/tools/README to docs/TOOLS

1 files changed, 27 insertions, 0 deletions

diff --git a/docs/TOOlS b/docs/TOOlS
new file mode 100644
index 000000000..0b2b2ec32
--- /dev/null
+++ b/docs/TOOlS
@@ -0,0 +1,27 @@
+Anope Bundled Tools
+-------------------
+
+1) Anope SMTP Client
+
+    Provided with Anope is a simple SMTP client which can be used instead of
+    programs like SendMail in some cases.
+
+    The SMTP client can be used instead of sendmail for use with Anope's mail
+    options. To use the SMTP client instead of sendmail, find the line in your
+    services configuration file (services.conf) that defines SendMailPath. On
+    that line, change the path to your services installation directory, then
+    followed by "tools/anopesmtp" and the IP address of a valid SMTP server. It
+    should look like this:
+
+        SendMailPath "/home/anope/services/tools/anopesmtp 127.0.0.1"
+
+    If the SMTP client doesn't send mail, or if there's an other problem with
+    it, you can compile it in debug mode. To do this, open smtp.h, and look
+    for "smtp_debug" near the bottom. Change this from 0 to 1 and recompile
+    the code. This should generate a log file of what happened when it tried
+    to connect to the SMTP server.
+
+        Credits:
+    Originally written by  Dominick Meglio    <codemastr@unrealircd.com>
+    Ported to *nix by      Trystan Scott Lee  <trystan@nomadirc.net>
+