Mercurial > irccd
comparison man/irccd.1 @ 864:0028704ab284
doc: improve irccd.1 wording
author | David Demelier <markand@malikania.fr> |
---|---|
date | Thu, 25 Jul 2019 21:16:00 +0000 |
parents | 00a4720c4874 |
children | f0d6bc79aa32 |
comparison
equal
deleted
inserted
replaced
863:659be263703e | 864:0028704ab284 |
---|---|
20 .Sh NAME | 20 .Sh NAME |
21 .Nm irccd | 21 .Nm irccd |
22 .Nd IRC Client Daemon | 22 .Nd IRC Client Daemon |
23 .\" SYNOPSIS | 23 .\" SYNOPSIS |
24 .Sh SYNOPSIS | 24 .Sh SYNOPSIS |
25 .Nm irccd | 25 .Nm |
26 .Op Fl c Ar file | 26 .Op Fl c Ar file |
27 .Op Fl v | 27 .Op Fl v |
28 .Nm irccd | 28 .Nm |
29 .Ar info | |
30 .Nm | |
29 .Ar version | 31 .Ar version |
30 .\" DESCRIPTION | 32 .\" DESCRIPTION |
31 .Sh DESCRIPTION | 33 .Sh DESCRIPTION |
32 The | 34 The |
33 .Nm | 35 .Nm |
34 program is an IRC bot which connects to one or more severs and | 36 program is an IRC bot which connects to one or more severs and |
35 dispatches events to plugins. | 37 dispatches events to plugins and connected clients. |
36 .Pp | 38 .Pp |
37 The following options are available: | 39 The following options are available: |
38 .Bl -tag -width indent-xxx | 40 .Bl -tag -width indent-xxx |
39 .It Fl c Ar file | 41 .It Fl c Ar file |
40 specify the configuration file. | 42 specify the configuration file. |
41 .It Fl v | 43 .It Fl v |
42 be verbose. | 44 be verbose. |
45 .El | |
46 .Pp | |
47 When ran without arguments, | |
48 .Nm | |
49 will read your configuration file and dispatch IRC events to the plugins and | |
50 connected clients indefinitely. | |
51 .Pp | |
52 Otherwise, the following commands are available: | |
53 .Bl -tag -width 12n | |
54 .It Cm info | |
55 Show in a scriptable manner the options that were selected during irccd's build. | |
56 .It Cm version | |
57 Get the irccd version. if Mercurial was available when building irccd then the | |
58 current revision is bundled in the output. | |
43 .El | 59 .El |
44 .\" PLUGINS | 60 .\" PLUGINS |
45 .Sh PLUGINS | 61 .Sh PLUGINS |
46 The | 62 The |
47 .Nm | 63 .Nm |
193 .Sh DIRECTORIES | 209 .Sh DIRECTORIES |
194 .Nm | 210 .Nm |
195 uses different types of paths depending on the context. | 211 uses different types of paths depending on the context. |
196 .Pp | 212 .Pp |
197 Paths prefixed by (W) means they are only used on Windows, others prefixed by | 213 Paths prefixed by (W) means they are only used on Windows, others prefixed by |
198 (U) means they are used on UNIX systems | 214 (U) means they are used on UNIX systems. |
199 .Pp | 215 .Pp |
200 .Ss Configuration | 216 .Ss Configuration |
201 The following directories are searched in the specified order for configuration | 217 The following directories are searched in the specified order for configuration |
202 files. For example, the files | 218 files. For example, the files |
203 .Pa irccd.conf | 219 .Pa irccd.conf |