BUILD : 1.7.8 (610) BUGS : NOTES : Update tools README for one documentation style

git-svn-id: svn://svn.anope.org/anope/trunk@610 31f1291d-b8d6-0310-a050-a5561fc1590b


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

1 files changed, 43 insertions, 34 deletions

diff --git a/src/tools/README b/src/tools/README
index 191076e5b..4c684cbe5 100644
--- a/src/tools/README
+++ b/src/tools/README
@@ -1,49 +1,58 @@
-Anope SMTP Client
------------------
+Anope Bundled Tools
+-------------------
 
-	- Provided with Anope is a simple SMTP client which can be used to replace programs like
-SendMail in some cases. 
+1) Anope SMTP Client
+2) Anope Database Merger
+3) Epona to Anope Database Converter
 
-	- To use the SMTP client find the line in your services.conf for the "SendMailPath", enter
-the path to your services installation directory, followed by the "anopesmtp" and the IP address
-of a valid SMTP server. It should look something like
+1) Anope SMTP Client
 
-SendMailPath "/home/usersname/services/anopesmtp 194.97.50.135"
+    Provided with Anope is a simple SMTP client which can be used instead of
+    programs like SendMail in some cases.
 
-	- If you run into a problem you can compile a debug into the code by opening smtp.h and at the
-bottom you should find "smtp_debug" change the 0 to a 1 and recompile the code. This should
-generate a log file of what happened when it attempted to connect to the SMTP server.
+    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 "anopemstp" and the IP address of a valid SMTP server. It
+    should look like this:
 
+        SendMailPath "/home/anope/services/anopesmtp 127.0.0.1"
 
-Credits:
-Orginally written by  Dominick Meglio <codemastr@unrealircd.com>
-Ported to *nix by Trystan Scott Lee <trystan@nomadirc.net>
+    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>
 
+2) Anope Database Merger
 
-Anope DB-Merger
----------------
+    This program tries to merge two standard Anope database sets (ChanServ,
+    NickServ, BotServ, and MemoServ).
 
-	- This program tries to merge two standard anope-1.7.7+ database sets (chanserv, nickserv, botserv
-and memoserv).
+    To merge two database sets, put them both in the folder where the merger
+    is located. The first database set must be named <name>1.db (nick1.db,
+    chan1.db, etc); the second database set must be named <name>2.db (nick2.db,
+    chan2.db, etc). If you execute the merger now the databases will be merged
+    into databases named <name>.db.
 
-	- Put the two db sets in the folder where db-merger is located. The first db set must be in the form
-<name>1.db, e.g. nick1.db or hosts1.db, the second set must be in the form <name>2.db, e.g. nick2.db or
-chan2.db. Then execute the merger and follow the instructions.
+        Credits:
+    Written by  Florian Schulze  <certus@anope.org>
 
-Credits:
-Written by Florian Schulze <Certus@anope.org>
+3) Epona to Anope Database Converter
 
+    This program tries to convert databases made by epona .4.15 and up to
+    standard anope databases. Currently, only the ChanServ database needs to
+    be converted.
 
+    Put your Epona (ChanServ) database in the folder where the epona2anope
+    executable file is located. Rename this ChanServ database file to
+    chan1.db and then run the converter (epona2anope). A new database called
+    chan.db will be created; this file is Anope-compatible.
 
-Epona to Anope DB Converter
----------------------------
-
-	- This program tries to convert epona-1.4.15+ dbs to anope standard dbs. At the moment this only
-affects chanserv databases.
-
-	- Put your epona (chanserv) database in the folder where the epona2anope file is located. Rename this
-db file to chan1.db and run epona2anope, which will create a chan.db file. This new file is anope compatible.
-
-Credits:
-Written by Florian Schulze <Certus@anope.org>
+        Credits:
+    Written by  Florian Schulze  <certus@anope.org>