Mercurial > irccd

annotate doc/html/guide/05-irccdctl/03-commands.md @ 0:1158cffe5a5e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Initial import
author David Demelier <markand@malikania.fr>
date Mon, 08 Feb 2016 16:43:14 +0100
parents
children 8384df86e195
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 ## Irccdctl 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.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
4
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 ### help
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
6
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 Get the help.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
8
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 **Usage**
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
10
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 $ irccdctl help subject
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
14
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 **Example**
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
16
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
18 $ irccdctl help server-message
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
20
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 ### plugin-info
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
22
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 Get plugin information.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
24
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 **Usage**
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 $ irccdctl plugin-info name
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
30
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 **Example**
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
32
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 $ irccdctl plugin-info ask
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
36
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 ### plugin-list
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
38
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 Get the list of all loaded plugins.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
40
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 **Usage**
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
42
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 $ irccdctl plugin-list
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
46
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 ### plugin-load
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
48
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 Load a plugin into the irccd instance.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
50
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 **Usage**
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
52
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
54 $ irccdctl plugin-load plugin
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
56
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
57 **Example**
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
58
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
59 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
60 $ irccdctl load ask
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
61 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
62
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
63 ### plugin-reload
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
64
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
65 Reload a plugin, parameter name is the plugin to reload.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
66
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
67 The plugin must be loaded.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
68
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
69 **Usage**
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
70
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
71 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
72 $ irccdctl plugin-reload name
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
73 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
74
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
75 **Example**
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 $ irccdctl plugin-reload logger
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
79 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
80
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
81 ### plugin-unload
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
82
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
83 Unload a loaded plugin from the irccd instance.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
84
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
85 **Usage**
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
86
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
87 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
88 $ irccdctl plugin-unload name
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
89 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
90
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
91 **Example**
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
92
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
93 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
94 $ irccdctl plugin-unload logger
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 ### server-cmode
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
98
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
99 Change the mode of the specified channel.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
100
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
101 **Usage**
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
102
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
103 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
104 $ irccdctl server-cmode server channel mode
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
105 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
106
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
107 **Example**
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
108
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
109 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
110 $ irccdctl server-cmode freenode #staff +t
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
111 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
112
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
113 ### server-cnotice
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
114
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
115 Send a notice to a public channel. This is a notice that everyone will be notified by.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
116
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
117 **Usage**
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
118
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
119 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
120 $ irccdctl server-cnotice server channel message
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
121 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
122
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
123 **Usage**
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
124
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
125 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
126 $ irccdctl server-cnotice freenode #staff "Don't flood"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
127 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
128
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
129 ### server-connect
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
130
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
131 Connect to a new IRC server.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
132
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
133 **Usage**
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
134
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
135 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
136 $ irccdctl server-connect [options] name host port
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
137 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
138
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
139 Available options:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
140
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
141 - **-c, --command**: specify the command char
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
142 - **-n, --nickname**: specify a nickname
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
143 - **-r, --realname**: specify a real name
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
144 - **-S, --ssl-verify**: verify SSL
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
145 - **-s, --ssl**: connect using SSL
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
146 - **-u, --username**: specify a user name
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
147
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
148 **Example**
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
149
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
150 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
151 $ irccdctl server-connect wanadoo chat.wanadoo.fr 6667
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
152 $ irccdctl server-connect -s -S -n "undead" wanadoo chat.wanadoo.fr 6697
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
153 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
154
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
155 ### server-disconnect
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
156
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
157 Disconnect from a connected server.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
158
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
159 **Usage**
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
160
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
161 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
162 $ irccdctl server-disconnect name
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
163 ````
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 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
168 $ irccdctl server-disconnect wanadoo
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
169 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
170
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
171 ### server-invite
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
172
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
173 Invite someone to a channel, needed for channel with mode +i
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
174
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
175 **Usage**
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
176
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
177 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
178 $ irccdctl server-invite server nickname channel
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
179 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
180
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
181 **Example**
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
182
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
183 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
184 $ irccdctl server-invite freenode xorg62 #staff
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
185 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
186
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
187 ### server-join
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
188
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
189 Join the specified channel, the password is optional.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
190
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
191 **Usage**
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
192
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
193 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
194 $ irccdctl server-join server channel [password]
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
195 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
196
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
197 **Example**
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
198
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
199 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
200 $ irccdctl server-join freenode #staff
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
201 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
202
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
203 ### server-kick
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
204
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
205 Kick the specified target from the channel, the reason is optional.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
206
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
207 **Usage**
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
208
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
209 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
210 $ irccdctl server-kick server target channel [reason]
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
211 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
212
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
213 **Example**
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
214
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
215 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
216 $ irccdctl kick freenode jean #staff "Stop flooding"
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 ### server-list
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
220
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
221 Get the list of all connected servers.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
222
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
223 **Usage**
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
224
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
225 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
226 $ irccdctl server-list
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
227 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
228
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
229 ### server-me
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
230
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
231 Send an action emote.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
232
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
233 **Usage**
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
234
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
235 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
236 $ irccdctl server-me server target message
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
237 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
238
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
239 **Example**
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 $ irccdctl server-me freenode #staff "going back soon"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
243 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
244
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
245 ### server-message
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
246
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
247 Send a message to the specified target or channel.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
248
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
249 **Usage**
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
250
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
251 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
252 $ irccdctl server-message server target message
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
253 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
254
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
255 **Example**
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
256
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
257 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
258 $ irccdctl server-message freenode #staff "Hello from irccd"
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 ### server-mode
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
262
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
263 Set the irccd's user mode.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
264
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
265 **Usage**
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
266
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
267 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
268 $ server-mode server mode
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
269 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
270
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
271 **Example**
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
272
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
273 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
274 $ irccdctl server-mode +i
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
275 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
276
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
277 ### server-nick
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
278
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
279 Change irccd's nickname.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
280
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
281 **Usage**
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
282
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
283 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
284 $ irccdctl server-nick server nickname
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
285 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
286
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
287 **Example**
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
288
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
289 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
290 $ irccdctl server-nick freenode david
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
291 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
292
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
293 ### server-notice
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
294
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
295 Send a private notice to the specified target.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
296
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
297 **Usage**
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
298
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
299 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
300 $ irccdctl server-notice server target message
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 **Example**
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
304
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
305 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
306 $ irccdctl server-notice freenode jean "I know you are here."
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
307 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
308
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
309 ### server-part
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
310
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
311 Leave the specified channel, the reason is optional.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
312
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
313 <div class="alert alert-warning" role="alert">
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
314 **Warning**: 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
315 </div>
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
316
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
317 **Usage**
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
318
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
319 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
320 $ irccdctl server-part server channel [reason]
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
321 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
322
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
323 **Example**
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
324
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
325 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
326 $ irccdctl server-part freenode #staff
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
327 $ irccdctl server-part freenode #botwar "too noisy"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
328 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
329
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
330 ### server-reconnect
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
331
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
332 Force reconnection of one or all servers.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
333
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
334 If server is not specified, all servers will try to reconnect.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
335
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
336 **Usage**
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
337
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
338 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
339 $ irccdctl server-reconnect [server]
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
340 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
341
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
342 **Example**
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
343
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
344 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
345 $ irccdctl server-reconnect
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
346 $ irccdctl server-reconnect wanadoo
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
347 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
348
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
349 ### server-topic
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
350
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
351 Change the topic of the specified channel.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
352
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
353 **Usage**
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
354
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
355 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
356 $ irccdctl server-topic server channel topic
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
357 ````
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 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
362 $ irccdctl server-topic freenode #wmfs "This is the best channel"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
363 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
364
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
365 ### watch
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
366
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
367 Start watching irccd events. You can use different output formats, native is human readable format, json is pretty
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
368 formatted json.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
369
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
370 **Usage**
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
371
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
372 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
373 $ irccdctl watch [-f|--format native|json]
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
374 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
375
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
376 **Example**
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
377
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
378 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
379 $ irccdctl watch
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
380 $ irccdctl watch -f json
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
381 ````