Document aka commands

doc/Admin.md

@@ -61,6 +61,11 @@
 * [Process management commands](#process-management-commands)
   * [ps](#ps)
   * [kill](#kill)
+* [Message history commands](#message-history-commands)
+  * [aka](#aka)
+  * [akalink](#akalink)
+  * [akaunlink](#akaunlink)
+  * [akadelete](#akadelete)
 * [Miscellaneous commands](#miscellaneous-commands)
   * [export](#export)
   * [refresh](#refresh)
@@ -602,6 +607,74 @@ Option | Description
 
 If neither options `-a` or `-t` are provided then the `pids...` option is required.
 
+## Message history commands
+Message history has an advanced user tracking algorithm in order to ensure that
+messages are being stored in the right message history accounts. The following commands
+query and manipulate the message history account links.
+
+Note that "message history account" and "PBot user account" are distinct accounts.
+
+### aka
+The `aka` command lists all known aliases for a given message history account.
+
+Usage: `aka [-hilngr] <nick> [-sort <by>]`
+
+Option | Description
+--- | ---
+`-h` | show hostmasks
+`-i` | show ids
+`-l` | show last seen
+`-n` | show nickserv accounts
+`-g` | show gecos
+`-r` | show relationships
+
+Sort by | Description
+--- | ---
+gecos    | GECOS field
+host     | host portion of hostmask
+hostmask | hostmask
+id       | account id
+nick     | nick portion of hostmask
+nickserv | NickServ account
+seen     | last seen timestamp
+user     | user portion of hostmask
+
+Examples:
+
+    <pragma-> aka bob
+       <PBot> bob also known as: bob, bobby, robert
+
+    <pragma-> aka -hl bob
+       <PBot> bob also known as: bob!~bob@user/bob (seen 5m ago), bobby!~bob@user/bob (seen 6d ago), robert!~bob@127.0.0.1 (seen 20d ago)
+
+### akalink
+The `akalink` command manually links two message history accounts together.
+
+Usage: `akalink <target id> <alias id> [type]`
+
+The optional `type` argument can be `0` (weak) or `1` (strong). Defaults to `1`.
+
+Use the `id` command to look up message history account ids for a given hostmask.
+
+### akaunlink
+The `akaunlink` command manually unlinks two message history accounts from each other.
+
+Usage: `akaunlink <target id> <alias id>`
+
+Use the `-r` option with the `aka` command to see the `target -> alias` relationship.
+
+### akadelete
+The `akadelete` command deletes message history account metadata or entire message history accounts.
+
+Usage: `akadelete [-hn] <account id or hostmask>`
+
+Option | Description
+--- | ---
+`-h` | delete only hostmask
+`-n` | delete only nickserv accounts
+
+If neither options `-h` or `-n` are given, then the entire message history account will be deleted.
+
 ## Miscellaneous commands
 These are some of the miscellaneous admin commands that have not been covered
 above or in the rest of the PBot documentation.

doc/Commands.md

@@ -83,6 +83,12 @@
       * [regfind](Registry.md#regfind)
       * [regsetmeta](Registry.md#regsetmeta)
       * [regunsetmeta](Registry.md#regunsetmeta)
+    * [Message history](#message-history)
+      * [recall](Commands.md#recall)
+      * [aka](Admin.md#aka)
+      * [akalink](Admin.md#akalink)
+      * [akaunlink](Admin.md#akaunlink)
+      * [akadelete](Admin.md#akadelete)
     * [Miscellaneous admin commands](#miscellaneous-admin-commands)
       * [export](Admin.md#export)
       * [refresh](Admin.md#refresh)
@@ -567,6 +573,13 @@ to have the command remember your location.
 ##### [regsetmeta](Registry.md#regsetmeta)
 ##### [regunsetmeta](Registry.md#regunsetmeta)
 
+#### Message history
+##### [recall](Commands.md#recall)
+##### [aka](Admin.md#aka)
+##### [akalink](Admin.md#akalink)
+##### [akaunlink](Admin.md#akaunlink)
+##### [akadelete](Admin.md#akadelete)
+
 #### Miscellaneous admin commands
 ##### [export](Admin.md#export)
 ##### [refresh](Admin.md#refresh)

doc/QuickStart.md

@@ -1,44 +1,43 @@
 # QuickStart
 
 <!-- md-toc-begin -->
-* [QuickStart](#quickstart)
+* [Installation](#installation)
-  * [Installation](#installation)
+  * [Installing Perl](#installing-perl)
-    * [Installing Perl](#installing-perl)
+  * [Installing PBot](#installing-pbot)
-    * [Installing PBot](#installing-pbot)
+    * [git (recommended)](#git-recommended)
-      * [git (recommended)](#git-recommended)
+    * [Download zip archive](#download-zip-archive)
-      * [Download zip archive](#download-zip-archive)
+* [Initial Setup](#initial-setup)
-  * [Initial Setup](#initial-setup)
+  * [Installing CPAN modules](#installing-cpan-modules)
-    * [Installing CPAN modules](#installing-cpan-modules)
+    * [Installing cpanminus](#installing-cpanminus)
-      * [Installing cpanminus](#installing-cpanminus)
+    * [Installing and using local::lib](#installing-and-using-locallib)
-      * [Installing and using local::lib](#installing-and-using-locallib)
+    * [Using cpanminus](#using-cpanminus)
-      * [Using cpanminus](#using-cpanminus)
+    * [re::engine::RE2](#reenginere2)
-      * [re::engine::RE2](#reenginere2)
+  * [Clone data-directory](#clone-data-directory)
-    * [Clone data-directory](#clone-data-directory)
+  * [Configuration](#configuration)
-    * [Configuration](#configuration)
+    * [Recommended settings for IRC Networks](#recommended-settings-for-irc-networks)
-      * [Recommended settings for IRC Networks](#recommended-settings-for-irc-networks)
+      * [Libera.Chat](#liberachat)
-        * [Libera.Chat](#liberachat)
+      * [IRCnet](#ircnet)
-        * [IRCnet](#ircnet)
+      * [Other networks](#other-networks)
-        * [Other networks](#other-networks)
+* [Starting PBot](#starting-pbot)
-  * [Starting PBot](#starting-pbot)
+  * [Usage](#usage)
-    * [Usage](#usage)
+    * [rlwrap](#rlwrap)
-      * [rlwrap](#rlwrap)
+    * [Overriding directories](#overriding-directories)
-      * [Overriding directories](#overriding-directories)
+    * [Overriding registry](#overriding-registry)
-      * [Overriding registry](#overriding-registry)
+  * [First-time start-up](#first-time-start-up)
-    * [First-time start-up](#first-time-start-up)
+    * [Using default settings](#using-default-settings)
-      * [Using default settings](#using-default-settings)
+    * [Using custom settings](#using-custom-settings)
-      * [Using custom settings](#using-custom-settings)
+      * [Custom recommended settings](#custom-recommended-settings)
-        * [Custom recommended settings](#custom-recommended-settings)
+      * [Custom recommended IRCnet/other network settings](#custom-recommended-ircnetother-network-settings)
-        * [Custom recommended IRCnet/other network settings](#custom-recommended-ircnetother-network-settings)
+  * [Regular start-up](#regular-start-up)
-    * [Regular start-up](#regular-start-up)
+* [Additional configuration](#additional-configuration)
-  * [Additional configuration](#additional-configuration)
+  * [Creating your bot owner admin account](#creating-your-bot-owner-admin-account)
-    * [Creating your bot owner admin account](#creating-your-bot-owner-admin-account)
+  * [Adding other users and admins](#adding-other-users-and-admins)
-    * [Adding other users and admins](#adding-other-users-and-admins)
+  * [Adding channels](#adding-channels)
-    * [Adding channels](#adding-channels)
+* [Further Reading](#further-reading)
-  * [Further Reading](#further-reading)
+  * [Commands](#commands)
-    * [Commands](#commands)
+  * [Factoids](#factoids)
-    * [Factoids](#factoids)
+  * [Plugins](#plugins)
-    * [Plugins](#plugins)
+  * [Modules](#modules)
-    * [Modules](#modules)
 <!-- md-toc-end -->
 
 ## Installation

doc/README.md

@@ -81,6 +81,7 @@
       * [Event queue](Commands.md#event-queue)
       * [Process management](Commands.md#process-management)
       * [Registry commands](Commands.md#registry-commands)
+      * [Message history](Commands.md#message-history)
       * [Miscellaneous admin commands](Commands.md#miscellaneous-admin-commands)
     * [Factoid commands](Commands.md#factoid-commands)
       * [Adding/removing factoids](Commands.md#addingremoving-factoids)
@@ -149,6 +150,11 @@
   * [Process management commands](Admin.md#process-management-commands)
     * [ps](Admin.md#ps)
     * [kill](Admin.md#kill)
+  * [Message history commands](Admin.md#message-history-commands)
+    * [aka](Admin.md#aka)
+    * [akalink](Admin.md#akalink)
+    * [akaunlink](Admin.md#akaunlink)
+    * [akadelete](Admin.md#akadelete)
   * [Miscellaneous commands](Admin.md#miscellaneous-commands)
     * [export](Admin.md#export)
     * [refresh](Admin.md#refresh)
@@ -312,9 +318,12 @@
 <!-- md-toc-end -->
 <!-- md-toc-begin -->
 * [Frequently Asked Questions](FAQ.md#frequently-asked-questions)
-    * [How do I change my password?](FAQ.md#how-do-i-change-my-password)
+  * [When I type `!version` it say "new version available"?](FAQ.md#when-i-type-version-it-say-new-version-available)
-    * [How do I make PBot remember my `date` timezone?](FAQ.md#how-do-i-make-pbot-remember-my-date-timezone)
+  * [How do I change the bot trigger?](FAQ.md#how-do-i-change-the-bot-trigger)
-    * [How do I make PBot remember my `weather` location?](FAQ.md#how-do-i-make-pbot-remember-my-weather-location)
+  * [How do I whitelist a user?](FAQ.md#how-do-i-whitelist-a-user)
-    * [How do I change the bot trigger?](FAQ.md#how-do-i-change-the-bot-trigger)
+  * [How do I change how the bot outputs multi-line messages?](FAQ.md#how-do-i-change-how-the-bot-outputs-multi-line-messages)
-    * [How do I whitelist a user?](FAQ.md#how-do-i-whitelist-a-user)
+  * [I made a command. It's supposed to output formatting with spaces and tabs?](FAQ.md#i-made-a-command-its-supposed-to-output-formatting-with-spaces-and-tabs)
+  * [How do I change my password?](FAQ.md#how-do-i-change-my-password)
+  * [How do I make PBot remember my `date` timezone?](FAQ.md#how-do-i-make-pbot-remember-my-date-timezone)
+  * [How do I make PBot remember my `weather` location?](FAQ.md#how-do-i-make-pbot-remember-my-weather-location)
 <!-- md-toc-end -->