Mercurial > irccd

annotate plugins/links/links.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 685b85367c8e
children cf99df45cb84
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
987
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 .\"
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 .\" Copyright (c) 2013-2020 David Demelier <markand@malikania.fr>
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 .\"
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 .\" Permission to use, copy, modify, and/or distribute this software for any
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 .\" purpose with or without fee is hereby granted, provided that the above
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 .\" copyright notice and this permission notice appear in all copies.
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 .\"
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 .\"
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 .Dd @IRCCD_MAN_DATE@
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 .Dt IRCCD-PLUGIN-LINKS 7
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
18 .Os
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 .\" NAME
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 .Sh NAME
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 .Nm links
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 .Nd irccd links plugin
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 .\" DESCRIPTION
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 .Sh DESCRIPTION
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 The
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 .Nm
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 is used to analyze links sent on channels. It will load the web page and extract
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 its title on the same channel.
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 .\" INSTALLATION
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 .Sh INSTALLATION
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 The plugin
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 .Nm
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 is distributed with irccd. To enable it add the following to your plugins
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 section:
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 .Pp
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 .Bd -literal
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 [plugins]
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 links = ""
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 .Ed
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 .\" USAGE
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 .Sh USAGE
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 The plugin will automatically fetch web page titles on message that contains
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 either http://something or https://something.
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 .Pp
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 Example of possible output:
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 .Bd -literal -offset Ds
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 markand: http://example.org
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 irccd: Example Domain
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 .Ed
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 .\" CONFIGURATION
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 .Sh CONFIGURATION
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 The following options are available under the
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 .Va [plugin.links]
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
54 section:
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 .Bl -tag -width 14n -offset Ds
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
56 .It Va timeout No (int)
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
57 Timeout in seconds before dropping a request (default: 30).
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
58 .El
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
59 .\" TEMPLATES
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
60 .Sh TEMPLATES
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
61 The
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
62 .Nm
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
63 plugin supports the following templates in
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
64 .Va [templates.links]
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
65 section:
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
66 .Bl -tag -width 14n -offset Ds
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
67 .It Va info
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
68 Message to be written when title has been retrieved successfully. Keywords:
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
69 .Em channel , nickname , origin , server , title .
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
70 .El
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
71 .\" BUGS
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
72 .Sh BUGS
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
73 As HTML pages are not always correct and not openable with a XML parser,
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
74 .Nm
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
75 actually searches for a <title></title> tag using a regular expression. While
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
76 this is not ideal, it usually works in most situations.
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
77 .Pp
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
78 Only a few set of HTML entity characters are converted to the human readable
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
79 format.
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
80 .\" SEE ALSO
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
81 .Sh SEE ALSO
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
82 .Xr irccd 1 ,
685b85367c8e plugin logger: resurrect
David Demelier <markand@malikania.fr>
parents:
diff changeset
83 .Xr irccd-templates 7