GitHub
/
pbot
mirror of https://github.com/pragma-/pbot.git
3
0
Fork 0
Code Issues Projects Releases Wiki Activity

doc: Adjustments to TOC

This commit is contained in:
Pragmatic Software 2019-12-23 17:41:26 -08:00
parent 630837d3b0
commit 50f9bf4f9d
5 changed files with 97 additions and 97 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/AntiAbuse.md
View File

@ -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.
<!-- md-toc-begin -->
* [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)
<!-- md-toc-end -->
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
-------------

16
doc/Channels.md
View File

@ -1,18 +1,16 @@
Channel Management
==================
<!-- md-toc-begin -->
* [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)
<!-- md-toc-end -->
#### chanadd
`chanadd` adds a channel to PBot's list of channels to auto-join and manage.

12
doc/CodeFactoids.md
View File

@ -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.
<!-- md-toc-begin -->
* [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)
<!-- md-toc-end -->
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.

144
doc/Modules.md
View File

@ -1,82 +1,82 @@
Modules
-------
PBot has several external command-line modules. Here is the documentation for most of them.
<!-- md-toc-begin -->
* [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)
<!-- md-toc-end -->
### 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.

12
doc/QuoteGrabs.md
View File

@ -1,16 +1,16 @@
Quotegrabs
----------
PBot can grab user messages and store/recall them for posterity.
<!-- md-toc-begin -->
* [Quotegrabs](#quotegrabs)
* [grab](#grab)
* [getq](#getq)
* [rq](#rq)
* [delq](#delq)
* [Quotegrabs](#quotegrabs)
* [grab](#grab)
* [getq](#getq)
* [rq](#rq)
* [delq](#delq)
<!-- md-toc-end -->
### 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).