2020-01-12 19:23:32 +01:00
# Quotegrabs
2019-12-24 02:30:57 +01:00
<!-- md - toc - begin -->
2020-01-22 03:24:16 +01:00
* [About ](#about )
* [Commands ](#commands )
* [grab ](#grab )
* [getq ](#getq )
* [rq ](#rq )
* [delq ](#delq )
2019-12-24 02:30:57 +01:00
<!-- md - toc - end -->
2020-01-12 19:23:32 +01:00
## About
PBot can grab user messages and store/recall them for posterity. This document
describes the Quotegrabs plugin.
## Commands
2019-12-24 02:30:57 +01:00
### 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).
2020-01-10 07:16:22 +01:00
You can use the `recall` command to test the arguments before grabbing (please use a private message).
2019-12-24 02:30:57 +01:00
Usage: `grab <nick> [history [channel]] [+ ...]`
where [history] is an optional argument regular expression used to search message contents;
e.g., to grab a message containing the text "pizza", use: grab nick pizza
< bob > Clowns are scary.
2020-01-10 07:16:22 +01:00
< pragma- > !grab bob clowns
2019-12-24 02:30:57 +01:00
< PBot > Quote grabbed: 1: < bob > Clowns are scary.
<!-- -->
< alice > Please put that in the right place.
< bob > That's what she said!
2020-01-10 07:16:22 +01:00
< pragma- > !grab alice place + bob said
2019-12-24 02:30:57 +01:00
< PBot > Quote grabbed 2: < alice > Please put that in the right place. < bob > That's what she said!
<!-- -->
< charlie > I know a funny programming knock-knock joke.
< charlie > Knock knock!
< charlie > Race condition.
< charlie > Who's there?
2020-01-10 07:16:22 +01:00
< pragma- > !grab charlie knock + charlie race + charlie there
2019-12-24 02:30:57 +01:00
< PBot > Quote grabbed 3: < charlie > Knock knock! < charlie > Race condition. < charlie > Who's there?
### getq
Retrieves and displays a specific grabbed quote from the quotegrabs database.
Usage: `getq <quote-id>`
2020-01-10 07:16:22 +01:00
< pragma- > !getq 1
2020-01-10 07:37:41 +01:00
< PBot > 1: grabbed by pragma- in #channel on Wed Dec 31 16:00:00 1969 [50 years and 21 days ago] < bob > Clowns are scary.
2020-01-10 07:16:22 +01:00
2019-12-24 02:30:57 +01:00
### rq
Retrieves and displays a random grabbed quote from the quotegrabs database. You may filter by nick, channel and/or quote text.
Usage: `rq [nick [channel [text]]] [-c,--channel <channel>] [-t,--text <text>]`
### delq
Deletes a specific grabbed quote from the quotegrabs database. You can only delete quotes you have grabbed unless you are logged in as an admin.
Usage: `delq <quote-id>`
