diff --git a/doc/README.md b/doc/README.md index c223dcfe..5b96175f 100644 --- a/doc/README.md +++ b/doc/README.md @@ -8,24 +8,12 @@ * [Installing Perl](QuickStart.md#installing-perl) * [Installing CPAN modules](QuickStart.md#installing-cpan-modules) * [Installing PBot](QuickStart.md#installing-pbot) - * [git (recommended)](QuickStart.md#git-recommended) - * [Download zip archive](QuickStart.md#download-zip-archive) * [Initial Setup](QuickStart.md#initial-setup) * [Clone data-directory](QuickStart.md#clone-data-directory) * [Configuration](QuickStart.md#configuration) - * [Recommended settings for IRC Networks](QuickStart.md#recommended-settings-for-irc-networks) - * [Freenode](QuickStart.md#freenode) - * [IRCnet](QuickStart.md#ircnet) - * [Other networks](QuickStart.md#other-networks) * [Starting PBot](QuickStart.md#starting-pbot) * [Usage](QuickStart.md#usage) - * [Overriding directories](QuickStart.md#overriding-directories) - * [Overriding registry](QuickStart.md#overriding-registry) * [First-time start-up](QuickStart.md#first-time-start-up) - * [Using default Freenode settings](QuickStart.md#using-default-freenode-settings) - * [Using custom settings](QuickStart.md#using-custom-settings) - * [Custom recommended Freenode settings](QuickStart.md#custom-recommended-freenode-settings) - * [Custom recommended IRCnet/other network settings](QuickStart.md#custom-recommended-ircnetother-network-settings) * [Regular start-up](QuickStart.md#regular-start-up) * [Additional configuration](QuickStart.md#additional-configuration) * [Creating your bot owner admin account](QuickStart.md#creating-your-bot-owner-admin-account) @@ -47,11 +35,7 @@ * [Inline invocation](Commands.md#inline-invocation) * [Types of commands](Commands.md#types-of-commands) * [Built-in commands](Commands.md#built-in-commands) - * [Creating new built-in commands](Commands.md#creating-new-built-in-commands) - * [Plugins](Commands.md#plugins) * [Factoids](Commands.md#factoids) - * [Code Factoids](Commands.md#code-factoids) - * [Modules](Commands.md#modules) * [Commands documented here](Commands.md#commands-documented-here) * [version](Commands.md#version) * [help](Commands.md#help) @@ -60,6 +44,8 @@ * [date](Commands.md#date) * [weather](Commands.md#weather) * [Commands documented elsewhere](Commands.md#commands-documented-elsewhere) + * [Administrative commands](Commands.md#administrative-commands) + * [Factoid commands](Commands.md#factoid-commands) * [Administrative](Admin.md#administrative) @@ -69,10 +55,8 @@ * [User management commands](Admin.md#user-management-commands) * [useradd](Admin.md#useradd) * [userdel](Admin.md#userdel) - * [Admin levels](Admin.md#admin-levels) * [userset](Admin.md#userset) * [userunset](Admin.md#userunset) - * [User metadata list](Admin.md#user-metadata-list) * [Listing users](Admin.md#listing-users) * [Channel management commands](Admin.md#channel-management-commands) * [join](Admin.md#join) @@ -82,7 +66,6 @@ * [chanset](Admin.md#chanset) * [chanunset](Admin.md#chanunset) * [chanlist](Admin.md#chanlist) - * [Channel metadata list](Admin.md#channel-metadata-list) * [ignore](Admin.md#ignore) * [unignore](Admin.md#unignore) * [whitelist](Admin.md#whitelist) @@ -125,15 +108,6 @@ * [/call](Factoids.md#call) * [/msg](Factoids.md#msg) * [/code](Factoids.md#code) - * [Supported languages](Factoids.md#supported-languages) - * [Special variables](Factoids.md#special-variables) - * [testargs example](Factoids.md#testargs-example) - * [Setting a usage message](Factoids.md#setting-a-usage-message) - * [poll/vote example](Factoids.md#pollvote-example) - * [SpongeBob Mock meme example](Factoids.md#spongebob-mock-meme-example) - * [Using command-piping](Factoids.md#using-command-piping) - * [Improving SpongeBob Mock meme](Factoids.md#improving-spongebob-mock-meme) - * [Formatting and editing lengthy Code Factoids](Factoids.md#formatting-and-editing-lengthy-code-factoids) * [Special variables](Factoids.md#special-variables-1) * [$args](Factoids.md#args) * [$arg[n]](Factoids.md#argn) @@ -200,39 +174,6 @@ * [Creating modules](Modules.md#creating-modules) * [Documentation for built-in modules](Modules.md#documentation-for-built-in-modules) * [cc](Modules.md#cc) - * [Usage](Modules.md#usage) - * [Supported Languages](Modules.md#supported-languages) - * [Default Language](Modules.md#default-language) - * [Disallowed system calls](Modules.md#disallowed-system-calls) - * [Program termination with no output](Modules.md#program-termination-with-no-output) - * [Abnormal program termination](Modules.md#abnormal-program-termination) - * [C and C++ Functionality](Modules.md#c-and-c-functionality) - * [Using the preprocessor](Modules.md#using-the-preprocessor) - * [Default #includes](Modules.md#default-includes) - * [Using #include](Modules.md#using-include) - * [Using #define](Modules.md#using-define) - * [main() Function Unnecessary](Modules.md#main-function-unnecessary) - * [Embedding Newlines](Modules.md#embedding-newlines) - * [Printing in binary/base2](Modules.md#printing-in-binarybase2) - * [Using the GDB debugger](Modules.md#using-the-gdb-debugger) - * [print](Modules.md#print) - * [ptype](Modules.md#ptype) - * [watch](Modules.md#watch) - * [trace](Modules.md#trace) - * [gdb](Modules.md#gdb) - * [Interactive Editing](Modules.md#interactive-editing) - * [copy](Modules.md#copy) - * [show](Modules.md#show) - * [diff](Modules.md#diff) - * [paste](Modules.md#paste) - * [run](Modules.md#run) - * [undo](Modules.md#undo) - * [s//](Modules.md#s) - * [replace](Modules.md#replace) - * [prepend](Modules.md#prepend) - * [append](Modules.md#append) - * [remove](Modules.md#remove) - * [Some Examples](Modules.md#some-examples) * [english](Modules.md#english) * [expand](Modules.md#expand) * [prec](Modules.md#prec) @@ -240,15 +181,6 @@ * [faq](Modules.md#faq) * [cfact](Modules.md#cfact) * [cjeopardy](Modules.md#cjeopardy) - * [hint](Modules.md#hint) - * [what](Modules.md#what) - * [w](Modules.md#w) - * [filter](Modules.md#filter) - * [score](Modules.md#score) - * [rank](Modules.md#rank) - * [reset](Modules.md#reset) - * [qstats](Modules.md#qstats) - * [qshow](Modules.md#qshow) * [c99std](Modules.md#c99std) * [c11std](Modules.md#c11std) * [man](Modules.md#man) @@ -298,3 +230,10 @@ * [Configuring Linux for PBot Communication](VirtualMachine.md#configuring-linux-for-pbot-communication) * [Hardening the PBot virtual machine](VirtualMachine.md#hardening-the-pbot-virtual-machine) + +* [Frequently Asked Questions](FAQ.md#frequently-asked-questions) + * [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) + * [How do I change the bot trigger?](FAQ.md#how-do-i-change-the-bot-trigger) +