Mercurial > irccd

annotate plugins/logger/logger.7 @ 1004:3ea3361f0fc7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
irccd: now track modes
author David Demelier <markand@malikania.fr>
date Tue, 16 Feb 2021 18:37:22 +0100
parents 5e25439fe98d
children cf99df45cb84
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 .\"
913
5e25439fe98d misc: update years
David Demelier <markand@malikania.fr>
parents: 862
diff changeset
2 .\" Copyright (c) 2013-2020 David Demelier <markand@malikania.fr>
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 .\"
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 .\" Permission to use, copy, modify, and/or distribute this software for any
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 .\" purpose with or without fee is hereby granted, provided that the above
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 .\" copyright notice and this permission notice appear in all copies.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 .\"
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 .\"
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 .Dd @IRCCD_MAN_DATE@
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 .Dt IRCCD-PLUGIN-LOGGER 7
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
18 .Os
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 .\" NAME
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 .Sh NAME
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 .Nm logger
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 .Nd irccd logger plugin
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 .\" DESCRIPTION
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 .Sh DESCRIPTION
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 The
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 .Nm
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 plugin may be used to log everything you want. It supports the following events:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 .Bl -bullet -compact
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 .It
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 onJoin.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 .It
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 onKick.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 .It
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 onMe.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 .It
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 onMessage.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 .It
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 onMode.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 .It
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 onNotice.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 .It
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 onPart.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 .It
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 onTopic.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 .\" INSTALLATION
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 .Sh INSTALLATION
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 The plugin
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 .Nm
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 is distributed with irccd. To enable it add the following to your plugins
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 section:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 .Bd -literal
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
54 [plugins]
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 logger = ""
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
56 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
57 .\" USAGE
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
58 .Sh USAGE
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
59 The
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
60 .Nm
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
61 plugin has no direct commands.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
62 .\" CONFIGURATION
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
63 .Sh CONFIGURATION
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
64 The following options are available under the
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
65 .Va [plugin.logger]
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
66 section:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
67 .Bl -tag -width 14n -offset Ds
862
6b65493d97cf plugin logger: rename path configuration to file, closes #1670
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
68 .It Va file No (string)
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
69 The path to the file where to store logs. Keywords:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
70 .Em channel , server , (date) .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
71 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
72 .\" TEMPLATES
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
73 .Sh TEMPLATES
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
74 The
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
75 .Nm
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
76 plugin supports the following templates in
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
77 .Va [templates.logger]
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
78 section:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
79 .Bl -tag -width 14n -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
80 .It Va join
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
81 Format when someone joins a channel.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
82 .It Va kick
847
a23b7b574ed2 irccd: rename [format] section to [templates], closes #1671
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
83 Format when someone has been kicked. Keywords:
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
84 .Em reason , target .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
85 .It Va me
847
a23b7b574ed2 irccd: rename [format] section to [templates], closes #1671
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
86 Format for emote actions. Keywords:
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
87 .Em message .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
88 .It Va message
847
a23b7b574ed2 irccd: rename [format] section to [templates], closes #1671
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
89 Format for channel messages. Keywords:
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
90 .Em message .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
91 .It Va mode
847
a23b7b574ed2 irccd: rename [format] section to [templates], closes #1671
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
92 Format for user mode change. Keywords:
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
93 .Em mode , limit , user , mask .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
94 .It Va notice
847
a23b7b574ed2 irccd: rename [format] section to [templates], closes #1671
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
95 Format on private notices. Keywords:
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
96 .Em message .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
97 .It Va part
847
a23b7b574ed2 irccd: rename [format] section to [templates], closes #1671
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
98 Format when someone leaves a channel. Keywords:
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
99 .Em reason .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
100 .It Va topic
847
a23b7b574ed2 irccd: rename [format] section to [templates], closes #1671
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
101 Format when a topic is changed. Keywords:
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
102 .Em topic .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
103 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
104 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
105 All templates support the following standard keywords:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
106 .Em channel , nickname , origin , server .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
107 .\" EXAMPLES
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
108 .Sh EXAMPLES
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
109 Example of configuration file:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
110 .Bd -literal
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
111 [plugin.logger]
862
6b65493d97cf plugin logger: rename path configuration to file, closes #1670
David Demelier <markand@malikania.fr>
parents: 847
diff changeset
112 file = "/var/log/irccd/#{server}/%y/%m/%d/#{channel}.txt"
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
113
847
a23b7b574ed2 irccd: rename [format] section to [templates], closes #1671
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
114 [templates.logger]
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
115 join = "user #{nickname} joined #{channel}"
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
116 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
117 .\" SEE ALSO
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
118 .Sh SEE ALSO
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
119 .Xr irccd 1 ,
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
120 .Xr irccd-templates 7