Mercurial > irccd

comparison man/irccdctl.1 @ 850:688f28dd3241

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
irccd: remove short options, closes #1673 While here, use a brand new home made option parsing.
author David Demelier <markand@malikania.fr>
date Tue, 16 Jul 2019 20:49:36 +0200
parents 00a4720c4874
children 6c4fb8f42aca
comparison
equal deleted inserted replaced
849:64f8f82ab110 850:688f28dd3241
85 .Cm server-connect 85 .Cm server-connect
86 .Op Fl 46s 86 .Op Fl 46s
87 .Op Fl n Ar nickname 87 .Op Fl n Ar nickname
88 .Op Fl r Ar realname 88 .Op Fl r Ar realname
89 .Op Fl u Ar username 89 .Op Fl u Ar username
90 .Op Fl p Ar port
90 .Ar id 91 .Ar id
91 .Ar hostname 92 .Ar hostname
92 .Op Ar port
93 .\" server-disconnect 93 .\" server-disconnect
94 .Nm 94 .Nm
95 .Cm server-disconnect 95 .Cm server-disconnect
96 .Op Ar server 96 .Op Ar server
97 .\" server-info 97 .\" server-info
181 requests. For more information see 181 requests. For more information see
182 .Xr irccd-ipc 7 . 182 .Xr irccd-ipc 7 .
183 .Pp 183 .Pp
184 The general syntax for running an irccdctl command is: 184 The general syntax for running an irccdctl command is:
185 .Bd -literal -offset Ds 185 .Bd -literal -offset Ds
186 irccdctl command options arg1 arg2 arg3 ... argn 186 irccdctl global-options command command-options command-arguments
187 .Ed 187 .Ed
188 .Pp
189 The following
190 .Ar global-options
191 are available
192 .Em before
193 the
194 .Ar command
195 name:
196 .Bl -tag -width 12n
197 .It Fl 4
198 Try to connect using IPv4. Specifying this option
199 unset
200 .Fl 6
201 option, set it explicitly to enable both families.
202 .It Fl 6
203 Try to connect using IPv6. Specifying this option will
204 unset
205 .Fl 4
206 option, set it explicitly to enable both families.
207 .It Fl h Ar hostname
208 Connect to the IP address or hostname.
209 .It Fl p Ar port
210 Use the
211 .Ar port
212 number or service name.
213 .It Fl P Ar path
214 Connect to the UNIX local socket specified by
215 .Ar path .
216 .El
217 .Pp
218 Note: options
219 .Fl h
220 and
221 .Fl P
222 are mutually exclusive.
188 .\" COMMANDS 223 .\" COMMANDS
189 .Sh COMMANDS 224 .Sh COMMANDS
190 .Bl -tag -width xxxxxxxx-yyyyyyyyy 225 .Bl -tag -width xxxxxxxx-yyyyyyyyy
191 .\" plugin-config 226 .\" plugin-config
192 .It Cm plugin-config 227 .It Cm plugin-config
302 .It Cm server-connect 337 .It Cm server-connect
303 Add and connect to a new IRC server. Server with identifier 338 Add and connect to a new IRC server. Server with identifier
304 .Ar id 339 .Ar id
305 must not be already present. The argument 340 must not be already present. The argument
306 .Ar hostname 341 .Ar hostname
307 can be a hostname or IP address. If the 342 can be a hostname or IP address.
308 .Ar port
309 number is not specified, the default value of 6667 is used instead.
310 .Pp 343 .Pp
311 Available options: 344 Available options:
312 .Bl -tag -width 12n 345 .Bl -tag -width 12n
313 .It Fl c Ar character 346 .It Fl c Ar character
314 specify the command character prefix. 347 specify the command character prefix.
316 specify a nickname. 349 specify a nickname.
317 .It Fl r Ar realname 350 .It Fl r Ar realname
318 specify a real name. 351 specify a real name.
319 .It Fl u Ar username 352 .It Fl u Ar username
320 specify a user name. 353 specify a user name.
354 .It Fl p Ar port
355 use the specific port, otherwise 6667 is used.
321 .El 356 .El
322 .\" server-disconnect 357 .\" server-disconnect
323 .It Cm server-disconnect 358 .It Cm server-disconnect
324 Disconnect and remove 359 Disconnect and remove
325 .Ar server 360 .Ar server