changeset 618:341568185492

Update documentation
author Mikael Berthe <mikael@lilotux.net>
date Fri, 16 Dec 2005 16:20:30 +0100
parents d3a8b43bf9e7
children 44ddf9bec3a5
files mcabber/ChangeLog mcabber/doc/mcabber.1 mcabber/doc/mcabber.1.html mcabber/doc/mcabber.1.txt
diffstat 4 files changed, 123 insertions(+), 35 deletions(-) [+]
line wrap: on
line diff
--- a/mcabber/ChangeLog	Fri Dec 16 13:34:13 2005 +0100
+++ b/mcabber/ChangeLog	Fri Dec 16 16:20:30 2005 +0100
@@ -5,6 +5,8 @@
    Commands now handle correctly resources or nicknames containing whitespace
  * The roster is updated in real time when receiving an update from the server
  * /info shows subscriptions (none, from, to, both)
+ * Add "/authorization" command, to manage subscriptions
+ * mcabber now answers IQ requests
  * The deprecated Agent list IQ request has been removed
  * Empty resources are displayed (do not use the arbitrary "default" string
    instead)
@@ -14,8 +16,11 @@
  * MUC: Add "/room affil" and "/room role"
  * MUC: Add "/room destroy"
  * MUC: Display a message when somebody is kicked/banned from a room
- * MUC: Multiple fixes and improvements
+ * MUC: Display a message (and the reason, if there is one) when a room has
+   been destroyed
+ * MUC: Multiple other fixes and improvements
  * Handle messages beginning with "/me " (it is replaced with the nickname)
+ * Documentation update
 
  -- Mikael, ?
 
--- a/mcabber/doc/mcabber.1	Fri Dec 16 13:34:13 2005 +0100
+++ b/mcabber/doc/mcabber.1	Fri Dec 16 16:20:30 2005 +0100
@@ -56,6 +56,9 @@
  Commands completion: If possible, mcabber will try to complete your command line if you hit the Tab key\&.
 .TP
 \(bu
+ Input line history: Any message or command entered is in the input line history and can be reused easily\&.
+.TP
+\(bu
  External actions: Some events (like receiving a message) can trigger an external action, for example a shell script (you need to enable it in your configuration file)\&. A sample events script ("eventcmd") is provided with mcabber source code, in the contrib directory\&.
 .LP
 
@@ -78,6 +81,9 @@
 PageUp and PageDown keys are used to move in the roster\&.
 
 
+Up and Down arrow keys can be used to move in the input line history; they jump to the previous/next line from the history beginning with the same string (from first column to the cursor column)\&.
+
+
 To send a message, move to the choosen buddy in the buddylist, type your message and hit enter\&. If the line begins with a slash, this will be interpreted as a command (see the COMMAND section below)\&. Hit escape to leave the chat mode\&.
 
 Here is a quick description of the key bindings:
@@ -86,11 +92,13 @@
 
 Ctrl\-e		Go to the end of the input line
 
-Ctrl\-l		Force a resize
+Ctrl\-l		Force a refresh
+
+Up/Down     	Move in the input line history
 
 PgUp/PgDown	Move inside the roster (buddylist)
 
-Tab			Complete current word, in the input line
+Tab    		Complete current word, in the input line
 
 Ctrl\-g		Cancel completion / ctrl\-g
 
@@ -124,6 +132,16 @@
 Example: "/alias away = status away"\&.
 
 .TP
+\fB/authorization\fR allow|cancel|request [jid]
+Manage the presence subscriptions\&.
+
+If no jid is provided, the current buddy is used\&.
+
+ \fBallow\fR  	allow the buddy to receive your presence updates
+ \fBcancel\fR 	cancel the buddy' subscription to your presence updates
+ \fBrequest\fR	request a subscription to the buddy's presence updates
+
+.TP
 \fB/bind\fR keycode = command line
 Bind a command line to the key with the "keycode" code number\&.
 
@@ -134,18 +152,18 @@
 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|search_backward|search_forward
+\fB/buffer\fR clear|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
- \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)
- \fBdown\fR [n]            	scroll the buffer down n lines (default: half a screen)
+ \fBclear\fR      	clear 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)
+ \fBdown\fR [n]   	scroll the buffer down n lines (default: half a screen)
+ \fBdate\fR date  	jump to the first line after the specified date in the chat buffer (date format: "YYYY\-mm\-dd[THH:MM:SS]", "\-" and ":" are optional)
+ \fB%\fR n        	jump to position %n of the buddy chat buffer
  \fBsearch_backward\fR text	search for "text" in the current buddy chat buffer
  \fBsearch_forward\fR  text	search for "text" in the current buddy chat buffer
