Mercurial > irccd

comparison plugins/links/links.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-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
33 is distributed with irccd. To enable it add the following to your plugins
34 section:
35 .Pp
36 .Bd -literal
37 [plugins]
38 links = ""
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 .\" CONFIGURATION
51 .Sh CONFIGURATION
52 The following options are available under the
53 .Va [plugin.links]
54 section:
55 .Bl -tag -width 14n -offset Ds
56 .It Va timeout No (int)
57 Timeout in seconds before dropping a request (default: 30).
58 .El
59 .\" TEMPLATES
60 .Sh TEMPLATES
61 The
62 .Nm
63 plugin supports the following templates in
64 .Va [templates.links]
65 section:
66 .Bl -tag -width 14n -offset Ds
67 .It Va info
68 Message to be written when title has been retrieved successfully. Keywords:
69 .Em channel , nickname , origin , server , title .
70 .El
71 .\" BUGS
72 .Sh BUGS
73 As HTML pages are not always correct and not openable with a XML parser,
74 .Nm
75 actually searches for a <title></title> tag using a regular expression. While
76 this is not ideal, it usually works in most situations.
77 .Pp
78 Only a few set of HTML entity characters are converted to the human readable
79 format.
80 .\" SEE ALSO
81 .Sh SEE ALSO
82 .Xr irccd 1 ,
83 .Xr irccd-templates 7