comparison mcabber/doc/mcabber.1.txt @ 204:dcb5ed79f719

[/trunk] Changeset 216 by mikael * AsciiDoc source updates.
author mikael
date Sat, 07 May 2005 17:36:50 +0000
parents 5ff01a4a38b6
children e01bf6d9b4b8
comparison
equal deleted inserted replaced
203:5ff01a4a38b6 204:dcb5ed79f719
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 with (optional) SSL support. + 16 `mcabber(1)` is a small Jabber console client. +
17 For now it needs a configuration file to start, so please copy the sample 17 For now it needs a configuration file to start, so please copy the sample
18 mcabberrc file and update your connection options. 18 mcabberrc file and update your connection options.
19 19
20 The `mcabber(1)` screen is divided into 4 regions. 20 The `mcabber(1)` screen is divided into 4 regions.
21 The 'roster', alias 'buddylist', is on the left. The 'chat window', or chat 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, 22 buffer, is on the right. The 'input line' lies at the bottom of the screen,
23 under a small 'log window'. 23 under a small 'log window'.
24 24
25 Commands completion. If possible, `mcabber(1)` will try to complete your 25 To display buddies chat buffers, you will have to enter 'chat mode'.
26 commands line if you hit the Tab key. 26 You can enter chat mode by pressing enter, and leave chat mode with the ESC
27 key. Sending a message also enables chat mode implicitly.
27 28
28 Chat mode. When 'chat mode' is enabled, the buddies chat buffers are 29 Here are some of the features of `mcabber`:
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 30
33 History logging. If enabled (see the CONFIGURATION FILE section), 31 - 'SSL support'.
34 `mcabber(1)` can save discussions to history log files. 32 - 'History logging:' If enabled (see the CONFIGURATION FILE section),
35 33 `mcabber(1)` can save discussions to history log files.
36 External actions. Some 'events' (like receiving a message) can trigger an 34 - 'Commands completion:' If possible, `mcabber(1)` will try to complete your
37 external action, for example a shell script (you need to enable it in your 35 commands line if you hit the Tab key.
38 configuration file). 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 39
40 OPTIONS 40 OPTIONS
41 ------- 41 -------
42 --help, -h:: 42 --help, -h::
43 Quick help usage message 43 Quick help usage message
137 Certainly a lot. Please tell me if you find one! :-) 137 Certainly a lot. Please tell me if you find one! :-)
138 138
139 AUTHOR 139 AUTHOR
140 ------ 140 ------
141 Written by mailto:bmikael@lists.lilotux.net[Mikael BERTHE]. + 141 Written by mailto:bmikael@lists.lilotux.net[Mikael BERTHE]. +
142 Originally based on cabber 142 Originally based on http://cabber.sourceforge.net[Cabber], please
143 (http://cabber.sourceforge.net[Cabber homepage]), please
144 consult the AUTHORS file for details. 143 consult the AUTHORS file for details.
145 144
146 RESOURCES 145 RESOURCES
147 --------- 146 ---------
148 http://www.lilotux.net/~mikael/mcabber/[Main web site] 147 http://www.lilotux.net/~mikael/mcabber/[Main web site]