- \fBdate\fR date           	jump to the first line after the specified date in the chat buffer (date format: "YYYY\-mm\-dd[THH:MM:SS]", "\-" and ":" are optional)
- \fB%\fR n                 	jump to position %n of the buddy chat buffer
 
 .TP
 \fB/clear\fR
@@ -234,7 +252,7 @@
  \fBshow_offline\fR	show offline buddies
  \fBtoggle_offline\fR	toggle display of offline buddies
  \fBsearch\fR bud	search for a buddy with a name or buddy containing "bud" (only in the displayed buddylist)
- \fBalternate\fR	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")
+ \fBalternate\fR 	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")
  \fBunread_first\fR	jump to the first unread message
  \fBunread_next\fR	jump to the next unread message
 
--- a/mcabber/doc/mcabber.1.html	Fri Dec 16 13:34:13 2005 +0100
+++ b/mcabber/doc/mcabber.1.html	Fri Dec 16 16:20:30 2005 +0100
@@ -58,6 +58,12 @@
 </li>
 <li>
 <p>
+<b>Input line history:</b>  Any message or command entered is in the input line
+  history and can be reused easily.
+</p>
+</li>
+<li>
+<p>
 <b>External actions:</b>  Some events (like receiving a message) can trigger an
   external action, for example a shell script (you need to enable it in your
   configuration file).  A sample events script ("eventcmd") is provided with
@@ -84,6 +90,9 @@
 <p>Text typing occurs in the <b>input line</b>; basic operations are supported
 (left arrow, right arrow, home/end keys, insert, delete, backspace&#8230;).</p>
 <p>PageUp and PageDown keys are used to move in the roster.</p>
+<p>Up and Down arrow keys can be used to move in the input line history; they
+jump to the previous/next line from the history beginning with the same string
+(from first column to the cursor column).</p>
 <p>To send a message, move to the choosen buddy in the buddylist, type your
 message and hit enter.  If the line begins with a slash, this will be
 interpreted as a command (see the COMMAND section below).  Hit escape to
@@ -111,7 +120,15 @@
 Ctrl-l
 </td>
 <td>
-Force a resize
+Force a refresh
+</td>
+</tr>
+<tr valign="top">
+<td>
+Up/Down
+</td>
+<td>
+Move in the input line history
 </td>
 </tr>
 <tr valign="top">
@@ -216,6 +233,39 @@
         Example: "/alias away = status away".
 </dd>
 <dt><b>
+/authorization allow|cancel|request [jid]
+</b></dt>
+<dd>
+        Manage the presence subscriptions.<br />
+        If no jid is provided, the current buddy is used.
+<table class="hlist">
+<tr valign="top">
+<td>
+<b>allow</b>
+</td>
+<td>
+allow the buddy to receive your presence updates
+</td>
+</tr>
+<tr valign="top">
+<td>
+<b>cancel</b>
+</td>
+<td>
+cancel the buddy' subscription to your presence updates
+</td>
+</tr>
+<tr valign="top">
+<td>
+<b>request</b>
+</td>
+<td>
+request a subscription to the buddy's presence updates
+</td>
+</tr>
+</table>
+</dd>
+<dt><b>
 /bind keycode = command line
 </b></dt>
 <dd>
@@ -229,7 +279,7 @@
         depend on your ncurses installation).
 </dd>
 <dt><b>
-/buffer clear|top|bottom|search_backward|search_forward|date|%
+/buffer clear|top|bottom|date|%|search_backward|search_forward
 </b></dt>
 <dd>
         The <b>buffer</b> command manipulates the current buddy's buffer
@@ -277,6 +327,22 @@
 </tr>
 <tr valign="top">
 <td>
+<b>date</b> date
+</td>
+<td>
+jump to the first line after the specified date in the chat buffer (date format: "YYYY-mm-dd[THH:MM:SS]", "-" and ":" are optional)
+</td>
+</tr>
+<tr valign="top">
+<td>
+<b>%</b> n
+</td>
+<td>
+jump to position %n of the buddy chat buffer
+</td>
+</tr>
+<tr valign="top">
+<td>
 <b>search_backward</b> text
 </td>
 <td>
