comparison mcabber/doc/mcabber.1.html @ 450:fa93f47a08fe

Update manual page * Add /room and /status_to documentation * Some other corrections
author Mikael Berthe <mikael@lilotux.net>
date Mon, 26 Sep 2005 00:24:22 +0200
parents 264f40222872
children 52171a3dc199
comparison
equal deleted inserted replaced
449:e08b0c2d0e54 450:fa93f47a08fe
218 Keycodes of unused keys are displayed by <tt>mcabber</tt> in the log window 218 Keycodes of unused keys are displayed by <tt>mcabber</tt> in the log window
219 when pressing the key, for example "Unknown key=265".<br /> 219 when pressing the key, for example "Unknown key=265".<br />
220 "/bind keycode" displays the command line bound to the given keycode; 220 "/bind keycode" displays the command line bound to the given keycode;
221 "/bind keycode" unbinds the given keycode.<br /> 221 "/bind keycode" unbinds the given keycode.<br />
222 Note: aliases can be used in key bindings.<br /> 222 Note: aliases can be used in key bindings.<br />
223 Example: "/bind 265 = status online" (265 is F1 for me, but it can 223 Example: "/bind 265 = status online" (265 is F1 for me, but it may
224 depend on your ncurses installation). 224 depend on your ncurses installation).
225 </dd> 225 </dd>
226 <dt><b> 226 <dt><b>
227 /buffer clear|top|bottom|search_backward|search_forward 227 /buffer clear|top|bottom|search_backward|search_forward
228 </b></dt> 228 </b></dt>
353 <dd> 353 <dd>
354 Send a multi-line message. To write a single message with several 354 Send a multi-line message. To write a single message with several
355 lines, the <b>multi-line mode</b> should be used.<br /> 355 lines, the <b>multi-line mode</b> should be used.<br />
356 In multi-line mode, each line (except command lines) typed in the input 356 In multi-line mode, each line (except command lines) typed in the input
357 line will be added to the multi-line message. Once the message is 357 line will be added to the multi-line message. Once the message is
358 finished, it can be sent to the current selected buddy with the "msay 358 finished, it can be sent to the current selected buddy with the "/msay
359 /send" command.<br /> 359 send" command.<br />
360 The <b>verbatim</b> multi-line mode disables commands, so that it is 360 The <b>verbatim</b> multi-line mode disables commands, so that it is
361 possible to enter lines starting with a slash. Only the "/msay" 361 possible to enter lines starting with a slash. Only the "/msay"
362 command (with send or abort parameters) can be used to exit verbatim 362 command (with send or abort parameters) can be used to exit verbatim
363 mode. 363 mode.
364 <table class="hlist"> 364 <table class="hlist">
412 /rename nickname 412 /rename nickname
413 </b></dt> 413 </b></dt>
414 <dd> 414 <dd>
415 Rename current buddy to the given nickname. 415 Rename current buddy to the given nickname.
416 This command does not work for groups, at the moment (but you can move 416 This command does not work for groups, at the moment (but you can move
417 the buddies to another group with the /move command). 417 the buddies to another group with the "/move" command).
418 </dd>
419 <dt><b>
420 /room join|leave|names|remove
421 </b></dt>
422 <dd>
423 The <b>room</b> command handles Multi-User Chat room actions.
424 <table class="hlist">
425 <tr valign="top">
426 <td>
427 <b>join</b> room nick
428 </td>
429 <td>
430 join "room", using "nick" as nickname
431 </td>
432 </tr>
433 <tr valign="top">
434 <td>
435 <b>leave</b>
436 </td>
437 <td>
438 leave the current room
439 </td>
440 </tr>
441 <tr valign="top">
442 <td>
443 <b>names</b>
444 </td>
445 <td>
446 display members of the current room
447 </td>
448 </tr>
449 <tr valign="top">
450 <td>
451 <b>remove</b>
452 </td>
453 <td>
454 remove the current room from the roster. You must have left this room before.
455 </td>
456 </tr>
457 </table>
418 </dd> 458 </dd>
419 <dt><b> 459 <dt><b>
420 /roster bottom|top|hide_offline|show_offline|toggle_offline 460 /roster bottom|top|hide_offline|show_offline|toggle_offline
421 </b></dt> 461 </b></dt>
422 <dt><b> 462 <dt><b>
531 <dd> 571 <dd>
532 Set the current status. If no status is specified, display the 572 Set the current status. If no status is specified, display the
533 current status.<br /> 573 current status.<br />
534 If a status message is specified, it will overrride the message* 574 If a status message is specified, it will overrride the message*
535 variables. 575 variables.
576 </dd>
577 <dt><b>
578 /status_to jid online|avail|invisible|free|dnd|notavail|away [StatusMessage]
579 </b></dt>
580 <dd>
581 Send the requested status to the specified Jabber user.<br />
582 Note: this status will be overridden by subsequent "/status" commands.
583 If you are using the auto-away feature, the status will overridden
584 too.<br />
585 Note: The jid can include a resource (i.e. user@server/resource).
536 </dd> 586 </dd>
537 </dl> 587 </dl>
538 <h2>CONFIGURATION FILE</h2> 588 <h2>CONFIGURATION FILE</h2>
539 <p>See the provided sample configuration file, which should be self-documented.</p> 589 <p>See the provided sample configuration file, which should be self-documented.</p>
540 <h2>FILES</h2> 590 <h2>FILES</h2>
556 <p>Free use of this software is granted under the terms of the GNU General Public 606 <p>Free use of this software is granted under the terms of the GNU General Public
557 License (GPL).</p> 607 License (GPL).</p>
558 <div id="footer"> 608 <div id="footer">
559 <p> 609 <p>
560 Version 0.6.9-dev<br /> 610 Version 0.6.9-dev<br />
561 Last updated 20-Sep-2005 23:15:49 CEST 611 Last updated 26-Sep-2005 00:06:42 CEST
562 </p> 612 </p>
563 </div> 613 </div>
564 </div> 614 </div>
565 </body> 615 </body>
566 </html> 616 </html>