Bug fix: Fixed broken rehash.

This reverts commit cc1c8fd5bc.
Failed.

.gitignore

@@ -1,3 +1,4 @@
-*.conf
+auto.conf
 build/*
 *.swp
+autodoc/*

NEWS

@@ -11,30 +11,21 @@
 The future of IRC bots is here! Xelhua gives to you, Auto 3.0, a new version of
 the popular Auto IRC bot.
 
-In this alpha4 release, we have added:
+In this alpha5 release, we have added:
 
-* MySQL support.
-* PostgreSQL support.
-* A Greet module for greeting users on join.
-* IRC logchan functionality.
-* Improved multilingual support.
-* A ChanTopics module for advanced management of channel topics.
-* buildmod now generates HTML and man(1) pages from a module's POD.
-* server:ajoin now supports channel keys by spacing the name and key.
-* A Dictionary module for looking up definitions of words.
-* Heavily improved module API.
+* LinkTitle module for returning the page title of links sent to a channel.
+* Added core command MODLIST.
+* Added SEARCH and MORE to QDB. Amount of results returned at a time with
+  qdb_search_resnum in the config.
 
 Bug fixes:
 
-* Commands getting Permission denied even with incorrect prefix.
-* Program not properly shutting down if all IRC connections close.
+* Fixed a bug when viewing non-existent quotes.
+* SEVERE: Fixed a bug that caused rehash to fail.
 
 Incompatibilities:
 
-* Database: Changed structure of the `qdb` table. Modify the configuration
-  values in upgrade.pl then run it to upgrade the database.
-* database:format is now required in the config.
-* bantype is now required in the config.
+None
 
 We thank you for choosing Auto. Please remember that he is still in early
 development stages. But we hope we've piqued your interest, as Auto's upcoming
@@ -44,4 +35,4 @@ there for everyone to use.
 Auto's goal is to create an efficient, stable and highly customizable IRC bot
 in Perl. To offer an alternative to other platforms.
 
-Enjoy Auto 3.0.0 Alpha 4!
+Enjoy Auto 3.0.0 Alpha 5!

auto

@@ -5,8 +5,7 @@
 # Written in sh because the user may not have Perl...to run Auto....
 
 PID=bin/auto.pid
-MODS="Mouse Class::Unload"
-EMODS="MIME::Base64 XML::Simple"
+MODS="Class::Unload DBI"
 
 if [ "$1" = "start" ] ; then
     if [ -e $PID ]; then
@@ -47,11 +46,8 @@ elif [ "$1" = "status" ]; then
 elif [ "$1" = "getmodules" ]; then
     cpan -i $MODS
 
-elif [ "$1" = "getextras" ]; then
-	cpan -i $EMODS
-
 else
-	echo "Usage: auto (start|stop|rehash|status|getmodules|getextras)"
+    echo "Usage: auto (start|stop|rehash|status|getmodules)"
 fi
 
 # vim: set ai sw=4 ts=4:

bin/auto

@@ -33,7 +33,7 @@ BEGIN {
 }
 use Lib::Auto;
 use API::Std qw(conf_get err);
-use API::Log qw(println alog dbug);
+use API::Log qw(alog dbug);
 #use DB::Flatfile;
 use Parser::Config;
 use Parser::Lang;
@@ -434,6 +434,7 @@ undef $it;
 API::Std::cmd_add('MODLOAD', 1, 'cfunc.modules', \%Core::Cmd::HELP_MODLOAD, \&Core::Cmd::cmd_modload);
 API::Std::cmd_add('MODUNLOAD', 1, 'cfunc.modules', \%Core::Cmd::HELP_MODUNLOAD, \&Core::Cmd::cmd_modunload);
 API::Std::cmd_add('MODRELOAD', 1, 'cfunc.modules', \%Core::Cmd::HELP_MODRELOAD, \&Core::Cmd::cmd_modreload);
+API::Std::cmd_add('MODLIST', 1, 'cfunc.modules', \%Core::Cmd::HELP_MODLIST, \&Core::Cmd::cmd_modlist);
 API::Std::cmd_add('SHUTDOWN', 2, 'cmd.shutdown', \%Core::Cmd::HELP_SHUTDOWN, \&Core::Cmd::cmd_shutdown);
 API::Std::cmd_add('RESTART', 2, 'cmd.restart', \%Core::Cmd::HELP_RESTART, \&Core::Cmd::cmd_restart);
 API::Std::cmd_add('REHASH', 2, 'cmd.rehash', \%Core::Cmd::HELP_REHASH, \&Core::Cmd::cmd_rehash);

doc/CHANGELOG

@@ -2,6 +2,20 @@ Auto IRC Bot 3.0: Change Log
 -------------------------------------------------------------------------------
 
 3.0 Indev
+===============================================================================
+    * Bug fix: Fixed broken rehash.
+    * Ignore PRIVMSG's if they're from an invalid source.
+    * Fixed an odd bug when viewing non-existent quotes.
+    * You can now define how many results are returned by QDB SEARCH/MORE at a
+      time with qdb_search_resnum in the config.
+    * Added SEARCH and MORE to QDB.
+    * Killed EMODS in the starter script and updated MODS
+    * Added core command MODLIST.
+    * Added command level 3 for logchan-only command.
+    * Added a LinkTitle module for getting the title of a web page posted in a
+      channel.
+
+3.0 Alpha 4
 ===============================================================================
     * Added a Dictionary module for looking up definitions of words.
     * server:ajoin now supports channel keys by spacing the name and key.

lib/API/Std.pm

@@ -26,7 +26,7 @@ sub mod_init
     if (keys %Auto::SOCKET) { API::Log::slog('MODULES: Attempting to load '.$name.' (version '.$version.') by '.$author.'...'); }
 
     # Check if this module is compatible with this version of Auto.
-	if ($autover ne '3.0.0a4') {
+    if ($autover ne '3.0.0a4' and $autover ne '3.0.0a5') {
     	API::Log::dbug('MODULES: Failed to load '.$name.': Incompatible with your version of Auto.');
     	API::Log::alog('MODULES: Failed to load '.$name.': Incompatible with your version of Auto.');
         if (keys %Auto::SOCKET) { API::Log::slog('MODULES: Failed to load '.$name.': Incompatible with your version of Auto.'); }
@@ -115,12 +115,12 @@ sub cmd_add
     $cmd = uc $cmd;
 
     if (defined $API::Std::CMDS{$cmd}) { return; }
-	if ($lvl =~ m/[^0-2]/sm) { return; } ## no critic qw(RegularExpressions::RequireExtendedFormatting)
+    if ($lvl =~ m/[^0-3]/sm) { return; } ## no critic qw(RegularExpressions::RequireExtendedFormatting)
 
     $API::Std::CMDS{$cmd}{lvl}   = $lvl;
     $API::Std::CMDS{$cmd}{help}  = $help;
     $API::Std::CMDS{$cmd}{priv}  = $priv;
-	$API::Std::CMDS{$cmd}{sub}   = $sub;
+    $API::Std::CMDS{$cmd}{'sub'} = $sub;
 
     return 1;
 }

lib/Core/Cmd.pm

@@ -125,9 +125,31 @@ sub cmd_modreload
     return 1;
 }
 
+# Help hash for MODLIST. Spanish, French and German needed.
+our %HELP_MODLIST = (
+    'en' => "This will return a list of all currently loaded modules. \2Syntax:\2 MODLIST",
+);
+# MODLIST callback.
+sub cmd_modlist
+{
+    my ($src, undef) = @_;
+
+    # Iterate through all loaded modules.
+    my $str;
+    foreach (keys %API::Std::MODULE) {
+        $str .= ", \2$_\2 (v".$API::Std::MODULE{$_}{version}.')';
+    }
+
+    # Return it.
+    $str = substr $str, 2;
+    notice($src->{svr}, $src->{nick}, "\2Module List:\2 $str");
+
+    return 1;
+}
+
 # Help hash for SHUTDOWN. Spanish, French and German needed.
 our %HELP_SHUTDOWN = (
-    'en' => 'This will send out shutdown notifications, quit all networks, flush the database then exit the program.',
+    'en' => "This will send out shutdown notifications, quit all networks, flush the database then exit the program. \2Syntax:\2 SHUTDOWN",
 );
 # SHUTDOWN callback.
 sub cmd_shutdown

lib/Lib/Auto.pm

@@ -4,11 +4,12 @@
 package Lib::Auto;
 use strict;
 use warnings;
+use feature qw(say);
 use English qw(-no_match_vars);
 use Sys::Hostname;
 use feature qw(switch);
 use API::Std qw(hook_add conf_get err);
-use API::Log qw(println dbug alog);
+use API::Log qw(dbug alog);
 our $VERSION = 3.000000;
 
 # Core events.
@@ -19,7 +20,7 @@ API::Std::event_add('on_rehash');
 sub checkver
 {
     if (!$Auto::NUC and Auto::RSTAGE ne 'd') {
-        println '* Connecting to update server...';
+        say '* Connecting to update server...';
         my $uss = IO::Socket::INET->new(
             'Proto'    => 'tcp',
             'PeerAddr' => 'dist.xelhua.org',
@@ -37,11 +38,11 @@ sub checkver
             }
             elsif ($v eq 'version') {
                 if (Auto::VER.q{.}.Auto::SVER.q{.}.Auto::REV.Auto::RSTAGE ne $c) {
-                    println('!!! NOTICE !!! Your copy of Auto is outdated. Current version: '.Auto::VER.q{.}.Auto::SVER.q{.}.Auto::REV.Auto::RSTAGE.' - Latest version: '.$c);
-                    println('!!! NOTICE !!! You can get the latest Auto by downloading '.$dll);
+                    say('!!! NOTICE !!! Your copy of Auto is outdated. Current version: '.Auto::VER.q{.}.Auto::SVER.q{.}.Auto::REV.Auto::RSTAGE.' - Latest version: '.$c);
+                    say('!!! NOTICE !!! You can get the latest Auto by downloading '.$dll);
                 }
                 else {
-                    println('* Auto is up-to-date.');
+                    say('* Auto is up-to-date.');
                 }
             }
         }
@@ -54,7 +55,7 @@ sub rehash
     my %newsettings = $Auto::CONF->parse or err(2, 'Failed to parse configuration file!', 0) and return;
 
     # Check for required configuration values.
-    my @REQCVALS = qw(locale expire_logs server fantasy_pf ratelimit database:format bantype);
+    my @REQCVALS = qw(locale expire_logs server fantasy_pf ratelimit bantype);
     foreach my $REQCVAL (@REQCVALS) {
         if (!defined $newsettings{$REQCVAL}) {
             err(2, "Missing required configuration value: $REQCVAL", 0) and return;
@@ -261,7 +262,7 @@ sub signal_perlwarn
     my ($warnmsg) = @_;
     $warnmsg =~ s/(\n|\r)//xsmg;
     alog 'Perl Warning: '.$warnmsg;
-    if ($Auto::DEBUG) { println 'Perl Warning: '.$warnmsg; }
+    if ($Auto::DEBUG) { say 'Perl Warning: '.$warnmsg; }
     return 1;
 }
 
@@ -276,7 +277,7 @@ sub signal_perldie
     foreach (keys %Auto::SOCKET) { API::IRC::quit($_, 'A fatal error occurred!'); }
     API::Std::event_run('on_shutdown');
     sleep 1;
-    println 'FATAL: '.$diemsg;
+    say 'FATAL: '.$diemsg;
     exit;
 }
 

lib/Parser/IRC.pm

@@ -303,12 +303,12 @@ sub cjoin
     
     # Check if this is coming from ourselves.
     if ($src{nick} eq $botnick{$svr}{nick}) {
-		$botchans{$svr}{lc(substr $ex[2], 1)} = 1;
+    	$botchans{$svr}{lc $chan} = 1;
     	API::Std::event_run("on_ucjoin", ($svr, $chan));
     }
     else {
     	# It isn't. Update chanusers and trigger on_rcjoin.
-        $chanusers{$svr}{lc(substr $ex[2], 1)}{$src{nick}} = 1;
+        $chanusers{$svr}{lc $chan}{$src{nick}} = 1;
         $src{svr} = $svr;
     	API::Std::event_run("on_rcjoin", (\%src, $chan));
     }
@@ -532,6 +532,9 @@ sub privmsg
     my ($svr, @ex) = @_;
     my %data = API::IRC::usrc(substr($ex[0], 1));
 
+    # Ensure this is coming from a user rather than a server.
+    if ($ex[0] !~ m/!/xsm) { return; }
+
     my @argv;
     for (my $i = 4; $i < scalar(@ex); $i++) {
     	push(@argv, $ex[$i]);
@@ -603,12 +606,12 @@ sub privmsg
                             }
                             else {
                                 # Else give them the boot.
-                                API::IRC::notice($data{svr}, $data{nick}, API::Std::trans("Permission denied").".");
+                                API::IRC::notice($data{svr}, $data{nick}, API::Std::trans('Permission denied').q{.});
                             }
                         }
                         else {
                             # Else continue executing without any extra checks.
-                            &{ $API::Std::CMDS{$cmd}{'sub'} }(\%data, @argv) if $rprefix eq $cprefix;
+                            &{ $API::Std::CMDS{$cmd}{'sub'} }(\%data, @argv);
                         }
                     }
                     else {
@@ -616,6 +619,28 @@ sub privmsg
                         API::IRC::notice($data{svr}, $data{nick}, trans('Rate limit exceeded').q{.});
                     }
                 }
+                elsif ($API::Std::CMDS{$cmd}{lvl} == 3) {
+                    # Or if it's a logchan command...
+                    my ($lcn, $lcc) = split '/', (conf_get('logchan'))[0][0];
+                    if ($lcn eq $data{svr} and lc $lcc eq lc $data{chan}) {
+                        # Check if it's being sent from the logchan.
+                        if ($API::Std::CMDS{$cmd}{priv}) {
+                            # If this command takes a privilege...
+                            if (API::Std::has_priv(API::Std::match_user(%data), $API::Std::CMDS{$cmd}{priv})) {
+                                # Make sure they have it.
+                                &{ $API::Std::CMDS{$cmd}{'sub'} }(\%data, @argv);
+                            }
+                            else {
+                                # Else give them the boot.
+                                API::IRC::notice($data{svr}, $data{nick}, API::Std::trans('Permission denied').q{.});
+                            }
+                        }
+                        else {
+                            # Else continue executing without any extra checks.
+                            &{ $API::Std::CMDS{$cmd}{'sub'} }(\%data, @argv);
+                        }
+                    }
+                }
     	    }
         }
 

modules/LinkTitle.pm

@@ -0,0 +1,122 @@
+# Module: LinkTitle. See below for documentation.
+# Copyright (C) 2010-2011 Xelhua Development Group, et al.
+# This program is free software; rights to this code are stated in doc/LICENSE.
+package M::LinkTitle;
+use strict;
+use warnings;
+use LWP::UserAgent;
+use HTML::Entities;
+use API::Std qw(hook_add hook_del);
+use API::IRC qw(privmsg);
+
+# Initialization subroutine.
+sub _init
+{
+    # Create the on_cprivmsg hook.
+    hook_add('on_cprivmsg', 'privmsg.html.returntitle', \&M::LinkTitle::gettitle) or return;
+
+    # Success.
+    return 1;
+}
+
+# Void subroutine.
+sub _void
+{
+    # Delete the hook we created.
+    hook_del('on_cprivmsg', 'privmsg.html.returntitle') or return;
+
+    # Success.
+    return 1;
+}
+
+# Hook callback.
+sub gettitle
+{
+    my ($src, $chan, @msg) = @_;
+
+    # Check if the message contains a URL.
+    foreach my $smw (@msg) {
+        if ($smw =~ m{(http|https)://}xsm) {
+            # We've got a match, connect to the server.
+            my $srv = $1;
+            # Create an instance of LWP::UserAgent.
+            my $ua = LWP::UserAgent->new();
+            $ua->agent('Auto IRC Bot');
+            $ua->timeout(3);
+            # Get data.
+            my $res = $ua->get($smw);
+            
+            # Check if we're successful.
+            if ($res->is_success) {
+                # We were, decode the data.
+                my $data = $res->decoded_content;
+                
+                # Check for <title>
+                if ($data =~ m{<title>(.*)</title>}ixsm) {
+                    # Found. Decode it.
+                    my $title = decode_entities($1);
+                    # Return to channel.
+                    privmsg($src->{svr}, $chan, "\2Title:\2 $title");
+                }
+            }
+        }
+    }
+
+    return 1;
+}
+
+# Start initialization.
+API::Std::mod_init('LinkTitle', 'Xelhua', '1.00', '3.0.0a5', __PACKAGE__);
+# vim: set ai sw=4 ts=4:
+# build: cpan=LWP::UserAgent,HTML::Entities perl=5.010000
+
+__END__
+
+=head1 NAME
+
+LinkTitle - A module for returning the page title of links.
+
+=head1 VERSION
+
+ 1.00
+
+=head1 SYNOPSIS
+
+ <starcoder> http://xelhua.org/auto.php 
+ <blue> Title: Xelhua / Projects / Auto
+
+=head1 DESCRIPTION
+
+This module will make Auto parse all links sent to a channel. When a link is
+detected, Auto will connect to it and get the page title by scanning for the
+<title> tag and returning its contents to the channel.
+
+=head1 DEPENDENCIES
+
+This module is dependent on two modules from the CPAN.
+
+=over
+
+=item L<LWP::UserAgent|LWP::UserAgent>
+
+This module is used for connecting to the target web server via HTTP(S).
+
+=item L<HTML::Entities|HTML::Entities>
+
+This module is used for decoding HTML entities in the response we receive from
+the server.
+
+=back
+
+=head1 AUTHOR
+
+This module was written by Elijah Perrault.
+
+This module is maintained by Xelhua Development Group.
+
+=head1 LICENSE AND COPYRIGHT
+
+This module is Copyright 2010-2011 Xelhua Development Group. All rights
+reserved.
+
+This module is released under the same licensing terms as Auto itself.

modules/QDB.pm

@@ -5,8 +5,9 @@ package M::QDB;
 use strict;
 use warnings;
 use feature qw(switch);
-use API::Std qw(cmd_add cmd_del trans has_priv match_user);
+use API::Std qw(cmd_add cmd_del trans has_priv conf_get match_user);
 use API::IRC qw(privmsg notice);
+our @BUFFER;
 
 sub _init
 {
@@ -34,7 +35,7 @@ sub _void
 
 # Help hash for QDB. Spanish, French and German translations needed.
 our %HELP_QDB = (
-    'en' => "This command allows you to add, read, and delete quotes. \002Syntax:\002 QDB (ADD|VIEW|COUNT|RAND|DEL) [quote]",
+    'en' => "This command allows you to add, read, and delete quotes. \002Syntax:\002 QDB (ADD|VIEW|COUNT|RAND|SEARCH|MORE|DEL) [quote|expression]",
 );
 sub cmd_qdb
 {
@@ -46,7 +47,7 @@ sub cmd_qdb
         return;
     }
     
-    # ADD|VIEW|COUNT|RAND|DEL.
+    # ADD|VIEW|COUNT|RAND|SEARCH|MORE|DEL.
     given (uc $argv[0]) {
         when ('ADD') {
             # QDB ADD.
@@ -55,13 +56,10 @@ sub cmd_qdb
                 return;
             }
 
-            # Get rid of the ADD part.
-            shift @argv;
-
             # Insert into database.
             my $dbq = $Auto::DB->prepare('INSERT INTO qdb (creator, time, quote) VALUES (?, ?, ?)') or 
                 notice($src->{svr}, $src->{nick}, trans('An error occurred').q{.}) and return;
-            $dbq->execute($src->{nick}, time, join(q{ }, @argv)) or
+            $dbq->execute($src->{nick}, time, join(q{ }, @argv[1..$#argv])) or
                 notice($src->{svr}, $src->{nick}, trans('An error occurred').q{.}) and return;
 
             # Get ID.
@@ -83,6 +81,9 @@ sub cmd_qdb
             $dbq->execute($argv[1]) or notice($src->{svr}, $src->{nick}, trans('An error occurred').'. Quote might not exist.') and return;
             my @data = $dbq->fetchrow_array;
 
+            # Check for an unusual issue.
+            if (!defined $data[1]) { notice($src->{svr}, $src->{nick}, trans('An error occurred').'. Quote might not exist.'); return; }
+
             # Send it back.
             privmsg($src->{svr}, $src->{chan}, "\002Submitted by\002 $data[1] \002on\002 ".POSIX::strftime('%F', localtime($data[2]))." \002at\002 ".POSIX::strftime('%I:%M %p', localtime($data[2])));
             privmsg($src->{svr}, $src->{chan}, $data[3]);
@@ -114,6 +115,78 @@ sub cmd_qdb
             privmsg($src->{svr}, $src->{chan}, "\002ID:\002 $data[0] - \002Submitted by\002 $data[1] \002on\002 ".POSIX::strftime('%F', localtime($data[2]))." \002at\002 ".POSIX::strftime('%I:%M %p', localtime($data[2])));
             privmsg($src->{svr}, $src->{chan}, $data[3]);
         }
+        when ('SEARCH') {
+            # QDB SEARCH.
+
+            # Get all quotes.
+            my $dbq = $Auto::DB->prepare('SELECT * FROM qdb') or return;
+            $dbq->execute or return;
+            my $quotes = $dbq->fetchall_hashref('quoteid') or return;
+
+            # Set expression.
+            my $expr = my $rexpr = join ' ', @argv[1 .. $#argv];
+            $rexpr =~ s{\(}{\\\(}g;
+            $rexpr =~ s{\)}{\\\)}g;
+            $rexpr =~ s{\?}{\\\?}g;
+            $rexpr =~ s{\*}{\\\*}g;
+            $rexpr =~ s{\[}{\\\[}g;
+            $rexpr =~ s{\]}{\\\]}g;
+            $rexpr =~ s{\.}{\\\.}g;
+            $rexpr =~ s{\$}{\\\$}g;
+            $rexpr =~ s{\^}{\\\^}g;
+
+            # Clear the buffer.
+            @BUFFER = ();
+
+            # Iterate through all quotes.
+            foreach my $qkt (keys %$quotes) {
+                # Check if we have a match.
+                if ($quotes->{$qkt}->{quote} =~ m/$rexpr/ixsm) {
+                    # Match. Add to buffer.
+                    push @BUFFER, "\2ID:\2 $qkt - ".$quotes->{$qkt}->{quote};
+                }
+            }
+
+            # Check if we had any matches.
+            if (!defined $BUFFER[0]) {
+                privmsg($src->{svr}, $src->{chan}, "No results for \2$expr\2.");
+                return;
+            }
+
+            # Return four quotes.
+            privmsg($src->{svr}, $src->{chan}, "\2".scalar @BUFFER."\2 results for \2$expr\2:");
+            my $i = 0;
+            my $si = 3;
+            if (conf_get('qdb_search_resnum')) { $si = (conf_get('qdb_search_resnum'))[0][0] - 1; }
+            while ($i <= $si) {
+                if (!defined $BUFFER[0]) {
+                    last;
+                }
+
+                privmsg($src->{svr}, $src->{chan}, shift @BUFFER);
+                $i++;
+            }
+        }
+        when ('MORE') {
+            # Check if there's any quotes in the buffer.
+            if (!defined $BUFFER[0]) { 
+                notice($src->{svr}, $src->{nick}, 'No quotes in buffer.');
+                return; 
+            }
+
+            # Return four quotes.
+            my $i = 0;
+            my $si = 3;
+            if (conf_get('qdb_search_resnum')) { $si = (conf_get('qdb_search_resnum'))[0][0] - 1; }
+            while ($i <= $si) {
+                if (!defined $BUFFER[0]) {
+                    last;
+                }
+
+                privmsg($src->{svr}, $src->{chan}, shift @BUFFER);
+                $i++;
+            }
+        }
         when ('DEL') {
             # Check for the cmd.qdbdel privilege.
             if (!has_priv(match_user(%$src), 'cmd.qdbdel')) {
@@ -138,37 +211,52 @@ sub cmd_qdb
 }
 
 
-API::Std::mod_init('QDB', 'Xelhua', '1.00', '3.0.0a4', __PACKAGE__);
+API::Std::mod_init('QDB', 'Xelhua', '1.02', '3.0.0a4', __PACKAGE__);
 # vim: set ai sw=4 ts=4:
 # build: perl=5.010000
 
 __END__
 
-=head1 QDB
+=head1 NAME
 
-=head2 Description
+QDB - Quote database module.
 
-=over
+=head1 VERSION
 
-This module adds the QDB (ADD|VIEW|COUNT|RAND|DEL) command, for adding,
-viewing, listing number of, viewing a random, deleting a quote from the Auto
-database.
+ 1.02
 
-=back
+=head1 SYNOPSIS
 
-=head2 Examples
+ <JohnSmith> !qdb add <JohnDoe> moocows
+ <Auto> Quote successfully submitted. ID: 732
 
-=over
+=head1 DESCRIPTION
 
-<JohnSmith> !qdb add <JohnDoe> moocows
-<Auto> Quote successfully submitted. ID: 732
+This module adds the QDB (ADD|VIEW|COUNT|RAND|SEARCH|MORE|DEL) command, for
+adding, viewing, listing number of, viewing a random, deleting a quote from the
+Auto database.
 
-=back
+=head1 INSTALL
 
-=head2 Technical
+Before using QDB, we'd recommend adding the following to your configuration
+file:
 
-=over
+ qdb_search_resnum <number>;
 
-This module is compatible with Auto v3.0.0a4+.
+Where <number> is the amount of results returned per SEARCH/MORE load.
 
-=back
+This is not required, 4 will be used if it is not specified.
+
+=head1 AUTHOR
+
+This module was written by Elijah Perrault.
+
+This module is maintained by Xelhua Development Group.
+
+=head1 LICENSE AND COPYRIGHT
+
+This module is Copyright 2010-2011 Xelhua Development Group.
+
+Released under the same licensing terms as Auto itself.
+
+=cut