# HG changeset patch # User mikael # Date 1118169304 0 # Node ID bfc14cfb068e1e3496c309825e262beb54c1bfc8 # Parent f29a95231102fcf9966ffbd15ec8fb2685ff2390 [/trunk] Changeset 241 by mikael * Update doc (man + html). diff -r f29a95231102 -r bfc14cfb068e mcabber/doc/mcabber.1 --- a/mcabber/doc/mcabber.1 Tue Jun 07 17:20:34 2005 +0000 +++ b/mcabber/doc/mcabber.1 Tue Jun 07 18:35:04 2005 +0000 @@ -34,7 +34,7 @@ The mcabber(1) screen is divided into 4 regions\&. The \fIroster\fR, alias \fIbuddylist\fR, is on the left\&. The \fIchat window\fR, or chat buffer, is on the right\&. The \fIinput line\fR lies at the bottom of the screen, under a small \fIlog window\fR\&. -To display buddies chat buffers, you will have to enter \fIchat mode\fR\&. You can enter chat mode by pressing enter, and leave chat mode with the ESC key\&. Sending a message also enables chat mode implicitly\&. +To display buddies chat buffers, you will have to enter \fIchat mode\fR\&. You can enter chat mode by pressing enter, and leave chat mode with the ESC key\&. Simply sending a message will also enable chat mode\&. Here are some of the features of mcabber: @@ -47,7 +47,7 @@ History logging: If enabled (see the CONFIGURATION FILE section), mcabber(1) can save discussions to history log files\&. .TP \(bu - Commands completion: If possible, mcabber(1) will try to complete your commands line if you hit the Tab key\&. + Commands completion: If possible, mcabber(1) will try to complete your command line if you hit the Tab key\&. .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)\&. @@ -66,7 +66,7 @@ .SH "KEYS" -Text typing happens in the \fIinput line\fR; basic operations are supported (left arrow, right arrow, home/end keys, insert, delete, backspace...)\&. +Text typing occurs in the \fIinput line\fR; basic operations are supported (left arrow, right arrow, home/end keys, insert, delete, backspace...)\&. PageUp and PageDown keys are used to move in the roster\&. @@ -74,147 +74,94 @@ 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: - -Ctrl\-a - -Go to the beginning of the input line +Ctrl\-a Go to the beginning of the input line -Ctrl\-e +Ctrl\-e Go to the end of the input line -Go to the end of the input line - -Ctrl\-l +Ctrl\-l Force a resize -Force a resize - -PgUp/PgDown - -Move inside the roster (buddylist) +PgUp/PgDown Move inside the roster (buddylist) -Tab +Tab Complete current word, in the input line -Complete current word, in the input line - -Ctrl\-g +Ctrl\-g Cancel completion / ctrl\-g -Cancel completion / ctrl\-g - -Ctrl\-p/Ctrl\-n - -Scroll up/down half a screen in the buffer window (chat mode) +Ctrl\-p/Ctrl\-n Scroll up/down half a screen in the buffer window (chat mode) -Ctrl\-u +Ctrl\-u Delete from beginning of the line to the cursor -Delete from beginning of the line to the cursor - -Ctrl\-k +Ctrl\-k Delete from the cursor to the end of line -Delete from the cursor to the end of line - -Ctrl\-w - -Backward kill word +Ctrl\-w Backward kill word -Ctrl\-t - -Transpose chars +Ctrl\-t Transpose chars -Ctrl\-q - -Jump to the next unread message (Not yet implemented) +Ctrl\-q Jump to the next unread message (Not yet implemented) .SH "COMMANDS" .TP -/add jid +\fB/add\fR jid Add the jid Jabber user to our roster, and send a notification request to this buddy\&. .TP -/buffer clear|top|bottom +\fB/buffer\fR clear|top|bottom The buffer command manipulates the current buddy's buffer (chat window)\&. - \fIclear\fR - -clear the current buddy chat window - \fItop\fR - -jump to the top of the current buddy chat buffer - - \fIbottom\fR - -jump to the bottom of the current buddy chat buffer - + \fBclear\fR clear the current buddy chat window + \fBtop\fR jump to the top of the current buddy chat buffer + \fBbottom\fR jump to the bottom of the current buddy chat buffer .TP -/clear +\fB/clear\fR The clear command is actually an alias for "/buffer clear"\&. .TP -/del +\fB/del\fR Delete the current buddy from our roster, unsubscribe from its presence notification and unsubscribe it from ours\&. .TP -/group expand|shrink|toggle +\fB/group\fR expand|shrink|toggle The group command changes the group display settings\&. - \fIexpand\fR - -expand the current group tree in the roster (syn: \fIunfold\fR) - \fIshrink\fR - -shrink the current group tree in the roster (syn: \fIfold\fR) - - \fItoggle\fR - -toggle the fold/unfold state of the current tree - + \fBexpand\fR expand the current group tree in the roster (syn: unfold) + \fBshrink\fR shrink the current group tree in the roster (syn: fold) + \fBtoggle\fR toggle the fold/unfold state of the current tree .TP -/info +\fB/info\fR Display info on the selected entry (user, agent, group...)\&. .TP -/move [groupname] -Move the current buddy to the requested group\&. If no group is specified, then the buddy is moved to the default group\&. This command only works with users (not agents), right now\&. +\fB/move\fR [groupname] +Move the current buddy to the requested group\&. If no group is specified, then the buddy is moved to the default group\&. This command only works with users (not agents), at the moment\&. .TP -/quit -Disconnect and leave mcabber(1)\&. - -.TP -/rename nickname -Rename current buddy to the given nickname\&. This command does not work for groups, right now (but you can move the buddies to another group with the /move command)\&. +\fB/quit\fR +Disconnect and leave mcabber(1) .TP -/roster hide_offline|show_offline|top|bottom -The roster command manipulates the roster/buddylist\&. - \fIhide_offline\fR - -hide offline buddies - - \fIshow_offline\fR - -show offline buddies - - \fItop\fR - -jump to the top of the roster - - \fIbottom\fR - -jump to the bottom of the roster - +\fB/rename\fR nickname +Rename current buddy to the given nickname\&. This command does not work for groups, at the moment (but you can move the buddies to another group with the /move command)\&. .TP -/say text +\fB/roster\fR hide_offline|show_offline|top|bottom +The roster command manipulates the roster/buddylist\&. + + \fBhide_offline\fR hide offline buddies + \fBshow_offline\fR show offline buddies + \fBtop\fR jump to the top of the roster + \fBbottom\fR jump to the bottom of the roster + +.TP +\fB/say\fR text Send the text message to the currently selected buddy\&. Can be useful if you want to send a message beginning with a slash, for example\&. .TP -/status [online|avail|invisible|free|dnd|busy|notavail|away] +\fB/status\fR [online|avail|invisible|free|dnd|busy|notavail|away] Set the current status\&. If no status is specified, display the current status\&. .SH "CONFIGURATION FILE" @@ -243,17 +190,20 @@ .SH "AUTHOR" -Written by Mikael BERTHE: \fImailto:mcabber@lilotux.net\fR\&. Originally based on Cabber: \fIhttp://cabber.sourceforge.net\fR, please consult the AUTHORS file for details\&. +Written by Mikael BERTHE <\fImcabber@lilotux.net\fR>\&. +Originally based on cabber (Cabber homepage: <\fIhttp://cabber.sourceforge.net\fR>), please consult the AUTHORS file for details\&. .SH "RESOURCES" -Main web site: \fIhttp://www.lilotux.net/~mikael/mcabber/\fR +Main web site: <\fIhttp://www.lilotux.net/~mikael/mcabber/\fR> .SH "COPYING" -Copyright (C) 2005 Mikael Berthe\&. Some portions are Copyright (C) 2002\-2004 cabber@ajmacias\&.com: \fImailto:cabber@ajmacias.com\fR\&. +Copyright (C) 2005 Mikael Berthe\&. + +Some portions are Copyright (C) 2002\-2004 \&. Free use of this software is granted under the terms of the GNU General Public License (GPL)\&. diff -r f29a95231102 -r bfc14cfb068e mcabber/doc/mcabber.1.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mcabber/doc/mcabber.1.html Tue Jun 07 18:35:04 2005 +0000 @@ -0,0 +1,486 @@ + + + + + + + + +mcabber + + +
+

