pbot/doc/README.md

PBot Documentation

Table of Contents

• QuickStart
  • Installation
    • Installing Perl
    • Installing CPAN modules
    • Installing PBot
      • git (recommended)
      • Download zip archive
  • Initial Setup
    • Clone data-directory
    • Configuration
      • Recommended settings for IRC Networks
  • Starting PBot
    • Usage
      • Overriding directories
      • Overriding registry
    • First-time start-up
      • Using default Freenode settings
      • Using custom settings
    • Regular start-up
  • Additional configuration
    • Creating your bot owner admin account
    • Adding other users and admins
    • Adding channels
  • Further Reading
    • Commands
    • Factoids
    • Plugins
    • Modules
• Commands
  • Command interpreter
    • Command invocation
    • Addressing output to users
    • Inline invocation
    • Chaining
    • Piping
    • Substitution
    • Variables
    • Selectors
    • Background processing
  • Types of commands
    • Built-in commands
      • Creating new built-in commands
      • Plugins
      • Functions
    • Factoids
      • Code Factoids
      • Modules
  • Commands documented here
    • version
    • help
    • uptime
    • my
    • date
    • weather
  • Commands documented elsewhere
    • Administrative commands
      • Logging in and out of PBot
      • User management commands
      • Channel management commands
      • Module management commands
      • Plugin management commands
      • Command metadata
      • Event queue
      • Process management
      • Registry commands
      • Miscellaneous admin commands
    • Factoid commands
      • Adding/removing factoids
      • Displaying factoids
      • Editing factoids
      • Factoid metadata
      • Information about factoids
• Administrative
  • Logging in and out
    • login
    • logout
  • User management commands
    • useradd
    • userdel
    • userset
    • userunset
      • User metadata list
    • Listing users
  • User capabilities
    • Introduction
    • cap
      • Listing capabilities
      • Grouping capabilities
      • Giving capabilities to users
      • Checking user capabilities
      • Listing users who have a capability
      • User capabilities list
  • Channel management commands
    • join
    • part
    • chanadd
    • chanrem
    • chanset
    • chanunset
    • chanlist
      • Channel metadata list
    • ignore
    • unignore
    • blacklist
    • op
    • deop
    • voice
    • devoice
    • mode
    • ban/mute
    • unban/unmute
    • invite
    • kick
  • Module management commands
    • load
    • unload
    • Listing modules
  • Plugin management commands
    • plug
    • unplug
    • replug
    • pluglist
  • Command metadata commands
    • cmdset
    • cmdunset
    • Command metadata list
  • Event queue management
    • eventqueue
  • Process management commands
    • ps
    • kill
  • Miscellaneous commands
    • export
    • refresh
    • reload
    • sl
    • die
• Factoids
  • About
  • Special commands
    • /say
    • /me
    • /call
    • /msg
    • /code
      • Supported languages
      • Special variables
      • testargs example
      • Setting a usage message
      • poll/vote example
      • SpongeBob Mock meme example
      • Using command-piping
      • Improving SpongeBob Mock meme
      • Formatting and editing lengthy Code Factoids
  • Special variables
    • $args
    • $arg[n]
    • $arg[n:m]
    • $arglen
    • $channel
    • $nick
    • $randomnick
    • $0
  • List variables
    • Expansion modifiers
  • action_with_args
  • add_nick
  • Channel namespaces
  • Adding/removing factoids
    • factadd
    • factrem
    • forget
    • factalias
  • Displaying factoids
    • fact
    • factshow
  • Editing factoids
    • factchange
    • factmove
    • factundo
    • factredo
  • Factoid metadata
    • factset
    • factunset
    • Factoid metadata List
  • Information about factoids
    • factfind
    • factinfo
    • factlog
    • factset
    • count
    • histogram
    • top20
• Registry
  • About
    • Types of values
    • Creating array values
    • Overriding Registry values per-channel
  • Overriding Registry values via command-line
  • Registry commands
    • regset
    • regunset
    • regchange
    • regshow
    • regfind
    • regsetmeta
    • regunsetmeta
  • Editing Registry file
  • Metadata list
  • List of known Registry items
    • Channel-specific Registry items
• Modules
  • About
  • Creating modules
  • Documentation for built-in modules
    • cc
      • Usage
      • Supported Languages
      • Default Language
      • Disallowed system calls
      • Program termination with no output
      • Abnormal program termination
      • C and C++ Functionality
      • Using the preprocessor
      • main() Function Unnecessary
      • Embedding Newlines
      • Printing in binary/base2
      • Using the GDB debugger
      • Interactive Editing
      • Some Examples
    • english
    • expand
    • prec
    • paren
    • faq
    • cfact
    • cjeopardy
      • hint
      • what
      • w
      • filter
      • score
      • rank
      • reset
      • qstats
      • qshow
    • c99std
    • c11std
    • man
    • google
    • define
    • dict
    • foldoc
    • vera
    • udict
    • wdict
    • acronym
    • math
    • calc
    • qalc
    • compliment
    • insult
    • excuse
    • horoscope
    • quote
• Plugins
  • About
    • PBot Plugins
      • Plang
      • Quotegrabs
• Anti-Abuse
  • Flood control
    • Message flood
    • Join flood
    • Enter key abuse
    • Nick flood
  • Anti-away/Nick-control
  • Anti-auto-rejoin control
  • Opping/Deopping
• Virtual Machine
  • About
  • Creating a new virtual machine
  • Configuring the virtual machine
  • Installing Linux in the virtual machine
  • Configuring Linux for PBot Communication
  • Hardening the PBot virtual machine
• Frequently Asked Questions
  • How do I change my password?
  • How do I make PBot remember my date timezone?
  • How do I make PBot remember my weather location?
  • How do I change the bot trigger?
  • How do I whitelist a user?