Mercurial > ~mikael > mcabber > hg
annotate mcabber/doc/mcabber.1.html @ 1131:73e6ca0a03a9
Un-hardcode Ctrl-q binding, it can be done in the config. file
| author | Mikael Berthe <mikael@lilotux.net> |
|---|---|
| date | Sun, 21 Jan 2007 15:31:34 +0100 |
| parents | f64af9258f3c |
| children | 104676e3389b |
| 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" /> | |
| 799 | 5 <meta name="generator" content="AsciiDoc 7.1.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>Here are some of the features of <tt>mcabber</tt>:</p> |
| 229 | 29 <ul> |
| 30 <li> | |
| 31 <p> | |
| 32 <b>SSL support</b>. | |
| 33 </p> | |
| 34 </li> | |
| 35 <li> | |
| 36 <p> | |
| 467 | 37 <b>MUC support</b> (Multi-User Chat). |
| 38 </p> | |
| 39 </li> | |
| 40 <li> | |
| 41 <p> | |
| 1096 | 42 <b>PGP support</b> |
| 43 </p> | |
| 44 </li> | |
| 45 <li> | |
| 46 <p> | |
| 47 <b>Chat States</b> support (typing notifications) | |
| 48 </p> | |
| 49 </li> | |
| 50 <li> | |
| 51 <p> | |
| 229 | 52 <b>History logging:</b> If enabled (see the CONFIGURATION FILE section), |
| 432 | 53 <tt>mcabber</tt> can save discussions to history log files. |
| 229 | 54 </p> |
| 55 </li> | |
| 56 <li> | |
| 57 <p> | |
| 432 | 58 <b>Commands completion:</b> If possible, <tt>mcabber</tt> will try to complete your |
| 229 | 59 command line if you hit the Tab key. |
| 60 </p> | |
| 61 </li> | |
| 62 <li> | |
| 63 <p> | |
| 618 | 64 <b>Input line history:</b> Any message or command entered is in the input line |
| 65 history and can be reused easily. | |
| 66 </p> | |
| 67 </li> | |
| 68 <li> | |
| 69 <p> | |
| 229 | 70 <b>External actions:</b> Some events (like receiving a message) can trigger an |
| 854 | 71 external action such as a shell script if you enable it in your |
| 72 configuration file. A sample events script ("eventcmd") is provided with | |
| 432 | 73 <tt>mcabber</tt> source code, in the contrib directory. |
| 229 | 74 </p> |
| 75 </li> | |
| 76 </ul> | |
| 77 <h2>OPTIONS</h2> | |
| 78 <dl> | |
| 79 <dt><b> | |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
80 --help, -h |
| 229 | 81 </b></dt> |
| 82 <dd> | |
| 83 Quick help usage message | |
| 84 </dd> | |
| 85 <dt><b> | |
| 86 -f configfile | |
| 87 </b></dt> | |
| 88 <dd> | |
| 89 Use configuration file <b>configfile</b> | |
| 90 </dd> | |
| 91 </dl> | |
| 854 | 92 <h2>WINDOWS/PANES</h2> |
| 93 <p>The <tt>mcabber(1)</tt> screen is divided into 4 regions. | |
| 94 The <b>roster</b>, alias <b>buddylist</b>, is on the left. The <b>chat window</b>, or chat | |
| 95 buffer, is on the right. The <b>input line</b> lies at the bottom of the screen, | |
| 96 under a small <b>log window</b>.</p> | |
| 97 <p>Two status lines surround the log window. The bottom status line is the | |
| 98 "main status line" and reflects mcabber general status. The other line | |
| 99 is the "chat status line" and shows the status of the currently selected | |
| 100 buddy.</p> | |
| 101 <p>To display buddies chat buffers, you will have to enter <b>chat mode</b>. | |
| 102 You can enter chat mode by pressing enter, and leave chat mode with the ESC | |
| 103 key. Simply sending a message will also enable chat mode.</p> | |
| 104 <p>There are several advantages to the two-mode implementation: first, it allows | |
| 105 accurate "unread" message functionality, as described in the next section; | |
| 106 without this, merely scrolling to a specific buddy will "read" the new | |
| 107 messages of all buddies in-between. Second, it allows quickly hiding the | |
| 108 conversation with a single keystroke. Third, it allows jumping between | |
| 109 the few buddies with whom you are conversing with the <b>/roster alternate</b> | |
| 110 command described in another section, without having to manually scroll | |
| 111 back and forth.</p> | |
| 229 | 112 <h2>KEYS</h2> |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
113 <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
|
114 (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
|
115 <p>PageUp and PageDown keys are used to move in the roster.</p> |
| 618 | 116 <p>Up and Down arrow keys can be used to move in the input line history; they |
| 117 jump to the previous/next line from the history beginning with the same string | |
| 118 (from first column to the cursor column).</p> | |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
119 <p>To send a message, move to the choosen buddy in the buddylist, type your |
| 229 | 120 message and hit enter. If the line begins with a slash, this will be |
| 121 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
|
122 leave the chat mode.</p> |
|
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
123 <p>Here is a quick description of the key bindings:</p> |
| 229 | 124 <table class="hlist"> |
| 125 <tr valign="top"> | |
| 126 <td> | |
| 1096 | 127 Esc |
| 128 </td> | |
| 129 <td> | |
| 130 Disable chat mode | |
| 131 </td> | |
| 132 </tr> | |
| 133 <tr valign="top"> | |
| 134 <td> | |
| 229 | 135 Ctrl-a |
| 136 </td> | |
| 137 <td> | |
| 138 Go to the beginning of the input line | |
| 139 </td> | |
| 140 </tr> | |
| 141 <tr valign="top"> | |
| 142 <td> | |
| 143 Ctrl-e | |
| 144 </td> | |
| 145 <td> | |
| 146 Go to the end of the input line | |
| 147 </td> | |
| 148 </tr> | |
| 149 <tr valign="top"> | |
| 150 <td> | |
| 151 Ctrl-l | |
| 152 </td> | |
| 153 <td> | |
| 618 | 154 Force a refresh |
| 155 </td> | |
| 156 </tr> | |
| 157 <tr valign="top"> | |
| 158 <td> | |
| 159 Up/Down | |
| 160 </td> | |
| 161 <td> | |
| 162 Move in the input line history | |
| 229 | 163 </td> |
| 164 </tr> | |
| 165 <tr valign="top"> | |
| 166 <td> | |
| 167 PgUp/PgDown | |
| 168 </td> | |
| 169 <td> | |
| 170 Move inside the roster (buddylist) | |
| 171 </td> | |
| 172 </tr> | |
| 173 <tr valign="top"> | |
| 174 <td> | |
| 175 Tab | |
| 176 </td> | |
| 177 <td> | |
| 178 Complete current word, in the input line | |
| 179 </td> | |
| 180 </tr> | |
| 181 <tr valign="top"> | |
| 182 <td> | |
| 183 Ctrl-g | |
| 184 </td> | |
| 185 <td> | |
| 1096 | 186 Cancel completion |
| 187 </td> | |
| 188 </tr> | |
| 189 <tr valign="top"> | |
| 190 <td> | |
| 191 Ctrl-c | |
| 192 </td> | |
| 193 <td> | |
| 194 Abort multi-line messages and completions | |
| 195 </td> | |
| 196 </tr> | |
| 197 <tr valign="top"> | |
| 198 <td> | |
| 199 Ctrl-d | |
| 200 </td> | |
| 201 <td> | |
| 202 Send/terminate a multi-line message | |
| 229 | 203 </td> |
| 204 </tr> | |
| 205 <tr valign="top"> | |
| 206 <td> | |
| 207 Ctrl-p/Ctrl-n | |
| 208 </td> | |
| 209 <td> | |
| 210 Scroll up/down half a screen in the buffer window (chat mode) | |
| 211 </td> | |
| 212 </tr> | |
| 213 <tr valign="top"> | |
| 214 <td> | |
|
775
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
215 Ctrl-Left |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
216 </td> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
217 <td> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
218 Move the cursor back to the start of the current or previous word |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
219 </td> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
220 </tr> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
221 <tr valign="top"> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
222 <td> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
223 Ctrl-Right |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
224 </td> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
225 <td> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
226 Move the cursor forward to the end of the current or next word |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
227 </td> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
228 </tr> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
229 <tr valign="top"> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
230 <td> |
| 229 | 231 Ctrl-u |
| 232 </td> | |
| 233 <td> | |
| 234 Delete from beginning of the line to the cursor | |
| 235 </td> | |
| 236 </tr> | |
| 237 <tr valign="top"> | |
| 238 <td> | |
| 239 Ctrl-k | |
| 240 </td> | |
| 241 <td> | |
| 242 Delete from the cursor to the end of line | |
| 243 </td> | |
| 244 </tr> | |
| 245 <tr valign="top"> | |
| 246 <td> | |
| 247 Ctrl-w | |
| 248 </td> | |
| 249 <td> | |
| 250 Backward kill word | |
| 251 </td> | |
| 252 </tr> | |
| 253 <tr valign="top"> | |
| 254 <td> | |
| 255 Ctrl-t | |
| 256 </td> | |
| 257 <td> | |
| 258 Transpose chars | |
| 259 </td> | |
| 260 </tr> | |
| 261 <tr valign="top"> | |
| 262 <td> | |
| 263 | 263 Ctrl-o |
| 264 </td> | |
| 265 <td> | |
| 266 Accept line and put the next history line in the input line (accept-line-and-down-history) | |
| 267 </td> | |
| 268 </tr> | |
| 229 | 269 </table> |
| 1096 | 270 <p>Additional key bindings may be specified using the <b>/bind</b> command described |
| 854 | 271 in the COMMANDS section.</p> |
| 272 <h2>MCABBER'S ROSTER</h2> | |
| 273 <p>The first listed resource on the roster is <b>[status]</b>, which keeps a log of | |
| 274 everything that appears in the short log window below the main chat area. | |
| 275 While the log window was designed for showing the latest few elements, the | |
| 276 dedicated <b>[status]</b> buffer allows more comfortable viewing of the log, as | |
| 277 well as scrolling it in a standard manner.</p> | |
| 278 <p>Group names are displayed above the resources that are within them, and are | |
| 279 indicated by <b>---</b> to the left of the name.</p> | |
| 280 <p>For every real Jabber resource, the roster displays four pieces of information: | |
| 281 the resource's name or alias, its online status, its authorization status, and | |
| 282 whether there are unread messages from the resource waiting for you.</p> | |
| 283 <p>The online status is one of the following:</p> | |
| 284 <table class="hlist"> | |
| 285 <tr valign="top"> | |
| 286 <td> | |
| 287 <b>o</b> | |
| 288 </td> | |
| 289 <td> | |
| 290 online | |
| 291 </td> | |
| 292 </tr> | |
| 293 <tr valign="top"> | |
| 294 <td> | |
| 295 <b>f</b> | |
| 296 </td> | |
| 297 <td> | |
| 298 free for chat | |
| 299 </td> | |
| 300 </tr> | |
| 301 <tr valign="top"> | |
| 302 <td> | |
| 303 <b>a</b> | |
| 304 </td> | |
| 305 <td> | |
| 306 away | |
| 307 </td> | |
| 308 </tr> | |
| 309 <tr valign="top"> | |
| 310 <td> | |
| 311 <b>n</b> | |
| 312 </td> | |
| 313 <td> | |
| 314 not available (labeled <b>extended away</b> in some clients) | |
| 315 </td> | |
| 316 </tr> | |
| 317 <tr valign="top"> | |
| 318 <td> | |
| 319 <b>d</b> | |
| 320 </td> | |
| 321 <td> | |
| 322 do not disturb | |
| 323 </td> | |
| 324 </tr> | |
| 325 <tr valign="top"> | |
| 326 <td> | |
| 327 <b>i</b> | |
| 328 </td> | |
| 329 <td> | |
| 330 invisible (displayed only for your resource) | |
| 331 </td> | |
| 332 </tr> | |
| 333 <tr valign="top"> | |
| 334 <td> | |
| 335 <b>_</b> | |
| 336 </td> | |
| 337 <td> | |
| 338 offline (or invisible to you) | |
| 339 </td> | |
| 340 </tr> | |
| 341 <tr valign="top"> | |
| 342 <td> | |
| 343 <b>?</b> | |
| 344 </td> | |
| 345 <td> | |
| 346 unknown, usually meaning you are not authorized to see this resource's status | |
| 347 </td> | |
| 348 </tr> | |
| 349 <tr valign="top"> | |
| 350 <td> | |
| 351 <b>x</b> | |
| 352 </td> | |
| 353 <td> | |
| 354 a conference room in which you are not participating | |
| 355 </td> | |
| 356 </tr> | |
| 357 <tr valign="top"> | |
| 358 <td> | |
| 359 <b>C</b> | |
| 360 </td> | |
| 361 <td> | |
| 362 a conference room in which you are participating | |
| 363 </td> | |
| 364 </tr> | |
| 365 </table> | |
| 366 <p>The authorization status indicates whether a resource is authorized to receive | |
| 367 your online status updates, and is displayed by the brackets surrounding the | |
| 368 resource's online status. Square brackets, like <b>[o]</b>, indicate that this | |
| 369 resource is authorized to receive your status. Curly braces, like <b>{o}</b>, | |
| 370 indicate that they are not authorized to receive your status.</p> | |
| 371 <p>When there are unread messages from the resource which you have not looked at, | |
| 372 a hash mark (<b>#</b>) appears in the leftmost section of the roster for that | |
| 373 resource. The hash mark disappears once you view that resource's message log.</p> | |
| 374 <p>Examples:</p> | |
| 375 <table class="hlist"> | |
| 376 <tr valign="top"> | |
| 377 <td> | |
| 378 <b> --- Buds</b> | |
| 379 </td> | |
| 380 <td> | |
| 381 This is a group named <b>Buds</b> | |
| 382 </td> | |
| 383 </tr> | |
| 384 <tr valign="top"> | |
| 385 <td> | |
| 386 <b>#[o] John</b> | |
| 387 </td> | |
| 388 <td> | |
| 389 John is online, can see your status, and sent you a message that you did not read yet | |
| 390 </td> | |
| 391 </tr> | |
| 392 <tr valign="top"> | |
| 393 <td> | |
| 394 <b> {?} Sally</b> | |
| 395 </td> | |
| 396 <td> | |
| 397 Neither you nor Sally have authorized each other to see your online status | |
| 398 </td> | |
| 399 </tr> | |
| 400 <tr valign="top"> | |
| 401 <td> | |
| 402 <b> {a} Jane</b> | |
| 403 </td> | |
| 404 <td> | |
| 405 Jane is away, but she cannot see your online status | |
| 406 </td> | |
| 407 </tr> | |
| 408 <tr valign="top"> | |
| 409 <td> | |
| 410 <b>#[C] x@y.c</b> | |
| 411 </td> | |
| 412 <td> | |
| 413 You are participating in x@y.c conference room, and there are unread messages | |
| 414 </td> | |
| 415 </tr> | |
| 416 </table> | |
| 417 <h2>COMMANDS RELATED TO MCABBER</h2> | |
| 229 | 418 <dl> |
| 419 <dt><b> | |
| 870 | 420 /alias [name [= command line]] |
|
286
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
421 </b></dt> |
|
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
422 <dd> |
| 289 | 423 Add "name" as an alias for "command line".<br /> |
| 424 Aliases are expanded only once, thus they can not be chained.<br /> | |
| 870 | 425 "/alias name" displays the value associated with the "name" alias;<br /> |
| 289 | 426 "/alias name =" unsets the "name" alias.<br /> |
| 870 | 427 "/alias" displays a list of the existing aliases.<br /> |
|
286
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
428 Example: "/alias away = status away". |
| 289 | 429 </dd> |
| 430 <dt><b> | |
| 870 | 431 /bind [keycode [= command line]] |
| 289 | 432 </b></dt> |
| 433 <dd> | |
| 434 Bind a command line to the key with the "keycode" code number.<br /> | |
| 432 | 435 Keycodes of unused keys are displayed by <tt>mcabber</tt> in the log window |
| 289 | 436 when pressing the key, for example "Unknown key=265".<br /> |
| 870 | 437 "/bind keycode" displays the command line bound to the given keycode;<br /> |
| 438 "/bind keycode =" unbinds the given keycode.<br /> | |
| 439 "/bind" displays a list of the bound keycodes.<br /> | |
| 289 | 440 Note: aliases can be used in key bindings.<br /> |
| 450 | 441 Example: "/bind 265 = status online" (265 is F1 for me, but it may |
| 289 | 442 depend on your ncurses installation). |
|
286
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
443 </dd> |
|
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
444 <dt><b> |
| 870 | 445 /buffer clear|purge|top|bottom|date|%|search_backward|search_forward |
| 229 | 446 </b></dt> |
| 876 | 447 <dt><b> |
| 448 /buffer scroll_lock|scroll_unlock|scroll_toggle | |
| 449 </b></dt> | |
| 229 | 450 <dd> |
| 451 The <b>buffer</b> command manipulates the current buddy's buffer | |
| 452 (chat window). | |
| 453 <table class="hlist"> | |
| 454 <tr valign="top"> | |
| 455 <td> | |
| 456 <b>clear</b> | |
| 457 </td> | |
| 458 <td> | |
| 459 clear the current buddy chat window | |
| 460 </td> | |
| 461 </tr> | |
| 462 <tr valign="top"> | |
| 463 <td> | |
| 870 | 464 <b>purge</b> |
| 465 </td> | |
| 466 <td> | |
| 876 | 467 clear the current buddy chat window and empty all contents of the chat buffer |
| 870 | 468 </td> |
| 469 </tr> | |
| 470 <tr valign="top"> | |
| 471 <td> | |
| 511 | 472 <b>bottom</b> |
| 473 </td> | |
| 474 <td> | |
| 475 jump to the bottom of the current buddy chat buffer | |
| 476 </td> | |
| 477 </tr> | |
| 478 <tr valign="top"> | |
| 479 <td> | |
| 229 | 480 <b>top</b> |
| 481 </td> | |
| 482 <td> | |
| 483 jump to the top of the current buddy chat buffer | |
| 484 </td> | |
| 485 </tr> | |
| 486 <tr valign="top"> | |
| 487 <td> | |
| 511 | 488 <b>up</b> [n] |
| 229 | 489 </td> |
| 490 <td> | |
| 511 | 491 scroll the buffer up n lines (default: half a screen) |
| 492 </td> | |
| 493 </tr> | |
| 494 <tr valign="top"> | |
| 495 <td> | |
| 496 <b>down</b> [n] | |
| 497 </td> | |
| 498 <td> | |
| 499 scroll the buffer down n lines (default: half a screen) | |
| 229 | 500 </td> |
| 501 </tr> | |
|
372
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
502 <tr valign="top"> |
|
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
503 <td> |
| 618 | 504 <b>date</b> date |
| 505 </td> | |
| 506 <td> | |
| 507 jump to the first line after the specified date in the chat buffer (date format: "YYYY-mm-dd[THH:MM:SS]", "-" and ":" are optional) | |
| 508 </td> | |
| 509 </tr> | |
| 510 <tr valign="top"> | |
| 511 <td> | |
| 512 <b>%</b> n | |
| 513 </td> | |
| 514 <td> | |
| 515 jump to position %n of the buddy chat buffer | |
| 516 </td> | |
| 517 </tr> | |
| 518 <tr valign="top"> | |
| 519 <td> | |
|
372
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
520 <b>search_backward</b> text |
|
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
521 </td> |
|
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
522 <td> |
| 491 | 523 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
|
524 </td> |
|
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
525 </tr> |
|
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
526 <tr valign="top"> |
|
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
527 <td> |
|
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
528 <b>search_forward</b> text |
|
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
529 </td> |
|
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
530 <td> |
| 491 | 531 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
|
532 </td> |
|
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
533 </tr> |
| 876 | 534 <tr valign="top"> |
| 535 <td> | |
| 536 <b>scroll_lock</b> | |
| 537 </td> | |
| 538 <td> | |
| 539 lock buffer scrolling | |
| 540 </td> | |
| 541 </tr> | |
| 542 <tr valign="top"> | |
| 543 <td> | |
| 544 <b>scroll_unlock</b> | |
| 545 </td> | |
| 546 <td> | |
| 547 unlock buffer scrolling | |
| 548 </td> | |
| 549 </tr> | |
| 550 <tr valign="top"> | |
| 551 <td> | |
| 552 <b>scroll_toggle</b> | |
| 553 </td> | |
| 554 <td> | |
| 555 toggle buffer scrolling (lock/unlock) | |
| 556 </td> | |
| 557 </tr> | |
| 229 | 558 </table> |
| 559 </dd> | |
| 560 <dt><b> | |
| 561 /clear | |
| 562 </b></dt> | |
| 563 <dd> | |
| 564 The <b>clear</b> command is actually an alias for "/buffer clear". | |
| 565 </dd> | |
| 566 <dt><b> | |
| 870 | 567 /help [command] |
| 568 </b></dt> | |
| 569 <dd> | |
| 570 Display generic help or help about a specific mcabber command. | |
| 571 </dd> | |
| 572 <dt><b> | |
| 854 | 573 /quit |
| 574 </b></dt> | |
| 575 <dd> | |
| 576 Disconnect and leave <tt>mcabber(1)</tt>. | |
| 577 </dd> | |
| 578 <dt><b> | |
| 579 /version | |
| 580 </b></dt> | |
| 581 <dd> | |
| 582 Display mcabber version | |
| 583 </dd> | |
| 584 </dl> | |
| 585 <h2>COMMANDS RELATED TO THE SERVER AND CONNECTION</h2> | |
| 586 <dl> | |
| 587 <dt><b> | |
|
298
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
588 /connect |
|
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
589 </b></dt> |
|
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
590 <dd> |
|
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
591 Establish connection to the Jabber server. |
|
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
592 </dd> |
|
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
593 <dt><b> |
|
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
594 /disconnect |
|
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
595 </b></dt> |
|
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
596 <dd> |
|
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
597 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
|
598 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
|
599 buddylist is empty when disconnected. |
|
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
600 </dd> |
|
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
601 <dt><b> |
| 829 | 602 /event #n|* accept|ignore|reject |
|
775
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
603 </b></dt> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
604 <dt><b> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
605 /event list |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
606 </b></dt> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
607 <dd> |
| 829 | 608 Tell mcabber what to do about a pending event.<br /> |
| 609 If the first parameter is "*", the command will apply to all | |
| 610 queued events. | |
|
775
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
611 <table class="hlist"> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
612 <tr valign="top"> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
613 <td> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
614 <b>accept</b> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
615 </td> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
616 <td> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
617 accept the event #n |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
618 </td> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
619 </tr> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
620 <tr valign="top"> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
621 <td> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
622 <b>ignore</b> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
623 </td> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
624 <td> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
625 remove the event #n from the list |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
626 </td> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
627 </tr> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
628 <tr valign="top"> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
629 <td> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
630 <b>reject</b> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
631 </td> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
632 <td> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
633 reject the event #n |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
634 </td> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
635 </tr> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
636 <tr valign="top"> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
637 <td> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
638 <b>list</b> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
639 </td> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
640 <td> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
641 list all pending events |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
642 </td> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
643 </tr> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
644 </table> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
645 </dd> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
646 <dt><b> |
| 901 | 647 /rawxml send string |
| 854 | 648 </b></dt> |
| 649 <dd> | |
| 650 <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. | |
| 651 </dd> | |
| 652 </dl> | |
| 653 <h2>COMMANDS RELATED TO THE ROSTER AND JABBER RESOURCES</h2> | |
| 654 <dl> | |
| 655 <dt><b> | |
| 656 /add [jid [nickname]] | |
| 657 </b></dt> | |
| 658 <dd> | |
| 659 Add the "jid" Jabber user to our roster (default group), and send a | |
| 660 notification request to this buddy. If no nickname is specified, the | |
| 661 jid is used. If no jid (or an empty string "") is provided or if jid | |
| 662 is ".", the current buddy is used. | |
| 663 </dd> | |
| 664 <dt><b> | |
| 665 /authorization allow|cancel|request|request_unsubscribe [jid] | |
| 666 </b></dt> | |
| 667 <dd> | |
| 668 Manage the presence subscriptions.<br /> | |
| 669 If no jid is provided, the current buddy is used. | |
| 670 <table class="hlist"> | |
| 671 <tr valign="top"> | |
| 672 <td> | |
| 673 <b>allow</b> | |
| 674 </td> | |
| 675 <td> | |
| 676 allow the buddy to receive your presence updates | |
| 677 </td> | |
| 678 </tr> | |
| 679 <tr valign="top"> | |
| 680 <td> | |
| 681 <b>cancel</b> | |
| 682 </td> | |
| 683 <td> | |
| 684 cancel the buddy' subscription to your presence updates | |
| 685 </td> | |
| 686 </tr> | |
| 687 <tr valign="top"> | |
| 688 <td> | |
| 689 <b>request</b> | |
| 690 </td> | |
| 691 <td> | |
| 692 request a subscription to the buddy's presence updates | |
| 693 </td> | |
| 694 </tr> | |
| 695 <tr valign="top"> | |
| 696 <td> | |
| 697 <b>request_unsubscribe</b> | |
| 698 </td> | |
| 699 <td> | |
| 700 request unsubscription from the buddy's presence updates | |
| 701 </td> | |
| 702 </tr> | |
| 703 </table> | |
| 704 </dd> | |
| 705 <dt><b> | |
| 706 /del | |
| 707 </b></dt> | |
| 708 <dd> | |
| 709 Delete the current buddy from our roster, unsubscribe from its presence | |
| 710 notification and unsubscribe it from ours. | |
| 711 </dd> | |
| 712 <dt><b> | |
| 240 | 713 /group fold|unfold|toggle |
| 229 | 714 </b></dt> |
| 715 <dd> | |
| 240 | 716 The <b>group</b> command changes the current group display. |
| 229 | 717 <table class="hlist"> |
| 718 <tr valign="top"> | |
| 719 <td> | |
| 240 | 720 <b>fold</b> |
| 229 | 721 </td> |
| 722 <td> | |
| 240 | 723 fold (shrink) the current group tree in the roster |
| 229 | 724 </td> |
| 725 </tr> | |
| 726 <tr valign="top"> | |
| 727 <td> | |
| 240 | 728 <b>unfold</b> |
| 229 | 729 </td> |
| 730 <td> | |
| 240 | 731 unfold (expand) the current group tree in the roster |
| 229 | 732 </td> |
| 733 </tr> | |
| 734 <tr valign="top"> | |
| 735 <td> | |
| 736 <b>toggle</b> | |
| 737 </td> | |
| 738 <td> | |
| 240 | 739 toggle the state (fold/unfold) of the current tree |
| 229 | 740 </td> |
| 741 </tr> | |
| 742 </table> | |
| 743 </dd> | |
| 744 <dt><b> | |
| 745 /info | |
| 746 </b></dt> | |
| 747 <dd> | |
|
440
264f40222872
Update documentation (/info command)
Mikael Berthe <mikael@lilotux.net>
parents:
436
diff
changeset
|
748 Display info on the selected entry (user, agent, group…).<br /> |
|
264f40222872
Update documentation (/info command)
Mikael Berthe <mikael@lilotux.net>
parents:
436
diff
changeset
|
749 For users, resources are displayed with the status, priority and |
|
264f40222872
Update documentation (/info command)
Mikael Berthe <mikael@lilotux.net>
parents:
436
diff
changeset
|
750 status message (if available) of each resource. |
| 229 | 751 </dd> |
| 752 <dt><b> | |
| 753 /move [groupname] | |
| 754 </b></dt> | |
| 755 <dd> | |
| 756 Move the current buddy to the requested group. If no group is | |
| 975 | 757 specified, then the buddy is moved to the default group. |
| 758 If the group groupname doesn't exist, it is created.<br /> | |
|
506
74dcd0df532e
"/move" does not jump to the buddy in the new group
Mikael Berthe <mikael@lilotux.net>
parents:
495
diff
changeset
|
759 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
|
760 to jump to the moved buddy. |
| 229 | 761 </dd> |
| 762 <dt><b> | |
| 839 | 763 /msay begin|verbatim|send|send_to|toggle|toggle_verbatim|abort |
| 238 | 764 </b></dt> |
| 765 <dd> | |
| 766 Send a multi-line message. To write a single message with several | |
| 289 | 767 lines, the <b>multi-line mode</b> should be used.<br /> |
| 768 In multi-line mode, each line (except command lines) typed in the input | |
| 769 line will be added to the multi-line message. Once the message is | |
| 450 | 770 finished, it can be sent to the current selected buddy with the "/msay |
| 1096 | 771 send" command (or Ctrl-d).<br /> |
| 810 | 772 The <b>begin</b> subcommand enables multi-line mode. Note that it allows |
| 773 a message subject to be specified.<br /> | |
| 289 | 774 The <b>verbatim</b> multi-line mode disables commands, so that it is |
| 775 possible to enter lines starting with a slash. Only the "/msay" | |
| 776 command (with send or abort parameters) can be used to exit verbatim | |
| 799 | 777 mode.<br /> |
| 839 | 778 The <b>toggle</b> and <b>toggle_verbatim</b> subcommands can be bound to a key to |
| 779 use the multi-line mode quickly (for example, "bind M109 = msay toggle" | |
| 780 to switch using the Meta-m combination). | |
| 238 | 781 <table class="hlist"> |
| 782 <tr valign="top"> | |
| 783 <td> | |
| 810 | 784 <b>begin</b> [subject] |
| 238 | 785 </td> |
| 786 <td> | |
| 787 enter multi-line mode | |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
788 </td> |
|
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
789 </tr> |
|
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
790 <tr valign="top"> |
|
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
791 <td> |
|
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
792 <b>verbatim</b> |
|
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
793 </td> |
|
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
794 <td> |
|
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
795 enter verbatim multi-line mode |
| 238 | 796 </td> |
| 797 </tr> | |
| 798 <tr valign="top"> | |
| 799 <td> | |
| 800 <b>send</b> | |
| 801 </td> | |
| 802 <td> | |
| 803 send the current multi-line message to the currently selected buddy | |
| 804 </td> | |
| 805 </tr> | |
| 806 <tr valign="top"> | |
| 807 <td> | |
| 637 | 808 <b>send_to</b> jid |
| 809 </td> | |
| 810 <td> | |
| 811 send the current multi-line message to "jid" | |
| 812 </td> | |
| 813 </tr> | |
| 814 <tr valign="top"> | |
| 815 <td> | |
| 799 | 816 <b>toggle</b> |
| 817 </td> | |
| 818 <td> | |
| 819 switch to/from multi-line mode (begin/send) | |
| 820 </td> | |
| 821 </tr> | |
| 822 <tr valign="top"> | |
| 823 <td> | |
| 839 | 824 <b>toggle_verbatim</b> |
| 825 </td> | |
| 826 <td> | |
| 827 same with verbatim multi-line mode | |
| 828 </td> | |
| 829 </tr> | |
| 830 <tr valign="top"> | |
| 831 <td> | |
| 238 | 832 <b>abort</b> |
| 833 </td> | |
| 834 <td> | |
| 835 leave multi-line mode without sending the message | |
| 836 </td> | |
| 837 </tr> | |
| 838 </table> | |
| 839 </dd> | |
| 840 <dt><b> | |
| 1096 | 841 /pgp disable|enable|info [jid] |
| 842 </b></dt> | |
| 843 <dt><b> | |
| 844 /pgp setkey [jid [key]] | |
| 845 </b></dt> | |
| 846 <dd> | |
| 847 Manipulate PGP settings for the specified jid (by default the currently selected contact). Please note that PGP encryption won't be used if no remote PGP support is detected, even if PGP is enabled with this command. | |
| 848 <table class="hlist"> | |
| 849 <tr valign="top"> | |
| 850 <td> | |
| 851 <b>disable</b> [jid] | |
| 852 </td> | |
| 853 <td> | |
| 854 disable PGP encryption for jid (or the currently selected contact) | |
| 855 </td> | |
| 856 </tr> | |
| 857 <tr valign="top"> | |
| 858 <td> | |
| 859 <b>enable</b> [jid] | |
| 860 </td> | |
| 861 <td> | |
| 862 enable PGP encryption for jid (or the currently selected contact) | |
| 863 </td> | |
| 864 </tr> | |
| 865 <tr valign="top"> | |
| 866 <td> | |
| 867 <b>info</b> [jid] | |
| 868 </td> | |
| 869 <td> | |
| 870 show current PGP settings for the contact | |
| 871 </td> | |
| 872 </tr> | |
| 873 <tr valign="top"> | |
| 874 <td> | |
| 875 <b>setkey</b> [jid [key]] | |
| 876 </td> | |
| 877 <td> | |
| 878 set the PGP key to be used to encrypt message for this contact. If no key is provided, the current key is erased. You can use the shortcut-jid "." for the currently selected contact. | |
| 879 </td> | |
| 880 </tr> | |
| 881 </table> | |
| 882 </dd> | |
| 883 <dt><b> | |
| 886 | 884 /rename name |
| 229 | 885 </b></dt> |
| 886 <dd> | |
| 886 | 887 Rename current buddy or group to the given name. |
| 888 Please note that a group name change is only done when the server's | |
| 889 acknowledgment is received, so a slight delay can be noticed. | |
| 450 | 890 </dd> |
| 891 <dt><b> | |
| 1096 | 892 /request last|time|vcard|version [jid] |
| 700 | 893 </b></dt> |
| 894 <dd> | |
| 895 Send a "IQ" query to the current buddy, or to the specified Jabber | |
| 896 user. If the resource is not provided with the jid, mcabber will | |
| 897 send the query to all known resources for this user. | |
| 898 </dd> | |
| 899 <dt><b> | |
| 601 | 900 /room join|leave|names|nick|privmsg|remove|topic|unlock|destroy |
| 573 | 901 </b></dt> |
| 902 <dt><b> | |
| 593 | 903 /room invite|kick|ban|role|affil |
| 450 | 904 </b></dt> |
| 1096 | 905 <dt><b> |
| 906 /room bookmark [add|del] [-autojoin|+autojoin] | |
| 907 </b></dt> | |
| 450 | 908 <dd> |
| 909 The <b>room</b> command handles Multi-User Chat room actions. | |
| 910 <table class="hlist"> | |
| 911 <tr valign="top"> | |
| 912 <td> | |
| 901 | 913 <b>join</b> [room [nick [pass]]] |
| 450 | 914 </td> |
| 915 <td> | |
| 901 | 916 join "room", using "nick" as nickname. If no nickname is provided (or if it is an empty string), the "nickname" option value is used (see sample configuration file). If the currently selected entry is correctly recognized as a room by mcabber, the shortcut "." can be used instead of the full room id. A password can be provided to enter protected rooms. If your nickname contains space characters, use quotes. |
| 450 | 917 </td> |
| 918 </tr> | |
| 919 <tr valign="top"> | |
| 920 <td> | |
| 487 | 921 <b>leave</b> [message] |
| 450 | 922 </td> |
| 923 <td> | |
| 924 leave the current room | |
| 925 </td> | |
| 926 </tr> | |
| 927 <tr valign="top"> | |
| 928 <td> | |
| 929 <b>names</b> | |
| 930 </td> | |
| 931 <td> | |
| 932 display members of the current room | |
| 933 </td> | |
| 934 </tr> | |
| 935 <tr valign="top"> | |
| 936 <td> | |
| 470 | 937 <b>nick</b> nick |
| 938 </td> | |
| 939 <td> | |
| 940 change your nickname in the current room | |
| 941 </td> | |
| 942 </tr> | |
| 943 <tr valign="top"> | |
| 944 <td> | |
| 491 | 945 <b>privmsg</b> nick msg |
| 946 </td> | |
| 947 <td> | |
| 948 send private message "msg" to "nick" | |
| 949 </td> | |
| 950 </tr> | |
| 951 <tr valign="top"> | |
| 952 <td> | |
| 450 | 953 <b>remove</b> |
| 954 </td> | |
| 955 <td> | |
| 467 | 956 remove the current room from the roster (you must have left this room before) |
| 957 </td> | |
| 958 </tr> | |
| 959 <tr valign="top"> | |
| 960 <td> | |
|
475
fa49ac0bb8f3
Add "/room topic", and display topic changes
Mikael Berthe <mikael@lilotux.net>
parents:
470
diff
changeset
|
961 <b>topic</b> |
|
fa49ac0bb8f3
Add "/room topic", and display topic changes
Mikael Berthe <mikael@lilotux.net>
parents:
470
diff
changeset
|
962 </td> |
|
fa49ac0bb8f3
Add "/room topic", and display topic changes
Mikael Berthe <mikael@lilotux.net>
parents:
470
diff
changeset
|
963 <td> |
|
fa49ac0bb8f3
Add "/room topic", and display topic changes
Mikael Berthe <mikael@lilotux.net>
parents:
470
diff
changeset
|
964 set topic for current room |
|
fa49ac0bb8f3
Add "/room topic", and display topic changes
Mikael Berthe <mikael@lilotux.net>
parents:
470
diff
changeset
|
965 </td> |
|
fa49ac0bb8f3
Add "/room topic", and display topic changes
Mikael Berthe <mikael@lilotux.net>
parents:
470
diff
changeset
|
966 </tr> |
|
fa49ac0bb8f3
Add "/room topic", and display topic changes
Mikael Berthe <mikael@lilotux.net>
parents:
470
diff
changeset
|
967 <tr valign="top"> |
|
fa49ac0bb8f3
Add "/room topic", and display topic changes
Mikael Berthe <mikael@lilotux.net>
parents:
470
diff
changeset
|
968 <td> |
| 467 | 969 <b>unlock</b> |
| 970 </td> | |
| 971 <td> | |
| 972 unlock current room (if you are the owner) | |
| 450 | 973 </td> |
| 974 </tr> | |
| 573 | 975 <tr valign="top"> |
| 976 <td> | |
| 601 | 977 <b>destroy</b> [reason] |
| 978 </td> | |
| 979 <td> | |
| 980 destroy the current room (use with care!) | |
| 981 </td> | |
| 982 </tr> | |
| 983 <tr valign="top"> | |
| 984 <td> | |
| 573 | 985 <b>whois</b> nick |
| 986 </td> | |
| 987 <td> | |
| 988 display MUC information about "nick" | |
| 989 </td> | |
| 990 </tr> | |
| 593 | 991 <tr valign="top"> |
| 992 <td> | |
| 993 <b>ban</b> jid [reason] | |
| 994 </td> | |
| 995 <td> | |
| 996 ban jid from the current room | |
| 997 </td> | |
| 998 </tr> | |
| 999 <tr valign="top"> | |
| 1000 <td> | |
| 1001 <b>invite</b> jid [reason] | |
| 1002 </td> | |
| 1003 <td> | |
| 1004 invite jid to the current room | |
| 1005 </td> | |
| 1006 </tr> | |
| 1007 <tr valign="top"> | |
| 1008 <td> | |
| 1009 <b>kick</b> nick [reason] | |
| 1010 </td> | |
| 1011 <td> | |
| 1012 kick "nick" from the current room | |
| 1013 </td> | |
| 1014 </tr> | |
| 1015 <tr valign="top"> | |
| 1016 <td> | |
| 1017 <b>role</b> jid role [reason] | |
| 1018 </td> | |
| 1019 <td> | |
| 1020 change jid's role (role can be "none", "visitor", "participant", "moderator") | |
| 1021 </td> | |
| 1022 </tr> | |
| 1023 <tr valign="top"> | |
| 1024 <td> | |
| 1025 <b>affil</b> jid affil [reason] | |
| 1026 </td> | |
| 1027 <td> | |
| 1028 change jid's affiliation (affil can be "none", "member", "admin", "owner") | |
| 1096 | 1029 <b>bookmark</b> add/update/remove a room bookmark, set/unset autojoin |
| 593 | 1030 </td> |
| 1031 </tr> | |
| 450 | 1032 </table> |
| 229 | 1033 </dd> |
| 1034 <dt><b> | |
| 1096 | 1035 /roster bottom|top|up|down|group_prev|group_next |
| 710 | 1036 </b></dt> |
| 1037 <dt><b> | |
|
360
20283b69db99
Doc: Say a Jabber account should already exist for using mcabber
Mikael Berthe <mikael@lilotux.net>
parents:
345
diff
changeset
|
1038 /roster alternate|unread_first|unread_next |
| 265 | 1039 </b></dt> |
| 1040 <dt><b> | |
| 1041 /roster search bud | |
| 229 | 1042 </b></dt> |
| 1096 | 1043 <dt><b> |
| 1044 /roster hide_offline|show_offline|toggle_offline | |
| 1045 </b></dt> | |
| 1046 <dt><b> | |
| 1047 /roster item_lock|item_unlock | |
| 1048 </b></dt> | |
| 1049 <dt><b> | |
| 1050 /roster hide|show|toggle | |
| 1051 </b></dt> | |
| 1052 <dt><b> | |
| 1053 /roster note [-|text] | |
| 1054 </b></dt> | |
| 229 | 1055 <dd> |
| 265 | 1056 The <b>roster</b> command manipulates the roster/buddylist. Here are the available parameters: |
| 229 | 1057 <table class="hlist"> |
| 1058 <tr valign="top"> | |
| 1059 <td> | |
| 265 | 1060 <b>bottom</b> |
| 1061 </td> | |
| 1062 <td> | |
| 1063 jump to the bottom of the roster | |
| 1064 </td> | |
| 1065 </tr> | |
| 1066 <tr valign="top"> | |
| 1067 <td> | |
| 1068 <b>top</b> | |
| 1069 </td> | |
| 1070 <td> | |
| 1071 jump to the top of the roster | |
| 1072 </td> | |
| 1073 </tr> | |
| 1074 <tr valign="top"> | |
| 1075 <td> | |
|
377
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
1076 <b>up</b> |
|
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
1077 </td> |
|
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
1078 <td> |
|
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
1079 move up in the roster |
|
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
1080 </td> |
|
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
1081 </tr> |
|
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
1082 <tr valign="top"> |
|
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
1083 <td> |
|
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
1084 <b>down</b> |
|
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
1085 </td> |
|
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
1086 <td> |
|
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
1087 move down in the roster |
|
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
1088 </td> |
|
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
1089 </tr> |
|
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
1090 <tr valign="top"> |
|
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
1091 <td> |
| 1096 | 1092 <b>group_prev</b> |
| 1093 </td> | |
| 1094 <td> | |
| 1095 jump to the previous group in the roster | |
| 1096 </td> | |
| 1097 </tr> | |
| 1098 <tr valign="top"> | |
| 1099 <td> | |
| 1100 <b>group_next</b> | |
| 1101 </td> | |
| 1102 <td> | |
| 1103 jump to the next group in the roster | |
| 1104 </td> | |
| 1105 </tr> | |
| 1106 <tr valign="top"> | |
| 1107 <td> | |
| 1108 <b>alternate</b> | |
| 1109 </td> | |
| 1110 <td> | |
| 1111 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") | |
| 1112 </td> | |
| 1113 </tr> | |
| 1114 <tr valign="top"> | |
| 1115 <td> | |
| 1116 <b>unread_first</b> | |
| 1117 </td> | |
| 1118 <td> | |
| 1119 jump to the first unread message | |
| 1120 </td> | |
| 1121 </tr> | |
| 1122 <tr valign="top"> | |
| 1123 <td> | |
| 1124 <b>unread_next</b> | |
| 1125 </td> | |
| 1126 <td> | |
| 1127 jump to the next unread message | |
| 1128 </td> | |
| 1129 </tr> | |
| 1130 <tr valign="top"> | |
| 1131 <td> | |
| 1132 <b>search</b> bud | |
| 1133 </td> | |
| 1134 <td> | |
| 1135 search for a buddy with a name or jid containing "bud" (only in the displayed buddylist) | |
| 1136 </td> | |
| 1137 </tr> | |
| 1138 <tr valign="top"> | |
| 1139 <td> | |
| 229 | 1140 <b>hide_offline</b> |
| 1141 </td> | |
| 1142 <td> | |
| 1143 hide offline buddies | |
| 1144 </td> | |
| 1145 </tr> | |
| 1146 <tr valign="top"> | |
| 1147 <td> | |
| 1148 <b>show_offline</b> | |
| 1149 </td> | |
| 1150 <td> | |
| 1151 show offline buddies | |
| 1152 </td> | |
| 1153 </tr> | |
| 1154 <tr valign="top"> | |
| 1155 <td> | |
|
290
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
1156 <b>toggle_offline</b> |
|
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
1157 </td> |
|
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
1158 <td> |
|
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
1159 toggle display of offline buddies |
|
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
1160 </td> |
|
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
1161 </tr> |
|
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
1162 <tr valign="top"> |
|
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
1163 <td> |
| 1096 | 1164 <b>item_lock</b> jid |
| 1165 </td> | |
| 1166 <td> | |
| 1167 lock the roster item so it remains visible regardless of its status | |
| 1168 </td> | |
| 1169 </tr> | |
| 1170 <tr valign="top"> | |
| 1171 <td> | |
| 1172 <b>item_unlock</b> jid | |
| 1173 </td> | |
| 1174 <td> | |
| 1175 undo the effects of item_lock | |
| 1176 </td> | |
| 1177 </tr> | |
| 1178 <tr valign="top"> | |
| 1179 <td> | |
| 710 | 1180 <b>hide</b> |
| 1181 </td> | |
| 1182 <td> | |
| 1183 hide roster (full-width chat window) | |
| 1184 </td> | |
| 1185 </tr> | |
| 1186 <tr valign="top"> | |
| 1187 <td> | |
| 1188 <b>show</b> | |
| 1189 </td> | |
| 1190 <td> | |
| 1191 show roster | |
| 1192 </td> | |
| 1193 </tr> | |
| 1194 <tr valign="top"> | |
| 1195 <td> | |
| 1196 <b>toggle</b> | |
| 1197 </td> | |
| 1198 <td> | |
| 1199 toggle roster visibility | |
| 1200 </td> | |
| 1201 </tr> | |
| 1202 <tr valign="top"> | |
| 1203 <td> | |
| 1096 | 1204 <b>note</b> [text] |
| 229 | 1205 </td> |
| 1206 <td> | |
| 1096 | 1207 display or set an annotation (if text is "-", the annotation is deleted). In the "status" buffer, it will display all annotations. |
| 236 | 1208 </td> |
| 1209 </tr> | |
| 229 | 1210 </table> |
| 1211 </dd> | |
| 1212 <dt><b> | |
| 1213 /say text | |
| 1214 </b></dt> | |
| 1215 <dd> | |
| 491 | 1216 Send the "text" message to the currently selected buddy. Can be useful |
| 229 | 1217 if you want to send a message beginning with a slash, for example. |
| 1218 </dd> | |
| 1219 <dt><b> | |
| 480 | 1220 /say_to jid text |
| 1221 </b></dt> | |
| 1222 <dd> | |
| 491 | 1223 Send the "text" message to the specified jid. |
| 480 | 1224 Please note that this command doesn't set the default resource for |
| 1225 a contact, so if you want to send several messages to a specific | |
| 916 | 1226 resource you will have to use "/say_to" for each message. |
| 480 | 1227 </dd> |
| 1228 <dt><b> | |
| 522 | 1229 /status [online|avail|invisible|free|dnd|notavail|away [-|StatusMessage]] |
| 229 | 1230 </b></dt> |
| 1231 <dd> | |
| 522 | 1232 Show or set the current status.<br /> |
| 1233 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
|
1234 If a status message is specified, it will overrride the message* |
| 522 | 1235 variables (these variables can be set in the configuration file). |
| 1236 If no relevant message* variable is set and no status message provided, | |
| 1237 the current status message is kept. If StatusMessage is "-", the | |
| 1238 current status message is cleared. | |
| 229 | 1239 </dd> |
| 450 | 1240 <dt><b> |
| 1241 /status_to jid online|avail|invisible|free|dnd|notavail|away [StatusMessage] | |
| 1242 </b></dt> | |
| 1243 <dd> | |
| 1244 Send the requested status to the specified Jabber user.<br /> | |
| 660 | 1245 If the specified jid is ".", the current buddy is used.<br /> |
| 450 | 1246 Note: this status will be overridden by subsequent "/status" commands. |
| 1247 If you are using the auto-away feature, the status will overridden | |
| 1248 too.<br /> | |
| 1249 Note: The jid can include a resource (i.e. user@server/resource). | |
| 1250 </dd> | |
| 229 | 1251 </dl> |
| 1252 <h2>CONFIGURATION FILE</h2> | |
| 854 | 1253 <p>See the provided sample configuration file, which should be self-documenting.</p> |
| 229 | 1254 <h2>FILES</h2> |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
1255 <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
|
1256 <div class="literalparagraph"><pre>$HOME/.mcabber/mcabberrc Default configuration file |
| 229 | 1257 $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
|
1258 $HOME/.mcabber/histo/ Default directory for storing chat history files, if enabled</pre></div> |
| 229 | 1259 <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
|
1260 <p>Certainly. Please tell me if you find one! :-)</p> |
| 229 | 1261 <h2>AUTHOR</h2> |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
1262 <p>Written by <a href="mailto:mcabber@lilotux.net">Mikael BERTHE</a>.<br /> |
| 229 | 1263 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
|
1264 consult the AUTHORS file for details.</p> |
| 229 | 1265 <h2>RESOURCES</h2> |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
1266 <p><a href="http://www.lilotux.net/~mikael/mcabber/">Main web site</a></p> |
| 229 | 1267 <h2>COPYING</h2> |
| 1096 | 1268 <p>Copyright (C) 2005, 2006 Mikael Berthe.<br /> |
| 1269 Some portions are Copyright (C) 2002-2004 <a href="mailto:cabber@ajmacias.com">cabber@ajmacias.com</a>.</p> | |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
1270 <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
|
1271 License (GPL).</p> |
| 229 | 1272 <div id="footer"> |
| 1273 <p> | |
|
1111
f64af9258f3c
Ready for release 0.9.0
Mikael Berthe <mikael@lilotux.net>
parents:
1096
diff
changeset
|
1274 Version 0.9.0<br /> |
| 1096 | 1275 Last updated 09-Dec-2006 11:19:42 CEST |
| 229 | 1276 </p> |
| 1277 </div> | |
| 1278 </div> | |
| 1279 </body> | |
| 1280 </html> |