* Updated FAQ with some hopefully helpful starter tips for fact packs

[infobot.git] / FAQ

diff --git a/FAQ b/FAQ
index 1f684763e88ac338ab9ccd3599b64447da27ecb0..30681dfc3bcdf25619c6190c3ffe4e0008aa0303 100644 (file)
--- a/FAQ
+++ b/FAQ
@@ -1,11 +1,51 @@
-FAQ for blootbot
-----------------
+# $Id$
 
-1.Q    Running "./blootbot" fails to connect to an IRC server.  The output
-       I get is "!WARN! PERL: Can't connect to irc.debian.org:6667! at
-       /usr/share/perl5/Net/IRC.pm line 192".
+Q: What are factpacks and how do I install them?
+A: A factpack is a partial database of factoids that you can import into
+   your configured infobot by running the script called "factpack.pl".
 
-1.A    Have a look at /etc/hosts.  Make sure it is valid, especially
-       the localhost line.  My file looks like this:
-       # ip            hostname                alias
-       127.0.0.1       localhost               localhost
+   # IMPORTANT: Run from the bots base directory!
+   eg: ./scripts/factpack.pl /path/to/areacodes.fact
+
+Q: Can I remove a fact pack I have installed?
+A: Yes, but at the moment, you need to manually use SQL commands in your
+   favorite SQL program. The "created_by" field in the factoids will be
+   set to the filename of the fact pack you installed. For example, if
+   you installed the "areacodes.fact" file, "created_by" would be set to
+   "areacodes.fact". The SQL to remove the above example would be:
+
+   sql> DELETE FROM factoids WHERE created_by = 'areacodes.fact';
+
+Q: The bot exits after I run 'factstats testing' or 'kernel' or anything
+   that uses fork(). Is this a bug in the bot?
+
+A: No, this is not a bug in the bot but rather Net::IRC.  A cheap hack is
+   to edit /usr/lib/perl5/Net/IRC/Connection.pm, search for DESTROY, and
+   comment out '$self->quit();'
+
+
+Q: I notice that, in the bot logs, the bot attempts to close all current
+   DCC CHAT connections whenever a forked process ends. Why is this?
+
+A: Yet another bug in Net::IRC. Currently, DCC CHAT connections are not
+   closed because there is an endless-loop bug when it is done.
+
+
+Q: I executed 'scripts/setup_user.pl' but it said 'connection refused to
+   localhost'
+
+A: Looks like a bug in the installation of mysqld. You need to reload or
+   restart the daemon.
+       reload => 'mysqladmin -u root -p reload'
+       restart => '/etc/init.d/mysql stop; /etc/init.d/mysql start'
+
+Q: How do I get my bot to automatically ask for OP's from chanserv?
+
+A: By default, the "chanServCheck" option is off in _default. You can
+   set it on a per channel basis or as default. For example, the following
+   commands will enable asking for OP by default, except on #notmychannel
+
+       chanset _default chanServCheck 1
+       chanset #notmychannel chanServCheck 0
+
+# vim:ts=4:sw=4:expandtab:tw=80