Mercurial > ~mikael > mcabber > hg

comparison mcabber/doc/mcabber.1.html @ 1242:b335d30881bd

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update manpage
author Mikael Berthe <mikael@lilotux.net>
date Mon, 18 Jun 2007 19:18:48 +0200
parents 19d95608b4fe
children 03447ed1115d
comparison
equal deleted inserted replaced
1241:3a4018f18bdf 1242:b335d30881bd
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html> 2 <html>
3 <head> 3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /> 4 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
5 <meta name="generator" content="AsciiDoc 7.1.2" /> 5 <meta name="generator" content="AsciiDoc 8.2.1" />
6 <meta name="author" content="Mikael BERTHE" /> 6 <meta name="author" content="Mikael BERTHE" />
7 <meta name="author-email" content="mcabber@lilotux.net" /> 7 <meta name="author-email" content="mcabber@lilotux.net" />
8 <link rel="stylesheet" href="./manpage.css" type="text/css" /> 8 <link rel="stylesheet" href="./manpage.css" type="text/css" />
9 <title>mcabber</title> 9 <title>mcabber</title>
10 </head> 10 </head>
412 <td> 412 <td>
413 You are participating in x@y.c conference room, and there are unread messages 413 You are participating in x@y.c conference room, and there are unread messages
414 </td> 414 </td>
415 </tr> 415 </tr>
416 </table> 416 </table>
417 <h2>COMMANDS</h2>
418 <p>Please refer to the online help (command /help), it is probably more up-to-date than this manpage. Furthermore, help files have been translated into several languages.<br />
419 You will find an overview of the <tt>mcabber</tt> commands in this manual.</p>
417 <h2>COMMANDS RELATED TO MCABBER</h2> 420 <h2>COMMANDS RELATED TO MCABBER</h2>
418 <dl> 421 <dl>
419 <dt><b> 422 <dt><b>
420 /alias [name [= command line]] 423 /alias [name [= command line]]
421 </b></dt> 424 </b></dt>
422 <dd> 425 <dd>
423 Add "name" as an alias for "command line".<br /> 426 Add "name" as an alias for "command line". <tt>
424 Aliases are expanded only once, thus they can not be chained.<br /> 427 Aliases are expanded only once, thus they can not be chained. </tt>
425 "/alias name" displays the value associated with the "name" alias;<br /> 428 "/alias name" displays the value associated with the "name" alias; <tt>
426 "/alias name =" unsets the "name" alias.<br /> 429 "/alias name =" unsets the "name" alias. </tt>
427 "/alias" displays a list of the existing aliases.<br /> 430 "/alias" displays a list of the existing aliases.<br />
428 Example: "/alias away = status away". 431 Example: "/alias away = status away".
429 </dd> 432 </dd>
430 <dt><b> 433 <dt><b>
431 /bind [keycode [= command line]] 434 /bind [keycode [= command line]]
432 </b></dt> 435 </b></dt>
433 <dd> 436 <dd>
434 Bind a command line to the key with the "keycode" code number.<br /> 437 Bind a command line to the key with the "keycode" code number. <tt>
435 Keycodes of unused keys are displayed by <tt>mcabber</tt> in the log window 438 Keycodes of unused keys are displayed by <tt>mcabber</tt> in the log window
436 when pressing the key, for example "Unknown key=265".<br /> 439 when pressing the key, for example "Unknown key=265". </tt>
437 "/bind keycode" displays the command line bound to the given keycode;<br /> 440 "/bind keycode" displays the command line bound to the given keycode; <tt>
438 "/bind keycode =" unbinds the given keycode.<br /> 441 "/bind keycode =" unbinds the given keycode. </tt>
439 "/bind" displays a list of the bound keycodes.<br /> 442 "/bind" displays a list of the bound keycodes. <tt>
440 Note: aliases can be used in key bindings.<br /> 443 Note: aliases can be used in key bindings. </tt>
441 Example: "/bind 265 = status online" (265 is F1 for me, but it may 444 Example: "/bind 265 = status online" (265 is F1 for me, but it may
442 depend on your ncurses installation). 445 depend on your ncurses installation).
443 </dd> 446 </dd>
444 <dt><b> 447 <dt><b>
445 /buffer clear|close|close_all|purge 448 /buffer clear|close|close_all|purge
591 <dt><b> 594 <dt><b>
592 /quit 595 /quit
593 </b></dt> 596 </b></dt>
594 <dd> 597 <dd>
595 Disconnect and leave <tt>mcabber(1)</tt>. 598 Disconnect and leave <tt>mcabber(1)</tt>.
599 </dd>
600 <dt><b>
601 /set option[=value]
602 </b></dt>
603 <dd>
604 Display or set an option value.
605 </dd>
606 <dt><b>
607 /source [file]
608 </b></dt>
609 <dd>
610 Read a configuration file.
596 </dd> 611 </dd>
597 <dt><b> 612 <dt><b>
598 /version 613 /version
599 </b></dt> 614 </b></dt>
600 <dd> 615 <dd>
781 <dt><b> 796 <dt><b>
782 /msay begin|verbatim|send|send_to|toggle|toggle_verbatim|abort 797 /msay begin|verbatim|send|send_to|toggle|toggle_verbatim|abort
783 </b></dt> 798 </b></dt>
784 <dd> 799 <dd>
785 Send a multi-line message. To write a single message with several 800 Send a multi-line message. To write a single message with several
786 lines, the <b>multi-line mode</b> should be used.<br /> 801 lines, the <b>multi-line mode</b> should be used. <tt>
787 In multi-line mode, each line (except command lines) typed in the input 802 In multi-line mode, each line (except command lines) typed in the input
788 line will be added to the multi-line message. Once the message is 803 line will be added to the multi-line message. Once the message is
789 finished, it can be sent to the current selected buddy with the "/msay 804 finished, it can be sent to the current selected buddy with the "/msay
790 send" command (or Ctrl-d).<br /> 805 send" command (or Ctrl-d). </tt>
791 The <b>begin</b> subcommand enables multi-line mode. Note that it allows 806 The <b>begin</b> subcommand enables multi-line mode. Note that it allows
792 a message subject to be specified.<br /> 807 a message subject to be specified. <tt>
793 The <b>verbatim</b> multi-line mode disables commands, so that it is 808 The <b>verbatim</b> multi-line mode disables commands, so that it is
794 possible to enter lines starting with a slash. Only the "/msay" 809 possible to enter lines starting with a slash. Only the "/msay"
795 command (with send or abort parameters) can be used to exit verbatim 810 command (with send or abort parameters) can be used to exit verbatim
796 mode.<br /> 811 mode. </tt>
797 The <b>toggle</b> and <b>toggle_verbatim</b> subcommands can be bound to a key to 812 The <b>toggle</b> and <b>toggle_verbatim</b> subcommands can be bound to a key to
798 use the multi-line mode quickly (for example, "bind M109 = msay toggle" 813 use the multi-line mode quickly (for example, "bind M109 = msay toggle"
799 to switch using the Meta-m combination). 814 to switch using the Meta-m combination).
800 <table class="hlist"> 815 <table class="hlist">
801 <tr valign="top"> 816 <tr valign="top">
855 </td> 870 </td>
856 </tr> 871 </tr>
857 </table> 872 </table>
858 </dd> 873 </dd>
859 <dt><b> 874 <dt><b>
860 /pgp disable|enable|info [jid] 875 /pgp disable|enable|force|info [jid]
861 </b></dt> 876 </b></dt>
862 <dt><b> 877 <dt><b>
863 /pgp setkey [jid [key]] 878 /pgp setkey [jid [key]]
864 </b></dt> 879 </b></dt>
865 <dd> 880 <dd>
877 <td> 892 <td>
878 <b>enable</b> [jid] 893 <b>enable</b> [jid]
879 </td> 894 </td>
880 <td> 895 <td>
881 enable PGP encryption for jid (or the currently selected contact) 896 enable PGP encryption for jid (or the currently selected contact)
897 </td>
898 </tr>
899 <tr valign="top">
900 <td>
901 <b>force</b> [jid]
902 </td>
903 <td>
904 enforce PGP encryption, even for offline messages, and always assume the recipient has PGP support
882 </td> 905 </td>
883 </tr> 906 </tr>
884 <tr valign="top"> 907 <tr valign="top">
885 <td> 908 <td>
886 <b>info</b> [jid] 909 <b>info</b> [jid]
943 leave the current room 966 leave the current room
944 </td> 967 </td>
945 </tr> 968 </tr>
946 <tr valign="top"> 969 <tr valign="top">
947 <td> 970 <td>
948 <b>names</b> 971 <b>names</b> [--short|--quiet]
949 </td> 972 </td>
950 <td> 973 <td>
951 display members of the current room 974 display the members of the current room
952 </td> 975 </td>
953 </tr> 976 </tr>
954 <tr valign="top"> 977 <tr valign="top">
955 <td> 978 <td>
956 <b>nick</b> nick 979 <b>nick</b> nick
1246 </dd> 1269 </dd>
1247 <dt><b> 1270 <dt><b>
1248 /status [online|avail|invisible|free|dnd|notavail|away [-|StatusMessage]] 1271 /status [online|avail|invisible|free|dnd|notavail|away [-|StatusMessage]]
1249 </b></dt> 1272 </b></dt>
1250 <dd> 1273 <dd>
1251 Show or set the current status.<br /> 1274 Show or set the current status. <tt>
1252 If no status is specified, display the current status.<br /> 1275 If no status is specified, display the current status. </tt>
1253 If a status message is specified, it will overrride the message* 1276 If a status message is specified, it will overrride the message*
1254 variables (these variables can be set in the configuration file). 1277 variables (these variables can be set in the configuration file).
1255 If no relevant message* variable is set and no status message provided, 1278 If no relevant message* variable is set and no status message provided,
1256 the current status message is kept. If StatusMessage is "-", the 1279 the current status message is kept. If StatusMessage is "-", the
1257 current status message is cleared. 1280 current status message is cleared.
1258 </dd> 1281 </dd>
1259 <dt><b> 1282 <dt><b>
1260 /status_to jid online|avail|invisible|free|dnd|notavail|away [StatusMessage] 1283 /status_to jid online|avail|invisible|free|dnd|notavail|away [StatusMessage]
1261 </b></dt> 1284 </b></dt>
1262 <dd> 1285 <dd>
1263 Send the requested status to the specified Jabber user.<br /> 1286 Send the requested status to the specified Jabber user. <tt>
1264 If the specified jid is ".", the current buddy is used.<br /> 1287 If the specified jid is ".", the current buddy is used. </tt>
1265 Note: this status will be overridden by subsequent "/status" commands. 1288 Note: this status will be overridden by subsequent "/status" commands.
1266 If you are using the auto-away feature, the status will overridden 1289 If you are using the auto-away feature, the status will overridden
1267 too.<br /> 1290 too.<br />
1268 Note: The jid can include a resource (i.e. user@server/resource). 1291 Note: The jid can include a resource (i.e. user@server/resource).
1269 </dd> 1292 </dd>
1282 Originally based on <a href="http://cabber.sourceforge.net">Cabber</a>, please 1305 Originally based on <a href="http://cabber.sourceforge.net">Cabber</a>, please
1283 consult the AUTHORS file for details.</p> 1306 consult the AUTHORS file for details.</p>
1284 <h2>RESOURCES</h2> 1307 <h2>RESOURCES</h2>
1285 <p><a href="http://www.lilotux.net/~mikael/mcabber/">Main web site</a></p> 1308 <p><a href="http://www.lilotux.net/~mikael/mcabber/">Main web site</a></p>
1286 <h2>COPYING</h2> 1309 <h2>COPYING</h2>
1287 <p>Copyright (C) 2005, 2006 Mikael Berthe.<br /> 1310 <p>Copyright (C) 2005, 2006, 2007 Mikael Berthe.<br />
1288 Some portions are Copyright (C) 2002-2004 <a href="mailto:cabber@ajmacias.com">cabber@ajmacias.com</a>.</p> 1311 Some portions are Copyright (C) 2002-2004 <a href="mailto:cabber@ajmacias.com">cabber@ajmacias.com</a>.</p>
1289 <p>Free use of this software is granted under the terms of the GNU General Public 1312 <p>Free use of this software is granted under the terms of the GNU General Public
1290 License (GPL).</p> 1313 License (GPL).</p>
1291 <div id="footer"> 1314 <div id="footer">
1292 <p> 1315 <p>
1293 Version 0.9.3-dev<br /> 1316 Version 0.9.3-dev<br />
1294 Last updated 04-Feb-2007 11:44:42 CEST 1317 Last updated 17-Jun-2007 17:36:09 CEST
1295 </p> 1318 </p>
1296 </div> 1319 </div>
1297 </div> 1320 </div>
1298 </body> 1321 </body>
1299 </html> 1322 </html>