Mercurial > irccd

annotate man/irccdctl.1 @ 1035:b460e70a324d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
irccdctl: implement server-connect
author David Demelier <markand@malikania.fr>
date Thu, 08 Apr 2021 21:16:01 +0200
parents 509bcfb14670
children f06e9761cc90
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 .\"
1018
cf99df45cb84 misc: update copyright years
David Demelier <markand@malikania.fr>
parents: 913
diff changeset
2 .\" Copyright (c) 2013-2021 David Demelier <markand@malikania.fr>
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 .\"
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 .\" Permission to use, copy, modify, and/or distribute this software for any
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 .\" purpose with or without fee is hereby granted, provided that the above
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 .\" copyright notice and this permission notice appear in all copies.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 .\"
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 .\"
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 .Dd @IRCCD_MAN_DATE@
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 .Dt IRCCD 1
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
18 .Os
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 .\" NAME
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 .Sh NAME
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 .Nm irccdctl
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 .Nd irccd controller agent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 .\" SYNOPSIS
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 .Sh SYNOPSIS
895
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 856
diff changeset
25 .\" hook-add
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 .Nm
895
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 856
diff changeset
27 .Cm hook-add
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 856
diff changeset
28 .Ar id
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 856
diff changeset
29 .Ar path
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 856
diff changeset
30 .\" hook-list
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 856
diff changeset
31 .Nm
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 856
diff changeset
32 .Cm hook-list
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 856
diff changeset
33 .\" hook-remove
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 856
diff changeset
34 .Nm
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 856
diff changeset
35 .Cm hook-remove
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 856
diff changeset
36 .Ar id
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 .\" plugin-config
895
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 856
diff changeset
38 .Nm
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 .Cm plugin-config
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 .Ar id
1029
113e523d999a man: update some manual pages
David Demelier <markand@malikania.fr>
parents: 1018
diff changeset
41 .Op Ar variable Op Ar value
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 .\" plugin-info
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 .Nm
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 .Cm plugin-info
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 .Ar id
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 .\" plugin-list
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 .Nm
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 .Cm plugin-list
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 .\" plugin-load
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 .Nm
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 .Cm plugin-load
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 .Ar name
1030
509bcfb14670 misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents: 1029
diff changeset
53 .\" plugin-path
509bcfb14670 misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents: 1029
diff changeset
54 .Nm
509bcfb14670 misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents: 1029
diff changeset
55 .Cm plugin-path
509bcfb14670 misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents: 1029
diff changeset
56 .Ar id
509bcfb14670 misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents: 1029
diff changeset
57 .Op Ar variable Op Ar value
509bcfb14670 misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents: 1029
diff changeset
58 .\" plugin-template
509bcfb14670 misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents: 1029
diff changeset
59 .Nm
509bcfb14670 misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents: 1029
diff changeset
60 .Cm plugin-template
509bcfb14670 misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents: 1029
diff changeset
61 .Ar id
509bcfb14670 misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents: 1029
diff changeset
62 .Op Ar variable Op Ar value
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
63 .\" plugin-reload
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
64 .Nm
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
65 .Cm plugin-reload
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
66 .Ar plugin
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
67 .\" plugin-unload
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
68 .Cm plugin-unload
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
69 .Ar plugin
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
70 .\" rule-add
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
71 .Nm
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
72 .Cm rule-add
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
73 .Op Fl c Ar channel
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
74 .Op Fl e Ar event
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
75 .Op Fl i Ar index
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
76 .Op Fl o Ar origin
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
77 .Op Fl s Ar server
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
78 .Ar accept|drop
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
79 .\" rule-edit
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
80 .Nm
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
81 .Cm rule-edit
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
82 .Op Fl a Ar accept|drop
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
83 .Op Fl c|C Ar channel
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
84 .Op Fl e|E Ar event
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
85 .Op Fl o|O Ar origin
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
86 .Op Fl s|S Ar server
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
87 .Ar index
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
88 .\" rule-info
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
89 .Nm
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
90 .Cm rule-info
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
91 .Ar index
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
92 .\" rule-list
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
93 .Nm
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
94 .Cm rule-list
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
95 .\" rule-move
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
96 .Nm
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
97 .Cm rule-move
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
98 .Ar from
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
99 .Ar to
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
100 .\" rule-remove
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
101 .Nm
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
102 .Cm rule-remove
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
103 .Ar index
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
104 .\" server-connect
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
105 .Nm
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
106 .Cm server-connect
1035
b460e70a324d irccdctl: implement server-connect
David Demelier <markand@malikania.fr>
parents: 1030
diff changeset
107 .Op Fl s
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
108 .Op Fl n Ar nickname
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
109 .Op Fl r Ar realname
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
110 .Op Fl u Ar username
850
688f28dd3241 irccd: remove short options, closes #1673
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
111 .Op Fl p Ar port
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
112 .Ar id
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
113 .Ar hostname
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
114 .\" server-disconnect
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
115 .Nm
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
116 .Cm server-disconnect
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
117 .Op Ar server
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
118 .\" server-info
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
119 .Nm
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
120 .Cm server-info
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
121 .Ar server
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
122 .\" server-invite
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
123 .Nm
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
124 .Cm server-invite
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
125 .Ar server
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
126 .Ar target
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
127 .Ar channel
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
128 .\" server-join
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
129 .Nm
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
130 .Cm server-join
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
131 .Ar server
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
132 .Ar channel
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
133 .Op Ar password
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
134 .\" server-kick
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
135 .Nm
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
136 .Cm server-kick
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
137 .Ar server
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
138 .Ar target
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
139 .Ar channel
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
140 .Op Ar reason
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
141 .\" server-list
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
142 .Nm
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
143 .Cm server-list
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
144 .\" server-me
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
145 .Nm
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
146 .Cm server-me
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
147 .Ar server
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
148 .Ar target
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
149 .Ar message
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
150 .\" server-message
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
151 .Nm
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
152 .Cm server-message
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
153 .Ar server
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
154 .Ar target
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
155 .Ar message
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
156 .\" server-mode
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
157 .Nm
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
158 .Cm server-mode
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
159 .Ar server
1030
509bcfb14670 misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents: 1029
diff changeset
160 .Ar channel
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
161 .Ar mode
1030
509bcfb14670 misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents: 1029
diff changeset
162 .Op Ar args
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
163 .\" server-nick
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
164 .Nm
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
165 .Cm server-nick
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
166 .Ar server
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
167 .Ar nickname
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
168 .\" server-notice
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
169 .Nm
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
170 .Cm server-notice
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
171 .Ar server
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
172 .Ar target
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
173 .Ar message
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
174 .\" server-part
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
175 .Nm
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
176 .Cm server-part
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
177 .Ar server
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
178 .Ar channel
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
179 .Op Ar reason
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
180 .\" server-reconnect
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
181 .Nm
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
182 .Cm server-reconnect
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
183 .Op Ar server
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
184 .\" server-topic
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
185 .Nm
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
186 .Cm server-topic
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
187 .Ar server
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
188 .Ar channel
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
189 .Ar topic
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
190 .\" watch
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
191 .Nm
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
192 .Cm watch
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
193 .\" DESCRIPTION
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
194 .Sh DESCRIPTION
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
195 The
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
196 .Nm irccdctl
1030
509bcfb14670 misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents: 1029
diff changeset
197 utility is the official utility that let you control a running irccd instance.
509bcfb14670 misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents: 1029
diff changeset
198 It connects to the UNIX domain socket opened by
509bcfb14670 misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents: 1029
diff changeset
199 .Xr irccd 1
509bcfb14670 misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents: 1029
diff changeset
200 to make requests through the
509bcfb14670 misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents: 1029
diff changeset
201 .Xr irccd-ipc 7
509bcfb14670 misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents: 1029
diff changeset
202 protocol.
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
203 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
204 The general syntax for running an irccdctl command is:
1030
509bcfb14670 misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents: 1029
diff changeset
205 .Bd -literal -offset indent
850
688f28dd3241 irccd: remove short options, closes #1673
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
206 irccdctl global-options command command-options command-arguments
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
207 .Ed
850
688f28dd3241 irccd: remove short options, closes #1673
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
208 .Pp
688f28dd3241 irccd: remove short options, closes #1673
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
209 The following
688f28dd3241 irccd: remove short options, closes #1673
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
210 .Ar global-options
688f28dd3241 irccd: remove short options, closes #1673
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
211 are available
688f28dd3241 irccd: remove short options, closes #1673
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
212 .Em before
688f28dd3241 irccd: remove short options, closes #1673
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
213 the
688f28dd3241 irccd: remove short options, closes #1673
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
214 .Ar command
688f28dd3241 irccd: remove short options, closes #1673
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
215 name:
1030
509bcfb14670 misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents: 1029
diff changeset
216 .Bl -tag "path"
509bcfb14670 misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents: 1029
diff changeset
217 .It Fl s Ar path
850
688f28dd3241 irccd: remove short options, closes #1673
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
218 Connect to the UNIX local socket specified by
688f28dd3241 irccd: remove short options, closes #1673
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
219 .Ar path .
1030
509bcfb14670 misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents: 1029
diff changeset
220 .It Fl v
509bcfb14670 misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents: 1029
diff changeset
221 Be more verbose.
850
688f28dd3241 irccd: remove short options, closes #1673
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
222 .El
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
223 .\" COMMANDS
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
224 .Sh COMMANDS
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
225 .Bl -tag -width xxxxxxxx-yyyyyyyyy
895
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 856
diff changeset
226 .\" hook-add
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 856
diff changeset
227 .It Cm hook-add
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 856
diff changeset
228 Add a new hook with
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 856
diff changeset
229 .Ar id
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 856
diff changeset
230 as unique identifier and
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 856
diff changeset
231 .Ar path
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 856
diff changeset
232 as local path (on the machine where irccd is running).
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 856
diff changeset
233 .\" hook-list
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 856
diff changeset
234 .It Cm hook-list
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 856
diff changeset
235 List active hooks.
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 856
diff changeset
236 .\" hook-remove
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 856
diff changeset
237 .It Cm hook-remove
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 856
diff changeset
238 Remove a hook with identifier
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 856
diff changeset
239 .Ar id .
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
240 .\" plugin-config
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
241 .It Cm plugin-config
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
242 Manipulate a configuration variable for the plugin specified by
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
243 .Ar id .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
244 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
245 If both
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
246 .Ar variable
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
247 and
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
248 .Ar value
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
249 are provided, sets the plugin configuration to the
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
250 respective variable name and value.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
251 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
252 If only
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
253 .Ar variable
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
254 is specified, shows its current value. Otherwise, list all variables and their
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
255 values.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
256 .\" plugin-info
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
257 .It Cm plugin-info
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
258 Get plugin information specified by
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
259 .Ar id .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
260 .\" plugin-list
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
261 .It Cm plugin-list
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
262 Get the list of all loaded plugins.
1030
509bcfb14670 misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents: 1029
diff changeset
263 .\" plugin-load
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
264 .It Cm plugin-load
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
265 Load a plugin into the irccd instance.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
266 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
267 Note: since irccdctl can be used remotely, the argument
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
268 .Ar name
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
269 will always be evaluated as plugin name and not as a filesystem path. Therefore,
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
270 the plugin will be searched through the irccd directories.
1030
509bcfb14670 misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents: 1029
diff changeset
271 .\" plugin-path
509bcfb14670 misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents: 1029
diff changeset
272 .It Cm plugin-path
509bcfb14670 misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents: 1029
diff changeset
273 Exactly the same usage as
509bcfb14670 misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents: 1029
diff changeset
274 .Cm plugin-config
509bcfb14670 misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents: 1029
diff changeset
275 but for plugin paths.
509bcfb14670 misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents: 1029
diff changeset
276 .\" plugin-template
509bcfb14670 misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents: 1029
diff changeset
277 .It Cm plugin-template
509bcfb14670 misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents: 1029
diff changeset
278 Exactly the same usage as
509bcfb14670 misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents: 1029
diff changeset
279 .Cm plugin-config
509bcfb14670 misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents: 1029
diff changeset
280 but for plugin templates.
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
281 .\" plugin-reload
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
282 .It Cm plugin-reload
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
283 Reload a plugin specified by
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
284 .Ar id
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
285 by calling the appropriate onReload event, the plugin is not unloaded and must
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
286 be already loaded.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
287 .\" plugin-unload
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
288 .It Cm plugin-unload
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
289 Unload the plugin
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
290 .Ar id
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
291 from the irccd instance.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
292 .\" rule-add
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
293 .It Cm rule-add
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
294 Add a new rule to irccd.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
295 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
296 If no index is specified, the rule is added to the end.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
297 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
298 Available options:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
299 .Bl -tag -width 12n
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
300 .It Fl c Ar channel
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 850
diff changeset
301 Match a channel.
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
302 .It Fl e Ar event
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 850
diff changeset
303 Match an event.
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
304 .It Fl i Ar index
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 850
diff changeset
305 Rule position.
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
306 .It Fl o Ar origin
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 850
diff changeset
307 Match an origin.
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
308 .It Fl p Ar plugin
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 850
diff changeset
309 Match a plugin.
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
310 .It Fl s Ar server
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 850
diff changeset
311 Match a server.
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
312 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
313 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
314 Note: all options (except
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
315 .Fl i )
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
316 may be specified multiple times.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
317 .\" rule-edit
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
318 .It Cm rule-edit
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
319 Edit an existing rule in irccd.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
320 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
321 Available options:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
322 .Bl -tag -width 14n
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
323 .It Fl a Ar accept|drop
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 850
diff changeset
324 Set action.
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
325 .It Fl c|C Ar channel
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 850
diff changeset
326 Match or unmatch a channel respectively.
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
327 .It Fl e|E Ar event
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 850
diff changeset
328 Match or unmatch an event respectively.
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
329 .It Fl o|O Ar origin
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 850
diff changeset
330 Match or unmatch an origin respectively.
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
331 .It Fl p|P Ar plugin
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 850
diff changeset
332 Match or unmatch a plugin respectively.
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
333 .It Fl s|S Ar server
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 850
diff changeset
334 Match or unmatch a server respectively.
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
335 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
336 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
337 Note: all options (except
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
338 .Fl a )
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
339 may be specified multiple times.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
340 .\" rule-info
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
341 .It Cm rule-info
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
342 Show information about the rule specified by
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
343 .Ar index .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
344 .\" rule-list
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
345 .It Cm rule-list
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
346 List all rules.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
347 .\" rule-move
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
348 .It Cm rule-move
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
349 Move a rule from the index
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
350 .Ar from
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
351 at the index specified by
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
352 .Ar to .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
353 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
354 The rule will replace the existing one at the given destination moving
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
355 down every other rules. If destination is greater or equal the number of rules,
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
356 the rule is moved to the end.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
357 .\" rule-remove
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
358 .It Cm rule-remove
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
359 Remove the existing rule at the given
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
360 .Ar index .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
361 .\" server-connect
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
362 .It Cm server-connect
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
363 Add and connect to a new IRC server. Server with identifier
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
364 .Ar id
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
365 must not be already present. The argument
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
366 .Ar hostname
850
688f28dd3241 irccd: remove short options, closes #1673
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
367 can be a hostname or IP address.
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
368 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
369 Available options:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
370 .Bl -tag -width 12n
1035
b460e70a324d irccdctl: implement server-connect
David Demelier <markand@malikania.fr>
parents: 1030
diff changeset
371 .It Fl s
b460e70a324d irccdctl: implement server-connect
David Demelier <markand@malikania.fr>
parents: 1030
diff changeset
372 Enable SSL.
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
373 .It Fl n Ar nickname
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 850
diff changeset
374 Specify a nickname.
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
375 .It Fl r Ar realname
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 850
diff changeset
376 Specify a real name.
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
377 .It Fl u Ar username
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 850
diff changeset
378 Specify a user name.
850
688f28dd3241 irccd: remove short options, closes #1673
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
379 .It Fl p Ar port
856
6c4fb8f42aca doc: improve wording and style
David Demelier <markand@malikania.fr>
parents: 850
diff changeset
380 Use the specific port, otherwise 6667 is used.
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
381 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
382 .\" server-disconnect
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
383 .It Cm server-disconnect
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
384 Disconnect and remove
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
385 .Ar server
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
386 from the irccd registry. If
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
387 .Ar server
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
388 is not specified, disconnect and remove all servers
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
389 .\" server-info
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
390 .It Cm server-info
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
391 Get information about
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
392 .Ar server .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
393 .\" server-invite
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
394 .It Cm server-invite
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
395 Invite the specified
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
396 .Ar target
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
397 on the
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
398 .Ar channel .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
399 .\" server-join
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
400 .It Cm server-join
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
401 Join the specified
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
402 .Ar channel ,
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
403 the
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
404 .Ar password
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
405 is optional.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
406 .\" server-kick
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
407 .It Cm server-kick
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
408 Kick the specified
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
409 .Ar target
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
410 from the
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
411 .Ar channel ,
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
412 the
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
413 .Ar reason
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
414 is optional.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
415 .\" server-list
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
416 .It Cm server-list
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
417 Get the list of all registered servers.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
418 .\" server-me
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
419 .It Cm server-me
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
420 Send an action emote to the
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
421 .Ar target
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
422 with the given
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
423 .Ar message .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
424 .\" server-message
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
425 .It Cm server-message
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
426 Send a
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
427 .Ar message
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
428 to the specified
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
429 .Ar target .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
430 .\" server-mode
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
431 .It Cm server-mode
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
432 Set
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
433 .Ar target
1030
509bcfb14670 misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents: 1029
diff changeset
434 or irccd's user
509bcfb14670 misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents: 1029
diff changeset
435 .Ar mode .
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
436 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
437 When
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
438 .Ar target
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
439 is the bot's nickname, the command change its mode. Otherwise it applies to a
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
440 channel and modes are treated differently.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
441 .Pp
1030
509bcfb14670 misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents: 1029
diff changeset
442 The optional
509bcfb14670 misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents: 1029
diff changeset
443 .Ar args
509bcfb14670 misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents: 1029
diff changeset
444 contains additional mode arguments usually separated by spaces. Make sure to
509bcfb14670 misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents: 1029
diff changeset
445 quote them in the shell to detect as a single argument, otherwise
509bcfb14670 misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents: 1029
diff changeset
446 .Nm
509bcfb14670 misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents: 1029
diff changeset
447 will not understand the command usage.
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
448 .\" server-nick
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
449 .It Cm server-nick
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
450 Change irccd's
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
451 .Ar nickname .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
452 .\" server-notice
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
453 .It Cm server-notice
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
454 Send a private notice to the specified
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
455 .Ar target .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
456 .\" server-part
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
457 .It Cm server-part
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
458 Leave the specified
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
459 .Ar channel ,
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
460 the
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
461 .Ar reason
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
462 is optional.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
463 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
464 Warning: while rare, not all IRC servers support giving a reason to leave a
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
465 channel, do not specify it if you require portability.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
466 .\" server-reconnect
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
467 .It Cm server-reconnect
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
468 Force reconnection of all servers unless
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
469 .Ar server
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
470 is specified.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
471 .\" server-topic
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
472 .It Cm server-topic
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
473 Set the
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
474 .Ar channel
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
475 new
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
476 .Ar topic .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
477 .\" watch
1030
509bcfb14670 misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents: 1029
diff changeset
478 .It Cm watch
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
479 Start watching irccd events. This command will indefinitely wait for new events
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
480 to arrive from irccd.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
481 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
482 .\" BUGS
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
483 .Sh BUGS
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
484 Some shells may discard arguments if they begins with a hash. For instance,
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
485 bash will not understand the following command:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
486 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
487 irccdctl server-join localhost #staff
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
488 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
489 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
490 Instead, enclose the arguments with quotes
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
491 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
492 irccdctl server-join localhost "#staff"
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
493 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
494 .\" SEE ALSO
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
495 .Sh SEE ALSO
1030
509bcfb14670 misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents: 1029
diff changeset
496 .Xr irccd 1
906
b831d9f48b0e doc: fix various errors
David Demelier <markand@malikania.fr>
parents: 856
diff changeset
497 .\" AUTHORS
b831d9f48b0e doc: fix various errors
David Demelier <markand@malikania.fr>
parents: 856
diff changeset
498 .Sh AUTHORS
b831d9f48b0e doc: fix various errors
David Demelier <markand@malikania.fr>
parents: 856
diff changeset
499 .Nm
b831d9f48b0e doc: fix various errors
David Demelier <markand@malikania.fr>
parents: 856
diff changeset
500 was written by David Demelier <markand@malikania.fr>