comparison mcabber/doc/mcabber.1.html @ 229:bfc14cfb068e

[/trunk] Changeset 241 by mikael * Update doc (man + html).
author mikael
date Tue, 07 Jun 2005 18:35:04 +0000
parents
children 72fd1273f2b7
comparison
equal deleted inserted replaced
228:f29a95231102 229:bfc14cfb068e
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
5 <meta name="generator" content="AsciiDoc 6.0.3" />
6 <meta name="author" content="Mikael BERTHE" />
7 <meta name="author-email" content="mcabber@lilotux.net" />
8 <link rel="stylesheet" href="./manpage.css" type="text/css" />
9 <title>mcabber</title>
10 </head>
11 <body>
12 <div id="content">
13 <h1>MCABBER(1) Manual Page</h1>
14 <h2>NAME</h2>
15 <p>mcabber -
16 a simple Jabber console client
17 </p>
18 <div id="synopsis">
19 <h2>SYNOPSIS</h2>
20 <p>
21 <b>mcabber</b> [ -f configfile ] [ &#8212;help | -h ]
22 </p>
23 </div>
24 <h2>DESCRIPTION</h2>
25 <p>
26 <tt>mcabber(1)</tt> is a small Jabber console client.<br />
27 For now it needs a configuration file to start, so please copy the sample
28 mcabberrc file and adapt your connection settings.
29 </p>
30 <p>
31 The <tt>mcabber(1)</tt> screen is divided into 4 regions.
32 The <b>roster</b>, alias <b>buddylist</b>, is on the left. The <b>chat window</b>, or chat
33 buffer, is on the right. The <b>input line</b> lies at the bottom of the screen,
34 under a small <b>log window</b>.
35 </p>
36 <p>
37 To display buddies chat buffers, you will have to enter <b>chat mode</b>.
38 You can enter chat mode by pressing enter, and leave chat mode with the ESC
39 key. Simply sending a message will also enable chat mode.
40 </p>
41 <p>
42 Here are some of the features of <tt>mcabber</tt>:
43 </p>
44 <ul>
45 <li>
46 <p>
47 <b>SSL support</b>.
48 </p>
49 </li>
50 <li>
51 <p>
52 <b>History logging:</b> If enabled (see the CONFIGURATION FILE section),
53 <tt>mcabber(1)</tt> can save discussions to history log files.
54 </p>
55 </li>
56 <li>
57 <p>
58 <b>Commands completion:</b> If possible, <tt>mcabber(1)</tt> will try to complete your
59 command line if you hit the Tab key.
60 </p>
61 </li>
62 <li>
63 <p>
64 <b>External actions:</b> Some events (like receiving a message) can trigger an
65 external action, for example a shell script (you need to enable it in your
66 configuration file).
67 </p>
68 </li>
69 </ul>
70 <h2>OPTIONS</h2>
71 <dl>
72 <dt><b>
73 &#8212;help, -h
74 </b></dt>
75 <dd>
76
77 Quick help usage message
78
79 </dd>
80 <dt><b>
81 -f configfile
82 </b></dt>
83 <dd>
84
85 Use configuration file <b>configfile</b>
86
87 </dd>
88 </dl>
89 <h2>KEYS</h2>
90 <p>
91 Text typing occurs in the <b>input line</b>; basic operations are supported
92 (left arrow, right arrow, home/end keys, insert, delete, backspace&#8230;).
93 </p>
94 <p>
95 PageUp and PageDown keys are used to move in the roster.
96 </p>
97 <p>
98 To send a message, move to the choosen buddy in the buddylist, type your
99 message and hit enter. If the line begins with a slash, this will be
100 interpreted as a command (see the COMMAND section below). Hit escape to
101 leave the chat mode.
102 </p>
103 <p>
104 Here is a quick description of the key bindings:
105 </p>
106 <table class="hlist">
107 <tr valign="top">
108 <td>
109 Ctrl-a
110 </td>
111 <td>
112
113 Go to the beginning of the input line
114
115 </td>
116 </tr>
117 <tr valign="top">
118 <td>
119 Ctrl-e
120 </td>
121 <td>
122
123 Go to the end of the input line
124
125 </td>
126 </tr>
127 <tr valign="top">
128 <td>
129 Ctrl-l
130 </td>
131 <td>
132
133 Force a resize
134
135 </td>
136 </tr>
137 <tr valign="top">
138 <td>
139 PgUp/PgDown
140 </td>
141 <td>
142
143 Move inside the roster (buddylist)
144
145 </td>
146 </tr>
147 <tr valign="top">
148 <td>
149 Tab
150 </td>
151 <td>
152
153 Complete current word, in the input line
154
155 </td>
156 </tr>
157 <tr valign="top">
158 <td>
159 Ctrl-g
160 </td>
161 <td>
162
163 Cancel completion / ctrl-g
164
165 </td>
166 </tr>
167 <tr valign="top">
168 <td>
169 Ctrl-p/Ctrl-n
170 </td>
171 <td>
172
173 Scroll up/down half a screen in the buffer window (chat mode)
174
175 </td>
176 </tr>
177 <tr valign="top">
178 <td>
179 Ctrl-u
180 </td>
181 <td>
182
183 Delete from beginning of the line to the cursor
184
185 </td>
186 </tr>
187 <tr valign="top">
188 <td>
189 Ctrl-k
190 </td>
191 <td>
192
193 Delete from the cursor to the end of line
194
195 </td>
196 </tr>
197 <tr valign="top">
198 <td>
199 Ctrl-w
200 </td>
201 <td>
202
203 Backward kill word
204
205 </td>
206 </tr>
207 <tr valign="top">
208 <td>
209 Ctrl-t
210 </td>
211 <td>
212
213 Transpose chars
214
215 </td>
216 </tr>
217 <tr valign="top">
218 <td>
219 Ctrl-q
220 </td>
221 <td>
222
223 Jump to the next unread message (Not yet implemented)
224
225 </td>
226 </tr>
227 </table>
228 <h2>COMMANDS</h2>
229 <dl>
230 <dt><b>
231 /add jid
232 </b></dt>
233 <dd>
234
235 Add the <b>jid</b> Jabber user to our roster, and send a notification
236 request to this buddy.
237
238 </dd>
239 <dt><b>
240 /buffer clear|top|bottom
241 </b></dt>
242 <dd>
243
244 The <b>buffer</b> command manipulates the current buddy's buffer
245 (chat window).
246
247 <table class="hlist">
248 <tr valign="top">
249 <td>
250 <b>clear</b>
251 </td>
252 <td>
253
254 clear the current buddy chat window
255
256 </td>
257 </tr>
258 <tr valign="top">
259 <td>
260 <b>top</b>
261 </td>
262 <td>
263
264 jump to the top of the current buddy chat buffer
265
266 </td>
267 </tr>
268 <tr valign="top">
269 <td>
270 <b>bottom</b>
271 </td>
272 <td>
273
274 jump to the bottom of the current buddy chat buffer
275
276 </td>
277 </tr>
278 </table>
279 </dd>
280 <dt><b>
281 /clear
282 </b></dt>
283 <dd>
284
285 The <b>clear</b> command is actually an alias for "/buffer clear".
286
287 </dd>
288 <dt><b>
289 /del
290 </b></dt>
291 <dd>
292
293 Delete the current buddy from our roster, unsubscribe from its presence
294 notification and unsubscribe it from ours.
295
296 </dd>
297 <dt><b>
298 /group expand|shrink|toggle
299 </b></dt>
300 <dd>
301
302 The <b>group</b> command changes the group display settings.
303
304 <table class="hlist">
305 <tr valign="top">
306 <td>
307 <b>expand</b>
308 </td>
309 <td>
310
311 expand the current group tree in the roster (syn: <b>unfold</b>)
312
313 </td>
314 </tr>
315 <tr valign="top">
316 <td>
317 <b>shrink</b>
318 </td>
319 <td>
320
321 shrink the current group tree in the roster (syn: <b>fold</b>)
322
323 </td>
324 </tr>
325 <tr valign="top">
326 <td>
327 <b>toggle</b>
328 </td>
329 <td>
330
331 toggle the fold/unfold state of the current tree
332
333 </td>
334 </tr>
335 </table>
336 </dd>
337 <dt><b>
338 /info
339 </b></dt>
340 <dd>
341
342 Display info on the selected entry (user, agent, group&#8230;).
343
344 </dd>
345 <dt><b>
346 /move [groupname]
347 </b></dt>
348 <dd>
349
350 Move the current buddy to the requested group. If no group is
351 specified, then the buddy is moved to the default group.
352 This command only works with users (not agents), at the moment.
353
354 </dd>
355 <dt><b>
356 /quit
357 </b></dt>
358 <dd>
359
360 Disconnect and leave <tt>mcabber(1)</tt>.
361
362 </dd>
363 <dt><b>
364 /rename nickname
365 </b></dt>
366 <dd>
367
368 Rename current buddy to the given nickname.
369 This command does not work for groups, at the moment (but you can move
370 the buddies to another group with the /move command).
371
372 </dd>
373 <dt><b>
374 /roster hide_offline|show_offline|top|bottom
375 </b></dt>
376 <dd>
377
378 The <b>roster</b> command manipulates the roster/buddylist.
379
380 <table class="hlist">
381 <tr valign="top">
382 <td>
383 <b>hide_offline</b>
384 </td>
385 <td>
386
387 hide offline buddies
388
389 </td>
390 </tr>
391 <tr valign="top">
392 <td>
393 <b>show_offline</b>
394 </td>
395 <td>
396
397 show offline buddies
398
399 </td>
400 </tr>
401 <tr valign="top">
402 <td>
403 <b>top</b>
404 </td>
405 <td>
406
407 jump to the top of the roster
408
409 </td>
410 </tr>
411 <tr valign="top">
412 <td>
413 <b>bottom</b>
414 </td>
415 <td>
416
417 jump to the bottom of the roster
418
419 </td>
420 </tr>
421 </table>
422 </dd>
423 <dt><b>
424 /say text
425 </b></dt>
426 <dd>
427
428 Send the text message to the currently selected buddy. Can be useful
429 if you want to send a message beginning with a slash, for example.
430
431 </dd>
432 <dt><b>
433 /status [online|avail|invisible|free|dnd|busy|notavail|away]
434 </b></dt>
435 <dd>
436
437 Set the current status. If no status is specified, display the
438 current status.
439
440 </dd>
441 </dl>
442 <h2>CONFIGURATION FILE</h2>
443 <p>
444 See the provided sample configuration file, which should be self-documented.
445 </p>
446 <h2>FILES</h2>
447 <p>
448 The following files can be used by <tt>mcabber(1)</tt>:
449 </p>
450 <div class="literalparagraph"><pre>
451 $HOME/.mcabber/mcabberrc Default configuration file
452 $HOME/.mcabberrc Configuration file used if no other has been found
453 $HOME/.mcabber/histo/ Default directory for storing chat history files, if enabled
454 </pre></div>
455 <h2>BUGS</h2>
456 <p>
457 Certainly a lot. Please tell me if you find one! :-)
458 </p>
459 <h2>AUTHOR</h2>
460 <p>
461 Written by <a href="mailto:mcabber@lilotux.net">Mikael BERTHE</a>.<br />
462 Originally based on <a href="http://cabber.sourceforge.net">Cabber</a>, please
463 consult the AUTHORS file for details.
464 </p>
465 <h2>RESOURCES</h2>
466 <p>
467 <a href="http://www.lilotux.net/~mikael/mcabber/">Main web site</a>
468 </p>
469 <h2>COPYING</h2>
470 <p>
471 Copyright &#169; 2005 Mikael Berthe.<br />
472 Some portions are Copyright &#169; 2002-2004 <a href="mailto:cabber@ajmacias.com">cabber@ajmacias.com</a>.
473 </p>
474 <p>
475 Free use of this software is granted under the terms of the GNU General Public
476 License (GPL).
477 </p>
478 <div id="footer">
479 <p>
480 Version 0.6.0<br />
481 Last updated 07-Jun-2005 22:11:00 CEST
482 </p>
483 </div>
484 </div>
485 </body>
486 </html>