From 330e5c37e80e7169c0c88c47795d7dec60e79654 Mon Sep 17 00:00:00 2001
From: "ian%hixie.ch" <ian%hixie.ch>
Date: Sun, 19 Oct 2003 17:32:39 +0000
Subject: [PATCH] Improve the documentation for people troubleshooting
 connection problems.

---
 webtools/mozbot/INSTALL   | 34 ++++++++++++++++++++++++++--------
 webtools/mozbot/mozbot.pl |  9 ++++-----
 2 files changed, 30 insertions(+), 13 deletions(-)

diff --git a/webtools/mozbot/INSTALL b/webtools/mozbot/INSTALL
index 7e5a33c79414..35ed8f8cc49f 100644
--- a/webtools/mozbot/INSTALL
+++ b/webtools/mozbot/INSTALL
@@ -290,6 +290,32 @@ are prompted for during initial startup. The interesting ones are:
    bot (/msg mozbot cycle) then the bot will change servers without
    shutting down.
 
+   localAddr -- if you don't seem to be able to establish a
+   connection, but it works fine with other software, then you should
+   try setting the localAddr variable to your IP address. Technically,
+   this variable sets which interface to use to form the outgoing
+   connection. (This is to work around a limitation of Net::IRC.) 
+   Typically you would set this variable directly in the configuration
+   file, by adding a line that says "localAddr=10.11.12.13" or
+   whatever your IP address is.
+
+   simpleIRCNameServer -- if the value of this variable equals the
+   name of the server, then the IRC Name sent to the server will be
+   simplified so that it doesn't include the URI of the mozbot help
+   files. This is usually dealt with automatically, but if you are
+   having troubles connecting, you could try setting it. (It is set to
+   the name of the server so that if you change servers, by default
+   mozbot will use a complete IRC Name again.)
+
+   username -- if this variable has a true value, then the bot will
+   use its value as its IRC username. By default, the bot uses
+   "pid-1234" as the username, where "1234" is the bot's process ID. 
+   This can cause problems on networks or with BNCs that require a
+   valid and accurate ident, in which case this variable can provide a
+   solution. (You can also set this variable by entering
+   "username=blah" into the configuration file, where blah is the
+   username you want to use.)
+
    channels -- unlike other modules, the channels variable for the
    Admin module actually controls which channels the bot itself
    appears in. The preferred method for controlling this is using
@@ -354,14 +380,6 @@ are prompted for during initial startup. The interesting ones are:
       <foobot> user: green is good.
       * user patpats mozbot
 
-   simpleIRCNameServer -- If the value of this variable equals the
-   name of the server, then the IRC Name sent to the server will be
-   simplified so that it doesn't include the URI of the mozbot help
-   files. This is usually dealt with automatically, but if you are
-   having troubles connecting, you could try setting it. (It is set to
-   the name of the server so that if you change servers, by default
-   mozbot will use a complete IRC Name again.)
-
 Changes to variables are usually immediately recorded in the
 configuration file and will be saved for the next time the bot is
 loaded.
diff --git a/webtools/mozbot/mozbot.pl b/webtools/mozbot/mozbot.pl
index 4bab6f1726b5..92baa800040c 100755
--- a/webtools/mozbot/mozbot.pl
+++ b/webtools/mozbot/mozbot.pl
@@ -316,14 +316,13 @@ sub connect {
             &debug('I couldn\'t resolve it.');
         }
         if (defined($localAddr)) {
-            if ($Net::IRC::VERSION < 0.73) {
-                &debug("Note that to use 'localAddr' you need Net::IRC version 0.73 or higher (you have $Net::IRC::VERSION)");
-            } else {
-                &debug("Is '$localAddr' the correct address of the interface to use?");
-            }
+            &debug("Is '$localAddr' the correct address of the interface to use?");
         } else {
             &debug("Try editing '$cfgfile' to set 'localAddr' to the address of the interface to use.");
         }
+        if ($Net::IRC::VERSION < 0.73) {
+            &debug("Note that to use 'localAddr' you need Net::IRC version 0.73 or higher (you have $Net::IRC::VERSION)");
+        }
         $mailed = &Mails::ServerDown($server, $port, $localAddr, $nicks[$nick], "[mozbot] $helpline", $nicks[0]) unless $mailed;
         sleep($sleepdelay);
         &Configuration::Get($cfgfile, &configStructure(\$server, \$port, \$password, \@nicks, \$nick, \$owner, \$sleepdelay));