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