Mercurial > irccd
annotate doc/man/irccdctl.1.in @ 519:63faa8087c46
Irccd: store configuration path, closes #723
| author | David Demelier <markand@malikania.fr> |
|---|---|
| date | Thu, 26 Oct 2017 20:55:20 +0200 |
| parents | c6fbb6e0e06d |
| children |
| rev | line source |
|---|---|
| 0 | 1 .\" |
| 394 | 2 .\" Copyright (c) 2013-2017 David Demelier <markand@malikania.fr> |
| 0 | 3 .\" |
| 4 .\" Permission to use, copy, modify, and/or distribute this software for any | |
| 5 .\" purpose with or without fee is hereby granted, provided that the above | |
| 6 .\" copyright notice and this permission notice appear in all copies. | |
| 7 .\" | |
| 8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES | |
| 9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF | |
| 10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR | |
| 11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES | |
| 12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN | |
| 13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF | |
| 14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | |
| 15 .\" | |
| 16 .Dd @MONTH@ @DAY@, @YEAR@ | |
| 17 .Dt IRCCDCTL 1 | |
| 18 .Os | |
| 19 .Sh NAME | |
| 20 .Nm irccdctl | |
| 21 .Nd irccd controller utility | |
| 22 .\" SYNOPSIS | |
| 23 .Sh SYNOPSIS | |
| 24 This is the list of commands supported by | |
| 25 .Ns Nm | |
| 26 utility: | |
| 27 .Pp | |
| 28 .\" HELP | |
| 29 .Nm | |
| 30 .Cm help | |
| 31 .Ar topic | |
| 32 .\" WATCH | |
| 33 .Nm | |
| 34 .Cm watch | |
| 35 .Op Ar options | |
| 36 .Pp | |
|
371
c6fb00344c19
Docs: add plugin-config in irccdctl.1
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
37 .\" PLUGIN-CONFIG |
|
c6fb00344c19
Docs: add plugin-config in irccdctl.1
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
38 .Nm |
|
c6fb00344c19
Docs: add plugin-config in irccdctl.1
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
39 .Cm plugin-config |
|
c6fb00344c19
Docs: add plugin-config in irccdctl.1
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
40 .Ar name |
|
c6fb00344c19
Docs: add plugin-config in irccdctl.1
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
41 .Op Ar variable |
|
c6fb00344c19
Docs: add plugin-config in irccdctl.1
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
42 .Op Ar value |
| 0 | 43 .\" PLUGIN-INFO |
| 44 .Nm | |
| 45 .Cm plugin-info | |
| 46 .Ar name | |
|
371
c6fb00344c19
Docs: add plugin-config in irccdctl.1
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
47 .\" PLUGIN-LIST |
| 0 | 48 .Nm |
| 49 .Cm plugin-list | |
| 50 .\" PLUGIN-LOAD | |
| 51 .Nm | |
| 52 .Cm plugin-load | |
| 53 .Ar name | |
| 54 .\" PLUGIN-RELOAD | |
| 55 .Nm | |
| 56 .Cm plugin-reload | |
| 57 .Ar name | |
| 58 .\" PLUGIN-UNLOAD | |
| 59 .Nm | |
| 60 .Cm plugin-unload | |
| 61 .Ar name | |
| 62 .Pp | |
| 63 .\" SERVER-CMODE | |
| 64 .Nm | |
| 65 .Cm server-cmode | |
| 66 .Ar server | |
| 67 .Ar channel | |
| 68 .Ar mode | |
| 69 .\" SERVER-CNOTICE | |
| 70 .Nm | |
| 71 .Cm server-cnotice | |
| 72 .Ar server | |
| 73 .Ar channel | |
| 74 .Ar message | |
| 75 .\" SERVER-CONNECT | |
| 76 .Nm | |
| 77 .Cm server-connect | |
| 78 .Op Ar options | |
| 79 .Ar name | |
| 80 .Ar host | |
| 81 .Op Ar port | |
| 82 .\" SERVER-DISCONNECT | |
| 83 .Nm | |
| 84 .Cm server-disconnect | |
| 85 .Op Ar server | |
| 86 .\" SERVER-INFO | |
| 87 .Nm | |
| 88 .Cm server-info | |
| 89 .Ar server | |
| 90 .\" SERVER-INVITE | |
| 91 .Nm | |
| 92 .Cm server-invite | |
| 93 .Ar server | |
| 94 .Ar target | |
| 95 .Ar channel | |
| 96 .\" SERVER-JOIN | |
| 97 .Nm | |
| 98 .Cm server-join | |
| 99 .Ar server | |
| 100 .Ar channel | |
| 101 .Op Ar password | |
| 102 .\" SERVER-KICK | |
| 103 .Nm | |
| 104 .Cm server-kick | |
| 105 .Ar server | |
| 106 .Ar nickname | |
| 107 .Ar channel | |
| 108 .Op Ar reason | |
| 109 .\" SERVER-LIST | |
| 110 .Nm | |
| 111 .Cm server-list | |
| 112 .\" SERVER-ME | |
| 113 .Nm | |
| 114 .Cm server-me | |
| 115 .Ar server | |
| 116 .Ar target | |
| 117 .Ar message | |
| 118 .\" SERVER-MESSAGE | |
| 119 .Nm | |
| 120 .Cm server-message | |
| 121 .Ar server | |
| 122 .Ar target | |
| 123 .Ar message | |
| 124 .\" SERVER-MODE | |
| 125 .Nm | |
| 126 .Cm server-mode | |
| 127 .Ar server | |
| 128 .Ar mode | |
| 129 .\" SERVER-NICK | |
| 130 .Nm | |
| 131 .Cm server-nick | |
| 132 .Ar server | |
| 133 .Ar newnickname | |
| 134 .\" SERVER-NOTICE | |
| 135 .Nm | |
| 136 .Cm server-notice | |
| 137 .Ar server | |
| 138 .Ar nickname | |
| 139 .Ar message | |
| 140 .\" SERVER-PART | |
| 141 .Nm | |
| 142 .Cm server-part | |
| 143 .Ar server | |
| 144 .Ar channel | |
| 145 .\" SERVER-RECONNECT | |
| 146 .Nm | |
| 147 .Cm server-reconnect | |
| 148 .Op Ar name | |
| 149 .\" SERVER-TOPIC | |
| 150 .Nm | |
| 151 .Cm server-topic | |
| 152 .Ar server | |
| 153 .Ar channel | |
| 154 .Ar topic | |
| 155 .\" DESCRIPTION | |
| 156 .Sh DESCRIPTION | |
| 157 The | |
| 158 .Nm irccdctl | |
| 159 utility provides serveral options to manipulate a running | |
| 160 irccd instance. | |
| 161 .Pp | |
| 162 It uses sockets to do a basic IPC messaging with irccd, you can use unix | |
| 163 or internet domain sockets. | |
| 164 .Pp | |
| 165 The following options are available: | |
| 166 .Bl -tag -width indent | |
| 167 .It Fl c Ar config | |
| 168 A path to a config file. | |
| 169 .It Fl t, Fl -type Ar domain | |
| 170 The domain to use, specify internet or unix. | |
| 171 .It Fl v | |
| 172 Be more verbose. | |
| 173 .El | |
| 174 .\" INTERNET OPTIONS | |
| 175 .Pp | |
| 176 The following options are available for | |
| 177 .Fl t Ar ip, ipv6 : | |
| 178 .Bl -tag -width indent | |
| 179 .It Fl h, Fl -host | |
| 180 The hostname to connect. | |
| 181 .It Fl p, Fl -port | |
| 182 The port to use. | |
| 183 .El | |
| 184 .\" UNIX OPTIONS | |
| 185 .Pp | |
| 186 The following options are available for | |
| 187 .Fl t Ar unix : | |
| 188 .Bl -tag -width indent | |
| 189 .It Fl P, Fl -part Ar path | |
| 190 The path to the unix socket. | |
| 191 .El | |
| 192 .\" EXAMPLES | |
| 193 .Sh EXAMPLES | |
| 194 .Bl -tag -width 0n | |
| 195 .It Sy Example 1 Show help | |
| 196 .Bd -literal -offset 2n | |
| 197 $ irccdctl help server-message | |
| 198 .Ed | |
| 199 .El | |
| 200 .Bl -tag -width 0n | |
| 201 .It Sy Example 2 Sending a message | |
| 202 .Pp | |
| 203 .Bd -literal -offset 2n | |
| 204 $ irccdctl server-message localhost #staff "Hello World" | |
| 205 .Ed | |
| 206 .It Sy Example 3 Connect to a Unix socket to join a channel | |
| 207 .Pp | |
| 208 .Bd -literal -offset 2n | |
| 209 $ irccdctl -t unix -P /tmp/foo.sock server-join localhost #foo | |
| 210 .Ed | |
| 211 .El | |
| 212 .\" SEE ALSO | |
| 213 .Sh SEE ALSO | |
| 214 .Xr irccd 1 , | |
| 215 .Xr irccdctl.conf 5 | |
| 216 .\" BUGS | |
| 217 .Sh BUGS | |
| 218 Be careful when using channel names, some shells (i.e bash) ignore the # | |
| 219 character. In that case, quote the command like this: | |
| 220 .Bd -literal -offset 2n | |
| 221 $ irccdctl join localhost "#bar" | |
| 222 .Ed | |
| 223 .\" AUTHORS | |
| 224 .Sh AUTHORS | |
| 225 irccdctl was written by David Demelier <markand@malikania.fr> |