MCABBER(1) Manual Page

+

NAME

+

mcabber - + a simple Jabber console client +

+
+

SYNOPSIS

+

+mcabber [ -f configfile ] [ —help | -h ] +

+
+

DESCRIPTION

+

+mcabber(1) is a small Jabber console client.
+For now it needs a configuration file to start, so please copy the sample +mcabberrc file and adapt your connection settings. +

+

+The mcabber(1) screen is divided into 4 regions. +The roster, alias buddylist, is on the left. The chat window, or chat +buffer, is on the right. The input line lies at the bottom of the screen, +under a small log window. +

+

+To display buddies chat buffers, you will have to enter chat mode. +You can enter chat mode by pressing enter, and leave chat mode with the ESC +key. Simply sending a message will also enable chat mode. +

+

+Here are some of the features of mcabber: +

+ +

OPTIONS

+
+
+—help, -h +
+
+ + Quick help usage message + +
+
+-f configfile +
+
+ + Use configuration file configfile + +
+
+

KEYS

+

+Text typing occurs in the input line; basic operations are supported +(left arrow, right arrow, home/end keys, insert, delete, backspace…). +

+

+PageUp and PageDown keys are used to move in the roster. +

+

+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: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+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 + +
+PgUp/PgDown + + +Move inside the roster (buddylist) + +
+Tab + + +Complete current word, in the input line + +
+Ctrl-g + + +Cancel completion / ctrl-g + +
+Ctrl-p/Ctrl-n + + +Scroll up/down half a screen in the buffer window (chat mode) + +
+Ctrl-u + + +Delete from beginning of the line to the cursor + +
+Ctrl-k + + +Delete from the cursor to the end of line + +
+Ctrl-w + + +Backward kill word + +
+Ctrl-t + + +Transpose chars + +
+Ctrl-q + + +Jump to the next unread message (Not yet implemented) + +
+

