Mercurial > irccd
comparison plugins/history/history.md @ 0:1158cffe5a5e
Initial import
| author | David Demelier <markand@malikania.fr> |
|---|---|
| date | Mon, 08 Feb 2016 16:43:14 +0100 |
| parents | |
| children | 8384df86e195 |
comparison
equal
deleted
inserted
replaced
| -1:000000000000 | 0:1158cffe5a5e |
|---|---|
| 1 --- | |
| 2 title: "History plugin" | |
| 3 header: "History plugin" | |
| 4 --- | |
| 5 | |
| 6 The plugin **history** is used to check when someone has been seen for the last time on a channel. For that purpose, | |
| 7 irccd needs to be on that channel forever if possible. | |
| 8 | |
| 9 ## Installation | |
| 10 | |
| 11 The plugin **history** is distributed with irccd. To enable it add the following to your `plugins` section: | |
| 12 | |
| 13 ````ini | |
| 14 [plugins] | |
| 15 history = "" | |
| 16 ```` | |
| 17 | |
| 18 ## Usage | |
| 19 | |
| 20 The plugin **history** only reacts to the special command. It understands `seen` and `said` sub commands. | |
| 21 | |
| 22 - The sub command `seen` tells you when the user has been seen for the last time. | |
| 23 - The sub command `said` tells you what the user has said for the last time. | |
| 24 | |
| 25 Example: | |
| 26 | |
| 27 markand: !history seen jean | |
| 28 irccd: markand, the last time I've seen jean was on 18/01/1989 at 20:55 | |
| 29 markand: !history said jean | |
| 30 irccd: markand, the last thing that jean said was: hello world | |
| 31 | |
| 32 ## Configuration | |
| 33 | |
| 34 You can use different formats. | |
| 35 | |
| 36 The following options are available under the `[plugin.history]` section: | |
| 37 | |
| 38 - **path**: (string) path to the JSON file for saving information (Optional, default to cache directory). | |
| 39 - **format-error**: (string) format when an internal error occured, | |
| 40 - **format-seen**: (string) format for showing last seen, | |
| 41 - **format-said**: (string) format for showing the last message, | |
| 42 - **format-unknown**: (string) format when the user has never been seen, | |
| 43 - **format-usage**: (strnig) format to show the plugin usage. | |
| 44 | |
| 45 ### Keywords supported | |
| 46 | |
| 47 The following keywords are supported: | |
| 48 | |
| 49 | Format | Keywords | Notes | | |
| 50 |-------------------------|-----------------------------------|---------------------------------| | |
| 51 | (any) | server, channel, nickname, origin | | | |
| 52 | **path** | server, channel | does not support (any) | | |
| 53 | **format-seen** | target, (date) | target is the specified nick | | |
| 54 | **format-said** | target, message, (date) | | | |
| 55 | **format-unknown** | target | | | |
| 56 | |
| 57 Example: | |
| 58 | |
| 59 ````ini | |
| 60 [plugin.history] | |
| 61 format-seen = "#{target} has been seen on #{channel} the last time on: %d/%m/%Y %H:%M" | |
| 62 ```` |