Mercurial > irccd

annotate plugins/logger/logger.md @ 577:3d0dbc0bee7d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Irccd: update references to onChannel(Mode|Notice), onMode - Update hangman, logger and their tests, - Update dynlib_plugin and js_plugin.
author David Demelier <markand@malikania.fr>
date Thu, 30 Nov 2017 13:19:38 +0100
parents 9bc2da03dbe1
children ebe561276c33
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 ---
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 title: "Logger plugin"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
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
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 ---
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
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
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
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
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 ## Installation
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
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
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
23
577
3d0dbc0bee7d Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents: 413
diff changeset
24 ```ini
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 [plugins]
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 logger = ""
577
3d0dbc0bee7d Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents: 413
diff changeset
27 ```
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
28
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 ## Usage
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
30
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 There is nothing to do, except configuring it.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
32
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 ## Configuration
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
34
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 The following options are available under the `[plugin.logger]` section:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
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
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 - **join**: (string) format when someone joins a channel,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 - **kick**: (string) format when someone has been kicked,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 - **me**: (string) format for emote actions,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 - **message**: (string) format for channel messages,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 - **mode**: (string) format for user mode change,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 - **notice**: (string) format on private notices,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 - **part**: (string) format when someone leaves a channel,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 - **topic**: (string) format when a topic is changed.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
52
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 ### Keywords supported
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
54
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 The following keywords are supported:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
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
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
67
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
68 Example:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
69
32
b5906772bac0 Plugin logger:
David Demelier <markand@malikania.fr>
parents: 11
diff changeset
70 <div class="panel panel-info">
b5906772bac0 Plugin logger:
David Demelier <markand@malikania.fr>
parents: 11
diff changeset
71 <div class="panel-heading">~/.config/irccd/irccd.conf</div>
b5906772bac0 Plugin logger:
David Demelier <markand@malikania.fr>
parents: 11
diff changeset
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
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
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
b5906772bac0 Plugin logger:
David Demelier <markand@malikania.fr>
parents: 11
diff changeset
80 </div>
b5906772bac0 Plugin logger:
David Demelier <markand@malikania.fr>
parents: 11
diff changeset
81 </div>