Mercurial > irccd

comparison plugins/logger/logger.7 @ 845:00a4720c4874

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