Mercurial > irccd

annotate doc/html/guide/07-socket/02-commands.md @ 203:c26754e419c4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Irccd: rename RemoteCommand to Command
author David Demelier <markand@malikania.fr>
date Thu, 09 Jun 2016 13:50:55 +0200
parents 1158cffe5a5e
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 ## Commands
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
2
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 The following commands are available. Please note that a lot of commands require a server as the first argument, it’s
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 one of defined in the **irccd.conf** file in the server section.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
5
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 ### server-cnotice
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
7
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 Send a message notice on a channel.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
9
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 #### Properties
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
11
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 - **command**: (string) "server-cnotice",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 - **server**: (string) the server unique id,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 - **channel**: (string) the channel name,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 - **message**: (string) the notice message.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
16
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 #### Example
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 ````json
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 "command": "server-cnotice",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 "server": "myserver",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 "channel": "#staff",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 "message": "please be quiet"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 }
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
27
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 ### server-connect
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
29
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 Connect to a server.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
31
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 #### Properties
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
33
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 - **command**: (string) "server-connect",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 - **name**: (string) the server unique id,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 - **host**: (string) the host address,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 - **port**: (int) the port number (Optional, default: 6667),
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 - **ssl**: (bool) use SSL (Optional, default: false),
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 - **sslVerify**: (bool) verify SSL (Optional, default: false),
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 - **nickname**: (string) the nickname to use (Optional, default: irccd),
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 - **username**: (string) the user name to use (Optional, default: irccd),
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 - **realname**: (string) the real name to use (Optional, default: IRC Client Daemon),
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 - **ctcpVersion**: (string) the CTCP Version to answer (Optional, default: the irccd's version),
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 - **commandChar**: (string) the command character to use to invoke commands (Optional, default: !),
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 - **reconnectTries**: (int) the number of reconnection to try (Optional, default: -1),
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 - **reconnectTimeout**: (int) the number of seconds to wait before retrying to connect (Optional, default: 30).
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
47
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 #### Example
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
49
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 ````json
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 "command": "server-connect",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 "name": "myserver",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
54 "host": "localhost",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 "nickname": "edouard"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
56 }
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
57 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
58
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
59 ### server-disconnect
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
60
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
61 Disconnect from a server.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
62
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
63 If server is not specified, irccd disconnects all servers.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
64
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
65 #### Properties
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
66
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
67 - **command**: (string) "server-disconnect",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
68 - **server**: (string) the server unique id (Optional, default: none).
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
69
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
70 #### Example
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
71
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
72 ````json
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
73 {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
74 "command": "server-disconnect",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
75 "server": "myserver"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
76 }
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
77 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
78
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
79 ### server-info
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
80
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
81 Get server information.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
82
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
83 #### Properties
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
84
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
85 - **command**: (string) "server-info",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
86 - **server**: (string) the server unique id.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
87
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
88 #### Example
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
89
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
90 ````json
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
91 {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
92 "command": "server-info",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
93 "server": "myserver"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
94 }
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
95 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
96
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
97 #### Responses
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
98
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
99 - **name**: (string) the server unique id,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
100 - **host**: (string) the server hostname,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
101 - **port**: (int) the port,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
102 - **ipv6**: (bool) true if using IPv6,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
103 - **ssl**: (bool) true if connection is using SSL,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
104 - **sslVerify**: (bool) true if SSL was verified,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
105 - **channels**: (string list) list of channels.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
106 - **nickname**: (string) the current nickname in use,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
107 - **username**: (string) the username in use,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
108 - **realname**: (string) the realname in use.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
109
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
110 ### server-invite
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
111
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
112 Invite the specified target on the channel.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
113
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
114 #### Properties
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
115
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
116 - **command**: (string) "server-invite",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
117 - **server**: (string) the server unique id,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
118 - **target**: (string) the nickname to invite,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
119 - **channel**: (string) the channel.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
120
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
121 #### Example
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
122
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
123 ````json
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
124 {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
125 "command": "server-invite",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
126 "server": "myserver",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
127 "target": "edouard",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
128 "channel": "#staff"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
129 }
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
130 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
131
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
132 ### server-join
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
133
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
134 Join the specified channel, the password is optional.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
135
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
136 #### Properties
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
137
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
138 - **command**: (string) "server-join",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
139 - **server**: (string) the server unique id,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
140 - **channel**: (string) the channel to join,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
141 - **password**: (string) the password (Optional, default: none).
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
142
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
143 #### Example
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
144
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
145 ````json
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
146 {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
147 "command": "server-join",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
148 "server": "myserver",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
149 "channel": "#games"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
150 }
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
151 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
152
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
153 ### server-kick
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
154
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
155 Kick the specified target from the channel, the reason is optional.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
156
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
157 #### Properties
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
158
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
159 - **command**: (string) "server-kick",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
160 - **server**: (string) the server unique id,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
161 - **target**: (string) the target nickname,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
162 - **channel**: (string) the channel,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
163 - **reason**: (string) the reason (Optional, default: none).
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
164
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
165 #### Example
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
166
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
167 ````json
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
168 {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
169 "command": "server-kick",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
170 "server": "myserver",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
171 "target": "edouard",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
172 "channel": "#staff",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
173 "reason": "please be nice"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
174 }
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
175 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
176
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
177 ### server-list
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
178
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
179 Get the list of all connected servers.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
180
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
181 #### Properties
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
182
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
183 - **command**: (string) "server-list".
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
184
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
185 #### Example
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
186
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
187 ````json
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
188 {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
189 "command": "server-list"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
190 }
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
191 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
192
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
193 #### Responses
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
194
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
195 - The following properties:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
196 - **list**: (string list) the list of all server unique ids.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
197
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
198 ### server-me
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
199
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
200 Send an action emote.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
201
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
202 #### Properties
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
203
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
204 - **command**: (string) "server-me",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
205 - **server**: (string) the server unique id,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
206 - **target**: (string) the target or channel,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
207 - **message**: (string) the message.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
208
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
209 #### Example
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
210
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
211 ````json
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
212 {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
213 "command": "server-me",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
214 "server": "myserver",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
215 "channel": "#staff",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
216 "message": "like that"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
217 }
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
218 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
219
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
220 ### server-message
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
221
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
222 Send a message to the specified target or channel.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
223
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
224 #### Properties
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
225
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
226 - **command**: (string) "server-message",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
227 - **server**: (string) the server unique id,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
228 - **target**: (string) the target or channel,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
229 - **message**: (string) the message.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
230
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
231 #### Example
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
232
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
233 ````json
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
234 {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
235 "command": "server-message",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
236 "server": "myserver",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
237 "target": "#staff",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
238 "message": "this channel is nice"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
239 }
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
240 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
241
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
242 ### server-mode
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
243
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
244 Set the irccd's user mode.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
245
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
246 #### Properties
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
247
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
248 - **command**: (string) "server-mode",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
249 - **server**: (string) the server unique id,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
250 - **mode**: (string) the mode.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
251
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
252 #### Example
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
253
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
254 ````json
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
255 {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
256 "command": "server-mode",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
257 "server": "myserver",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
258 "mode": "mode"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
259 }
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
260 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
261
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
262 ### server-nick
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
263
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
264 Change irccd's nickname.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
265
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
266 #### Properties
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
267
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
268 - **command**: (string) "server-nick",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
269 - **server**: (string) the server unique id,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
270 - **nickname**: (string) the new nickname.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
271
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
272 #### Example
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
273
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
274 ````json
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
275 {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
276 "command": "server-nick",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
277 "server": "myserver",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
278 "nickname": "edouard"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
279 }
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
280 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
281
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
282 ### server-notice
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
283
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
284 Send a private notice to the specified target.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
285
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
286 #### Properties
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
287
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
288 - **command**: (string) "server-notice",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
289 - **server**: (string) the server unique id,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
290 - **target**: (string) the target,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
291 - **message**: (string) the notice message.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
292
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
293 #### Example
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
294
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
295 ````json
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
296 {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
297 "command": "server-notice",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
298 "server": "myserver",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
299 "target": "edouard",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
300 "message": "hello dude"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
301 }
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
302 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
303
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
304 ### server-part
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
305
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
306 Leave the specified channel, the reason is optional.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
307
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
308 Not all IRC servers support giving a reason to leave a channel, do not specify it if this is a concern.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
309
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
310 #### Properties
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
311
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
312 - **command**: (string) "server-part",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
313 - **server**: (string) the unique server id,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
314 - **channel**: (string) the channel to leave,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
315 - **reason**: (string) the reason (Optional, default: none).
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
316
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
317 #### Example
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
318
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
319 ````json
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
320 {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
321 "command": "server-part",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
322 "server": "myserver",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
323 "channel": "#staff",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
324 "reason": "the reason"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
325 }
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
326 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
327
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
328 ### server-reconnect
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
329
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
330 Force reconnection of one or all servers.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
331
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
332 If server is not specified, all servers will try to reconnect.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
333
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
334 #### Properties
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
335
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
336 - **command**: (string) "server-reconnect",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
337 - **server**: (string) the server unique id (Optional, default: none).
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
338
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
339 #### Example
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
340
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
341 ````json
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
342 {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
343 "command": "server-reconnect",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
344 "server": "myserver"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
345 }
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
346 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
347
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
348 ### server-topic
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
349
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
350 Change the topic of the specified channel.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
351
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
352 #### Properties
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
353
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
354 - **command**: (string) "server-topic",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
355 - **server**: (string) the unique server id,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
356 - **channel**: (string) the channel,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
357 - **topic**: (string) the new topic.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
358
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
359 #### Example
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
360
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
361 ````json
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
362 {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
363 "command": "server-topic",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
364 "server": "myserver",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
365 "channel": "#staff",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
366 "topic": "the new topic"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
367 }
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
368 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
369
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
370 ### server-umode
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
371
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
372 Change your irccd user mode for the specified server.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
373
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
374 ````json
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
375 {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
376 "command": "umode",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
377 "server": "the server name",
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
378 "mode": "the mode"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
379 }
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
380 ````