Mercurial > ~mikael > mcabber > hg
annotate mcabber/doc/mcabber.1.html @ 637:aff6df4b408b
Update documentation
Mention "/msay send_to" in the manpage.
| author | Mikael Berthe <mikael@lilotux.net> |
|---|---|
| date | Mon, 26 Dec 2005 19:42:57 +0100 |
| parents | d04b950122b9 |
| children | 3edd3687c38d |
| rev | line source |
|---|---|
| 229 | 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| 2 <html> | |
| 3 <head> | |
| 4 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /> | |
|
506
74dcd0df532e
"/move" does not jump to the buddy in the new group
Mikael Berthe <mikael@lilotux.net>
parents:
495
diff
changeset
|
5 <meta name="generator" content="AsciiDoc 7.0.2" /> |
| 229 | 6 <meta name="author" content="Mikael BERTHE" /> |
| 7 <meta name="author-email" content="mcabber@lilotux.net" /> | |
| 8 <link rel="stylesheet" href="./manpage.css" type="text/css" /> | |
| 9 <title>mcabber</title> | |
| 10 </head> | |
| 11 <body> | |
| 12 <div id="content"> | |
| 13 <h1>MCABBER(1) Manual Page</h1> | |
| 14 <h2>NAME</h2> | |
| 15 <p>mcabber - | |
| 16 a simple Jabber console client | |
| 17 </p> | |
| 18 <div id="synopsis"> | |
| 19 <h2>SYNOPSIS</h2> | |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
20 <p><b>mcabber</b> [ -f configfile ] [ --help | -h ]</p> |
| 229 | 21 </div> |
| 22 <h2>DESCRIPTION</h2> | |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
23 <p><tt>mcabber(1)</tt> is a small Jabber console client.<br /> |
| 229 | 24 For now it needs a configuration file to start, so please copy the sample |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
25 mcabberrc file and adapt your connection settings.</p> |
|
360
20283b69db99
Doc: Say a Jabber account should already exist for using mcabber
Mikael Berthe <mikael@lilotux.net>
parents:
345
diff
changeset
|
26 <p>You also need to have an existing Jabber account to use this software, as |
|
20283b69db99
Doc: Say a Jabber account should already exist for using mcabber
Mikael Berthe <mikael@lilotux.net>
parents:
345
diff
changeset
|
27 it cannot (un)register accounts yet.</p> |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
28 <p>The <tt>mcabber(1)</tt> screen is divided into 4 regions. |
| 229 | 29 The <b>roster</b>, alias <b>buddylist</b>, is on the left. The <b>chat window</b>, or chat |
| 30 buffer, is on the right. The <b>input line</b> lies at the bottom of the screen, | |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
31 under a small <b>log window</b>.</p> |
|
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
32 <p>To display buddies chat buffers, you will have to enter <b>chat mode</b>. |
| 229 | 33 You can enter chat mode by pressing enter, and leave chat mode with the ESC |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
34 key. Simply sending a message will also enable chat mode.</p> |
|
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
35 <p>Here are some of the features of <tt>mcabber</tt>:</p> |
| 229 | 36 <ul> |
| 37 <li> | |
| 38 <p> | |
| 39 <b>SSL support</b>. | |
| 40 </p> | |
| 41 </li> | |
| 42 <li> | |
| 43 <p> | |
| 467 | 44 <b>MUC support</b> (Multi-User Chat). |
| 45 </p> | |
| 46 </li> | |
| 47 <li> | |
| 48 <p> | |
| 229 | 49 <b>History logging:</b> If enabled (see the CONFIGURATION FILE section), |
| 432 | 50 <tt>mcabber</tt> can save discussions to history log files. |
| 229 | 51 </p> |
| 52 </li> | |
| 53 <li> | |
| 54 <p> | |
| 432 | 55 <b>Commands completion:</b> If possible, <tt>mcabber</tt> will try to complete your |
| 229 | 56 command line if you hit the Tab key. |
| 57 </p> | |
| 58 </li> | |
| 59 <li> | |
| 60 <p> | |
| 618 | 61 <b>Input line history:</b> Any message or command entered is in the input line |
| 62 history and can be reused easily. | |
| 63 </p> | |
| 64 </li> | |
| 65 <li> | |
| 66 <p> | |
| 229 | 67 <b>External actions:</b> Some events (like receiving a message) can trigger an |
| 68 external action, for example a shell script (you need to enable it in your | |
| 432 | 69 configuration file). A sample events script ("eventcmd") is provided with |
| 70 <tt>mcabber</tt> source code, in the contrib directory. | |
| 229 | 71 </p> |
| 72 </li> | |
| 73 </ul> | |
| 74 <h2>OPTIONS</h2> | |
| 75 <dl> | |
| 76 <dt><b> | |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
77 --help, -h |
| 229 | 78 </b></dt> |
| 79 <dd> | |
| 80 Quick help usage message | |
| 81 </dd> | |
| 82 <dt><b> | |
| 83 -f configfile | |
| 84 </b></dt> | |
| 85 <dd> | |
| 86 Use configuration file <b>configfile</b> | |
| 87 </dd> | |
| 88 </dl> | |
| 89 <h2>KEYS</h2> | |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
90 <p>Text typing occurs in the <b>input line</b>; basic operations are supported |
|
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
91 (left arrow, right arrow, home/end keys, insert, delete, backspace…).</p> |
|
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
92 <p>PageUp and PageDown keys are used to move in the roster.</p> |
| 618 | 93 <p>Up and Down arrow keys can be used to move in the input line history; they |
| 94 jump to the previous/next line from the history beginning with the same string | |
| 95 (from first column to the cursor column).</p> | |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
96 <p>To send a message, move to the choosen buddy in the buddylist, type your |
| 229 | 97 message and hit enter. If the line begins with a slash, this will be |
| 98 interpreted as a command (see the COMMAND section below). Hit escape to | |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
99 leave the chat mode.</p> |
|
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
100 <p>Here is a quick description of the key bindings:</p> |
| 229 | 101 <table class="hlist"> |
| 102 <tr valign="top"> | |
| 103 <td> | |
| 104 Ctrl-a | |
| 105 </td> | |
| 106 <td> | |
| 107 Go to the beginning of the input line | |
| 108 </td> | |
| 109 </tr> | |
| 110 <tr valign="top"> | |
| 111 <td> | |
| 112 Ctrl-e | |
| 113 </td> | |
| 114 <td> | |
| 115 Go to the end of the input line | |
| 116 </td> | |
| 117 </tr> | |
| 118 <tr valign="top"> | |
| 119 <td> | |
| 120 Ctrl-l | |
| 121 </td> | |
| 122 <td> | |
| 618 | 123 Force a refresh |
| 124 </td> | |
| 125 </tr> | |
| 126 <tr valign="top"> | |
| 127 <td> | |
| 128 Up/Down | |
| 129 </td> | |
| 130 <td> | |
| 131 Move in the input line history | |
| 229 | 132 </td> |
| 133 </tr> | |
| 134 <tr valign="top"> | |
| 135 <td> | |
| 136 PgUp/PgDown | |
| 137 </td> | |
| 138 <td> | |
| 139 Move inside the roster (buddylist) | |
| 140 </td> | |
| 141 </tr> | |
| 142 <tr valign="top"> | |
| 143 <td> | |
| 144 Tab | |
| 145 </td> | |
| 146 <td> | |
| 147 Complete current word, in the input line | |
| 148 </td> | |
| 149 </tr> | |
| 150 <tr valign="top"> | |
| 151 <td> | |
| 152 Ctrl-g | |
| 153 </td> | |
| 154 <td> | |
| 155 Cancel completion / ctrl-g | |
| 156 </td> | |
| 157 </tr> | |
| 158 <tr valign="top"> | |
| 159 <td> | |
| 160 Ctrl-p/Ctrl-n | |
| 161 </td> | |
| 162 <td> | |
| 163 Scroll up/down half a screen in the buffer window (chat mode) | |
| 164 </td> | |
| 165 </tr> | |
| 166 <tr valign="top"> | |
| 167 <td> | |
| 168 Ctrl-u | |
| 169 </td> | |
| 170 <td> | |
| 171 Delete from beginning of the line to the cursor | |
| 172 </td> | |
| 173 </tr> | |
| 174 <tr valign="top"> | |
| 175 <td> | |
| 176 Ctrl-k | |
| 177 </td> | |
| 178 <td> | |
| 179 Delete from the cursor to the end of line | |
| 180 </td> | |
| 181 </tr> | |
| 182 <tr valign="top"> | |
| 183 <td> | |
| 184 Ctrl-w | |
| 185 </td> | |
| 186 <td> | |
| 187 Backward kill word | |
| 188 </td> | |
| 189 </tr> | |
| 190 <tr valign="top"> | |
| 191 <td> | |
| 192 Ctrl-t | |
| 193 </td> | |
| 194 <td> | |
| 195 Transpose chars | |
| 196 </td> | |
| 197 </tr> | |
| 198 <tr valign="top"> | |
| 199 <td> | |
| 263 | 200 Ctrl-o |
| 201 </td> | |
| 202 <td> | |
| 203 Accept line and put the next history line in the input line (accept-line-and-down-history) | |
| 204 </td> | |
| 205 </tr> | |
| 206 <tr valign="top"> | |
| 207 <td> | |
| 229 | 208 Ctrl-q |
| 209 </td> | |
| 210 <td> | |
| 236 | 211 Jump to the next unread message |
| 229 | 212 </td> |
| 213 </tr> | |
| 214 </table> | |
| 215 <h2>COMMANDS</h2> | |
| 216 <dl> | |
| 217 <dt><b> | |
| 245 | 218 /add jid [nickname] |
| 229 | 219 </b></dt> |
| 220 <dd> | |
| 491 | 221 Add the "jid" Jabber user to our roster (default group), and send a |
| 245 | 222 notification request to this buddy. If no nickname is specified, the |
| 223 jid is used. | |
| 229 | 224 </dd> |
| 225 <dt><b> | |
|
286
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
226 /alias name = command line |
|
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
227 </b></dt> |
|
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
228 <dd> |
| 289 | 229 Add "name" as an alias for "command line".<br /> |
| 230 Aliases are expanded only once, thus they can not be chained.<br /> | |
| 231 "/alias name" displays the value associated with the "name" alias; | |
| 232 "/alias name =" unsets the "name" alias.<br /> | |
|
286
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
233 Example: "/alias away = status away". |
| 289 | 234 </dd> |
| 235 <dt><b> | |
| 618 | 236 /authorization allow|cancel|request [jid] |
| 237 </b></dt> | |
| 238 <dd> | |
| 239 Manage the presence subscriptions.<br /> | |
| 240 If no jid is provided, the current buddy is used. | |
| 241 <table class="hlist"> | |
| 242 <tr valign="top"> | |
| 243 <td> | |
| 244 <b>allow</b> | |
| 245 </td> | |
| 246 <td> | |
| 247 allow the buddy to receive your presence updates | |
| 248 </td> | |
| 249 </tr> | |
| 250 <tr valign="top"> | |
| 251 <td> | |
| 252 <b>cancel</b> | |
| 253 </td> | |
| 254 <td> | |
| 255 cancel the buddy' subscription to your presence updates | |
| 256 </td> | |
| 257 </tr> | |
| 258 <tr valign="top"> | |
| 259 <td> | |
| 260 <b>request</b> | |
| 261 </td> | |
| 262 <td> | |
| 263 request a subscription to the buddy's presence updates | |
| 264 </td> | |
| 265 </tr> | |
| 266 </table> | |
| 267 </dd> | |
| 268 <dt><b> | |
| 289 | 269 /bind keycode = command line |
| 270 </b></dt> | |
| 271 <dd> | |
| 272 Bind a command line to the key with the "keycode" code number.<br /> | |
| 432 | 273 Keycodes of unused keys are displayed by <tt>mcabber</tt> in the log window |
| 289 | 274 when pressing the key, for example "Unknown key=265".<br /> |
| 275 "/bind keycode" displays the command line bound to the given keycode; | |
| 276 "/bind keycode" unbinds the given keycode.<br /> | |
| 277 Note: aliases can be used in key bindings.<br /> | |
| 450 | 278 Example: "/bind 265 = status online" (265 is F1 for me, but it may |
| 289 | 279 depend on your ncurses installation). |
|
286
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
280 </dd> |
|
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
281 <dt><b> |
| 618 | 282 /buffer clear|top|bottom|date|%|search_backward|search_forward |
| 229 | 283 </b></dt> |
| 284 <dd> | |
| 285 The <b>buffer</b> command manipulates the current buddy's buffer | |
| 286 (chat window). | |
| 287 <table class="hlist"> | |
| 288 <tr valign="top"> | |
| 289 <td> | |
| 290 <b>clear</b> | |
| 291 </td> | |
| 292 <td> | |
| 293 clear the current buddy chat window | |
| 294 </td> | |
| 295 </tr> | |
| 296 <tr valign="top"> | |
| 297 <td> | |
| 511 | 298 <b>bottom</b> |
| 299 </td> | |
| 300 <td> | |
| 301 jump to the bottom of the current buddy chat buffer | |
| 302 </td> | |
| 303 </tr> | |
| 304 <tr valign="top"> | |
| 305 <td> | |
| 229 | 306 <b>top</b> |
| 307 </td> | |
| 308 <td> | |
| 309 jump to the top of the current buddy chat buffer | |
| 310 </td> | |
| 311 </tr> | |
| 312 <tr valign="top"> | |
| 313 <td> | |
| 511 | 314 <b>up</b> [n] |
| 229 | 315 </td> |
| 316 <td> | |
| 511 | 317 scroll the buffer up n lines (default: half a screen) |
| 318 </td> | |
| 319 </tr> | |
| 320 <tr valign="top"> | |
| 321 <td> | |
| 322 <b>down</b> [n] | |
| 323 </td> | |
| 324 <td> | |
| 325 scroll the buffer down n lines (default: half a screen) | |
| 229 | 326 </td> |
| 327 </tr> | |
|
372
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
328 <tr valign="top"> |
|
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
329 <td> |
| 618 | 330 <b>date</b> date |
| 331 </td> | |
| 332 <td> | |
| 333 jump to the first line after the specified date in the chat buffer (date format: "YYYY-mm-dd[THH:MM:SS]", "-" and ":" are optional) | |
| 334 </td> | |
| 335 </tr> | |
| 336 <tr valign="top"> | |
| 337 <td> | |
| 338 <b>%</b> n | |
| 339 </td> | |
| 340 <td> | |
| 341 jump to position %n of the buddy chat buffer | |
| 342 </td> | |
| 343 </tr> | |
| 344 <tr valign="top"> | |
| 345 <td> | |
|
372
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
346 <b>search_backward</b> text |
|
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
347 </td> |
|
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
348 <td> |
| 491 | 349 search for "text" in the current buddy chat buffer |
|
372
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
350 </td> |
|
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
351 </tr> |
|
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
352 <tr valign="top"> |
|
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
353 <td> |
|
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
354 <b>search_forward</b> text |
|
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
355 </td> |
|
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
356 <td> |
| 491 | 357 search for "text" in the current buddy chat buffer |
|
372
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
358 </td> |
|
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
359 </tr> |
| 229 | 360 </table> |
| 361 </dd> | |
| 362 <dt><b> | |
| 363 /clear | |
| 364 </b></dt> | |
| 365 <dd> | |
| 366 The <b>clear</b> command is actually an alias for "/buffer clear". | |
| 367 </dd> | |
| 368 <dt><b> | |
|
298
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
369 /connect |
|
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
370 </b></dt> |
|
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
371 <dd> |
|
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
372 Establish connection to the Jabber server. |
|
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
373 </dd> |
|
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
374 <dt><b> |
| 229 | 375 /del |
| 376 </b></dt> | |
| 377 <dd> | |
| 378 Delete the current buddy from our roster, unsubscribe from its presence | |
| 379 notification and unsubscribe it from ours. | |
| 380 </dd> | |
| 381 <dt><b> | |
|
298
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
382 /disconnect |
|
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
383 </b></dt> |
|
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
384 <dd> |
|
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
385 Terminate connection to the Jabber server. Note: the roster is only |
|
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
386 available when the connection to the server is active, so the |
|
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
387 buddylist is empty when disconnected. |
|
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
388 </dd> |
|
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
389 <dt><b> |
| 240 | 390 /group fold|unfold|toggle |
| 229 | 391 </b></dt> |
| 392 <dd> | |
| 240 | 393 The <b>group</b> command changes the current group display. |
| 229 | 394 <table class="hlist"> |
| 395 <tr valign="top"> | |
| 396 <td> | |
| 240 | 397 <b>fold</b> |
| 229 | 398 </td> |
| 399 <td> | |
| 240 | 400 fold (shrink) the current group tree in the roster |
| 229 | 401 </td> |
| 402 </tr> | |
| 403 <tr valign="top"> | |
| 404 <td> | |
| 240 | 405 <b>unfold</b> |
| 229 | 406 </td> |
| 407 <td> | |
| 240 | 408 unfold (expand) the current group tree in the roster |
| 229 | 409 </td> |
| 410 </tr> | |
| 411 <tr valign="top"> | |
| 412 <td> | |
| 413 <b>toggle</b> | |
| 414 </td> | |
| 415 <td> | |
| 240 | 416 toggle the state (fold/unfold) of the current tree |
| 229 | 417 </td> |
| 418 </tr> | |
| 419 </table> | |
| 420 </dd> | |
| 421 <dt><b> | |
| 422 /info | |
| 423 </b></dt> | |
| 424 <dd> | |
|
440
264f40222872
Update documentation (/info command)
Mikael Berthe <mikael@lilotux.net>
parents:
436
diff
changeset
|
425 Display info on the selected entry (user, agent, group…).<br /> |
|
264f40222872
Update documentation (/info command)
Mikael Berthe <mikael@lilotux.net>
parents:
436
diff
changeset
|
426 For users, resources are displayed with the status, priority and |
|
264f40222872
Update documentation (/info command)
Mikael Berthe <mikael@lilotux.net>
parents:
436
diff
changeset
|
427 status message (if available) of each resource. |
| 229 | 428 </dd> |
| 429 <dt><b> | |
| 430 /move [groupname] | |
| 431 </b></dt> | |
| 432 <dd> | |
| 433 Move the current buddy to the requested group. If no group is | |
| 623 | 434 specified, then the buddy is moved to the default group.<br /> |
|
506
74dcd0df532e
"/move" does not jump to the buddy in the new group
Mikael Berthe <mikael@lilotux.net>
parents:
495
diff
changeset
|
435 Tip: if the chatmode is enabled, you can use "/roster alternate" |
|
74dcd0df532e
"/move" does not jump to the buddy in the new group
Mikael Berthe <mikael@lilotux.net>
parents:
495
diff
changeset
|
436 to jump to the moved buddy. |
| 229 | 437 </dd> |
| 438 <dt><b> | |
| 637 | 439 /msay begin|verbatim|send|send_to|abort |
| 238 | 440 </b></dt> |
| 441 <dd> | |
| 442 Send a multi-line message. To write a single message with several | |
| 289 | 443 lines, the <b>multi-line mode</b> should be used.<br /> |
| 444 In multi-line mode, each line (except command lines) typed in the input | |
| 445 line will be added to the multi-line message. Once the message is | |
| 450 | 446 finished, it can be sent to the current selected buddy with the "/msay |
| 447 send" command.<br /> | |
| 289 | 448 The <b>verbatim</b> multi-line mode disables commands, so that it is |
| 449 possible to enter lines starting with a slash. Only the "/msay" | |
| 450 command (with send or abort parameters) can be used to exit verbatim | |
| 451 mode. | |
| 238 | 452 <table class="hlist"> |
| 453 <tr valign="top"> | |
| 454 <td> | |
| 455 <b>begin</b> | |
| 456 </td> | |
| 457 <td> | |
| 458 enter multi-line mode | |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
459 </td> |
|
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
460 </tr> |
|
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
461 <tr valign="top"> |
|
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
462 <td> |
|
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
463 <b>verbatim</b> |
|
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
464 </td> |
|
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
465 <td> |
|
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
466 enter verbatim multi-line mode |
| 238 | 467 </td> |
| 468 </tr> | |
| 469 <tr valign="top"> | |
| 470 <td> | |
| 471 <b>send</b> | |
| 472 </td> | |
| 473 <td> | |
| 474 send the current multi-line message to the currently selected buddy | |
| 475 </td> | |
| 476 </tr> | |
| 477 <tr valign="top"> | |
| 478 <td> | |
| 637 | 479 <b>send_to</b> jid |
| 480 </td> | |
| 481 <td> | |
| 482 send the current multi-line message to "jid" | |
| 483 </td> | |
| 484 </tr> | |
| 485 <tr valign="top"> | |
| 486 <td> | |
| 238 | 487 <b>abort</b> |
| 488 </td> | |
| 489 <td> | |
| 490 leave multi-line mode without sending the message | |
| 491 </td> | |
| 492 </tr> | |
| 493 </table> | |
| 494 </dd> | |
| 495 <dt><b> | |
| 229 | 496 /quit |
| 497 </b></dt> | |
| 498 <dd> | |
| 499 Disconnect and leave <tt>mcabber(1)</tt>. | |
| 500 </dd> | |
| 501 <dt><b> | |
| 436 | 502 /rawxml send |
| 503 </b></dt> | |
| 504 <dd> | |
| 505 <b>send</b> string: send string (raw XML format) to the Jabber server. No check is done on the string provided. BEWARE! Use this only if you know what you are doing, or you could terminate the connection. | |
| 506 </dd> | |
| 507 <dt><b> | |
| 229 | 508 /rename nickname |
| 509 </b></dt> | |
| 510 <dd> | |
| 511 Rename current buddy to the given nickname. | |
| 512 This command does not work for groups, at the moment (but you can move | |
| 450 | 513 the buddies to another group with the "/move" command). |
| 514 </dd> | |
| 515 <dt><b> | |
| 601 | 516 /room join|leave|names|nick|privmsg|remove|topic|unlock|destroy |
| 573 | 517 </b></dt> |
| 518 <dt><b> | |
| 593 | 519 /room invite|kick|ban|role|affil |
| 450 | 520 </b></dt> |
| 521 <dd> | |
| 522 The <b>room</b> command handles Multi-User Chat room actions. | |
| 523 <table class="hlist"> | |
| 524 <tr valign="top"> | |
| 525 <td> | |
| 526 <b>join</b> room nick | |
| 527 </td> | |
| 528 <td> | |
| 529 join "room", using "nick" as nickname | |
| 530 </td> | |
| 531 </tr> | |
| 532 <tr valign="top"> | |
| 533 <td> | |
| 487 | 534 <b>leave</b> [message] |
| 450 | 535 </td> |
| 536 <td> | |
| 537 leave the current room | |
| 538 </td> | |
| 539 </tr> | |
| 540 <tr valign="top"> | |
| 541 <td> | |
| 542 <b>names</b> | |
| 543 </td> | |
| 544 <td> | |
| 545 display members of the current room | |
| 546 </td> | |
| 547 </tr> | |
| 548 <tr valign="top"> | |
| 549 <td> | |
| 470 | 550 <b>nick</b> nick |
| 551 </td> | |
| 552 <td> | |
| 553 change your nickname in the current room | |
| 554 </td> | |
| 555 </tr> | |
| 556 <tr valign="top"> | |
| 557 <td> | |
| 491 | 558 <b>privmsg</b> nick msg |
| 559 </td> | |
| 560 <td> | |
| 561 send private message "msg" to "nick" | |
| 562 </td> | |
| 563 </tr> | |
| 564 <tr valign="top"> | |
| 565 <td> | |
| 450 | 566 <b>remove</b> |
| 567 </td> | |
| 568 <td> | |
| 467 | 569 remove the current room from the roster (you must have left this room before) |
| 570 </td> | |
| 571 </tr> | |
| 572 <tr valign="top"> | |
| 573 <td> | |
|
475
fa49ac0bb8f3
Add "/room topic", and display topic changes
Mikael Berthe <mikael@lilotux.net>
parents:
470
diff
changeset
|
574 <b>topic</b> |
|
fa49ac0bb8f3
Add "/room topic", and display topic changes
Mikael Berthe <mikael@lilotux.net>
parents:
470
diff
changeset
|
575 </td> |
|
fa49ac0bb8f3
Add "/room topic", and display topic changes
Mikael Berthe <mikael@lilotux.net>
parents:
470
diff
changeset
|
576 <td> |
|
fa49ac0bb8f3
Add "/room topic", and display topic changes
Mikael Berthe <mikael@lilotux.net>
parents:
470
diff
changeset
|
577 set topic for current room |
|
fa49ac0bb8f3
Add "/room topic", and display topic changes
Mikael Berthe <mikael@lilotux.net>
parents:
470
diff
changeset
|
578 </td> |
|
fa49ac0bb8f3
Add "/room topic", and display topic changes
Mikael Berthe <mikael@lilotux.net>
parents:
470
diff
changeset
|
579 </tr> |
|
fa49ac0bb8f3
Add "/room topic", and display topic changes
Mikael Berthe <mikael@lilotux.net>
parents:
470
diff
changeset
|
580 <tr valign="top"> |
|
fa49ac0bb8f3
Add "/room topic", and display topic changes
Mikael Berthe <mikael@lilotux.net>
parents:
470
diff
changeset
|
581 <td> |
| 467 | 582 <b>unlock</b> |
| 583 </td> | |
| 584 <td> | |
| 585 unlock current room (if you are the owner) | |
| 450 | 586 </td> |
| 587 </tr> | |
| 573 | 588 <tr valign="top"> |
| 589 <td> | |
| 601 | 590 <b>destroy</b> [reason] |
| 591 </td> | |
| 592 <td> | |
| 593 destroy the current room (use with care!) | |
| 594 </td> | |
| 595 </tr> | |
| 596 <tr valign="top"> | |
| 597 <td> | |
| 573 | 598 <b>whois</b> nick |
| 599 </td> | |
| 600 <td> | |
| 601 display MUC information about "nick" | |
| 602 </td> | |
| 603 </tr> | |
| 593 | 604 <tr valign="top"> |
| 605 <td> | |
| 606 <b>ban</b> jid [reason] | |
| 607 </td> | |
| 608 <td> | |
| 609 ban jid from the current room | |
| 610 </td> | |
| 611 </tr> | |
| 612 <tr valign="top"> | |
| 613 <td> | |
| 614 <b>invite</b> jid [reason] | |
| 615 </td> | |
| 616 <td> | |
| 617 invite jid to the current room | |
| 618 </td> | |
| 619 </tr> | |
| 620 <tr valign="top"> | |
| 621 <td> | |
| 622 <b>kick</b> nick [reason] | |
| 623 </td> | |
| 624 <td> | |
| 625 kick "nick" from the current room | |
| 626 </td> | |
| 627 </tr> | |
| 628 <tr valign="top"> | |
| 629 <td> | |
| 630 <b>role</b> jid role [reason] | |
| 631 </td> | |
| 632 <td> | |
| 633 change jid's role (role can be "none", "visitor", "participant", "moderator") | |
| 634 </td> | |
| 635 </tr> | |
| 636 <tr valign="top"> | |
| 637 <td> | |
| 638 <b>affil</b> jid affil [reason] | |
| 639 </td> | |
| 640 <td> | |
| 641 change jid's affiliation (affil can be "none", "member", "admin", "owner") | |
| 642 </td> | |
| 643 </tr> | |
| 450 | 644 </table> |
| 229 | 645 </dd> |
| 646 <dt><b> | |
|
360
20283b69db99
Doc: Say a Jabber account should already exist for using mcabber
Mikael Berthe <mikael@lilotux.net>
parents:
345
diff
changeset
|
647 /roster bottom|top|hide_offline|show_offline|toggle_offline |
|
20283b69db99
Doc: Say a Jabber account should already exist for using mcabber
Mikael Berthe <mikael@lilotux.net>
parents:
345
diff
changeset
|
648 </b></dt> |
|
20283b69db99
Doc: Say a Jabber account should already exist for using mcabber
Mikael Berthe <mikael@lilotux.net>
parents:
345
diff
changeset
|
649 <dt><b> |
|
20283b69db99
Doc: Say a Jabber account should already exist for using mcabber
Mikael Berthe <mikael@lilotux.net>
parents:
345
diff
changeset
|
650 /roster alternate|unread_first|unread_next |
| 265 | 651 </b></dt> |
| 652 <dt><b> | |
| 653 /roster search bud | |
| 229 | 654 </b></dt> |
| 655 <dd> | |
| 265 | 656 The <b>roster</b> command manipulates the roster/buddylist. Here are the available parameters: |
| 229 | 657 <table class="hlist"> |
| 658 <tr valign="top"> | |
| 659 <td> | |
| 265 | 660 <b>bottom</b> |
| 661 </td> | |
| 662 <td> | |
| 663 jump to the bottom of the roster | |
| 664 </td> | |
| 665 </tr> | |
| 666 <tr valign="top"> | |
| 667 <td> | |
| 668 <b>top</b> | |
| 669 </td> | |
| 670 <td> | |
| 671 jump to the top of the roster | |
| 672 </td> | |
| 673 </tr> | |
| 674 <tr valign="top"> | |
| 675 <td> | |
|
377
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
676 <b>up</b> |
|
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
677 </td> |
|
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
678 <td> |
|
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
679 move up in the roster |
|
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
680 </td> |
|
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
681 </tr> |
|
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
682 <tr valign="top"> |
|
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
683 <td> |
|
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
684 <b>down</b> |
|
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
685 </td> |
|
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
686 <td> |
|
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
687 move down in the roster |
|
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
688 </td> |
|
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
689 </tr> |
|
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
690 <tr valign="top"> |
|
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
691 <td> |
| 229 | 692 <b>hide_offline</b> |
| 693 </td> | |
| 694 <td> | |
| 695 hide offline buddies | |
| 696 </td> | |
| 697 </tr> | |
| 698 <tr valign="top"> | |
| 699 <td> | |
| 700 <b>show_offline</b> | |
| 701 </td> | |
| 702 <td> | |
| 703 show offline buddies | |
| 704 </td> | |
| 705 </tr> | |
| 706 <tr valign="top"> | |
| 707 <td> | |
|
290
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
708 <b>toggle_offline</b> |
|
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
709 </td> |
|
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
710 <td> |
|
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
711 toggle display of offline buddies |
|
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
712 </td> |
|
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
713 </tr> |
|
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
714 <tr valign="top"> |
|
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
715 <td> |
| 265 | 716 <b>search</b> bud |
| 229 | 717 </td> |
| 718 <td> | |
| 265 | 719 search for a buddy with a name or buddy containing "bud" (only in the displayed buddylist) |
| 229 | 720 </td> |
| 721 </tr> | |
| 236 | 722 <tr valign="top"> |
| 723 <td> | |
| 330 | 724 <b>alternate</b> |
| 725 </td> | |
| 726 <td> | |
| 727 jump to alternate buddy. The "alternate" buddy is the last buddy left while being in chat mode (this command is thus especially useful after commands like "/roster unread_first") | |
| 728 </td> | |
| 729 </tr> | |
| 730 <tr valign="top"> | |
| 731 <td> | |
| 236 | 732 <b>unread_first</b> |
| 733 </td> | |
| 734 <td> | |
| 735 jump to the first unread message | |
| 736 </td> | |
| 737 </tr> | |
| 738 <tr valign="top"> | |
| 739 <td> | |
| 740 <b>unread_next</b> | |
| 741 </td> | |
| 742 <td> | |
| 743 jump to the next unread message | |
| 744 </td> | |
| 745 </tr> | |
| 229 | 746 </table> |
| 747 </dd> | |
| 748 <dt><b> | |
| 749 /say text | |
| 750 </b></dt> | |
| 751 <dd> | |
| 491 | 752 Send the "text" message to the currently selected buddy. Can be useful |
| 229 | 753 if you want to send a message beginning with a slash, for example. |
| 754 </dd> | |
| 755 <dt><b> | |
| 480 | 756 /say_to jid text |
| 757 </b></dt> | |
| 758 <dd> | |
| 491 | 759 Send the "text" message to the specified jid. |
| 480 | 760 Please note that this command doesn't set the default resource for |
| 761 a contact, so if you want to send several messages to a specific | |
| 762 ressource you will have to use "/say_to" for each message. | |
| 763 </dd> | |
| 764 <dt><b> | |
| 522 | 765 /status [online|avail|invisible|free|dnd|notavail|away [-|StatusMessage]] |
| 229 | 766 </b></dt> |
| 767 <dd> | |
| 522 | 768 Show or set the current status.<br /> |
| 769 If no status is specified, display the current status.<br /> | |
|
320
dce1dd4d0ca8
Update documentation for "/status status message"
Mikael Berthe <mikael@lilotux.net>
parents:
305
diff
changeset
|
770 If a status message is specified, it will overrride the message* |
| 522 | 771 variables (these variables can be set in the configuration file). |
| 772 If no relevant message* variable is set and no status message provided, | |
| 773 the current status message is kept. If StatusMessage is "-", the | |
| 774 current status message is cleared. | |
| 229 | 775 </dd> |
| 450 | 776 <dt><b> |
| 777 /status_to jid online|avail|invisible|free|dnd|notavail|away [StatusMessage] | |
| 778 </b></dt> | |
| 779 <dd> | |
| 780 Send the requested status to the specified Jabber user.<br /> | |
| 781 Note: this status will be overridden by subsequent "/status" commands. | |
| 782 If you are using the auto-away feature, the status will overridden | |
| 783 too.<br /> | |
| 784 Note: The jid can include a resource (i.e. user@server/resource). | |
| 785 </dd> | |
| 623 | 786 <dt><b> |
| 787 /version | |
| 788 </b></dt> | |
| 789 <dd> | |
| 790 Display mcabber version | |
| 791 </dd> | |
| 229 | 792 </dl> |
| 793 <h2>CONFIGURATION FILE</h2> | |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
794 <p>See the provided sample configuration file, which should be self-documented.</p> |
| 229 | 795 <h2>FILES</h2> |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
796 <p>The following files can be used by <tt>mcabber(1)</tt>:</p> |
|
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
797 <div class="literalparagraph"><pre>$HOME/.mcabber/mcabberrc Default configuration file |
| 229 | 798 $HOME/.mcabberrc Configuration file used if no other has been found |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
799 $HOME/.mcabber/histo/ Default directory for storing chat history files, if enabled</pre></div> |
| 229 | 800 <h2>BUGS</h2> |
|
360
20283b69db99
Doc: Say a Jabber account should already exist for using mcabber
Mikael Berthe <mikael@lilotux.net>
parents:
345
diff
changeset
|
801 <p>Certainly. Please tell me if you find one! :-)</p> |
| 229 | 802 <h2>AUTHOR</h2> |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
803 <p>Written by <a href="mailto:mcabber@lilotux.net">Mikael BERTHE</a>.<br /> |
| 229 | 804 Originally based on <a href="http://cabber.sourceforge.net">Cabber</a>, please |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
805 consult the AUTHORS file for details.</p> |
| 229 | 806 <h2>RESOURCES</h2> |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
807 <p><a href="http://www.lilotux.net/~mikael/mcabber/">Main web site</a></p> |
| 229 | 808 <h2>COPYING</h2> |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
809 <p>Copyright © 2005 Mikael Berthe.<br /> |
|
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
810 Some portions are Copyright © 2002-2004 <a href="mailto:cabber@ajmacias.com">cabber@ajmacias.com</a>.</p> |
|
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
811 <p>Free use of this software is granted under the terms of the GNU General Public |
|
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
812 License (GPL).</p> |
| 229 | 813 <div id="footer"> |
| 814 <p> | |
| 637 | 815 Version 0.7.3-dev<br /> |
| 816 Last updated 26-Dec-2005 19:35:42 CEST | |
| 229 | 817 </p> |
| 818 </div> | |
| 819 </div> | |
| 820 </body> | |
| 821 </html> |