Mercurial > irccd
annotate plugins/logger/logger.md @ 479:298cae7487dc
Irccd: use boost::filesystem (fs::mkdir), #594
| author | David Demelier <markand@malikania.fr> |
|---|---|
| date | Thu, 16 Feb 2017 12:52:23 +0100 |
| parents | 9bc2da03dbe1 |
| children | 3d0dbc0bee7d |
| rev | line source |
|---|---|
| 0 | 1 --- |
| 2 title: "Logger plugin" | |
| 3 header: "Logger plugin" | |
|
275
c143682678b9
CMake: improve documentation related to plugins
David Demelier <markand@malikania.fr>
parents:
144
diff
changeset
|
4 guide: yes |
| 0 | 5 --- |
| 6 | |
| 7 The plugin **logger** may be used to log everything you want. It supports the following events: | |
| 8 | |
| 9 - Channel mode, | |
| 10 - Channel notice, | |
| 11 - Join, | |
| 12 - Kick, | |
| 13 - Me, | |
| 14 - Message, | |
| 15 - Mode, | |
| 16 - Notice, | |
| 17 - Part, | |
| 18 - Query, | |
| 19 - Topic. | |
| 20 | |
| 21 ## Installation | |
| 22 | |
| 23 The plugin **logger** is distributed with irccd. To enable it add the following to your `plugins` section: | |
| 24 | |
| 25 ````ini | |
| 26 [plugins] | |
| 27 logger = "" | |
| 28 ```` | |
| 29 | |
| 30 ## Usage | |
| 31 | |
| 32 There is nothing to do, except configuring it. | |
| 33 | |
| 34 ## Configuration | |
| 35 | |
| 36 The following options are available under the `[plugin.logger]` section: | |
| 37 | |
|
144
5ed0c78a6785
Plugin logger: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
38 - **path**: (string) the path to the file where to store logs, |
|
5ed0c78a6785
Plugin logger: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
39 |
|
5ed0c78a6785
Plugin logger: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
40 **Deprecated in irccd 2.1.0:** |
|
5ed0c78a6785
Plugin logger: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
41 |
|
5ed0c78a6785
Plugin logger: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
42 - **format-cmode**: Use `[format.logger] cmode` instead, |
|
5ed0c78a6785
Plugin logger: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
43 - **format-cnotice**: Use `[format.logger] cnotice` instead, |
|
5ed0c78a6785
Plugin logger: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
44 - **format-join**: Use `[format.logger] join` instead, |
|
5ed0c78a6785
Plugin logger: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
45 - **format-kick**: Use `[format.logger] kick` instead, |
|
5ed0c78a6785
Plugin logger: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
46 - **format-me**: Use `[format.logger] me` instead, |
|
5ed0c78a6785
Plugin logger: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
47 - **format-message**: Use `[format.logger] message` instead, |
|
5ed0c78a6785
Plugin logger: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
48 - **format-mode**: Use `[format.logger] mode` instead, |
|
5ed0c78a6785
Plugin logger: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
49 - **format-notice**: Use `[format.logger] notice` instead, |
|
5ed0c78a6785
Plugin logger: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
50 - **format-part**: Use `[format.logger] part` instead, |
|
5ed0c78a6785
Plugin logger: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
51 - **format-query**: Use `[format.logger] query` instead, |
|
5ed0c78a6785
Plugin logger: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
52 - **format-topic**: Use `[format.logger] topic` instead, |
|
5ed0c78a6785
Plugin logger: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
53 |
|
5ed0c78a6785
Plugin logger: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
54 ## Formats |
|
5ed0c78a6785
Plugin logger: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
55 |
|
5ed0c78a6785
Plugin logger: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
56 The **logger** plugin supports the following formats in `[format.logger]` section: |
|
5ed0c78a6785
Plugin logger: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
57 |
| 0 | 58 - **cmode**: (string) format for channel mode change, |
| 59 - **cnotice**: (string) format for channel notices, | |
| 60 - **join**: (string) format when someone joins a channel, | |
| 61 - **kick**: (string) format when someone has been kicked, | |
| 62 - **me**: (string) format for emote actions, | |
| 63 - **message**: (string) format for channel messages, | |
| 64 - **mode**: (string) format for user mode change, | |
| 65 - **notice**: (string) format on private notices, | |
| 66 - **part**: (string) format when someone leaves a channel, | |
| 67 - **query**: (string) format on private messages, | |
| 68 - **topic**: (string) format when a topic is changed. | |
| 69 | |
| 70 ### Keywords supported | |
| 71 | |
| 72 The following keywords are supported: | |
| 73 | |
|
144
5ed0c78a6785
Plugin logger: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
74 | Format | Keywords | Notes | |
|
5ed0c78a6785
Plugin logger: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
75 |-------------|-----------------------------------|---------------------------------| |
|
5ed0c78a6785
Plugin logger: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
76 | (any) | nickname, origin, server, source | source is the channel or nick | |
|
5ed0c78a6785
Plugin logger: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
77 | **cmode** | arg, channel, mode, | the mode and its arguments | |
|
5ed0c78a6785
Plugin logger: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
78 | **cnotice** | channel, message | the message notice | |
|
5ed0c78a6785
Plugin logger: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
79 | **join** | channel | | |
|
5ed0c78a6785
Plugin logger: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
80 | **kick** | channel, reason, target | | |
|
5ed0c78a6785
Plugin logger: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
81 | **me** | channel, message | message is the emote action | |
|
5ed0c78a6785
Plugin logger: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
82 | **message** | channel, message | | |
|
5ed0c78a6785
Plugin logger: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
83 | **mode** | arg, mode | the mode and its arguments | |
|
5ed0c78a6785
Plugin logger: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
84 | **notice** | message | the notice message | |
|
5ed0c78a6785
Plugin logger: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
85 | **part** | channel, reason | | |
|
5ed0c78a6785
Plugin logger: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
86 | **query** | message | | |
|
5ed0c78a6785
Plugin logger: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
87 | **topic** | channel, topic | | |
| 0 | 88 |
| 89 The **source** keyword is specially designed to use a generic path for the path parameter. | |
| 90 | |
| 91 Example: | |
| 92 | |
| 32 | 93 <div class="panel panel-info"> |
| 94 <div class="panel-heading">~/.config/irccd/irccd.conf</div> | |
| 95 <div class="panel-body"> | |
| 0 | 96 ````ini |
| 97 [plugin.logger] | |
|
144
5ed0c78a6785
Plugin logger: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
98 path = "/var/log/irccd/#{server}/%y/%m/%d/#{source}.txt" |
|
5ed0c78a6785
Plugin logger: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
99 |
|
5ed0c78a6785
Plugin logger: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
100 [format.logger] |
|
5ed0c78a6785
Plugin logger: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
101 join = "user #{nickname} joined #{channel}" |
| 0 | 102 ```` |
| 32 | 103 </div> |
| 104 </div> |