diff --git a/doc/AntiAbuse.md b/doc/AntiAbuse.md index 1aa9d475..3871e778 100644 --- a/doc/AntiAbuse.md +++ b/doc/AntiAbuse.md @@ -1,9 +1,10 @@ -Flood control -============= -PBot can monitor the channel for excessive rapid traffic originating from an individual and automatically ban the offender for a certain length of time. +Anti-Abuse +========== +PBot can monitor channels for abusive behavior and take appropriate action. +* [Anti-Abuse](#anti-abuse) * [Flood control](#flood-control) * [Message flood](#message-flood) * [Join flood](#join-flood) @@ -14,6 +15,9 @@ PBot can monitor the channel for excessive rapid traffic originating from an ind * [Opping/Deopping](#oppingdeopping) +Flood control +============= +PBot can monitor the channel for excessive rapid traffic originating from an individual and automatically ban the offender for a certain length of time. Message flood ------------- diff --git a/doc/Channels.md b/doc/Channels.md index 5ac24523..f0f3dadd 100644 --- a/doc/Channels.md +++ b/doc/Channels.md @@ -1,18 +1,16 @@ Channel Management ================== - - * [Channel Management](#channel-management) - * [chanadd](#chanadd) - * [chanrem](#chanrem) - * [chanset](#chanset) - * [Channel Metadata List](#channel-metadata-list) - * [chanunset](#chanunset) - * [chanlist](#chanlist) +* [Channel Management](#channel-management) + * [chanadd](#chanadd) + * [chanrem](#chanrem) + * [chanset](#chanset) + * [Channel Metadata List](#channel-metadata-list) + * [chanunset](#chanunset) + * [chanlist](#chanlist) - #### chanadd `chanadd` adds a channel to PBot's list of channels to auto-join and manage. diff --git a/doc/CodeFactoids.md b/doc/CodeFactoids.md index 73672c06..43893b3e 100644 --- a/doc/CodeFactoids.md +++ b/doc/CodeFactoids.md @@ -1,16 +1,14 @@ ### code-factoids Code-factoids are a special type of factoid whose text is executed as Perl instructions. The return value from these instructions is the final text of the factoid. This final text is then parsed and treated like any other factoid text. - - * [code-factoids](#code-factoids) - * [Special variables](#special-variables) - * [testargs example](#testargs-example) - * [rtfm example](#rtfm-example) - * [poll example](#poll-example) +* [code-factoids](#code-factoids) + * [Special variables](#special-variables) + * [testargs example](#testargs-example) + * [rtfm example](#rtfm-example) + * [poll example](#poll-example) - By default, the variables created within code-factoids do not persist between factoid invocations. This behavior can be overridden by factsetting a persist-key with a unique value. To create a code-factoid, simply wrap the factoid text with curly braces. diff --git a/doc/Modules.md b/doc/Modules.md index 28344cc2..014b976a 100644 --- a/doc/Modules.md +++ b/doc/Modules.md @@ -1,82 +1,82 @@ Modules ------- +PBot has several external command-line modules. Here is the documentation for most of them. - * [Modules](#modules) - * [cc](#cc) - * [Usage](#usage) - * [Supported Languages](#supported-languages) - * [Default Language](#default-language) - * [Disallowed system calls](#disallowed-system-calls) - * [Program termination with no output](#program-termination-with-no-output) - * [Abnormal program termination](#abnormal-program-termination) - * [C and C++ Functionality](#c-and-c-functionality) - * [Using the preprocessor](#using-the-preprocessor) - * [Default #includes](#default-includes) - * [Using #include](#using-include) - * [Using #define](#using-define) - * [main() Function Unnecessary](#main-function-unnecessary) - * [Embedding Newlines](#embedding-newlines) - * [Printing in binary/base2](#printing-in-binarybase2) - * [Using the GDB debugger](#using-the-gdb-debugger) - * [print](#print) - * [ptype](#ptype) - * [watch](#watch) - * [trace](#trace) - * [gdb](#gdb) - * [Interactive Editing](#interactive-editing) - * [copy](#copy) - * [show](#show) - * [diff](#diff) - * [paste](#paste) - * [run](#run) - * [undo](#undo) - * [s//](#s) - * [replace](#replace) - * [prepend](#prepend) - * [append](#append) - * [remove](#remove) - * [Some Examples](#some-examples) - * [english](#english) - * [expand](#expand) - * [prec](#prec) - * [paren](#paren) - * [faq](#faq) - * [cfact](#cfact) - * [cjeopardy](#cjeopardy) - * [hint](#hint) - * [what](#what) - * [w](#w) - * [filter](#filter) - * [score](#score) - * [rank](#rank) - * [reset](#reset) - * [qstats](#qstats) - * [qshow](#qshow) - * [c99std](#c99std) - * [c11std](#c11std) - * [man](#man) - * [google](#google) - * [define](#define) - * [dict](#dict) - * [foldoc](#foldoc) - * [vera](#vera) - * [udict](#udict) - * [wdict](#wdict) - * [acronym](#acronym) - * [math](#math) - * [calc](#calc) - * [qalc](#qalc) - * [compliment](#compliment) - * [insult](#insult) - * [excuse](#excuse) - * [horoscope](#horoscope) - * [horrorscope](#horrorscope) - * [quote](#quote) +* [Modules](#modules) +* [cc](#cc) + * [Usage](#usage) + * [Supported Languages](#supported-languages) + * [Default Language](#default-language) + * [Disallowed system calls](#disallowed-system-calls) + * [Program termination with no output](#program-termination-with-no-output) + * [Abnormal program termination](#abnormal-program-termination) + * [C and C++ Functionality](#c-and-c-functionality) + * [Using the preprocessor](#using-the-preprocessor) + * [Default #includes](#default-includes) + * [Using #include](#using-include) + * [Using #define](#using-define) + * [main() Function Unnecessary](#main-function-unnecessary) + * [Embedding Newlines](#embedding-newlines) + * [Printing in binary/base2](#printing-in-binarybase2) + * [Using the GDB debugger](#using-the-gdb-debugger) + * [print](#print) + * [ptype](#ptype) + * [watch](#watch) + * [trace](#trace) + * [gdb](#gdb) + * [Interactive Editing](#interactive-editing) + * [copy](#copy) + * [show](#show) + * [diff](#diff) + * [paste](#paste) + * [run](#run) + * [undo](#undo) + * [s//](#s) + * [replace](#replace) + * [prepend](#prepend) + * [append](#append) + * [remove](#remove) + * [Some Examples](#some-examples) +* [english](#english) +* [expand](#expand) +* [prec](#prec) +* [paren](#paren) +* [faq](#faq) +* [cfact](#cfact) +* [cjeopardy](#cjeopardy) + * [hint](#hint) + * [what](#what) + * [w](#w) + * [filter](#filter) + * [score](#score) + * [rank](#rank) + * [reset](#reset) + * [qstats](#qstats) + * [qshow](#qshow) +* [c99std](#c99std) +* [c11std](#c11std) +* [man](#man) +* [google](#google) +* [define](#define) +* [dict](#dict) +* [foldoc](#foldoc) +* [vera](#vera) +* [udict](#udict) +* [wdict](#wdict) +* [acronym](#acronym) +* [math](#math) +* [calc](#calc) +* [qalc](#qalc) +* [compliment](#compliment) +* [insult](#insult) +* [excuse](#excuse) +* [horoscope](#horoscope) +* [horrorscope](#horrorscope) +* [quote](#quote) - ### cc Code compiler (and executor). This command will compile and execute user-provided code in a number of languages, and then display the compiler and/or program output. diff --git a/doc/QuoteGrabs.md b/doc/QuoteGrabs.md index 15757297..b6bc617f 100644 --- a/doc/QuoteGrabs.md +++ b/doc/QuoteGrabs.md @@ -1,16 +1,16 @@ Quotegrabs ---------- +PBot can grab user messages and store/recall them for posterity. - * [Quotegrabs](#quotegrabs) - * [grab](#grab) - * [getq](#getq) - * [rq](#rq) - * [delq](#delq) +* [Quotegrabs](#quotegrabs) + * [grab](#grab) + * [getq](#getq) + * [rq](#rq) + * [delq](#delq) - ### grab Grabs a message someone says, and adds it to the quotegrabs database. You may grab multiple nicks/messages in one quotegrab by separating the arguments with a plus sign (the nicks need not be different -- you can grab multiple messages by the same nick by specifying a different history for each grab).