changeset 289:72fa52203651

Update documentation * Update /alias doc * Add documentation for /bind * Improve /msay help for AsciiDoc and HTML formats. Don't know how to get a better presentation with the manpage format :(
author Mikael Berthe <mikael@lilotux.net>
date Fri, 08 Jul 2005 22:10:42 +0100
parents 1eea0fa0955e
children f63839a4cb35
files mcabber/doc/mcabber.1 mcabber/doc/mcabber.1.html mcabber/doc/mcabber.1.txt
diffstat 3 files changed, 56 insertions(+), 21 deletions(-) [+]
line wrap: on
line diff
--- a/mcabber/doc/mcabber.1	Fri Jul 08 21:47:17 2005 +0100
+++ b/mcabber/doc/mcabber.1	Fri Jul 08 22:10:42 2005 +0100
@@ -111,7 +111,11 @@
 
 .TP
 \fB/alias\fR name = command line
-Add "name" as an alias for "command line"\&. Example: "/alias away = status away"\&. Aliases are expanded only once, thus they can not be chained\&.
+Add "name" as an alias for "command line"\&. Aliases are expanded only once, thus they can not be chained\&. "/alias name" displays the value associated with the "name" alias; "/alias name =" unsets the "name" alias\&. Example: "/alias away = status away"\&.
+
+.TP
+\fB/bind\fR keycode = command line
+Bind a command line to the key with the "keycode" code number\&. Keycodes of unused keys are displayed by mcabber in the log window when pressing the key, for example "Unknown key=265"\&. "/bind keycode" displays the command line bound to the given keycode; "/bind keycode" unbinds the given keycode\&. Note: aliases can be used in key bindings\&. Example: "/bind 265 = status online" (265 is F1 for me, but it can depend on your ncurses installation)\&.
 
 .TP
 \fB/buffer\fR clear|top|bottom
--- a/mcabber/doc/mcabber.1.html	Fri Jul 08 21:47:17 2005 +0100
+++ b/mcabber/doc/mcabber.1.html	Fri Jul 08 22:10:42 2005 +0100
@@ -201,9 +201,24 @@
 /alias name = command line
 </b></dt>
 <dd>
-        Add "name" as an alias for "command line".
+        Add "name" as an alias for "command line".<br />
+        Aliases are expanded only once, thus they can not be chained.<br />
+        "/alias name" displays the value associated with the "name" alias;
+        "/alias name =" unsets the "name" alias.<br />
         Example: "/alias away = status away".
-        Aliases are expanded only once, thus they can not be chained.
+</dd>
+<dt><b>
+/bind keycode = command line
+</b></dt>
+<dd>
+        Bind a command line to the key with the "keycode" code number.<br />
+        Keycodes of unused keys are displayed by mcabber in the log window
+        when pressing the key, for example "Unknown key=265".<br />
+        "/bind keycode" displays the command line bound to the given keycode;
+        "/bind keycode" unbinds the given keycode.<br />
+        Note: aliases can be used in key bindings.<br />
+        Example: "/bind 265 = status online" (265 is F1 for me, but it can
+        depend on your ncurses installation).
 </dd>
 <dt><b>
 /buffer clear|top|bottom
@@ -302,13 +317,15 @@
 </b></dt>
 <dd>
         Send a multi-line message.  To write a single message with several
-        lines, the <b>multi-line mode</b> should be used.  In multi-line mode,
-        each line (except command lines) typed in the input line will
-        be added to the multi-line message.  Once the message is finished, it
-        can be sent to the current selected buddy with the "msay /send"
-        command.  The <b>verbatim</b> multi-line mode disables commands, so that it
-        is possible to enter lines starting with a slash.  Only the "/msay"
-        command (with send or abort parameters) can be used to exit verbatim mode.
+        lines, the <b>multi-line mode</b> should be used.<br />
+        In multi-line mode, each line (except command lines) typed in the input
+        line will be added to the multi-line message.  Once the message is
+        finished, it can be sent to the current selected buddy with the "msay
+        /send" command.<br />
+        The <b>verbatim</b> multi-line mode disables commands, so that it is
+        possible to enter lines starting with a slash.  Only the "/msay"
+        command (with send or abort parameters) can be used to exit verbatim
+        mode.
 <table class="hlist">
 <tr valign="top">
 <td>
@@ -463,7 +480,7 @@
 <div id="footer">
 <p>
 Version 0.6.2<br />
-Last updated 08-Jul-2005 08:18:39 CEST
+Last updated 08-Jul-2005 23:04:30 CEST
 </p>
 </div>
 </div>
--- a/mcabber/doc/mcabber.1.txt	Fri Jul 08 21:47:17 2005 +0100
+++ b/mcabber/doc/mcabber.1.txt	Fri Jul 08 22:10:42 2005 +0100
@@ -1,7 +1,7 @@
 MCABBER(1)
 ===========
 Mikael BERTHE <mcabber@lilotux.net>
-v0.6.2, June 2005
+v0.6.2, July 2005
 
 NAME
 ----
@@ -83,9 +83,21 @@
         jid is used.
 
 /alias name = command line::
-        Add "name" as an alias for "command line".
+        Add "name" as an alias for "command line". +
+        Aliases are expanded only once, thus they can not be chained. +
+        "/alias name" displays the value associated with the "name" alias;
+        "/alias name =" unsets the "name" alias. +
         Example: "/alias away = status away".
-        Aliases are expanded only once, thus they can not be chained.
+
+/bind keycode = command line::
+        Bind a command line to the key with the "keycode" code number. +
+        Keycodes of unused keys are displayed by mcabber in the log window
+        when pressing the key, for example "Unknown key=265". +
+        "/bind keycode" displays the command line bound to the given keycode;
+        "/bind keycode" unbinds the given keycode. +
+        Note: aliases can be used in key bindings. +
+        Example: "/bind 265 = status online" (265 is F1 for me, but it can
+        depend on your ncurses installation).
 
 /buffer clear|top|bottom::
         The 'buffer' command manipulates the current buddy's buffer
@@ -119,13 +131,15 @@
 
 /msay begin|verbatim|send|abort::
         Send a multi-line message.  To write a single message with several
-        lines, the 'multi-line mode' should be used.  In multi-line mode,
-        each line (except command lines) typed in the input line will
-        be added to the multi-line message.  Once the message is finished, it
-        can be sent to the current selected buddy with the "msay /send"
-        command.  The 'verbatim' multi-line mode disables commands, so that it
-        is possible to enter lines starting with a slash.  Only the "/msay"
-        command (with send or abort parameters) can be used to exit verbatim mode.
+        lines, the 'multi-line mode' should be used. +
+        In multi-line mode, each line (except command lines) typed in the input
+        line will be added to the multi-line message.  Once the message is
+        finished, it can be sent to the current selected buddy with the "msay
+        /send" command. +
+        The 'verbatim' multi-line mode disables commands, so that it is
+        possible to enter lines starting with a slash.  Only the "/msay"
+        command (with send or abort parameters) can be used to exit verbatim
+        mode.
 
         'begin';; enter multi-line mode
         'verbatim';; enter verbatim multi-line mode