comparison plugins/logger/logger.md @ 32:b5906772bac0

Plugin logger: - Use file paramater (like hangman), - Update documentation.
author David Demelier <markand@malikania.fr>
date Mon, 22 Feb 2016 13:29:31 +0100
parents 64f05a1feade
children 131551c901ae
comparison
equal deleted inserted replaced
31:50b7b5d287e8 32:b5906772bac0
34 34
35 The plugin **logger** can be configured to format logs and to use different log path. 35 The plugin **logger** can be configured to format logs and to use different log path.
36 36
37 The following options are available under the `[plugin.logger]` section: 37 The following options are available under the `[plugin.logger]` section:
38 38
39 - **path**: (string) the path to the file where to store logs, 39 - **file**: (string) the path to the file where to store logs,
40 - **cmode**: (string) format for channel mode change, 40 - **cmode**: (string) format for channel mode change,
41 - **cnotice**: (string) format for channel notices, 41 - **cnotice**: (string) format for channel notices,
42 - **join**: (string) format when someone joins a channel, 42 - **join**: (string) format when someone joins a channel,
43 - **kick**: (string) format when someone has been kicked, 43 - **kick**: (string) format when someone has been kicked,
44 - **me**: (string) format for emote actions, 44 - **me**: (string) format for emote actions,
70 70
71 The **source** keyword is specially designed to use a generic path for the path parameter. 71 The **source** keyword is specially designed to use a generic path for the path parameter.
72 72
73 Example: 73 Example:
74 74
75 <div class="panel panel-info">
76 <div class="panel-heading">~/.config/irccd/irccd.conf</div>
77 <div class="panel-body">
75 ````ini 78 ````ini
76 [plugin.logger] 79 [plugin.logger]
77 path = "/var/logs/irccd/#{server}/%y/%m/%d/#{source}.txt" 80 file = "/var/log/irccd/#{server}/%y/%m/%d/#{source}.txt"
78 format-join = "user #{nickname} joined #{channel}" 81 format-join = "user #{nickname} joined #{channel}"
79 ```` 82 ````
83 </div>
84 </div>