changeset 1139:104676e3389b

Update documentation
author Mikael Berthe <mikael@lilotux.net>
date Sun, 04 Feb 2007 11:57:14 +0100
parents 8ba4b1e8b42d
children 800bb1e9019c
files mcabber/doc/mcabber.1 mcabber/doc/mcabber.1.html mcabber/doc/mcabber.1.txt mcabber/src/screen.c
diffstat 4 files changed, 69 insertions(+), 38 deletions(-) [+]
line wrap: on
line diff
--- a/mcabber/doc/mcabber.1	Sun Feb 04 11:41:05 2007 +0100
+++ b/mcabber/doc/mcabber.1	Sun Feb 04 11:57:14 2007 +0100
@@ -1,11 +1,11 @@
 .\"     Title: mcabber
 .\"    Author: Mikael BERTHE
 .\" Generator: DocBook XSL Stylesheets v1.71.0 <http://docbook.sf.net/>
-.\"      Date: 12/09/2006
+.\"      Date: 02/04/2007
 .\"    Manual: 
 .\"    Source: 
 .\"
-.TH "MCABBER" "1" "12/09/2006" "" ""
+.TH "MCABBER" "1" "02/04/2007" "" ""
 .\" disable hyphenation
 .nh
 .\" disable justification (adjust text to left margin only)
@@ -319,7 +319,7 @@
 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).
 .RE
 .PP
-/buffer clear|purge|top|bottom|date|%|search_backward|search_forward, /buffer scroll_lock|scroll_unlock|scroll_toggle
+/buffer clear|close|close_all|purge, /buffer top|bottom|date|%|search_backward|search_forward, /buffer scroll_lock|scroll_unlock|scroll_toggle
 .RS 3n
 The
 \fIbuffer\fR
@@ -345,25 +345,14 @@
 clear the current buddy chat window
 T}
 T{
-\fIsearch_forward\fR
-text
+\fIclose\fR
 T}:T{
-search for "text" in the current buddy chat buffer
+empty all contents of the buffer and close the current buddy chat window
 T}
 T{
-\fIscroll_lock\fR
-T}:T{
-lock buffer scrolling
-T}
-T{
-\fIscroll_unlock\fR
+\fIclose_all\fR
 T}:T{
-unlock buffer scrolling
-T}
-T{
-\fIscroll_toggle\fR
-T}:T{
-toggle buffer scrolling (lock/unlock)
+empty all contents of the chat buffers and close the chat windows
 T}
 T{
 \fIpurge\fR
@@ -371,16 +360,16 @@
 clear the current buddy chat window and empty all contents of the chat buffer
 T}
 T{
+\fItop\fR
+T}:T{
+jump to the top of the current buddy chat buffer
+T}
+T{
 \fIbottom\fR
 T}:T{
 jump to the bottom of the current buddy chat buffer
 T}
 T{
-\fItop\fR
-T}:T{
-jump to the top of the current buddy chat buffer
-T}
-T{
 \fIup\fR
 [n]
 T}:T{
@@ -410,6 +399,27 @@
 T}:T{
 search for "text" in the current buddy chat buffer
 T}
+T{
+\fIsearch_forward\fR
+text
+T}:T{
+search for "text" in the current buddy chat buffer
+T}
+T{
+\fIscroll_lock\fR
+T}:T{
+lock buffer scrolling
+T}
+T{
+\fIscroll_unlock\fR
+T}:T{
+unlock buffer scrolling
+T}
+T{
+\fIscroll_toggle\fR
+T}:T{
+toggle buffer scrolling (lock/unlock)
+T}
 .TE
 
 .RE
--- a/mcabber/doc/mcabber.1.html	Sun Feb 04 11:41:05 2007 +0100
+++ b/mcabber/doc/mcabber.1.html	Sun Feb 04 11:57:14 2007 +0100
@@ -442,7 +442,10 @@
         depend on your ncurses installation).
 </dd>
 <dt><b>
-/buffer clear|purge|top|bottom|date|%|search_backward|search_forward
+/buffer clear|close|close_all|purge
+</b></dt>
+<dt><b>
+/buffer top|bottom|date|%|search_backward|search_forward
 </b></dt>
 <dt><b>
 /buffer scroll_lock|scroll_unlock|scroll_toggle
@@ -461,6 +464,22 @@
 </tr>
 <tr valign="top">
 <td>
+<b>close</b>
+</td>
+<td>
+empty all contents of the buffer and close the current buddy chat window
+</td>
+</tr>
+<tr valign="top">
+<td>
+<b>close_all</b>
+</td>
+<td>
+empty all contents of the chat buffers and close the chat windows
+</td>
+</tr>
+<tr valign="top">
+<td>
 <b>purge</b>
 </td>
 <td>
@@ -469,6 +488,14 @@
 </tr>
 <tr valign="top">
 <td>
+<b>top</b>
+</td>
+<td>
+jump to the top of the current buddy chat buffer
+</td>
+</tr>
+<tr valign="top">
+<td>
 <b>bottom</b>
 </td>
 <td>
@@ -477,14 +504,6 @@
 </tr>
 <tr valign="top">
 <td>
-<b>top</b>
-</td>
-<td>
-jump to the top of the current buddy chat buffer
-</td>
-</tr>
-<tr valign="top">
-<td>
 <b>up</b> [n]
 </td>
 <td>
@@ -1271,8 +1290,8 @@
 License (GPL).</p>
 <div id="footer">
 <p>
-Version 0.9.0<br />
-Last updated 09-Dec-2006 11:19:42 CEST
+Version 0.9.1-dev<br />
+Last updated 04-Feb-2007 11:44:42 CEST
 </p>
 </div>
 </div>
--- a/mcabber/doc/mcabber.1.txt	Sun Feb 04 11:41:05 2007 +0100
+++ b/mcabber/doc/mcabber.1.txt	Sun Feb 04 11:57:14 2007 +0100
@@ -177,15 +177,18 @@
         Example: "/bind 265 = status online" (265 is F1 for me, but it may
         depend on your ncurses installation).
 
-/buffer clear|purge|top|bottom|date|%|search_backward|search_forward::
+/buffer clear|close|close_all|purge::
+/buffer top|bottom|date|%|search_backward|search_forward::
 /buffer scroll_lock|scroll_unlock|scroll_toggle::
         The 'buffer' command manipulates the current buddy's buffer
         (chat window).
 
         'clear';;                clear the current buddy chat window
+        'close';;                empty all contents of the buffer and close the current buddy chat window
+        'close_all';;            empty all contents of the chat buffers and close the chat windows
         'purge';;                clear the current buddy chat window and empty all contents of the chat buffer
+        'top';;                  jump to the top of the current buddy chat buffer
         '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)
         '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)
--- a/mcabber/src/screen.c	Sun Feb 04 11:41:05 2007 +0100
+++ b/mcabber/src/screen.c	Sun Feb 04 11:57:14 2007 +0100
@@ -413,8 +413,7 @@
 }
 
 //  scr_new_buddy(title, dontshow)
-// Note: title (aka winId) can be NULL for special buffers
-//static winbuf *scr_CreateBuddyPanel(const char *title, int dont_show)
+// Note: title (aka winId/jid) can be NULL for special buffers
 static winbuf *scr_new_buddy(const char *title, int dont_show)
 {
   winbuf *tmp;