author | Mikael Berthe <mikael@lilotux.net> |
Sun, 09 Oct 2005 22:05:11 +0200 | |
changeset 495 | 26f3c7695fe1 |
parent 491 | 28f67990ce7b |
child 497 | b5c2c3c50435 |
permissions | -rw-r--r-- |
198 | 1 |
MCABBER(1) |
2 |
=========== |
|
222 | 3 |
Mikael BERTHE <mcabber@lilotux.net> |
495 | 4 |
v0.7.0, October 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 |
|
360
20283b69db99
Doc: Say a Jabber account should already exist for using mcabber
Mikael Berthe <mikael@lilotux.net>
parents:
349
diff
changeset
|
20 |
You also need to have an existing Jabber account to use this software, as |
20283b69db99
Doc: Say a Jabber account should already exist for using mcabber
Mikael Berthe <mikael@lilotux.net>
parents:
349
diff
changeset
|
21 |
it cannot (un)register accounts yet. |
20283b69db99
Doc: Say a Jabber account should already exist for using mcabber
Mikael Berthe <mikael@lilotux.net>
parents:
349
diff
changeset
|
22 |
|
202 | 23 |
The `mcabber(1)` screen is divided into 4 regions. |
200 | 24 |
The 'roster', alias 'buddylist', is on the left. The 'chat window', or chat |
25 |
buffer, is on the right. The 'input line' lies at the bottom of the screen, |
|
26 |
under a small 'log window'. |
|
27 |
||
204 | 28 |
To display buddies chat buffers, you will have to enter 'chat mode'. |
29 |
You can enter chat mode by pressing enter, and leave chat mode with the ESC |
|
229 | 30 |
key. Simply sending a message will also enable chat mode. |
204 | 31 |
|
32 |
Here are some of the features of `mcabber`: |
|
200 | 33 |
|
204 | 34 |
- 'SSL support'. |
467 | 35 |
- 'MUC support' (Multi-User Chat). |
204 | 36 |
- 'History logging:' If enabled (see the CONFIGURATION FILE section), |
432 | 37 |
`mcabber` can save discussions to history log files. |
38 |
- 'Commands completion:' If possible, `mcabber` will try to complete your |
|
229 | 39 |
command line if you hit the Tab key. |
204 | 40 |
- 'External actions:' Some events (like receiving a message) can trigger an |
41 |
external action, for example a shell script (you need to enable it in your |
|
432 | 42 |
configuration file). A sample events script ("eventcmd") is provided with |
43 |
`mcabber` source code, in the contrib directory. |
|
200 | 44 |
|
45 |
OPTIONS |
|
46 |
------- |
|
47 |
--help, -h:: |
|
202 | 48 |
Quick help usage message |
200 | 49 |
|
50 |
-f configfile:: |
|
202 | 51 |
Use configuration file 'configfile' |
200 | 52 |
|
53 |
KEYS |
|
54 |
---- |
|
55 |
||
229 | 56 |
Text typing occurs in the 'input line'; basic operations are supported |
57 |
(left arrow, right arrow, home/end keys, insert, delete, backspace...). |
|
200 | 58 |
|
59 |
PageUp and PageDown keys are used to move in the roster. |
|
60 |
||
61 |
To send a message, move to the choosen buddy in the buddylist, type your |
|
62 |
message and hit enter. If the line begins with a slash, this will be |
|
63 |
interpreted as a command (see the COMMAND section below). Hit escape to |
|
64 |
leave the chat mode. |
|
65 |
||
66 |
Here is a quick description of the key bindings: |
|
67 |
||
68 |
Ctrl-a:: Go to the beginning of the input line |
|
69 |
Ctrl-e:: Go to the end of the input line |
|
70 |
Ctrl-l:: Force a resize |
|
71 |
PgUp/PgDown:: Move inside the roster (buddylist) |
|
72 |
Tab:: Complete current word, in the input line |
|
73 |
Ctrl-g:: Cancel completion / ctrl-g |
|
74 |
Ctrl-p/Ctrl-n:: Scroll up/down half a screen in the buffer window (chat mode) |
|
75 |
Ctrl-u:: Delete from beginning of the line to the cursor |
|
76 |
Ctrl-k:: Delete from the cursor to the end of line |
|
77 |
Ctrl-w:: Backward kill word |
|
78 |
Ctrl-t:: Transpose chars |
|
263 | 79 |
Ctrl-o:: Accept line and put the next history line in the input line (accept-line-and-down-history) |
236 | 80 |
Ctrl-q:: Jump to the next unread message |
198 | 81 |
|
199 | 82 |
COMMANDS |
83 |
-------- |
|
84 |
||
245 | 85 |
/add jid [nickname]:: |
491 | 86 |
Add the "jid" Jabber user to our roster (default group), and send a |
245 | 87 |
notification request to this buddy. If no nickname is specified, the |
88 |
jid is used. |
|
199 | 89 |
|
286
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
90 |
/alias name = command line:: |
289 | 91 |
Add "name" as an alias for "command line". + |
92 |
Aliases are expanded only once, thus they can not be chained. + |
|
93 |
"/alias name" displays the value associated with the "name" alias; |
|
94 |
"/alias name =" unsets the "name" alias. + |
|
286
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
95 |
Example: "/alias away = status away". |
289 | 96 |
|
97 |
/bind keycode = command line:: |
|
98 |
Bind a command line to the key with the "keycode" code number. + |
|
432 | 99 |
Keycodes of unused keys are displayed by `mcabber` in the log window |
289 | 100 |
when pressing the key, for example "Unknown key=265". + |
101 |
"/bind keycode" displays the command line bound to the given keycode; |
|
102 |
"/bind keycode" unbinds the given keycode. + |
|
103 |
Note: aliases can be used in key bindings. + |
|
450 | 104 |
Example: "/bind 265 = status online" (265 is F1 for me, but it may |
289 | 105 |
depend on your ncurses installation). |
286
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
106 |
|
465
52171a3dc199
Update manual page (/buffer command)
Mikael Berthe <mikael@lilotux.net>
parents:
450
diff
changeset
|
107 |
/buffer clear|top|bottom|search_backward|search_forward|date|%:: |
202 | 108 |
The 'buffer' command manipulates the current buddy's buffer |
109 |
(chat window). |
|
199 | 110 |
|
465
52171a3dc199
Update manual page (/buffer command)
Mikael Berthe <mikael@lilotux.net>
parents:
450
diff
changeset
|
111 |
'clear';; clear the current buddy chat window |
52171a3dc199
Update manual page (/buffer command)
Mikael Berthe <mikael@lilotux.net>
parents:
450
diff
changeset
|
112 |
'top';; jump to the top of the current buddy chat buffer |
52171a3dc199
Update manual page (/buffer command)
Mikael Berthe <mikael@lilotux.net>
parents:
450
diff
changeset
|
113 |
'bottom';; jump to the bottom of the current buddy chat buffer |
491 | 114 |
'search_backward' text;; search for "text" in the current buddy chat buffer |
115 |
'search_forward' text;; search for "text" in the current buddy chat buffer |
|
465
52171a3dc199
Update manual page (/buffer command)
Mikael Berthe <mikael@lilotux.net>
parents:
450
diff
changeset
|
116 |
'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) |
52171a3dc199
Update manual page (/buffer command)
Mikael Berthe <mikael@lilotux.net>
parents:
450
diff
changeset
|
117 |
'%' n;; jump to position %n of the buddy chat buffer |
199 | 118 |
|
119 |
/clear:: |
|
206 | 120 |
The 'clear' command is actually an alias for "/buffer clear". |
199 | 121 |
|
298
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
122 |
/connect:: |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
123 |
Establish connection to the Jabber server. |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
124 |
|
205 | 125 |
/del:: |
126 |
Delete the current buddy from our roster, unsubscribe from its presence |
|
127 |
notification and unsubscribe it from ours. |
|
128 |
||
298
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
129 |
/disconnect:: |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
130 |
Terminate connection to the Jabber server. Note: the roster is only |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
131 |
available when the connection to the server is active, so the |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
132 |
buddylist is empty when disconnected. |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
133 |
|
240 | 134 |
/group fold|unfold|toggle:: |
135 |
The 'group' command changes the current group display. |
|
199 | 136 |
|
240 | 137 |
'fold';; fold (shrink) the current group tree in the roster |
138 |
'unfold';; unfold (expand) the current group tree in the roster |
|
139 |
'toggle';; toggle the state (fold/unfold) of the current tree |
|
199 | 140 |
|
141 |
/info:: |
|
440
264f40222872
Update documentation (/info command)
Mikael Berthe <mikael@lilotux.net>
parents:
436
diff
changeset
|
142 |
Display info on the selected entry (user, agent, group...). + |
264f40222872
Update documentation (/info command)
Mikael Berthe <mikael@lilotux.net>
parents:
436
diff
changeset
|
143 |
For users, resources are displayed with the status, priority and |
264f40222872
Update documentation (/info command)
Mikael Berthe <mikael@lilotux.net>
parents:
436
diff
changeset
|
144 |
status message (if available) of each resource. |
199 | 145 |
|
210 | 146 |
/move [groupname]:: |
147 |
Move the current buddy to the requested group. If no group is |
|
148 |
specified, then the buddy is moved to the default group. |
|
229 | 149 |
This command only works with users (not agents), at the moment. |
210 | 150 |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
151 |
/msay begin|verbatim|send|abort:: |
238 | 152 |
Send a multi-line message. To write a single message with several |
289 | 153 |
lines, the 'multi-line mode' should be used. + |
154 |
In multi-line mode, each line (except command lines) typed in the input |
|
155 |
line will be added to the multi-line message. Once the message is |
|
450 | 156 |
finished, it can be sent to the current selected buddy with the "/msay |
157 |
send" command. + |
|
289 | 158 |
The 'verbatim' multi-line mode disables commands, so that it is |
159 |
possible to enter lines starting with a slash. Only the "/msay" |
|
160 |
command (with send or abort parameters) can be used to exit verbatim |
|
161 |
mode. |
|
238 | 162 |
|
163 |
'begin';; enter multi-line mode |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
164 |
'verbatim';; enter verbatim multi-line mode |
238 | 165 |
'send';; send the current multi-line message to the currently selected buddy |
166 |
'abort';; leave multi-line mode without sending the message |
|
167 |
||
199 | 168 |
/quit:: |
208 | 169 |
Disconnect and leave `mcabber(1)`. |
170 |
||
436 | 171 |
/rawxml send:: |
172 |
'send' string: send string (raw XML format) to the Jabber server. No check is done on the string provided. BEWARE! Use this only if you know what you are doing, or you could terminate the connection. |
|
173 |
||
208 | 174 |
/rename nickname:: |
175 |
Rename current buddy to the given nickname. |
|
229 | 176 |
This command does not work for groups, at the moment (but you can move |
450 | 177 |
the buddies to another group with the "/move" command). |
178 |
||
491 | 179 |
/room invite|join|leave|names|nick|privmsg|remove|topic|unlock:: |
450 | 180 |
The 'room' command handles Multi-User Chat room actions. |
181 |
||
487 | 182 |
'invite' jid [reason];; invite jid to the current room |
183 |
'join' room nick;; join "room", using "nick" as nickname |
|
184 |
'leave' [message];; leave the current room |
|
185 |
'names';; display members of the current room |
|
186 |
'nick' nick;; change your nickname in the current room |
|
491 | 187 |
'privmsg' nick msg;; send private message "msg" to "nick" |
487 | 188 |
'remove';; remove the current room from the roster (you must have left this room before) |
189 |
'topic';; set topic for current room |
|
190 |
'unlock';; unlock current room (if you are the owner) |
|
199 | 191 |
|
330 | 192 |
/roster bottom|top|hide_offline|show_offline|toggle_offline:: |
193 |
/roster alternate|unread_first|unread_next:: |
|
265 | 194 |
/roster search bud:: |
195 |
The 'roster' command manipulates the roster/buddylist. Here are the available parameters: |
|
199 | 196 |
|
265 | 197 |
'bottom';; jump to the bottom of the roster |
198 |
'top';; jump to the top of the roster |
|
377
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
199 |
'up';; move up in the roster |
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
200 |
'down';; move down in the roster |
202 | 201 |
'hide_offline';; hide offline buddies |
202 |
'show_offline';; show offline buddies |
|
290
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
203 |
'toggle_offline';; toggle display of offline buddies |
265 | 204 |
'search' bud;; search for a buddy with a name or buddy containing "bud" (only in the displayed buddylist) |
330 | 205 |
'alternate';; jump to alternate buddy. The "alternate" buddy is the last buddy left while being in chat mode (this command is thus especially useful after commands like "/roster unread_first") |
236 | 206 |
'unread_first';; jump to the first unread message |
207 |
'unread_next';; jump to the next unread message |
|
199 | 208 |
|
209 |
/say text:: |
|
491 | 210 |
Send the "text" message to the currently selected buddy. Can be useful |
199 | 211 |
if you want to send a message beginning with a slash, for example. |
212 |
||
480 | 213 |
/say_to jid text:: |
491 | 214 |
Send the "text" message to the specified jid. |
480 | 215 |
Please note that this command doesn't set the default resource for |
216 |
a contact, so if you want to send several messages to a specific |
|
217 |
ressource you will have to use "/say_to" for each message. |
|
218 |
||
320
dce1dd4d0ca8
Update documentation for "/status status message"
Mikael Berthe <mikael@lilotux.net>
parents:
310
diff
changeset
|
219 |
/status [online|avail|invisible|free|dnd|notavail|away [StatusMessage]]:: |
199 | 220 |
Set the current status. If no status is specified, display the |
320
dce1dd4d0ca8
Update documentation for "/status status message"
Mikael Berthe <mikael@lilotux.net>
parents:
310
diff
changeset
|
221 |
current status. + |
dce1dd4d0ca8
Update documentation for "/status status message"
Mikael Berthe <mikael@lilotux.net>
parents:
310
diff
changeset
|
222 |
If a status message is specified, it will overrride the message* |
dce1dd4d0ca8
Update documentation for "/status status message"
Mikael Berthe <mikael@lilotux.net>
parents:
310
diff
changeset
|
223 |
variables. |
199 | 224 |
|
450 | 225 |
/status_to jid online|avail|invisible|free|dnd|notavail|away [StatusMessage]:: |
226 |
Send the requested status to the specified Jabber user. + |
|
227 |
Note: this status will be overridden by subsequent "/status" commands. |
|
228 |
If you are using the auto-away feature, the status will overridden |
|
229 |
too. + |
|
230 |
Note: The jid can include a resource (i.e. user@server/resource). |
|
231 |
||
199 | 232 |
CONFIGURATION FILE |
233 |
------------------ |
|
234 |
See the provided sample configuration file, which should be self-documented. |
|
198 | 235 |
|
200 | 236 |
FILES |
237 |
----- |
|
202 | 238 |
The following files can be used by `mcabber(1)`: |
200 | 239 |
|
240 |
$HOME/.mcabber/mcabberrc Default configuration file |
|
241 |
$HOME/.mcabberrc Configuration file used if no other has been found |
|
242 |
$HOME/.mcabber/histo/ Default directory for storing chat history files, if enabled |
|
243 |
||
198 | 244 |
BUGS |
245 |
---- |
|
349 | 246 |
Certainly. Please tell me if you find one! :-) |
198 | 247 |
|
248 |
AUTHOR |
|
249 |
------ |
|
222 | 250 |
Written by mailto:mcabber@lilotux.net[Mikael BERTHE]. + |
204 | 251 |
Originally based on http://cabber.sourceforge.net[Cabber], please |
198 | 252 |
consult the AUTHORS file for details. |
253 |
||
254 |
RESOURCES |
|
255 |
--------- |
|
202 | 256 |
http://www.lilotux.net/~mikael/mcabber/[Main web site] |
198 | 257 |
|
258 |
COPYING |
|
259 |
------- |
|
202 | 260 |
Copyright (C) 2005 Mikael Berthe. + |
261 |
Some portions are Copyright (C) 2002-2004 mailto:cabber@ajmacias.com[]. |
|
198 | 262 |
|
263 |
Free use of this software is granted under the terms of the GNU General Public |
|
264 |
License (GPL). |
|
265 |