Mercurial > irccd

comparison plugins/history/history.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 5e25439fe98d
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-HISTORY 7
18 .Os
19 .\" NAME
20 .Sh NAME
21 .Nm history
22 .Nd irccd history plugin
23 .\" DESCRIPTION
24 .Sh DESCRIPTION
25 The
26 .Nm
27 plugin is used to check when someone has been seen for the last time on a
28 channel. For that purpose, irccd needs to be on that channel forever if
29 possible.
30 .\" INSTALLATION
31 .Sh INSTALLATION
32 The plugin
33 .Nm
34 is distributed with irccd. To enable it add the following to your plugins
35 section:
36 .Pp
37 .Bd -literal
38 [plugins]
39 history = ""
40 .Ed
41 .\" USAGE
42 .Sh USAGE
43 The plugin
44 .Nm history
45 only reacts to the special command. It understands
46 .Ar seen
47 and
48 .Ar said
49 sub commands.
50 .Pp
51 .Bl -bullet -compact
52 .It
53 The sub command
54 .Ar seen
55 tells you when the user has been seen for the last time.
56 .It
57 The sub command
58 .Ar said
59 tells you what the user has said for the last time.
60 .El
61 .Pp
62 Example
63 .Bd -literal -offset Ds
64 markand: !history seen jean
65 irccd: markand, the last time I've seen jean was on 18/01/1989 at 20:55
66 markand: !history said jean
67 irccd: markand, the last thing that jean said was: hello world
68 .Ed
69 .\" CONFIGURATION
70 .Sh CONFIGURATION
71 The following options are available under the
72 .Va [plugin.history]
73 section:
74 .Bl -tag -width 14n -offset Ds
75 .It Va file No (string)
76 path to the JSON file for saving information (Optional. default to cache
77 directory).
78 .El
79 .\" TEMPLATES
80 .Sh TEMPLATES
81 The
82 .Nm
83 plugin supports the following templates in
84 .Va [templates.history]
85 section:
86 .Bl -tag -width 14n -offset Ds
87 .It Va error
88 Template when an internal error occured. Keywords:
89 .It Va seen
90 Template for showing last seen. Keywords:
91 .Em target , (date) .
92 .It Va said
93 Template for showing the last message. Keywords:
94 .Em message , target , (date) .
95 .It Va unknown
96 Template when the user has never been seen. Keywords:
97 .Em target .
98 .It Va usage
99 Template to show the plugin usage.
100 .El
101 .Pp
102 All templates support the following standard keywords:
103 .Em channel , command , nickname , origin , plugin , server .
104 .\" EXAMPLES
105 .Sh EXAMPLES
106 Example of configuration file:
107 .Bd -literal
108 [templates.history]
109 seen = "#{target} has been seen on #{channel} the last time on: %d/%m/%Y %H:%M"
110 .Ed
111 .\" SEE ALSO
112 .Sh SEE ALSO
113 .Xr irccd 1 ,
114 .Xr irccd-templates 7