Mercurial > irccd
annotate plugins/links/links.7 @ 1091:52be05336310
irccdctl: misc cleanups
author | David Demelier <markand@malikania.fr> |
---|---|
date | Wed, 21 Jul 2021 16:06:36 +0200 |
parents | 3dec26654d06 |
children | f06e9761cc90 |
rev | line source |
---|---|
987 | 1 .\" |
1018
cf99df45cb84
misc: update copyright years
David Demelier <markand@malikania.fr>
parents:
987
diff
changeset
|
2 .\" Copyright (c) 2013-2021 David Demelier <markand@malikania.fr> |
987 | 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-LINKS 7 | |
18 .Os | |
19 .\" NAME | |
20 .Sh NAME | |
21 .Nm links | |
22 .Nd irccd links plugin | |
23 .\" DESCRIPTION | |
24 .Sh DESCRIPTION | |
25 The | |
26 .Nm | |
27 is used to analyze links sent on channels. It will load the web page and extract | |
28 its title on the same channel. | |
29 .\" INSTALLATION | |
30 .Sh INSTALLATION | |
31 The plugin | |
32 .Nm | |
1019
90eb31112a53
man: update plugin documentation
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
33 is distributed with irccd. To enable it add it into your |
90eb31112a53
man: update plugin documentation
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
34 .Xr irccd.conf 5 |
90eb31112a53
man: update plugin documentation
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
35 configuration file. |
987 | 36 .Pp |
1019
90eb31112a53
man: update plugin documentation
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
37 .Bd -literal -offset indent |
90eb31112a53
man: update plugin documentation
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
38 plugin "links" |
987 | 39 .Ed |
40 .\" USAGE | |
41 .Sh USAGE | |
42 The plugin will automatically fetch web page titles on message that contains | |
43 either http://something or https://something. | |
44 .Pp | |
45 Example of possible output: | |
46 .Bd -literal -offset Ds | |
47 markand: http://example.org | |
48 irccd: Example Domain | |
49 .Ed | |
50 .\" TEMPLATES | |
51 .Sh TEMPLATES | |
1019
90eb31112a53
man: update plugin documentation
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
52 The plugin |
987 | 53 .Nm |
1020 | 54 supports the following template properties: |
1019
90eb31112a53
man: update plugin documentation
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
55 .Bl -tag -width info |
987 | 56 .It Va info |
57 Message to be written when title has been retrieved successfully. Keywords: | |
58 .Em channel , nickname , origin , server , title . | |
59 .El | |
60 .\" BUGS | |
61 .Sh BUGS | |
62 As HTML pages are not always correct and not openable with a XML parser, | |
63 .Nm | |
64 actually searches for a <title></title> tag using a regular expression. While | |
65 this is not ideal, it usually works in most situations. | |
66 .Pp | |
67 Only a few set of HTML entity characters are converted to the human readable | |
68 format. | |
69 .\" SEE ALSO | |
70 .Sh SEE ALSO | |
71 .Xr irccd 1 , | |
72 .Xr irccd-templates 7 |