3
0
mirror of https://github.com/pragma-/pbot.git synced 2024-12-23 19:22:40 +01:00
pbot/doc/README.md

372 lines
18 KiB
Markdown
Raw Normal View History

2020-01-12 19:30:51 +01:00
# PBot Documentation
## Table of Contents
2020-01-13 07:25:26 +01:00
<!-- md-toc-begin -->
* [QuickStart](QuickStart.md#quickstart)
* [Installation](QuickStart.md#installation)
2024-04-04 21:23:45 +02:00
* [Docker](QuickStart.md#docker)
2020-01-13 07:25:26 +01:00
* [Installing Perl](QuickStart.md#installing-perl)
* [Installing PBot](QuickStart.md#installing-pbot)
2020-02-04 11:32:29 +01:00
* [git (recommended)](QuickStart.md#git-recommended)
* [Download zip archive](QuickStart.md#download-zip-archive)
2020-01-28 04:53:48 +01:00
* [Initial Setup](QuickStart.md#initial-setup)
* [Installing CPAN modules](QuickStart.md#installing-cpan-modules)
* [Installing cpanminus](QuickStart.md#installing-cpanminus)
* [Installing and using local::lib](QuickStart.md#installing-and-using-locallib)
* [Using cpanminus](QuickStart.md#using-cpanminus)
* [re::engine::RE2](QuickStart.md#reenginere2)
2020-01-13 07:25:26 +01:00
* [Clone data-directory](QuickStart.md#clone-data-directory)
2020-01-28 04:53:48 +01:00
* [Configuration](QuickStart.md#configuration)
2020-02-04 11:32:29 +01:00
* [Recommended settings for IRC Networks](QuickStart.md#recommended-settings-for-irc-networks)
2020-01-13 07:25:26 +01:00
* [Starting PBot](QuickStart.md#starting-pbot)
* [Usage](QuickStart.md#usage)
2020-09-22 23:05:25 +02:00
* [rlwrap](QuickStart.md#rlwrap)
2020-02-04 11:32:29 +01:00
* [Overriding directories](QuickStart.md#overriding-directories)
* [Overriding registry](QuickStart.md#overriding-registry)
2020-01-28 04:53:48 +01:00
* [First-time start-up](QuickStart.md#first-time-start-up)
2021-06-12 22:54:03 +02:00
* [Using default settings](QuickStart.md#using-default-settings)
2020-02-04 11:32:29 +01:00
* [Using custom settings](QuickStart.md#using-custom-settings)
2020-01-28 04:53:48 +01:00
* [Regular start-up](QuickStart.md#regular-start-up)
* [Additional configuration](QuickStart.md#additional-configuration)
2020-01-28 05:05:31 +01:00
* [Creating your bot owner admin account](QuickStart.md#creating-your-bot-owner-admin-account)
2020-01-28 04:53:48 +01:00
* [Adding other users and admins](QuickStart.md#adding-other-users-and-admins)
2020-01-28 05:18:22 +01:00
* [Adding channels](QuickStart.md#adding-channels)
2020-01-13 07:25:26 +01:00
* [Further Reading](QuickStart.md#further-reading)
* [Commands](QuickStart.md#commands)
* [Factoids](QuickStart.md#factoids)
2020-01-28 04:53:48 +01:00
* [Plugins](QuickStart.md#plugins)
* [Applets](QuickStart.md#applets)
2020-01-13 07:25:26 +01:00
<!-- md-toc-end -->
2020-01-12 19:30:51 +01:00
<!-- md-toc-begin -->
2020-07-23 23:37:04 +02:00
* [Plugins](Plugins.md#plugins)
* [About](Plugins.md#about)
* [Plang](Plugins/Plang.md)
* [Quotegrabs](Plugins/Quotegrabs.md)
<!-- md-toc-end -->
<!-- md-toc-begin -->
2020-01-22 03:39:11 +01:00
* [Commands](Commands.md#commands)
* [Command interpreter](Commands.md#command-interpreter)
* [Command invocation](Commands.md#command-invocation)
* [Addressing output to users](Commands.md#addressing-output-to-users)
* [Inline invocation](Commands.md#inline-invocation)
* [Chaining](Commands.md#chaining)
2020-01-22 03:39:11 +01:00
* [Piping](Commands.md#piping)
* [Substitution](Commands.md#substitution)
* [Nesting Pipes and Substitutions](Commands.md#nesting-pipes-and-substitutions)
2020-01-22 03:39:11 +01:00
* [Variables](Commands.md#variables)
2020-06-03 08:44:02 +02:00
* [Selectors](Commands.md#selectors)
2020-02-15 08:35:34 +01:00
* [Background processing](Commands.md#background-processing)
2020-01-22 03:39:11 +01:00
* [Types of commands](Commands.md#types-of-commands)
* [Built-in commands](Commands.md#built-in-commands)
* [Listing all built-in commands](Commands.md#listing-all-built-in-commands)
2020-02-04 11:32:29 +01:00
* [Creating new built-in commands](Commands.md#creating-new-built-in-commands)
* [Plugins](Commands.md#plugins)
2020-02-16 21:22:14 +01:00
* [Functions](Commands.md#functions)
2020-01-22 03:39:11 +01:00
* [Factoids](Commands.md#factoids)
2020-02-04 11:32:29 +01:00
* [Code Factoids](Commands.md#code-factoids)
* [Applets](Commands.md#applets)
2020-01-23 04:29:44 +01:00
* [Commands documented here](Commands.md#commands-documented-here)
2020-01-22 03:39:11 +01:00
* [version](Commands.md#version)
* [help](Commands.md#help)
2020-01-23 04:29:44 +01:00
* [uptime](Commands.md#uptime)
2020-01-27 05:15:45 +01:00
* [my](Commands.md#my)
* [date](Commands.md#date)
* [weather](Commands.md#weather)
2020-01-23 04:29:44 +01:00
* [Commands documented elsewhere](Commands.md#commands-documented-elsewhere)
* [Administrative](Commands.md#administrative)
2020-02-04 11:32:29 +01:00
* [Logging in and out of PBot](Commands.md#logging-in-and-out-of-pbot)
* [User-management](Commands.md#user-management)
* [Channel-management](Commands.md#channel-management)
* [Applet-management](Commands.md#applet-management)
* [Plugin-management](Commands.md#plugin-management)
2020-02-04 11:32:29 +01:00
* [Command metadata](Commands.md#command-metadata)
2021-09-15 06:23:01 +02:00
* [Event-queue management](Commands.md#event-queue-management)
* [Process-management](Commands.md#process-management)
* [Registry](Commands.md#registry)
* [Message-history/user-tracking](Commands.md#message-historyuser-tracking)
2020-02-04 11:32:29 +01:00
* [Miscellaneous admin commands](Commands.md#miscellaneous-admin-commands)
* [Factoid commands](Commands.md#factoid-commands)
* [Adding/removing factoids](Commands.md#addingremoving-factoids)
* [Displaying factoids](Commands.md#displaying-factoids)
* [Editing factoids](Commands.md#editing-factoids)
* [Factoid metadata](Commands.md#factoid-metadata)
* [Information about factoids](Commands.md#information-about-factoids)
2020-01-22 03:39:11 +01:00
<!-- md-toc-end -->
<!-- md-toc-begin -->
2020-01-12 19:30:51 +01:00
* [Administrative](Admin.md#administrative)
* [Logging in and out](Admin.md#logging-in-and-out)
* [login](Admin.md#login)
* [logout](Admin.md#logout)
* [User-management](Admin.md#user-management)
2020-01-27 04:52:37 +01:00
* [useradd](Admin.md#useradd)
* [userdel](Admin.md#userdel)
* [userset](Admin.md#userset)
* [userunset](Admin.md#userunset)
2020-02-04 11:32:29 +01:00
* [User metadata list](Admin.md#user-metadata-list)
2020-01-27 04:52:37 +01:00
* [Listing users](Admin.md#listing-users)
2020-02-04 11:30:26 +01:00
* [User capabilities](Admin.md#user-capabilities)
2020-02-06 20:22:47 +01:00
* [Introduction](Admin.md#introduction)
2020-02-04 11:30:26 +01:00
* [cap](Admin.md#cap)
2020-02-04 11:32:29 +01:00
* [Listing capabilities](Admin.md#listing-capabilities)
* [Grouping capabilities](Admin.md#grouping-capabilities)
* [Giving capabilities to users](Admin.md#giving-capabilities-to-users)
* [Checking user capabilities](Admin.md#checking-user-capabilities)
2020-02-06 20:22:47 +01:00
* [Listing users who have a capability](Admin.md#listing-users-who-have-a-capability)
2020-02-04 11:32:29 +01:00
* [User capabilities list](Admin.md#user-capabilities-list)
* [Channel management](Admin.md#channel-management)
2020-01-12 19:30:51 +01:00
* [join](Admin.md#join)
* [part](Admin.md#part)
* [chanadd](Admin.md#chanadd)
* [chanrem](Admin.md#chanrem)
* [chanset](Admin.md#chanset)
* [chanunset](Admin.md#chanunset)
* [chanlist](Admin.md#chanlist)
2020-02-04 11:32:29 +01:00
* [Channel metadata list](Admin.md#channel-metadata-list)
2020-01-12 19:30:51 +01:00
* [ignore](Admin.md#ignore)
* [unignore](Admin.md#unignore)
* [blacklist](Admin.md#blacklist)
2021-09-15 07:01:13 +02:00
* [nicklist](Admin.md#nicklist)
* [banlist](Admin.md#banlist)
2020-01-12 19:30:51 +01:00
* [op](Admin.md#op)
* [deop](Admin.md#deop)
* [voice](Admin.md#voice)
* [devoice](Admin.md#devoice)
* [mode](Admin.md#mode)
* [ban/mute](Admin.md#banmute)
* [unban/unmute](Admin.md#unbanunmute)
2021-09-15 07:01:13 +02:00
* [checkban](Admin.md#checkban)
* [checkmute](Admin.md#checkmute)
2020-01-12 19:30:51 +01:00
* [invite](Admin.md#invite)
* [kick](Admin.md#kick)
* [Applet-management](Admin.md#applet-management)
2020-01-12 19:30:51 +01:00
* [load](Admin.md#load)
* [unload](Admin.md#unload)
* [Listing applets](Admin.md#listing-applets)
* [Plugin-management](Admin.md#plugin-management)
2020-01-12 19:30:51 +01:00
* [plug](Admin.md#plug)
* [unplug](Admin.md#unplug)
* [replug](Admin.md#replug)
* [pluglist](Admin.md#pluglist)
* [Command metadata](Admin.md#command-metadata)
2020-01-23 07:25:09 +01:00
* [cmdset](Admin.md#cmdset)
* [cmdunset](Admin.md#cmdunset)
* [Command metadata list](Admin.md#command-metadata-list)
* [Event-queue management](Admin.md#event-queue-management)
2020-03-09 00:26:18 +01:00
* [eventqueue](Admin.md#eventqueue)
* [Process-management](Admin.md#process-management)
2020-02-15 08:06:24 +01:00
* [ps](Admin.md#ps)
* [kill](Admin.md#kill)
* [Message-history/user-tracking](Admin.md#message-historyuser-tracking)
* [recall](Admin.md#recall)
* [id](Admin.md#id)
2021-09-06 21:45:02 +02:00
* [aka](Admin.md#aka)
* [akalink](Admin.md#akalink)
* [akaunlink](Admin.md#akaunlink)
* [akadelete](Admin.md#akadelete)
* [Miscellaneous](Admin.md#miscellaneous)
2020-01-12 19:30:51 +01:00
* [export](Admin.md#export)
* [refresh](Admin.md#refresh)
* [reload](Admin.md#reload)
* [sl](Admin.md#sl)
* [die](Admin.md#die)
<!-- md-toc-end -->
<!-- md-toc-begin -->
* [Factoids](Factoids.md#factoids)
* [About](Factoids.md#about)
* [Special commands](Factoids.md#special-commands)
* [/say](Factoids.md#say)
* [/me](Factoids.md#me)
* [/call](Factoids.md#call)
* [/msg](Factoids.md#msg)
* [/code](Factoids.md#code)
2020-02-04 11:32:29 +01:00
* [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)
2020-01-12 19:30:51 +01:00
* [Special variables](Factoids.md#special-variables-1)
* [$args](Factoids.md#args)
* [$arg[n]](Factoids.md#argn)
* [$arg[n:m]](Factoids.md#argnm)
* [$arglen](Factoids.md#arglen)
* [$channel](Factoids.md#channel)
* [$nick](Factoids.md#nick)
* [$randomnick](Factoids.md#randomnick)
* [$0](Factoids.md#0)
* [List variables](Factoids.md#list-variables)
* [Expansion modifiers](Factoids.md#expansion-modifiers)
* [action_with_args](Factoids.md#action_with_args)
* [add_nick](Factoids.md#add_nick)
2020-01-23 04:29:44 +01:00
* [Channel namespaces](Factoids.md#channel-namespaces)
2020-01-22 03:39:11 +01:00
* [Adding/removing factoids](Factoids.md#addingremoving-factoids)
2020-01-12 19:30:51 +01:00
* [factadd](Factoids.md#factadd)
* [factrem](Factoids.md#factrem)
* [forget](Factoids.md#forget)
* [factalias](Factoids.md#factalias)
2020-01-22 03:39:11 +01:00
* [Displaying factoids](Factoids.md#displaying-factoids)
* [fact](Factoids.md#fact)
* [factshow](Factoids.md#factshow)
* [Editing factoids](Factoids.md#editing-factoids)
2020-01-12 19:30:51 +01:00
* [factchange](Factoids.md#factchange)
2020-01-22 03:39:11 +01:00
* [factmove](Factoids.md#factmove)
2020-01-12 19:30:51 +01:00
* [factundo](Factoids.md#factundo)
* [factredo](Factoids.md#factredo)
2020-02-06 20:22:47 +01:00
* [Factoid metadata](Factoids.md#factoid-metadata)
2020-01-12 19:30:51 +01:00
* [factset](Factoids.md#factset)
* [factunset](Factoids.md#factunset)
2020-02-06 20:22:47 +01:00
* [Factoid metadata List](Factoids.md#factoid-metadata-list)
2020-01-22 03:39:11 +01:00
* [Information about factoids](Factoids.md#information-about-factoids)
2020-01-12 19:30:51 +01:00
* [factfind](Factoids.md#factfind)
* [factinfo](Factoids.md#factinfo)
* [factlog](Factoids.md#factlog)
2020-01-22 03:39:11 +01:00
* [factset](Factoids.md#factset-1)
2020-01-12 19:30:51 +01:00
* [count](Factoids.md#count)
* [histogram](Factoids.md#histogram)
* [top20](Factoids.md#top20)
<!-- md-toc-end -->
<!-- md-toc-begin -->
2020-01-13 07:25:26 +01:00
* [Registry](Registry.md#registry)
* [About](Registry.md#about)
* [Types of values](Registry.md#types-of-values)
* [Creating array values](Registry.md#creating-array-values)
* [Overriding Registry values per-channel](Registry.md#overriding-registry-values-per-channel)
* [Overriding Registry values via command-line](Registry.md#overriding-registry-values-via-command-line)
* [Registry commands](Registry.md#registry-commands)
* [regset](Registry.md#regset)
* [regunset](Registry.md#regunset)
* [regchange](Registry.md#regchange)
* [regshow](Registry.md#regshow)
* [regfind](Registry.md#regfind)
* [regsetmeta](Registry.md#regsetmeta)
* [regunsetmeta](Registry.md#regunsetmeta)
* [Editing Registry file](Registry.md#editing-registry-file)
* [Metadata list](Registry.md#metadata-list)
* [List of known Registry items](Registry.md#list-of-known-registry-items)
* [Channel-specific Registry items](Registry.md#channel-specific-registry-items)
<!-- md-toc-end -->
<!-- md-toc-begin -->
* [Applets](Applets.md#applets)
* [About](Applets.md#about)
* [Creating applets](Applets.md#creating-applets)
* [Documentation for built-in applets](Applets.md#documentation-for-built-in-applets)
* [cc](Applets.md#cc)
* [Usage](Applets.md#usage)
* [Supported Languages](Applets.md#supported-languages)
* [Default Language](Applets.md#default-language)
* [Disallowed system calls](Applets.md#disallowed-system-calls)
* [Program termination with no output](Applets.md#program-termination-with-no-output)
* [Abnormal program termination](Applets.md#abnormal-program-termination)
* [C and C++ Functionality](Applets.md#c-and-c-functionality)
* [Using the preprocessor](Applets.md#using-the-preprocessor)
* [main() Function Unnecessary](Applets.md#main-function-unnecessary)
* [Embedding Newlines](Applets.md#embedding-newlines)
* [Printing in binary/base2](Applets.md#printing-in-binarybase2)
* [Using the GDB debugger](Applets.md#using-the-gdb-debugger)
* [Interactive Editing](Applets.md#interactive-editing)
* [Some Examples](Applets.md#some-examples)
* [english](Applets.md#english)
* [expand](Applets.md#expand)
* [prec](Applets.md#prec)
* [paren](Applets.md#paren)
* [faq](Applets.md#faq)
* [cfact](Applets.md#cfact)
* [cjeopardy](Applets.md#cjeopardy)
* [hint](Applets.md#hint)
* [what](Applets.md#what)
* [w](Applets.md#w)
* [filter](Applets.md#filter)
* [score](Applets.md#score)
* [rank](Applets.md#rank)
* [reset](Applets.md#reset)
* [qstats](Applets.md#qstats)
* [qshow](Applets.md#qshow)
* [c99](Applets.md#c99)
* [c11](Applets.md#c11)
* [c23](Applets.md#c23)
* [man](Applets.md#man)
* [google](Applets.md#google)
* [define](Applets.md#define)
* [dict](Applets.md#dict)
* [foldoc](Applets.md#foldoc)
* [vera](Applets.md#vera)
* [udict](Applets.md#udict)
* [wdict](Applets.md#wdict)
* [acronym](Applets.md#acronym)
* [math](Applets.md#math)
* [calc](Applets.md#calc)
* [qalc](Applets.md#qalc)
* [compliment](Applets.md#compliment)
* [insult](Applets.md#insult)
* [excuse](Applets.md#excuse)
* [horoscope](Applets.md#horoscope)
* [quote](Applets.md#quote)
2020-01-12 19:30:51 +01:00
<!-- md-toc-end -->
<!-- md-toc-begin -->
2020-01-13 07:25:26 +01:00
* [Anti-Abuse](AntiAbuse.md#anti-abuse)
* [Flood control](AntiAbuse.md#flood-control)
* [Message flood](AntiAbuse.md#message-flood)
* [Join flood](AntiAbuse.md#join-flood)
* [Enter key abuse](AntiAbuse.md#enter-key-abuse)
* [Nick flood](AntiAbuse.md#nick-flood)
* [Anti-away/Nick-control](AntiAbuse.md#anti-awaynick-control)
* [Anti-auto-rejoin control](AntiAbuse.md#anti-auto-rejoin-control)
* [Opping/Deopping](AntiAbuse.md#oppingdeopping)
2023-05-07 22:22:37 +02:00
* [Setting up automatic join-flood enforcement](AntiAbuse.md#setting-up-automatic-join-flood-enforcement)
2020-01-12 19:30:51 +01:00
<!-- md-toc-end -->
<!-- md-toc-begin -->
* [Virtual Machine](VirtualMachine.md#virtual-machine)
2024-04-04 21:23:45 +02:00
* [Installation methods](VirtualMachine.md#installation-methods)
* [libvirt and QEMU](VirtualMachine.md#libvirt-and-qemu)
* [Vagrant](VirtualMachine.md#vagrant)
2024-04-04 21:23:45 +02:00
* [Host vs guest](VirtualMachine.md#host-vs-guest)
* [Environment variables](VirtualMachine.md#environment-variables)
* [Initial virtual machine set-up](VirtualMachine.md#initial-virtual-machine-set-up)
* [Prerequisites](VirtualMachine.md#prerequisites)
* [CPU Virtualization Technology](VirtualMachine.md#cpu-virtualization-technology)
* [KVM](VirtualMachine.md#kvm)
* [libvirt and QEMU](VirtualMachine.md#libvirt-and-qemu-1)
2024-04-04 21:23:45 +02:00
* [Make a pbot-vm user or directory](VirtualMachine.md#make-a-pbot-vm-user-or-directory)
* [Add libvirt group to your user](VirtualMachine.md#add-libvirt-group-to-your-user)
* [Download Linux ISO](VirtualMachine.md#download-linux-iso)
* [Create a new virtual machine](VirtualMachine.md#create-a-new-virtual-machine)
* [libvirt](VirtualMachine.md#libvirt)
* [QEMU](VirtualMachine.md#qemu)
* [Install Linux in the virtual machine](VirtualMachine.md#install-linux-in-the-virtual-machine)
* [Set up serial ports](VirtualMachine.md#set-up-serial-ports)
* [libvirt](VirtualMachine.md#libvirt-1)
* [QEMU](VirtualMachine.md#qemu-1)
* [Set up virtio-vsock](VirtualMachine.md#set-up-virtio-vsock)
* [libvirt](VirtualMachine.md#libvirt-2)
* [QEMU](VirtualMachine.md#qemu-2)
* [Reboot virtual machine](VirtualMachine.md#reboot-virtual-machine)
* [Install PBot VM Guest](VirtualMachine.md#install-pbot-vm-guest)
* [Install software](VirtualMachine.md#install-software)
* [Start PBot VM Guest](VirtualMachine.md#start-pbot-vm-guest)
* [Test PBot VM Guest](VirtualMachine.md#test-pbot-vm-guest)
* [Save initial state](VirtualMachine.md#save-initial-state)
* [Install host packages](VirtualMachine.md#install-host-packages)
* [Initial virtual machine set-up complete](VirtualMachine.md#initial-virtual-machine-set-up-complete)
* [Start PBot VM Host](VirtualMachine.md#start-pbot-vm-host)
* [Test PBot](VirtualMachine.md#test-pbot)
* [Starting PBot VM again](VirtualMachine.md#starting-pbot-vm-again)
* [Adding additional VMs](VirtualMachine.md#adding-additional-vms)
* [QEMU command from libvirt](VirtualMachine.md#qemu-command-from-libvirt)
2020-01-12 19:30:51 +01:00
<!-- md-toc-end -->
2020-01-28 08:44:21 +01:00
<!-- md-toc-begin -->
* [Frequently Asked Questions](FAQ.md#frequently-asked-questions)
2021-09-06 21:45:02 +02:00
* [When I type `!version` it say "new version available"?](FAQ.md#when-i-type-version-it-say-new-version-available)
* [How do I change the bot trigger?](FAQ.md#how-do-i-change-the-bot-trigger)
* [How do I whitelist a user?](FAQ.md#how-do-i-whitelist-a-user)
* [How do I change how the bot outputs multi-line messages?](FAQ.md#how-do-i-change-how-the-bot-outputs-multi-line-messages)
* [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)
2023-05-07 22:22:37 +02:00
* [How do I set up automatic join-flood enforcement?](FAQ.md#how-do-i-set-up-automatic-join-flood-enforcement)
2020-01-28 08:44:21 +01:00
<!-- md-toc-end -->