author | Mikael Berthe <mikael@lilotux.net> |
Tue, 26 Jul 2005 19:43:51 +0100 | |
changeset 379 | 57474402997d |
parent 377 | 00809e3e327e |
child 381 | 685ac4c2e502 |
permissions | -rw-r--r-- |
198 | 1 |
MCABBER(1) |
2 |
=========== |
|
222 | 3 |
Mikael BERTHE <mcabber@lilotux.net> |
379 | 4 |
v0.6.5, July 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'. |
35 |
- 'History logging:' If enabled (see the CONFIGURATION FILE section), |
|
36 |
`mcabber(1)` can save discussions to history log files. |
|
37 |
- 'Commands completion:' If possible, `mcabber(1)` will try to complete your |
|
229 | 38 |
command line if you hit the Tab key. |
204 | 39 |
- 'External actions:' Some events (like receiving a message) can trigger an |
40 |
external action, for example a shell script (you need to enable it in your |
|
41 |
configuration file). |
|
200 | 42 |
|
43 |
OPTIONS |
|
44 |
------- |
|
45 |
--help, -h:: |
|
202 | 46 |
Quick help usage message |
200 | 47 |
|
48 |
-f configfile:: |
|
202 | 49 |
Use configuration file 'configfile' |
200 | 50 |
|
51 |
KEYS |
|
52 |
---- |
|
53 |
||
229 | 54 |
Text typing occurs in the 'input line'; basic operations are supported |
55 |
(left arrow, right arrow, home/end keys, insert, delete, backspace...). |
|
200 | 56 |
|
57 |
PageUp and PageDown keys are used to move in the roster. |
|
58 |
||
59 |
To send a message, move to the choosen buddy in the buddylist, type your |
|
60 |
message and hit enter. If the line begins with a slash, this will be |
|
61 |
interpreted as a command (see the COMMAND section below). Hit escape to |
|
62 |
leave the chat mode. |
|
63 |
||
64 |
Here is a quick description of the key bindings: |
|
65 |
||
66 |
Ctrl-a:: Go to the beginning of the input line |
|
67 |
Ctrl-e:: Go to the end of the input line |
|
68 |
Ctrl-l:: Force a resize |
|
69 |
PgUp/PgDown:: Move inside the roster (buddylist) |
|
70 |
Tab:: Complete current word, in the input line |
|
71 |
Ctrl-g:: Cancel completion / ctrl-g |
|
72 |
Ctrl-p/Ctrl-n:: Scroll up/down half a screen in the buffer window (chat mode) |
|
73 |
Ctrl-u:: Delete from beginning of the line to the cursor |
|
74 |
Ctrl-k:: Delete from the cursor to the end of line |
|
75 |
Ctrl-w:: Backward kill word |
|
76 |
Ctrl-t:: Transpose chars |
|
263 | 77 |
Ctrl-o:: Accept line and put the next history line in the input line (accept-line-and-down-history) |
236 | 78 |
Ctrl-q:: Jump to the next unread message |
198 | 79 |
|
199 | 80 |
COMMANDS |
81 |
-------- |
|
82 |
||
245 | 83 |
/add jid [nickname]:: |
84 |
Add the 'jid' Jabber user to our roster (default group), and send a |
|
85 |
notification request to this buddy. If no nickname is specified, the |
|
86 |
jid is used. |
|
199 | 87 |
|
286
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
88 |
/alias name = command line:: |
289 | 89 |
Add "name" as an alias for "command line". + |
90 |
Aliases are expanded only once, thus they can not be chained. + |
|
91 |
"/alias name" displays the value associated with the "name" alias; |
|
92 |
"/alias name =" unsets the "name" alias. + |
|
286
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
93 |
Example: "/alias away = status away". |
289 | 94 |
|
95 |
/bind keycode = command line:: |
|
96 |
Bind a command line to the key with the "keycode" code number. + |
|
97 |
Keycodes of unused keys are displayed by mcabber in the log window |
|
98 |
when pressing the key, for example "Unknown key=265". + |
|
99 |
"/bind keycode" displays the command line bound to the given keycode; |
|
100 |
"/bind keycode" unbinds the given keycode. + |
|
101 |
Note: aliases can be used in key bindings. + |
|
102 |
Example: "/bind 265 = status online" (265 is F1 for me, but it can |
|
103 |
depend on your ncurses installation). |
|
286
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
104 |
|
372
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
105 |
/buffer clear|top|bottom|search_backward|search_forward:: |
202 | 106 |
The 'buffer' command manipulates the current buddy's buffer |
107 |
(chat window). |
|
199 | 108 |
|
372
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
109 |
'clear';; clear the current buddy chat window |
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
110 |
'top';; jump to the top of the current buddy chat buffer |
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
111 |
'bottom';; jump to the bottom of the current buddy chat buffer |
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
112 |
'search_backward' text;; search for text in the current buddy chat buffer |
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
113 |
'search_forward' text;; search for text in the current buddy chat buffer |
199 | 114 |
|
115 |
/clear:: |
|
206 | 116 |
The 'clear' command is actually an alias for "/buffer clear". |
199 | 117 |
|
298
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
118 |
/connect:: |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
119 |
Establish connection to the Jabber server. |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
120 |
|
205 | 121 |
/del:: |
122 |
Delete the current buddy from our roster, unsubscribe from its presence |
|
123 |
notification and unsubscribe it from ours. |
|
124 |
||
298
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
125 |
/disconnect:: |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
126 |
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
|
127 |
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
|
128 |
buddylist is empty when disconnected. |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
129 |
|
240 | 130 |
/group fold|unfold|toggle:: |
131 |
The 'group' command changes the current group display. |
|
199 | 132 |
|
240 | 133 |
'fold';; fold (shrink) the current group tree in the roster |
134 |
'unfold';; unfold (expand) the current group tree in the roster |
|
135 |
'toggle';; toggle the state (fold/unfold) of the current tree |
|
199 | 136 |
|
137 |
/info:: |
|
208 | 138 |
Display info on the selected entry (user, agent, group...). |
199 | 139 |
|
210 | 140 |
/move [groupname]:: |
141 |
Move the current buddy to the requested group. If no group is |
|
142 |
specified, then the buddy is moved to the default group. |
|
229 | 143 |
This command only works with users (not agents), at the moment. |
210 | 144 |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
145 |
/msay begin|verbatim|send|abort:: |
238 | 146 |
Send a multi-line message. To write a single message with several |
289 | 147 |
lines, the 'multi-line mode' should be used. + |
148 |
In multi-line mode, each line (except command lines) typed in the input |
|
149 |
line will be added to the multi-line message. Once the message is |
|
150 |
finished, it can be sent to the current selected buddy with the "msay |
|
151 |
/send" command. + |
|
152 |
The 'verbatim' multi-line mode disables commands, so that it is |
|
153 |
possible to enter lines starting with a slash. Only the "/msay" |
|
154 |
command (with send or abort parameters) can be used to exit verbatim |
|
155 |
mode. |
|
238 | 156 |
|
157 |
'begin';; enter multi-line mode |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
158 |
'verbatim';; enter verbatim multi-line mode |
238 | 159 |
'send';; send the current multi-line message to the currently selected buddy |
160 |
'abort';; leave multi-line mode without sending the message |
|
161 |
||
199 | 162 |
/quit:: |
208 | 163 |
Disconnect and leave `mcabber(1)`. |
164 |
||
165 |
/rename nickname:: |
|
166 |
Rename current buddy to the given nickname. |
|
229 | 167 |
This command does not work for groups, at the moment (but you can move |
210 | 168 |
the buddies to another group with the /move command). |
199 | 169 |
|
330 | 170 |
/roster bottom|top|hide_offline|show_offline|toggle_offline:: |
171 |
/roster alternate|unread_first|unread_next:: |
|
265 | 172 |
/roster search bud:: |
173 |
The 'roster' command manipulates the roster/buddylist. Here are the available parameters: |
|
199 | 174 |
|
265 | 175 |
'bottom';; jump to the bottom of the roster |
176 |
'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
|
177 |
'up';; move up in the roster |
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
178 |
'down';; move down in the roster |
202 | 179 |
'hide_offline';; hide offline buddies |
180 |
'show_offline';; show offline buddies |
|
290
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
181 |
'toggle_offline';; toggle display of offline buddies |
265 | 182 |
'search' bud;; search for a buddy with a name or buddy containing "bud" (only in the displayed buddylist) |
330 | 183 |
'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 | 184 |
'unread_first';; jump to the first unread message |
185 |
'unread_next';; jump to the next unread message |
|
199 | 186 |
|
187 |
/say text:: |
|
202 | 188 |
Send the text message to the currently selected buddy. Can be useful |
199 | 189 |
if you want to send a message beginning with a slash, for example. |
190 |
||
320
dce1dd4d0ca8
Update documentation for "/status status message"
Mikael Berthe <mikael@lilotux.net>
parents:
310
diff
changeset
|
191 |
/status [online|avail|invisible|free|dnd|notavail|away [StatusMessage]]:: |
199 | 192 |
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
|
193 |
current status. + |
dce1dd4d0ca8
Update documentation for "/status status message"
Mikael Berthe <mikael@lilotux.net>
parents:
310
diff
changeset
|
194 |
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
|
195 |
variables. |
199 | 196 |
|
197 |
CONFIGURATION FILE |
|
198 |
------------------ |
|
199 |
See the provided sample configuration file, which should be self-documented. |
|
198 | 200 |
|
200 | 201 |
FILES |
202 |
----- |
|
202 | 203 |
The following files can be used by `mcabber(1)`: |
200 | 204 |
|
205 |
$HOME/.mcabber/mcabberrc Default configuration file |
|
206 |
$HOME/.mcabberrc Configuration file used if no other has been found |
|
207 |
$HOME/.mcabber/histo/ Default directory for storing chat history files, if enabled |
|
208 |
||
198 | 209 |
BUGS |
210 |
---- |
|
349 | 211 |
Certainly. Please tell me if you find one! :-) |
198 | 212 |
|
213 |
AUTHOR |
|
214 |
------ |
|
222 | 215 |
Written by mailto:mcabber@lilotux.net[Mikael BERTHE]. + |
204 | 216 |
Originally based on http://cabber.sourceforge.net[Cabber], please |
198 | 217 |
consult the AUTHORS file for details. |
218 |
||
219 |
RESOURCES |
|
220 |
--------- |
|
202 | 221 |
http://www.lilotux.net/~mikael/mcabber/[Main web site] |
198 | 222 |
|
223 |
COPYING |
|
224 |
------- |
|
202 | 225 |
Copyright (C) 2005 Mikael Berthe. + |
226 |
Some portions are Copyright (C) 2002-2004 mailto:cabber@ajmacias.com[]. |
|
198 | 227 |
|
228 |
Free use of this software is granted under the terms of the GNU General Public |
|
229 |
License (GPL). |
|
230 |