Mercurial > irccd

comparison plugins/logger/logger.7 @ 1019:90eb31112a53

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
man: update plugin documentation
author David Demelier <markand@malikania.fr>
date Sun, 21 Feb 2021 20:42:17 +0100
parents cf99df45cb84
children 3dec26654d06
comparison
equal deleted inserted replaced
1018:cf99df45cb84 1019:90eb31112a53
45 .El 45 .El
46 .\" INSTALLATION 46 .\" INSTALLATION
47 .Sh INSTALLATION 47 .Sh INSTALLATION
48 The plugin 48 The plugin
49 .Nm 49 .Nm
50 is distributed with irccd. To enable it add the following to your plugins 50 is distributed with irccd. To enable it add it into your
51 section: 51 .Xr irccd.conf 5
52 configuration file.
52 .Pp 53 .Pp
53 .Bd -literal 54 .Bd -literal -offset indent
54 [plugins] 55 plugin "logger"
55 logger = ""
56 .Ed 56 .Ed
57 .\" USAGE 57 .\" USAGE
58 .Sh USAGE 58 .Sh USAGE
59 The 59 The
60 .Nm 60 .Nm
61 plugin has no direct commands. 61 plugin has no direct commands.
62 .\" CONFIGURATION 62 .\" CONFIGURATION
63 .Sh CONFIGURATION 63 .Sh CONFIGURATION
64 The following options are available under the 64 The plugin
65 .Va [plugin.logger] 65 .Nm
66 section: 66 support the following configuration properties:
67 .Bl -tag -width 14n -offset Ds 67 .Bl -tag -width "file (string)"
68 .It Va file No (string) 68 .It Va file No (string)
69 The path to the file where to store logs. Keywords: 69 The path to the file where to store logs. Keywords:
70 .Em channel , server , (date) . 70 .Em channel , server , (date) .
71 .El 71 .El
72 .\" TEMPLATES 72 .\" TEMPLATES
73 .Sh TEMPLATES 73 .Sh TEMPLATES
74 The 74 The plugin
75 .Nm 75 .Nm
76 plugin supports the following templates in 76 support the following template properties:
77 .Va [templates.logger] 77 .Bl -tag -width message
78 section:
79 .Bl -tag -width 14n -offset Ds
80 .It Va join 78 .It Va join
81 Format when someone joins a channel. 79 Format when someone joins a channel.
82 .It Va kick 80 .It Va kick
83 Format when someone has been kicked. Keywords: 81 Format when someone has been kicked. Keywords:
84 .Em reason , target . 82 .Em reason , target .
106 .Em channel , nickname , origin , server . 104 .Em channel , nickname , origin , server .
107 .\" EXAMPLES 105 .\" EXAMPLES
108 .Sh EXAMPLES 106 .Sh EXAMPLES
109 Example of configuration file: 107 Example of configuration file:
110 .Bd -literal 108 .Bd -literal
111 [plugin.logger] 109 plugin "logger" {
112 file = "/var/log/irccd/#{server}/%y/%m/%d/#{channel}.txt" 110 config {
111 "file" "/var/log/irccd/#{server}/%y/%m/%d/#{channel}.txt";
112 }
113 113
114 [templates.logger] 114 templates {
115 join = "user #{nickname} joined #{channel}" 115 "join" "user #{nickname} joined #{channel}";
116 }
117 }
116 .Ed 118 .Ed
117 .\" SEE ALSO 119 .\" SEE ALSO
118 .Sh SEE ALSO 120 .Sh SEE ALSO
119 .Xr irccd 1 , 121 .Xr irccd 1 ,
120 .Xr irccd-templates 7 122 .Xr irccd-templates 7