changeset 511:c7cdb9c6d7aa

Update documentation
author Mikael Berthe <mikael@lilotux.net>
date Sat, 12 Nov 2005 17:49:29 +0100
parents 6c3cd3aa4a91
children 1744664332cd
files mcabber/doc/mcabber.1 mcabber/doc/mcabber.1.html mcabber/doc/mcabber.1.txt mcabber/mcabberrc.example
diffstat 4 files changed, 37 insertions(+), 9 deletions(-) [+]
line wrap: on
line diff
--- a/mcabber/doc/mcabber.1	Sat Nov 12 17:36:20 2005 +0100
+++ b/mcabber/doc/mcabber.1	Sat Nov 12 17:49:29 2005 +0100
@@ -138,8 +138,10 @@
 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
- \fBbottom\fR              	jump to the bottom 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)
  \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)
--- a/mcabber/doc/mcabber.1.html	Sat Nov 12 17:36:20 2005 +0100
+++ b/mcabber/doc/mcabber.1.html	Sat Nov 12 17:49:29 2005 +0100
@@ -245,6 +245,14 @@
 </tr>
 <tr valign="top">
 <td>
+<b>bottom</b>
+</td>
+<td>
+jump to the bottom of the current buddy chat buffer
+</td>
+</tr>
+<tr valign="top">
+<td>
 <b>top</b>
 </td>
 <td>
@@ -253,10 +261,18 @@
 </tr>
 <tr valign="top">
 <td>
-<b>bottom</b>
+<b>up</b> [n]
 </td>
 <td>
-jump to the bottom of the current buddy chat buffer
+scroll the buffer up n lines (default: half a screen)
+</td>
+</tr>
+<tr valign="top">
+<td>
+<b>down</b> [n]
+</td>
+<td>
+scroll the buffer down n lines (default: half a screen)
 </td>
 </tr>
 <tr valign="top">
@@ -680,7 +696,7 @@
 <div id="footer">
 <p>
 Version 0.7.1-dev<br />
-Last updated 11-Nov-2005 22:43:12 CEST
+Last updated 12-Nov-2005 17:44:00 CEST
 </p>
 </div>
 </div>
--- a/mcabber/doc/mcabber.1.txt	Sat Nov 12 17:36:20 2005 +0100
+++ b/mcabber/doc/mcabber.1.txt	Sat Nov 12 17:49:29 2005 +0100
@@ -109,8 +109,10 @@
         (chat window).
 
         'clear';;                clear 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
-        'bottom';;               jump to the bottom 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)
         '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)
--- a/mcabber/mcabberrc.example	Sat Nov 12 17:36:20 2005 +0100
+++ b/mcabber/mcabberrc.example	Sat Nov 12 17:49:29 2005 +0100
@@ -80,7 +80,7 @@
 #set tracelog_level = 1
 #set tracelog_file = /home/mikael/mcabber.log
 
-#  Status messages
+# Status messages
 # The "message" value will override all others, take care!
 #set message = Unique message status
 #set message_avail     = I'm available
@@ -90,7 +90,7 @@
 #set message_away      = I'm away
 #set message_autoaway  = Auto-away
 
-#  Colors
+# Colors
 # Colors are: black, red, green, yellow, blue, magenta, cyan, white
 # You can use the "default" color, too (i.e. for transparent background)
 #set color_background   = blue
@@ -100,13 +100,21 @@
 #set color_rosterselect = black
 #set color_backselected = cyan
 
-#  Aliases
+# Style
+# Buddy name format (in status window):
+# - 0: (default) "<jid/resource>"
+# - 1: "name <jid/resource>" (name is omitted if same as the jid)
+# - 2: "name/resource" (if the name is the same as the jid, use <jid/res>)
+# - 3: "name" (if the name is the same as the jid, use <jid/res>)
+#set buddy_format = 2
+
+# Aliases
 alias online   = status online
 alias away     = status away
 alias dnd      = status dnd
 alias notavail = status notavail
 
-#  Key bindings
+# Key bindings
 # Ctlr-X (24) bound to /roster alternate
 bind 24 = roster alternate
 # F5 (269) bound to /roster toggle_offline  (centericq-like, IIRC)