|
0
|
1 .\" |
|
|
2 .\" Copyright (c) 2013-2016 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 @MONTH@ @DAY@, @YEAR@ |
|
|
17 .Dt IRCCD 1 |
|
|
18 .Os |
|
|
19 .Sh NAME |
|
|
20 .Nm irccd |
|
|
21 .Nd an IRC client daemon |
|
|
22 .Sh SYNOPSIS |
|
|
23 .Nm |
|
|
24 .Op Fl f |
|
|
25 .Op Fl v |
|
|
26 .Op Fl c Ar config |
|
|
27 .Sh DESCRIPTION |
|
|
28 The irccd program aims to provide an IRC client that acts as a daemon. |
|
|
29 .Pp |
|
|
30 The features are listed below: |
|
|
31 .Bl -bullet |
|
|
32 .It |
|
|
33 Connect to one or more servers, |
|
|
34 .It |
|
|
35 Use different identities for each servers, |
|
|
36 .It |
|
|
37 Manageable by UNIX or Internet sockets (both TCP and UDP), |
|
|
38 .It |
|
|
39 Highly extensible with Lua plugins, |
|
|
40 .El |
|
|
41 .Pp |
|
|
42 The application run as daemon and wait for events in both IRC servers |
|
|
43 or from the irccdctl(1) utility. |
|
|
44 .Pp |
|
|
45 For instance, when IRC events happen, it calls Lua functions from plugins to |
|
|
46 execute specific actions. Example: someone join the channel, the |
|
|
47 .Nm irccd |
|
|
48 daemon will notify all plugins that a specific user joined. |
|
|
49 .Pp |
|
|
50 But it is also possible to use irccdctl(1) to control |
|
|
51 .Nm irccd . |
|
|
52 For instance, you may want at any time to change the nick of the irccd daemon, |
|
|
53 is it possible with one command. |
|
|
54 .Pp |
|
|
55 The following options are available: |
|
|
56 .Bl -tag -width indent |
|
|
57 .It Fl f |
|
|
58 Do not run as a daemon. |
|
|
59 .It Fl c Ar config |
|
|
60 A path to a config file. |
|
|
61 .It Fl v |
|
|
62 Be more verbose. |
|
|
63 .El |
|
|
64 .\" SEE ALSO |
|
|
65 .Sh SEE ALSO |
|
|
66 .Xr irccdctl 1 , |
|
|
67 .Xr irccd.conf 5 |
|
|
68 .\" AUTHORS |
|
|
69 .Sh AUTHORS |
|
|
70 irccd was written by David Demelier <markand@malikania.fr> |
