198
|
1 |
MCABBER(1)
|
|
2 |
===========
|
222
|
3 |
Mikael BERTHE <mcabber@lilotux.net>
|
236
|
4 |
v0.6.1, June 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 |
-----------
|
204
|
16 |
`mcabber(1)` is a small Jabber console client. +
|
200
|
17 |
For now it needs a configuration file to start, so please copy the sample
|
208
|
18 |
mcabberrc file and adapt your connection settings.
|
200
|
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 |
|
204
|
25 |
To display buddies chat buffers, you will have to enter 'chat mode'.
|
|
26 |
You can enter chat mode by pressing enter, and leave chat mode with the ESC
|
229
|
27 |
key. Simply sending a message will also enable chat mode.
|
204
|
28 |
|
|
29 |
Here are some of the features of `mcabber`:
|
200
|
30 |
|
204
|
31 |
- 'SSL support'.
|
|
32 |
- 'History logging:' If enabled (see the CONFIGURATION FILE section),
|
|
33 |
`mcabber(1)` can save discussions to history log files.
|
|
34 |
- 'Commands completion:' If possible, `mcabber(1)` will try to complete your
|
229
|
35 |
command line if you hit the Tab key.
|
204
|
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).
|
200
|
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 |
|
229
|
51 |
Text typing occurs in the 'input line'; basic operations are supported
|
|
52 |
(left arrow, right arrow, home/end keys, insert, delete, backspace...).
|
200
|
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
|
236
|
74 |
Ctrl-q:: Jump to the next unread message
|
198
|
75 |
|
199
|
76 |
COMMANDS
|
|
77 |
--------
|
|
78 |
|
|
79 |
/add jid::
|
|
80 |
Add the 'jid' Jabber user to our roster, and send a notification
|
208
|
81 |
request to this buddy.
|
199
|
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::
|
206
|
92 |
The 'clear' command is actually an alias for "/buffer clear".
|
199
|
93 |
|
205
|
94 |
/del::
|
|
95 |
Delete the current buddy from our roster, unsubscribe from its presence
|
|
96 |
notification and unsubscribe it from ours.
|
|
97 |
|
240
|
98 |
/group fold|unfold|toggle::
|
|
99 |
The 'group' command changes the current group display.
|
199
|
100 |
|
240
|
101 |
'fold';; fold (shrink) the current group tree in the roster
|
|
102 |
'unfold';; unfold (expand) the current group tree in the roster
|
|
103 |
'toggle';; toggle the state (fold/unfold) of the current tree
|
199
|
104 |
|
|
105 |
/info::
|
208
|
106 |
Display info on the selected entry (user, agent, group...).
|
199
|
107 |
|
210
|
108 |
/move [groupname]::
|
|
109 |
Move the current buddy to the requested group. If no group is
|
|
110 |
specified, then the buddy is moved to the default group.
|
229
|
111 |
This command only works with users (not agents), at the moment.
|
210
|
112 |
|
238
|
113 |
/msay begin|send|abort::
|
|
114 |
Send a multi-line message. To write a single message with several
|
|
115 |
lines, the 'multi-line mode' should be used. In multi-line mode,
|
|
116 |
each line (except command lines) typed in the input line will
|
|
117 |
be added to the multi-line message. Once the message is finished, it
|
|
118 |
can be sent to the current selected buddy with the "msay /send"
|
|
119 |
command.
|
|
120 |
|
|
121 |
'begin';; enter multi-line mode
|
|
122 |
'send';; send the current multi-line message to the currently selected buddy
|
|
123 |
'abort';; leave multi-line mode without sending the message
|
|
124 |
|
199
|
125 |
/quit::
|
208
|
126 |
Disconnect and leave `mcabber(1)`.
|
|
127 |
|
|
128 |
/rename nickname::
|
|
129 |
Rename current buddy to the given nickname.
|
229
|
130 |
This command does not work for groups, at the moment (but you can move
|
210
|
131 |
the buddies to another group with the /move command).
|
199
|
132 |
|
|
133 |
/roster hide_offline|show_offline|top|bottom::
|
202
|
134 |
The 'roster' command manipulates the roster/buddylist.
|
199
|
135 |
|
202
|
136 |
'hide_offline';; hide offline buddies
|
|
137 |
'show_offline';; show offline buddies
|
|
138 |
'top';; jump to the top of the roster
|
|
139 |
'bottom';; jump to the bottom of the roster
|
236
|
140 |
'unread_first';; jump to the first unread message
|
|
141 |
'unread_next';; jump to the next unread message
|
199
|
142 |
|
|
143 |
/say text::
|
202
|
144 |
Send the text message to the currently selected buddy. Can be useful
|
199
|
145 |
if you want to send a message beginning with a slash, for example.
|
|
146 |
|
|
147 |
/status [online|avail|invisible|free|dnd|busy|notavail|away]::
|
|
148 |
Set the current status. If no status is specified, display the
|
|
149 |
current status.
|
|
150 |
|
|
151 |
CONFIGURATION FILE
|
|
152 |
------------------
|
|
153 |
See the provided sample configuration file, which should be self-documented.
|
198
|
154 |
|
200
|
155 |
FILES
|
|
156 |
-----
|
202
|
157 |
The following files can be used by `mcabber(1)`:
|
200
|
158 |
|
|
159 |
$HOME/.mcabber/mcabberrc Default configuration file
|
|
160 |
$HOME/.mcabberrc Configuration file used if no other has been found
|
|
161 |
$HOME/.mcabber/histo/ Default directory for storing chat history files, if enabled
|
|
162 |
|
198
|
163 |
BUGS
|
|
164 |
----
|
202
|
165 |
Certainly a lot. Please tell me if you find one! :-)
|
198
|
166 |
|
|
167 |
AUTHOR
|
|
168 |
------
|
222
|
169 |
Written by mailto:mcabber@lilotux.net[Mikael BERTHE]. +
|
204
|
170 |
Originally based on http://cabber.sourceforge.net[Cabber], please
|
198
|
171 |
consult the AUTHORS file for details.
|
|
172 |
|
|
173 |
RESOURCES
|
|
174 |
---------
|
202
|
175 |
http://www.lilotux.net/~mikael/mcabber/[Main web site]
|
198
|
176 |
|
|
177 |
COPYING
|
|
178 |
-------
|
202
|
179 |
Copyright (C) 2005 Mikael Berthe. +
|
|
180 |
Some portions are Copyright (C) 2002-2004 mailto:cabber@ajmacias.com[].
|
198
|
181 |
|
|
182 |
Free use of this software is granted under the terms of the GNU General Public
|
|
183 |
License (GPL).
|
|
184 |
|