Mercurial > irccd

comparison plugins/history/history.md @ 31:50b7b5d287e8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Plugin history: - Use file paramater (like hangman), - Update documentation.
author David Demelier <markand@malikania.fr>
date Mon, 22 Feb 2016 13:25:31 +0100
parents 8384df86e195
children aa205621d7d6
comparison
equal deleted inserted replaced
30:1ea775153cdc 31:50b7b5d287e8
35 35
36 You can use different formats. 36 You can use different formats.
37 37
38 The following options are available under the `[plugin.history]` section: 38 The following options are available under the `[plugin.history]` section:
39 39
40 - **path**: (string) path to the JSON file for saving information (Optional, default to cache directory). 40 - **file**: (string) path to the JSON file for saving information (Optional, default to cache directory).
41 - **format-error**: (string) format when an internal error occured, 41 - **format-error**: (string) format when an internal error occured,
42 - **format-seen**: (string) format for showing last seen, 42 - **format-seen**: (string) format for showing last seen,
43 - **format-said**: (string) format for showing the last message, 43 - **format-said**: (string) format for showing the last message,
44 - **format-unknown**: (string) format when the user has never been seen, 44 - **format-unknown**: (string) format when the user has never been seen,
45 - **format-usage**: (strnig) format to show the plugin usage. 45 - **format-usage**: (strnig) format to show the plugin usage.
46
47 <div class="panel panel-warning">
48 <div class="panel-heading">If you don't want to specify the **file** parameter, irccd will try to use the plugin cache
49 path, you must create it.</div>
50 <div class="panel-body">
51 ````nohighlight
52 $ mkdir -p ~/.cache/irccd/plugin/history
53 ````
54 </div>
55 </div>
46 56
47 ### Keywords supported 57 ### Keywords supported
48 58
49 The following keywords are supported: 59 The following keywords are supported:
50 60
51 | Format | Keywords | Notes | 61 | Format | Keywords | Notes |
52 |-------------------------|-----------------------------------|---------------------------------| 62 |-------------------------|-----------------------------------|---------------------------------|
53 | (any) | server, channel, nickname, origin | | 63 | (any) | server, channel, nickname, origin | |
54 | **path** | server, channel | does not support (any) | 64 | **file** | server, channel | does not support (any) |
55 | **format-seen** | target, (date) | target is the specified nick | 65 | **format-seen** | target, (date) | target is the specified nick |
56 | **format-said** | target, message, (date) | | 66 | **format-said** | target, message, (date) | |
57 | **format-unknown** | target | | 67 | **format-unknown** | target | |
58 68
59 Example: 69 Example:
60 70
71 <div class="panel panel-info">
72 <div class="panel-heading">~/.config/irccd/irccd.conf</div>
73 <div class="panel-body">
61 ````ini 74 ````ini
62 [plugin.history] 75 [plugin.history]
63 format-seen = "#{target} has been seen on #{channel} the last time on: %d/%m/%Y %H:%M" 76 format-seen = "#{target} has been seen on #{channel} the last time on: %d/%m/%Y %H:%M"
64 ```` 77 ````
78 </div>
79 </div>