changeset 870:4b77a2ab18e5

Update manpage
author Mikael Berthe <mikael@lilotux.net>
date Thu, 25 May 2006 19:02:23 +0200
parents 9ce308598c0a
children cb54c9d76853
files mcabber/doc/mcabber.1 mcabber/doc/mcabber.1.html mcabber/doc/mcabber.1.txt
diffstat 3 files changed, 51 insertions(+), 18 deletions(-) [+]
line wrap: on
line diff
--- a/mcabber/doc/mcabber.1	Thu May 25 19:01:45 2006 +0200
+++ b/mcabber/doc/mcabber.1	Thu May 25 19:02:23 2006 +0200
@@ -176,28 +176,35 @@
 .SH "COMMANDS RELATED TO MCABBER"
 
 .TP
-\fB/alias\fR name = command line
+\fB/alias\fR [name [= 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\&.
+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\&.
+"/alias" displays a list of the existing aliases\&.
 
 Example: "/alias away = status away"\&.
 
 .TP
-\fB/bind\fR keycode = command line
+\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\&.
+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\&.
+"/bind" displays a list of the bound keycodes\&.
 
 Note: aliases can be used in key bindings\&.
 
 Example: "/bind 265 = status online" (265 is F1 for me, but it may depend on your ncurses installation)\&.
 
 .TP
-\fB/buffer\fR clear|top|bottom|date|%|search_backward|search_forward
+\fB/buffer\fR clear|purge|top|bottom|date|%|search_backward|search_forward
 The buffer command manipulates the current buddy's buffer (chat window)\&.
 
  \fBclear\fR      	clear the current buddy chat window
+ \fBpurge\fR      	purge the current buddy chat window
  \fBbottom\fR     	jump to the bottom of the current buddy chat buffer
  \fBtop\fR        	jump to the top of the current buddy chat buffer
  \fBup\fR [n]     	scroll the buffer up n lines (default: half a screen)
@@ -212,6 +219,10 @@
 The clear command is actually an alias for "/buffer clear"\&.
 
 .TP
+\fB/help\fR [command]
+Display generic help or help about a specific mcabber command\&.
+
+.TP
 \fB/quit\fR
 Disconnect and leave mcabber(1)\&.
 
--- a/mcabber/doc/mcabber.1.html	Thu May 25 19:01:45 2006 +0200
+++ b/mcabber/doc/mcabber.1.html	Thu May 25 19:02:23 2006 +0200
@@ -391,30 +391,32 @@
 <h2>COMMANDS RELATED TO MCABBER</h2>
 <dl>
 <dt><b>
-/alias name = command line
+/alias [name [= command line]]
 </b></dt>
 <dd>
         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" displays the value associated with the "name" alias;<br />
         "/alias name =" unsets the "name" alias.<br />
+        "/alias" displays a list of the existing aliases.<br />
         Example: "/alias away = status away".
 </dd>
 <dt><b>
-/bind keycode = command line
+/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 <tt>mcabber</tt> 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 />
+        "/bind keycode" displays the command line bound to the given keycode;<br />
+        "/bind keycode =" unbinds the given keycode.<br />
+        "/bind" displays a list of the bound keycodes.<br />
         Note: aliases can be used in key bindings.<br />
         Example: "/bind 265 = status online" (265 is F1 for me, but it may
         depend on your ncurses installation).
 </dd>
 <dt><b>
-/buffer clear|top|bottom|date|%|search_backward|search_forward
+/buffer clear|purge|top|bottom|date|%|search_backward|search_forward
 </b></dt>
 <dd>
         The <b>buffer</b> command manipulates the current buddy's buffer
@@ -430,6 +432,14 @@
 </tr>
 <tr valign="top">
 <td>
+<b>purge</b>
+</td>
+<td>
+purge the current buddy chat window
+</td>
+</tr>
+<tr valign="top">
+<td>
 <b>bottom</b>
 </td>
 <td>
@@ -501,6 +511,12 @@
         The <b>clear</b> command is actually an alias for "/buffer clear".
 </dd>
 <dt><b>
+/help [command]
+</b></dt>
+<dd>
+        Display generic help or help about a specific mcabber command.
+</dd>
+<dt><b>
 /quit
 </b></dt>
 <dd>
@@ -1106,7 +1122,7 @@
 <div id="footer">
 <p>
 Version 0.7.7-dev<br />
-Last updated 13-May-2006 12:23:01 CEST
+Last updated 25-May-2006 18:50:24 CEST
 </p>
 </div>
 </div>
--- a/mcabber/doc/mcabber.1.txt	Thu May 25 19:01:45 2006 +0200
+++ b/mcabber/doc/mcabber.1.txt	Thu May 25 19:02:23 2006 +0200
@@ -154,28 +154,31 @@
 
 COMMANDS RELATED TO MCABBER
 ---------------------------
-/alias name = command line::
+/alias [name [= 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" displays the value associated with the "name" alias; +
         "/alias name =" unsets the "name" alias. +
+        "/alias" displays a list of the existing aliases. +
         Example: "/alias away = status away".
 
-/bind keycode = command line::
+/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. +
+        "/bind keycode" displays the command line bound to the given keycode; +
+        "/bind keycode =" unbinds the given keycode. +
+        "/bind" displays a list of the bound keycodes. +
         Note: aliases can be used in key bindings. +
         Example: "/bind 265 = status online" (265 is F1 for me, but it may
         depend on your ncurses installation).
 
-/buffer clear|top|bottom|date|%|search_backward|search_forward::
+/buffer clear|purge|top|bottom|date|%|search_backward|search_forward::
         The 'buffer' command manipulates the current buddy's buffer
         (chat window).
 
         'clear';;                clear the current buddy chat window
+        'purge';;                purge the current buddy chat window
         'bottom';;               jump to the bottom of the current buddy chat buffer
         'top';;                  jump to the top of the current buddy chat buffer
         'up' [n];;               scroll the buffer up n lines (default: half a screen)
@@ -188,6 +191,9 @@
 /clear::
         The 'clear' command is actually an alias for "/buffer clear".
 
+/help [command]::
+        Display generic help or help about a specific mcabber command.
+
 /quit::
         Disconnect and leave `mcabber(1)`.