Mercurial > irccd

comparison plugins/auth/auth.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-AUTH 7
18 .Os
19 .\" NAME
20 .Sh NAME
21 .Nm auth
22 .Nd irccd auth plugin
23 .\" DESCRIPTION
24 .Sh DESCRIPTION
25 The plugin
26 .Nm
27 provides generic authentication to the most popular services.
28 .Pp
29 For the moment,
30 .Nm auth
31 supports the following backends:
32 .Bl -tag -width 12n -offset Ds
33 .It nickserv
34 the NickServ service, using /msg NickServ identify user pass
35 .It quakenet
36 the quakenet.org service, using /msg Q@CServe.quakenet.org AUTH user pass
37 .\" INSTALLATION
38 .Sh INSTALLATION
39 The plugin
40 .Nm
41 is distributed with irccd. To enable it add the following to your plugins
42 section:
43 .Pp
44 .Bd -literal
45 [plugins]
46 auth = ""
47 .Ed
48 .\" USAGE
49 .Sh USAGE
50 You must configure the file to enable authentication.
51 .\" CONFIGURATION
52 .Sh CONFIGURATION
53 In your irccd.conf file, add the
54 .Va [plugin.auth]
55 section and fill with the following parameters:
56 .Bl -tag -width 24n
57 .It Va server.type No (string)
58 must be
59 .Em nickserv
60 or
61 .Em quakenet .
62 .It Va server.password No (string)
63 the password.
64 .It Va server.username No (string)
65 the username to use. Required for quakenet, optional for nickserv.
66 .El
67 .Pp
68 Note: you must replace server with one defined in a
69 .Va [server]
70 section.
71 .Pp
72 Example of configuration:
73 .Bd -literal -offset Ds
74 [plugin.auth]
75 freenode.type = "nickserv"
76 freenode.password = "mysecretpassword"
77 freenode.username = "jeanfrancois"
78
79 wanadoo.type = "nickserv"
80 wanadoo.password = "wanadoo is dead"
81 .Ed