Mercurial > irccd

comparison man/irccd-test.1 @ 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-TEST 1
18 .Os
19 .\" NAME
20 .Sh NAME
21 .Nm irccd-test
22 .Nd irccd plugin tester
23 .\" SYNOPSIS
24 .Sh SYNOPSIS
25 .Nm irccd-test
26 .Op Fl c Ar config
27 .Ar id|path
28 .\" DESCRIPTION
29 .Sh DESCRIPTION
30 The
31 .Nm irccd-test
32 program is a simple utility to test plugins on the command line.
33 .Pp
34 You can test a global plugin by just specifying plugin's
35 .Ar id
36 or using a full filesystem
37 .Ar path .
38 .Pp
39 It opens a prompt that waits for user input, each line consist of a specific
40 plugin event. These are mostly the same as the Javascript API offers.
41 .Pp
42 If compiled with libedit library, the prompt offers basic completion for the
43 plugin events.
44 .Pp
45 When a event requires a server, a fake debugging server is created if it does
46 not exists already. That fake server simply prints every command on the command
47 line instead of sending them through IRC.
48 .\" COMMANDS
49 .Sh COMMANDS
50 The following commands are allowed as input:
51 .Bl -bullet -compact
52 .It
53 .Cm onCommand
54 .Ar server origin channel message
55 .It
56 .Cm onConnect
57 .Ar server
58 .It
59 .Cm onInvite
60 .Ar server origin channel target
61 .It
62 .Cm onJoin
63 .Ar server origin channel
64 .It
65 .Cm onKick
66 .Ar server origin channel reason
67 .It
68 .Cm onLoad
69 .It
70 .Cm onMe
71 .Ar server origin channel message
72 .It
73 .Cm onMessage
74 .Ar server origin channel message
75 .It
76 .Cm onMode
77 .Ar server origin channel mode limit user mask
78 .It
79 .Cm onNames
80 .Ar server channel nick1 nick2 nickN
81 .It
82 .Cm onNick
83 .Ar server origin nickname
84 .It
85 .Cm onNotice
86 .Ar server origin channel nickname
87 .It
88 .Cm onPart
89 .Ar server origin channel reason
90 .It
91 .Cm onReload
92 .It
93 .Cm onTopic
94 .Ar server origin channel topic
95 .It
96 .Cm onUnload
97 .It
98 .Cm onWhois
99 .Ar server nick user host realname chan1 chan2 chanN
100 .El
101 .\" EXAMPLES
102 .Sh EXAMPLES
103 Example with a local plugin:
104 .Bd -literal
105 $ irccd-test test.js
106 > onLoad
107 > onMessage localhost francis #general Bonjour
108 .Ed
109 .Pp
110 Example with a global plugin:
111 .Bd -literal
112 $ irccd-test hangman
113 > onLoad
114 > onCommand localhost francis #general
115 .Ed
116 .\" SEE ALSO
117 .Sh SEE ALSO
118 .Xr irccd 1