COMMANDS

+
+
+/add jid +
+
+ + Add the jid Jabber user to our roster, and send a notification + request to this buddy. + +
+
+/buffer clear|top|bottom +
+
+ + The buffer command manipulates the current buddy's buffer + (chat window). + + + + + + + + + + + + + + +
+clear + + +clear the current buddy chat window + +
+top + + +jump to the top of the current buddy chat buffer + +
+bottom + + +jump to the bottom of the current buddy chat buffer + +
+
+
+/clear +
+
+ + The clear command is actually an alias for "/buffer clear". + +
+
+/del +
+
+ + Delete the current buddy from our roster, unsubscribe from its presence + notification and unsubscribe it from ours. + +
+
+/group expand|shrink|toggle +
+
+ + The group command changes the group display settings. + + + + + + + + + + + + + + +
+expand + + +expand the current group tree in the roster (syn: unfold) + +
+shrink + + +shrink the current group tree in the roster (syn: fold) + +
+toggle + + +toggle the fold/unfold state of the current tree + +
+
+
+/info +
+
+ + Display info on the selected entry (user, agent, group…). + +
+
+/move [groupname] +
+
+ + Move the current buddy to the requested group. If no group is + specified, then the buddy is moved to the default group. + This command only works with users (not agents), at the moment. + +
+
+/quit +
+
+ + Disconnect and leave mcabber(1). + +
+
+/rename nickname +
+
+ + Rename current buddy to the given nickname. + This command does not work for groups, at the moment (but you can move + the buddies to another group with the /move command). + +
+
+/roster hide_offline|show_offline|top|bottom +
+
+ + The roster command manipulates the roster/buddylist. + + + + + + + + + + + + + + + + + + +
+hide_offline + + +hide offline buddies + +
+show_offline + + +show offline buddies + +
+top + + +jump to the top of the roster + +
+bottom + + +jump to the bottom of the roster + +
+
+
+/say text +
+
+ + Send the text message to the currently selected buddy. Can be useful + if you want to send a message beginning with a slash, for example. + +
+
+/status [online|avail|invisible|free|dnd|busy|notavail|away] +
+
+ + Set the current status. If no status is specified, display the + current status. + +
+
+

CONFIGURATION FILE

+

+See the provided sample configuration file, which should be self-documented. +

+

FILES

+

+The following files can be used by mcabber(1): +

+
+$HOME/.mcabber/mcabberrc    Default configuration file
+$HOME/.mcabberrc            Configuration file used if no other has been found
+$HOME/.mcabber/histo/       Default directory for storing chat history files, if enabled
+
+

BUGS

+

+Certainly a lot. Please tell me if you find one! :-) +

+

AUTHOR

+

+Written by Mikael BERTHE.
+Originally based on Cabber, please +consult the AUTHORS file for details. +

+

RESOURCES

+

+Main web site +

+

COPYING

+

+Copyright © 2005 Mikael Berthe.
+Some portions are Copyright © 2002-2004 cabber@ajmacias.com. +

+

+Free use of this software is granted under the terms of the GNU General Public +License (GPL). +

+ +
+ + diff -r f29a95231102 -r bfc14cfb068e mcabber/doc/mcabber.1.txt --- a/mcabber/doc/mcabber.1.txt Tue Jun 07 17:20:34 2005 +0000 +++ b/mcabber/doc/mcabber.1.txt Tue Jun 07 18:35:04 2005 +0000 @@ -24,7 +24,7 @@ To display buddies chat buffers, you will have to enter 'chat mode'. You can enter chat mode by pressing enter, and leave chat mode with the ESC -key. Sending a message also enables chat mode implicitly. +key. Simply sending a message will also enable chat mode. Here are some of the features of `mcabber`: @@ -32,7 +32,7 @@ - 'History logging:' If enabled (see the CONFIGURATION FILE section), `mcabber(1)` can save discussions to history log files. - 'Commands completion:' If possible, `mcabber(1)` will try to complete your - commands line if you hit the Tab key. + command line if you hit the Tab key. - '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). @@ -48,8 +48,8 @@ KEYS ---- -Text typing happens in the 'input line'; basic operations are supported (left -arrow, right arrow, home/end keys, insert, delete, backspace...). +Text typing occurs in the 'input line'; basic operations are supported +(left arrow, right arrow, home/end keys, insert, delete, backspace...). PageUp and PageDown keys are used to move in the roster. @@ -108,14 +108,14 @@ /move [groupname]:: Move the current buddy to the requested group. If no group is specified, then the buddy is moved to the default group. - This command only works with users (not agents), right now. + This command only works with users (not agents), at the moment. /quit:: Disconnect and leave `mcabber(1)`. /rename nickname:: Rename current buddy to the given nickname. - This command does not work for groups, right now (but you can move + This command does not work for groups, at the moment (but you can move the buddies to another group with the /move command). /roster hide_offline|show_offline|top|bottom::