3 Mikael BERTHE <bmikael@lists.lilotux.net> |
3 Mikael BERTHE <bmikael@lists.lilotux.net> |
4 May 2005 |
4 May 2005 |
5 |
5 |
6 NAME |
6 NAME |
7 ---- |
7 ---- |
8 mcabber - a simple jabber console client |
8 mcabber - a simple Jabber console client |
9 |
9 |
10 SYNOPSIS |
10 SYNOPSIS |
11 -------- |
11 -------- |
12 'mcabber' [ -f configfile ] [ --help | -h ] |
12 'mcabber' [ -f configfile ] [ --help | -h ] |
13 |
13 |
14 DESCRIPTION |
14 DESCRIPTION |
15 ----------- |
15 ----------- |
16 'mcabber'(1) is a small jabber console client. |
16 'mcabber'(1) is a small Jabber console client. |
17 Please copy the sample mcabberrc file and update your connection options. |
17 For now it needs a configuration file to start, so please copy the sample |
|
18 mcabberrc file and update your connection options. |
|
19 |
|
20 The mcabber(1) screen is divided into 4 regions. |
|
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 |
|
25 Commands completion. If possible, mcabber(1) will try to complete your |
|
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 |
|
33 History logging. If enabled (see the CONFIGURATION FILE section), mcabber(1) |
|
34 can save discussions to history log files. |
|
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:: |
|
43 Quick help usage message |
|
44 |
|
45 -f configfile:: |
|
46 Use configuration file 'configfile' |
|
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) |
18 |
75 |
19 COMMANDS |
76 COMMANDS |
20 -------- |
77 -------- |
21 |
78 |
22 /add jid:: |
79 /add jid:: |
70 |
127 |
71 /status [online|avail|invisible|free|dnd|busy|notavail|away]:: |
128 /status [online|avail|invisible|free|dnd|busy|notavail|away]:: |
72 Set the current status. If no status is specified, display the |
129 Set the current status. If no status is specified, display the |
73 current status. |
130 current status. |
74 |
131 |
75 OPTIONS |
|
76 ------- |
|
77 --help, -h:: |
|
78 Quick help usage message |
|
79 |
|
80 -f configfile:: |
|
81 Use configuration file 'configfile'. |
|
82 |
|
83 CONFIGURATION FILE |
132 CONFIGURATION FILE |
84 ------------------ |
133 ------------------ |
85 See the provided sample configuration file, which should be self-documented. |
134 See the provided sample configuration file, which should be self-documented. |
|
135 |
|
136 FILES |
|
137 ----- |
|
138 The following files can be used by mcabber(1): |
|
139 |
|
140 $HOME/.mcabber/mcabberrc Default configuration file |
|
141 $HOME/.mcabberrc Configuration file used if no other has been found |
|
142 $HOME/.mcabber/histo/ Default directory for storing chat history files, if enabled |
86 |
143 |
87 BUGS |
144 BUGS |
88 ---- |
145 ---- |
89 Certainly a lot. |
146 Certainly a lot. |
90 |
147 |