Mercurial > irccd
annotate plugins/logger/logger.md @ 655:cda30ca5bb76
Irccd: style (controller) #782
author | David Demelier <markand@malikania.fr> |
---|---|
date | Tue, 27 Mar 2018 20:30:59 +0200 |
parents | 3d0dbc0bee7d |
children | ebe561276c33 |
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 | |
577
3d0dbc0bee7d
Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents:
413
diff
changeset
|
7 The plugin **logger** may be used to log everything you want. It supports the |
3d0dbc0bee7d
Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents:
413
diff
changeset
|
8 following events: |
0 | 9 |
577
3d0dbc0bee7d
Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents:
413
diff
changeset
|
10 - onJoin, |
3d0dbc0bee7d
Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents:
413
diff
changeset
|
11 - onKick, |
3d0dbc0bee7d
Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents:
413
diff
changeset
|
12 - onMe, |
3d0dbc0bee7d
Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents:
413
diff
changeset
|
13 - onMessage, |
3d0dbc0bee7d
Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents:
413
diff
changeset
|
14 - onMode, |
3d0dbc0bee7d
Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents:
413
diff
changeset
|
15 - onNotice, |
3d0dbc0bee7d
Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents:
413
diff
changeset
|
16 - onPart, |
3d0dbc0bee7d
Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents:
413
diff
changeset
|
17 - onTopic. |
0 | 18 |
19 ## Installation | |
20 | |
577
3d0dbc0bee7d
Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents:
413
diff
changeset
|
21 The plugin **logger** is distributed with irccd. To enable it add the following |
3d0dbc0bee7d
Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents:
413
diff
changeset
|
22 to your `plugins` section: |
0 | 23 |
577
3d0dbc0bee7d
Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents:
413
diff
changeset
|
24 ```ini |
0 | 25 [plugins] |
26 logger = "" | |
577
3d0dbc0bee7d
Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents:
413
diff
changeset
|
27 ``` |
0 | 28 |
29 ## Usage | |
30 | |
31 There is nothing to do, except configuring it. | |
32 | |
33 ## Configuration | |
34 | |
35 The following options are available under the `[plugin.logger]` section: | |
36 | |
144
5ed0c78a6785
Plugin logger: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
37 - **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
|
38 |
5ed0c78a6785
Plugin logger: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
39 ## Formats |
5ed0c78a6785
Plugin logger: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
40 |
577
3d0dbc0bee7d
Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents:
413
diff
changeset
|
41 The **logger** plugin supports the following formats in `[format.logger]` |
3d0dbc0bee7d
Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents:
413
diff
changeset
|
42 section: |
144
5ed0c78a6785
Plugin logger: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
43 |
0 | 44 - **join**: (string) format when someone joins a channel, |
45 - **kick**: (string) format when someone has been kicked, | |
46 - **me**: (string) format for emote actions, | |
47 - **message**: (string) format for channel messages, | |
48 - **mode**: (string) format for user mode change, | |
49 - **notice**: (string) format on private notices, | |
50 - **part**: (string) format when someone leaves a channel, | |
51 - **topic**: (string) format when a topic is changed. | |
52 | |
53 ### Keywords supported | |
54 | |
55 The following keywords are supported: | |
56 | |
577
3d0dbc0bee7d
Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents:
413
diff
changeset
|
57 | Format | Keywords | Notes | |
3d0dbc0bee7d
Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents:
413
diff
changeset
|
58 |-------------|-----------------------------------|-----------------------------| |
3d0dbc0bee7d
Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents:
413
diff
changeset
|
59 | (any) | channel, nickname, origin, server | channel may be a nickname | |
3d0dbc0bee7d
Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents:
413
diff
changeset
|
60 | **kick** | reason, target | | |
3d0dbc0bee7d
Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents:
413
diff
changeset
|
61 | **me** | message | message is the emote action | |
3d0dbc0bee7d
Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents:
413
diff
changeset
|
62 | **message** | message | | |
3d0dbc0bee7d
Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents:
413
diff
changeset
|
63 | **mode** | mode, limit, user, mask | the mode and its arguments | |
3d0dbc0bee7d
Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents:
413
diff
changeset
|
64 | **notice** | message | the notice message | |
3d0dbc0bee7d
Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents:
413
diff
changeset
|
65 | **part** | reason | | |
3d0dbc0bee7d
Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents:
413
diff
changeset
|
66 | **topic** | topic | | |
0 | 67 |
68 Example: | |
69 | |
32 | 70 <div class="panel panel-info"> |
71 <div class="panel-heading">~/.config/irccd/irccd.conf</div> | |
72 <div class="panel-body"> | |
577
3d0dbc0bee7d
Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents:
413
diff
changeset
|
73 ```ini |
0 | 74 [plugin.logger] |
577
3d0dbc0bee7d
Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents:
413
diff
changeset
|
75 path = "/var/log/irccd/#{server}/%y/%m/%d/#{channel}.txt" |
144
5ed0c78a6785
Plugin logger: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
76 |
5ed0c78a6785
Plugin logger: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
77 [format.logger] |
5ed0c78a6785
Plugin logger: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
78 join = "user #{nickname} joined #{channel}" |
577
3d0dbc0bee7d
Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents:
413
diff
changeset
|
79 ``` |
32 | 80 </div> |
81 </div> |