@@ -291,22 +357,6 @@
 search for "text" in the current buddy chat buffer
 </td>
 </tr>
-<tr valign="top">
-<td>
-<b>date</b> date
-</td>
-<td>
-jump to the first line after the specified date in the chat buffer (date format: "YYYY-mm-dd[THH:MM:SS]", "-" and ":" are optional)
-</td>
-</tr>
-<tr valign="top">
-<td>
-<b>%</b> n
-</td>
-<td>
-jump to position %n of the buddy chat buffer
-</td>
-</tr>
 </table>
 </dd>
 <dt><b>
@@ -750,7 +800,7 @@
 <div id="footer">
 <p>
 Version 0.7.2-dev<br />
-Last updated 14-Dec-2005 00:04:31 CEST
+Last updated 16-Dec-2005 16:12:33 CEST
 </p>
 </div>
 </div>
--- a/mcabber/doc/mcabber.1.txt	Fri Dec 16 13:34:13 2005 +0100
+++ b/mcabber/doc/mcabber.1.txt	Fri Dec 16 16:20:30 2005 +0100
@@ -37,6 +37,8 @@
   `mcabber` can save discussions to history log files.
 - 'Commands completion:'  If possible, `mcabber` will try to complete your
   command line if you hit the Tab key.
+- 'Input line history:'  Any message or command entered is in the input line
+  history and can be reused easily.
 - 'External actions:'  Some events (like receiving a message) can trigger an
   external action, for example a shell script (you need to enable it in your
   configuration file).  A sample events script ("eventcmd") is provided with
@@ -58,6 +60,10 @@
 
 PageUp and PageDown keys are used to move in the roster.
 
+Up and Down arrow keys can be used to move in the input line history; they
+jump to the previous/next line from the history beginning with the same string
+(from first column to the cursor column).
+
 To send a message, move to the choosen buddy in the buddylist, type your
 message and hit enter.  If the line begins with a slash, this will be
 interpreted as a command (see the COMMAND section below).  Hit escape to
@@ -67,7 +73,8 @@
 
 Ctrl-a::        Go to the beginning of the input line
 Ctrl-e::        Go to the end of the input line
-Ctrl-l::        Force a resize
+Ctrl-l::        Force a refresh
+Up/Down::       Move in the input line history
 PgUp/PgDown::   Move inside the roster (buddylist)
 Tab::           Complete current word, in the input line
 Ctrl-g::        Cancel completion / ctrl-g
@@ -94,6 +101,14 @@
         "/alias name =" unsets the "name" alias. +
         Example: "/alias away = status away".
 
+/authorization allow|cancel|request [jid]::
+        Manage the presence subscriptions. +
+        If no jid is provided, the current buddy is used.
+
+        'allow';;   allow the buddy to receive your presence updates
+        'cancel';;  cancel the buddy' subscription to your presence updates
+        'request';; request a subscription to the buddy's presence updates
+
 /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
@@ -104,7 +119,7 @@
         Example: "/bind 265 = status online" (265 is F1 for me, but it may
         depend on your ncurses installation).
 
-/buffer clear|top|bottom|search_backward|search_forward|date|%::
+/buffer clear|top|bottom|date|%|search_backward|search_forward::
         The 'buffer' command manipulates the current buddy's buffer
         (chat window).
 
@@ -113,10 +128,10 @@
         'top';;                  jump to the top of the current buddy chat buffer
         'up' [n];;               scroll the buffer up n lines (default: half a screen)
         'down' [n];;             scroll the buffer down n lines (default: half a screen)
+        'date' date;;            jump to the first line after the specified date in the chat buffer (date format: "YYYY-mm-dd[THH:MM:SS]", "-" and ":" are optional)
+        '%' n;;                  jump to position %n of the buddy chat buffer
         'search_backward' text;; search for "text" in the current buddy chat buffer
         'search_forward'  text;; search for "text" in the current buddy chat buffer
-        'date' date;;            jump to the first line after the specified date in the chat buffer (date format: "YYYY-mm-dd[THH:MM:SS]", "-" and ":" are optional)
-        '%' n;;                  jump to position %n of the buddy chat buffer
 
 /clear::
         The 'clear' command is actually an alias for "/buffer clear".