198
|
1 |
MCABBER(1)
|
|
2 |
===========
|
|
3 |
Mikael BERTHE <bmikael@lists.lilotux.net>
|
202
|
4 |
v0.6.0, May 2005
|
198
|
5 |
|
|
6 |
NAME
|
|
7 |
----
|
200
|
8 |
mcabber - a simple Jabber console client
|
198
|
9 |
|
|
10 |
SYNOPSIS
|
|
11 |
--------
|
|
12 |
'mcabber' [ -f configfile ] [ --help | -h ]
|
|
13 |
|
|
14 |
DESCRIPTION
|
|
15 |
-----------
|
202
|
16 |
`mcabber(1)` is a small Jabber console client with (optional) SSL support. +
|
200
|
17 |
For now it needs a configuration file to start, so please copy the sample
|
|
18 |
mcabberrc file and update your connection options.
|
|
19 |
|
202
|
20 |
The `mcabber(1)` screen is divided into 4 regions.
|
200
|
21 |
The 'roster', alias 'buddylist', is on the left. The 'chat window', or chat
|
|
22 |
buffer, is on the right. The 'input line' lies at the bottom of the screen,
|
|
23 |
under a small 'log window'.
|
|
24 |
|
202
|
25 |
Commands completion. If possible, `mcabber(1)` will try to complete your
|
200
|
26 |
commands line if you hit the Tab key.
|
|
27 |
|
|
28 |
Chat mode. When 'chat mode' is enabled, the buddies chat buffers are
|
|
29 |
displayed. Otherwise, the chat window is empty. You can enter chat mode by
|
|
30 |
pressing enter, and leave chat mode with the ESC key. Sending a message also
|
|
31 |
enables chat mode implicitly.
|
|
32 |
|
202
|
33 |
History logging. If enabled (see the CONFIGURATION FILE section),
|
|
34 |
`mcabber(1)` can save discussions to history log files.
|
200
|
35 |
|
|
36 |
External actions. Some 'events' (like receiving a message) can trigger an
|
|
37 |
external action, for example a shell script (you need to enable it in your
|
|
38 |
configuration file).
|
|
39 |
|
|
40 |
OPTIONS
|
|
41 |
-------
|
|
42 |
--help, -h::
|
202
|
43 |
Quick help usage message
|
200
|
44 |
|
|
45 |
-f configfile::
|
202
|
46 |
Use configuration file 'configfile'
|
200
|
47 |
|
|
48 |
KEYS
|
|
49 |
----
|
|
50 |
|
|
51 |
Text typing happens in the 'input line'; basic operations are supported (left
|
|
52 |
arrow, right arrow, home/end keys, insert, delete, backspace...).
|
|
53 |
|
|
54 |
PageUp and PageDown keys are used to move in the roster.
|
|
55 |
|
|
56 |
To send a message, move to the choosen buddy in the buddylist, type your
|
|
57 |
message and hit enter. If the line begins with a slash, this will be
|
|
58 |
interpreted as a command (see the COMMAND section below). Hit escape to
|
|
59 |
leave the chat mode.
|
|
60 |
|
|
61 |
Here is a quick description of the key bindings:
|
|
62 |
|
|
63 |
Ctrl-a:: Go to the beginning of the input line
|
|
64 |
Ctrl-e:: Go to the end of the input line
|
|
65 |
Ctrl-l:: Force a resize
|
|
66 |
PgUp/PgDown:: Move inside the roster (buddylist)
|
|
67 |
Tab:: Complete current word, in the input line
|
|
68 |
Ctrl-g:: Cancel completion / ctrl-g
|
|
69 |
Ctrl-p/Ctrl-n:: Scroll up/down half a screen in the buffer window (chat mode)
|
|
70 |
Ctrl-u:: Delete from beginning of the line to the cursor
|
|
71 |
Ctrl-k:: Delete from the cursor to the end of line
|
|
72 |
Ctrl-w:: Backward kill word
|
|
73 |
Ctrl-t:: Transpose chars
|
|
74 |
Ctrl-q:: Jump to the next unread message (Not yet implemented)
|
198
|
75 |
|
199
|
76 |
COMMANDS
|
|
77 |
--------
|
|
78 |
|
|
79 |
/add jid::
|
|
80 |
Add the 'jid' Jabber user to our roster, and send a notification
|
|
81 |
request to this buddy
|
|
82 |
|
|
83 |
/buffer clear|top|bottom::
|
202
|
84 |
The 'buffer' command manipulates the current buddy's buffer
|
|
85 |
(chat window).
|
199
|
86 |
|
202
|
87 |
'clear';; clear the current buddy chat window
|
|
88 |
'top';; jump to the top of the current buddy chat buffer
|
|
89 |
'bottom';; jump to the bottom of the current buddy chat buffer
|
199
|
90 |
|
|
91 |
/clear::
|
202
|
92 |
The 'clear' command is an alias for "/buffer clear".
|
199
|
93 |
|
|
94 |
/group expand|shrink|toggle::
|
202
|
95 |
The 'group' command changes the group display settings.
|
199
|
96 |
|
202
|
97 |
'expand';; expand the current group tree in the roster (syn: 'unfold')
|
|
98 |
'shrink';; shrink the current group tree in the roster (syn: 'fold')
|
|
99 |
'toggle';; toggle the fold/unfold state of the current tree
|
199
|
100 |
|
|
101 |
/info::
|
202
|
102 |
Display info on the selected entry (user, agent, group...)
|
199
|
103 |
|
|
104 |
/quit::
|
202
|
105 |
Disconnect and leave `mcabber(1)`
|
199
|
106 |
|
|
107 |
/roster hide_offline|show_offline|top|bottom::
|
202
|
108 |
The 'roster' command manipulates the roster/buddylist.
|
199
|
109 |
|
202
|
110 |
'hide_offline';; hide offline buddies
|
|
111 |
'show_offline';; show offline buddies
|
|
112 |
'top';; jump to the top of the roster
|
|
113 |
'bottom';; jump to the bottom of the roster
|
199
|
114 |
|
|
115 |
/say text::
|
202
|
116 |
Send the text message to the currently selected buddy. Can be useful
|
199
|
117 |
if you want to send a message beginning with a slash, for example.
|
|
118 |
|
|
119 |
/status [online|avail|invisible|free|dnd|busy|notavail|away]::
|
|
120 |
Set the current status. If no status is specified, display the
|
|
121 |
current status.
|
|
122 |
|
|
123 |
CONFIGURATION FILE
|
|
124 |
------------------
|
|
125 |
See the provided sample configuration file, which should be self-documented.
|
198
|
126 |
|
200
|
127 |
FILES
|
|
128 |
-----
|
202
|
129 |
The following files can be used by `mcabber(1)`:
|
200
|
130 |
|
|
131 |
$HOME/.mcabber/mcabberrc Default configuration file
|
|
132 |
$HOME/.mcabberrc Configuration file used if no other has been found
|
|
133 |
$HOME/.mcabber/histo/ Default directory for storing chat history files, if enabled
|
|
134 |
|
198
|
135 |
BUGS
|
|
136 |
----
|
202
|
137 |
Certainly a lot. Please tell me if you find one! :-)
|
198
|
138 |
|
|
139 |
AUTHOR
|
|
140 |
------
|
203
|
141 |
Written by mailto:bmikael@lists.lilotux.net[Mikael BERTHE]. +
|
202
|
142 |
Originally based on cabber
|
|
143 |
(http://cabber.sourceforge.net[Cabber homepage]), please
|
198
|
144 |
consult the AUTHORS file for details.
|
|
145 |
|
|
146 |
RESOURCES
|
|
147 |
---------
|
202
|
148 |
http://www.lilotux.net/~mikael/mcabber/[Main web site]
|
198
|
149 |
|
|
150 |
COPYING
|
|
151 |
-------
|
202
|
152 |
Copyright (C) 2005 Mikael Berthe. +
|
|
153 |
Some portions are Copyright (C) 2002-2004 mailto:cabber@ajmacias.com[].
|
198
|
154 |
|
|
155 |
Free use of this software is granted under the terms of the GNU General Public
|
|
156 |
License (GPL).
|
|
157 |
|