GitHub/pbot

mirror of https://github.com/pragma-/pbot.git synced 2024-11-19 18:39:35 +01:00

Pragmatic Software abdb5adba1 README.md: update TOC

2020-01-26 19:52:37 -08:00

17 KiB

Raw Blame History

PBot Documentation

Table of Contents

QuickStart
Commands
- Command interpreter
- Types of commands
  - Built-in commands
    - Creating new built-in commands
    - Plugins
  - Factoids
    - Code Factoids
    - Modules
- Commands documented here
  - version
  - help
  - uptime
- Commands documented elsewhere
  - Administrative commands
    - Logging in and out of PBot
      - login
      - logout
    - Admin management commands
      - adminadd
      - adminrem
      - adminset
      - adminunset
      - list admins
    - Channel management commands
      - join
      - part
      - chanadd
      - chanrem
      - chanset
      - chanunset
      - chanlist
      - ignore
      - unignore
      - whitelist
      - blacklist
      - op
      - deop
      - voice
      - devoice
      - mode
      - ban/mute
      - unban/unmute
      - invite
      - kick
    - Module management commands
      - load
      - unload
      - list modules
    - Plugin management commands
      - plug
      - unplug
      - replug
      - pluglist
    - Command metadata
      - cmdset
      - cmdunset
    - Registry commands
      - regset
      - regunset
      - regchange
      - regshow
      - regfind
      - regsetmeta
      - regunsetmeta
    - Miscellaneous admin commands
      - export
      - refresh
      - reload
      - sl
      - die
  - Factoid commands
    - Adding/removing factoids
    - Displaying factoids
      - fact
      - factshow
    - Editing factoids
      - factchange
      - factmove
      - factundo
      - factredo
    - Factoid metadata
      - factset
      - factunset
    - Information about factoids
      - factfind
      - factinfo
      - factlog
      - count
      - histogram
      - top20
Administrative
- Logging in and out
  - login
  - logout
- User management commands
- Channel management commands
  - join
  - part
  - chanadd
  - chanrem
  - chanset
  - chanunset
  - chanlist
    - Channel metadata list
  - ignore
  - unignore
  - whitelist
  - blacklist
  - op
  - deop
  - voice
  - devoice
  - mode
  - ban/mute
  - unban/unmute
  - invite
  - kick
- Module management commands
- Plugin management commands
  - plug
  - unplug
  - replug
  - pluglist
- Command metadata commands
- Miscellaneous commands
  - export
  - refresh
  - reload
  - sl
  - die
Factoids
Registry
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
      - print
      - ptype
      - watch
      - trace
      - gdb
    - Interactive Editing
      - copy
      - show
      - diff
      - paste
      - run
      - undo
      - s//
      - replace
      - prepend
      - append
      - remove
    - 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
Quotegrabs
- About
- Commands
  - grab
  - getq
  - rq
  - delq
Anti-Abuse
Virtual Machine