Mercurial > ~mikael > mcabber > hg

comparison mcabber/doc/mcabber.1.html @ 854:bfaab692a683

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update manpage (pmw) This is Philip M. White's manpage update patch, slightly modified.
author Mikael Berthe <mikael@lilotux.net>
date Sat, 13 May 2006 22:26:15 +0200
parents f8c0447beec2
children 4b77a2ab18e5
comparison
equal deleted inserted replaced
853:bdd526ec62bc 854:bfaab692a683
23 <p><tt>mcabber(1)</tt> is a small Jabber console client.<br /> 23 <p><tt>mcabber(1)</tt> is a small Jabber console client.<br />
24 For now it needs a configuration file to start, so please copy the sample 24 For now it needs a configuration file to start, so please copy the sample
25 mcabberrc file and adapt your connection settings.</p> 25 mcabberrc file and adapt your connection settings.</p>
26 <p>You also need to have an existing Jabber account to use this software, as 26 <p>You also need to have an existing Jabber account to use this software, as
27 it cannot (un)register accounts yet.</p> 27 it cannot (un)register accounts yet.</p>
28 <p>The <tt>mcabber(1)</tt> screen is divided into 4 regions.
29 The <b>roster</b>, alias <b>buddylist</b>, is on the left. The <b>chat window</b>, or chat
30 buffer, is on the right. The <b>input line</b> lies at the bottom of the screen,
31 under a small <b>log window</b>.</p>
32 <p>Two status lines surround the log window. The bottom status line is the
33 "main status line" and reflects mcabber general status. The other line
34 is the "chat status line" and shows the status of the currently selected
35 buddy.</p>
36 <p>To display buddies chat buffers, you will have to enter <b>chat mode</b>.
37 You can enter chat mode by pressing enter, and leave chat mode with the ESC
38 key. Simply sending a message will also enable chat mode.</p>
39 <p>Here are some of the features of <tt>mcabber</tt>:</p> 28 <p>Here are some of the features of <tt>mcabber</tt>:</p>
40 <ul> 29 <ul>
41 <li> 30 <li>
42 <p> 31 <p>
43 <b>SSL support</b>. 32 <b>SSL support</b>.
67 </p> 56 </p>
68 </li> 57 </li>
69 <li> 58 <li>
70 <p> 59 <p>
71 <b>External actions:</b> Some events (like receiving a message) can trigger an 60 <b>External actions:</b> Some events (like receiving a message) can trigger an
72 external action, for example a shell script (you need to enable it in your 61 external action such as a shell script if you enable it in your
73 configuration file). A sample events script ("eventcmd") is provided with 62 configuration file. A sample events script ("eventcmd") is provided with
74 <tt>mcabber</tt> source code, in the contrib directory. 63 <tt>mcabber</tt> source code, in the contrib directory.
75 </p> 64 </p>
76 </li> 65 </li>
77 </ul> 66 </ul>
78 <h2>OPTIONS</h2> 67 <h2>OPTIONS</h2>
88 </b></dt> 77 </b></dt>
89 <dd> 78 <dd>
90 Use configuration file <b>configfile</b> 79 Use configuration file <b>configfile</b>
91 </dd> 80 </dd>
92 </dl> 81 </dl>
82 <h2>WINDOWS/PANES</h2>
83 <p>The <tt>mcabber(1)</tt> screen is divided into 4 regions.
84 The <b>roster</b>, alias <b>buddylist</b>, is on the left. The <b>chat window</b>, or chat
85 buffer, is on the right. The <b>input line</b> lies at the bottom of the screen,
86 under a small <b>log window</b>.</p>
87 <p>Two status lines surround the log window. The bottom status line is the
88 "main status line" and reflects mcabber general status. The other line
89 is the "chat status line" and shows the status of the currently selected
90 buddy.</p>
91 <p>To display buddies chat buffers, you will have to enter <b>chat mode</b>.
92 You can enter chat mode by pressing enter, and leave chat mode with the ESC
93 key. Simply sending a message will also enable chat mode.</p>
94 <p>There are several advantages to the two-mode implementation: first, it allows
95 accurate "unread" message functionality, as described in the next section;
96 without this, merely scrolling to a specific buddy will "read" the new
97 messages of all buddies in-between. Second, it allows quickly hiding the
98 conversation with a single keystroke. Third, it allows jumping between
99 the few buddies with whom you are conversing with the <b>/roster alternate</b>
100 command described in another section, without having to manually scroll
101 back and forth.</p>
93 <h2>KEYS</h2> 102 <h2>KEYS</h2>
94 <p>Text typing occurs in the <b>input line</b>; basic operations are supported 103 <p>Text typing occurs in the <b>input line</b>; basic operations are supported
95 (left arrow, right arrow, home/end keys, insert, delete, backspace&#8230;).</p> 104 (left arrow, right arrow, home/end keys, insert, delete, backspace&#8230;).</p>
96 <p>PageUp and PageDown keys are used to move in the roster.</p> 105 <p>PageUp and PageDown keys are used to move in the roster.</p>
97 <p>Up and Down arrow keys can be used to move in the input line history; they 106 <p>Up and Down arrow keys can be used to move in the input line history; they
230 <td> 239 <td>
231 Jump to the next unread message 240 Jump to the next unread message
232 </td> 241 </td>
233 </tr> 242 </tr>
234 </table> 243 </table>
235 <h2>COMMANDS</h2> 244 <p>Additional key bindings may be specified using the /bind command described
245 in the COMMANDS section.</p>
246 <h2>MCABBER'S ROSTER</h2>
247 <p>The first listed resource on the roster is <b>[status]</b>, which keeps a log of
248 everything that appears in the short log window below the main chat area.
249 While the log window was designed for showing the latest few elements, the
250 dedicated <b>[status]</b> buffer allows more comfortable viewing of the log, as
251 well as scrolling it in a standard manner.</p>
252 <p>Group names are displayed above the resources that are within them, and are
253 indicated by <b>---</b> to the left of the name.</p>
254 <p>For every real Jabber resource, the roster displays four pieces of information:
255 the resource's name or alias, its online status, its authorization status, and
256 whether there are unread messages from the resource waiting for you.</p>
257 <p>The online status is one of the following:</p>
258 <table class="hlist">
259 <tr valign="top">
260 <td>
261 <b>o</b>
262 </td>
263 <td>
264 online
265 </td>
266 </tr>
267 <tr valign="top">
268 <td>
269 <b>f</b>
270 </td>
271 <td>
272 free for chat
273 </td>
274 </tr>
275 <tr valign="top">
276 <td>
277 <b>a</b>
278 </td>
279 <td>
280 away
281 </td>
282 </tr>
283 <tr valign="top">
284 <td>
285 <b>n</b>
286 </td>
287 <td>
288 not available (labeled <b>extended away</b> in some clients)
289 </td>
290 </tr>
291 <tr valign="top">
292 <td>
293 <b>d</b>
294 </td>
295 <td>
296 do not disturb
297 </td>
298 </tr>
299 <tr valign="top">
300 <td>
301 <b>i</b>
302 </td>
303 <td>
304 invisible (displayed only for your resource)
305 </td>
306 </tr>
307 <tr valign="top">
308 <td>
309 <b>_</b>
310 </td>
311 <td>
312 offline (or invisible to you)
313 </td>
314 </tr>
315 <tr valign="top">
316 <td>
317 <b>?</b>
318 </td>
319 <td>
320 unknown, usually meaning you are not authorized to see this resource's status
321 </td>
322 </tr>
323 <tr valign="top">
324 <td>
325 <b>x</b>
326 </td>
327 <td>
328 a conference room in which you are not participating
329 </td>
330 </tr>
331 <tr valign="top">
332 <td>
333 <b>C</b>
334 </td>
335 <td>
336 a conference room in which you are participating
337 </td>
338 </tr>
339 </table>
340 <p>The authorization status indicates whether a resource is authorized to receive
341 your online status updates, and is displayed by the brackets surrounding the
342 resource's online status. Square brackets, like <b>[o]</b>, indicate that this
343 resource is authorized to receive your status. Curly braces, like <b>{o}</b>,
344 indicate that they are not authorized to receive your status.</p>
345 <p>When there are unread messages from the resource which you have not looked at,
346 a hash mark (<b>#</b>) appears in the leftmost section of the roster for that
347 resource. The hash mark disappears once you view that resource's message log.</p>
348 <p>Examples:</p>
349 <table class="hlist">
350 <tr valign="top">
351 <td>
352 <b> --- Buds</b>
353 </td>
354 <td>
355 This is a group named <b>Buds</b>
356 </td>
357 </tr>
358 <tr valign="top">
359 <td>
360 <b>#[o] John</b>
361 </td>
362 <td>
363 John is online, can see your status, and sent you a message that you did not read yet
364 </td>
365 </tr>
366 <tr valign="top">
367 <td>
368 <b> {?} Sally</b>
369 </td>
370 <td>
371 Neither you nor Sally have authorized each other to see your online status
372 </td>
373 </tr>
374 <tr valign="top">
375 <td>
376 <b> {a} Jane</b>
377 </td>
378 <td>
379 Jane is away, but she cannot see your online status
380 </td>
381 </tr>
382 <tr valign="top">
383 <td>
384 <b>#[C] x@y.c</b>
385 </td>
386 <td>
387 You are participating in x@y.c conference room, and there are unread messages
388 </td>
389 </tr>
390 </table>
391 <h2>COMMANDS RELATED TO MCABBER</h2>
236 <dl> 392 <dl>
237 <dt><b>
238 /add [jid [nickname]]
239 </b></dt>
240 <dd>
241 Add the "jid" Jabber user to our roster (default group), and send a
242 notification request to this buddy. If no nickname is specified, the
243 jid is used. If no jid (or an empty string "") is provided or if jid
244 is ".", the current buddy is used.
245 </dd>
246 <dt><b> 393 <dt><b>
247 /alias name = command line 394 /alias name = command line
248 </b></dt> 395 </b></dt>
249 <dd> 396 <dd>
250 Add "name" as an alias for "command line".<br /> 397 Add "name" as an alias for "command line".<br />
251 Aliases are expanded only once, thus they can not be chained.<br /> 398 Aliases are expanded only once, thus they can not be chained.<br />
252 "/alias name" displays the value associated with the "name" alias; 399 "/alias name" displays the value associated with the "name" alias;
253 "/alias name =" unsets the "name" alias.<br /> 400 "/alias name =" unsets the "name" alias.<br />
254 Example: "/alias away = status away". 401 Example: "/alias away = status away".
255 </dd>
256 <dt><b>
257 /authorization allow|cancel|request|request_unsubscribe [jid]
258 </b></dt>
259 <dd>
260 Manage the presence subscriptions.<br />
261 If no jid is provided, the current buddy is used.
262 <table class="hlist">
263 <tr valign="top">
264 <td>
265 <b>allow</b>
266 </td>
267 <td>
268 allow the buddy to receive your presence updates
269 </td>
270 </tr>
271 <tr valign="top">
272 <td>
273 <b>cancel</b>
274 </td>
275 <td>
276 cancel the buddy' subscription to your presence updates
277 </td>
278 </tr>
279 <tr valign="top">
280 <td>
281 <b>request</b>
282 </td>
283 <td>
284 request a subscription to the buddy's presence updates
285 </td>
286 </tr>
287 <tr valign="top">
288 <td>
289 <b>request_unsubscribe</b>
290 </td>
291 <td>
292 request unsubscription from the buddy's presence updates
293 </td>
294 </tr>
295 </table>
296 </dd> 402 </dd>
297 <dt><b> 403 <dt><b>
298 /bind keycode = command line 404 /bind keycode = command line
299 </b></dt> 405 </b></dt>
300 <dd> 406 <dd>
393 </b></dt> 499 </b></dt>
394 <dd> 500 <dd>
395 The <b>clear</b> command is actually an alias for "/buffer clear". 501 The <b>clear</b> command is actually an alias for "/buffer clear".
396 </dd> 502 </dd>
397 <dt><b> 503 <dt><b>
504 /quit
505 </b></dt>
506 <dd>
507 Disconnect and leave <tt>mcabber(1)</tt>.
508 </dd>
509 <dt><b>
510 /version
511 </b></dt>
512 <dd>
513 Display mcabber version
514 </dd>
515 </dl>
516 <h2>COMMANDS RELATED TO THE SERVER AND CONNECTION</h2>
517 <dl>
518 <dt><b>
398 /connect 519 /connect
399 </b></dt> 520 </b></dt>
400 <dd> 521 <dd>
401 Establish connection to the Jabber server. 522 Establish connection to the Jabber server.
402 </dd>
403 <dt><b>
404 /del
405 </b></dt>
406 <dd>
407 Delete the current buddy from our roster, unsubscribe from its presence
408 notification and unsubscribe it from ours.
409 </dd> 523 </dd>
410 <dt><b> 524 <dt><b>
411 /disconnect 525 /disconnect
412 </b></dt> 526 </b></dt>
413 <dd> 527 <dd>
457 <td> 571 <td>
458 list all pending events 572 list all pending events
459 </td> 573 </td>
460 </tr> 574 </tr>
461 </table> 575 </table>
576 </dd>
577 <dt><b>
578 /rawxml send
579 </b></dt>
580 <dd>
581 <b>send</b> 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.
582 </dd>
583 </dl>
584 <h2>COMMANDS RELATED TO THE ROSTER AND JABBER RESOURCES</h2>
585 <dl>
586 <dt><b>
587 /add [jid [nickname]]
588 </b></dt>
589 <dd>
590 Add the "jid" Jabber user to our roster (default group), and send a
591 notification request to this buddy. If no nickname is specified, the
592 jid is used. If no jid (or an empty string "") is provided or if jid
593 is ".", the current buddy is used.
594 </dd>
595 <dt><b>
596 /authorization allow|cancel|request|request_unsubscribe [jid]
597 </b></dt>
598 <dd>
599 Manage the presence subscriptions.<br />
600 If no jid is provided, the current buddy is used.
601 <table class="hlist">
602 <tr valign="top">
603 <td>
604 <b>allow</b>
605 </td>
606 <td>
607 allow the buddy to receive your presence updates
608 </td>
609 </tr>
610 <tr valign="top">
611 <td>
612 <b>cancel</b>
613 </td>
614 <td>
615 cancel the buddy' subscription to your presence updates
616 </td>
617 </tr>
618 <tr valign="top">
619 <td>
620 <b>request</b>
621 </td>
622 <td>
623 request a subscription to the buddy's presence updates
624 </td>
625 </tr>
626 <tr valign="top">
627 <td>
628 <b>request_unsubscribe</b>
629 </td>
630 <td>
631 request unsubscription from the buddy's presence updates
632 </td>
633 </tr>
634 </table>
635 </dd>
636 <dt><b>
637 /del
638 </b></dt>
639 <dd>
640 Delete the current buddy from our roster, unsubscribe from its presence
641 notification and unsubscribe it from ours.
462 </dd> 642 </dd>
463 <dt><b> 643 <dt><b>
464 /group fold|unfold|toggle 644 /group fold|unfold|toggle
465 </b></dt> 645 </b></dt>
466 <dd> 646 <dd>
586 </td> 766 </td>
587 </tr> 767 </tr>
588 </table> 768 </table>
589 </dd> 769 </dd>
590 <dt><b> 770 <dt><b>
591 /quit
592 </b></dt>
593 <dd>
594 Disconnect and leave <tt>mcabber(1)</tt>.
595 </dd>
596 <dt><b>
597 /rawxml send
598 </b></dt>
599 <dd>
600 <b>send</b> 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.
601 </dd>
602 <dt><b>
603 /rename nickname 771 /rename nickname
604 </b></dt> 772 </b></dt>
605 <dd> 773 <dd>
606 Rename current buddy to the given nickname. 774 Rename current buddy to the given nickname.
607 This command does not work for groups, at the moment (but you can move 775 This command does not work for groups, at the moment (but you can move
912 Note: this status will be overridden by subsequent "/status" commands. 1080 Note: this status will be overridden by subsequent "/status" commands.
913 If you are using the auto-away feature, the status will overridden 1081 If you are using the auto-away feature, the status will overridden
914 too.<br /> 1082 too.<br />
915 Note: The jid can include a resource (i.e. user@server/resource). 1083 Note: The jid can include a resource (i.e. user@server/resource).
916 </dd> 1084 </dd>
917 <dt><b>
918 /version
919 </b></dt>
920 <dd>
921 Display mcabber version
922 </dd>
923 </dl> 1085 </dl>
924 <h2>CONFIGURATION FILE</h2> 1086 <h2>CONFIGURATION FILE</h2>
925 <p>See the provided sample configuration file, which should be self-documented.</p> 1087 <p>See the provided sample configuration file, which should be self-documenting.</p>
926 <h2>FILES</h2> 1088 <h2>FILES</h2>
927 <p>The following files can be used by <tt>mcabber(1)</tt>:</p> 1089 <p>The following files can be used by <tt>mcabber(1)</tt>:</p>
928 <div class="literalparagraph"><pre>$HOME/.mcabber/mcabberrc Default configuration file 1090 <div class="literalparagraph"><pre>$HOME/.mcabber/mcabberrc Default configuration file
929 $HOME/.mcabberrc Configuration file used if no other has been found 1091 $HOME/.mcabberrc Configuration file used if no other has been found
930 $HOME/.mcabber/histo/ Default directory for storing chat history files, if enabled</pre></div> 1092 $HOME/.mcabber/histo/ Default directory for storing chat history files, if enabled</pre></div>
942 <p>Free use of this software is granted under the terms of the GNU General Public 1104 <p>Free use of this software is granted under the terms of the GNU General Public
943 License (GPL).</p> 1105 License (GPL).</p>
944 <div id="footer"> 1106 <div id="footer">
945 <p> 1107 <p>
946 Version 0.7.7-dev<br /> 1108 Version 0.7.7-dev<br />
947 Last updated 04-May-2006 20:19:47 CEST 1109 Last updated 13-May-2006 12:23:01 CEST
948 </p> 1110 </p>
949 </div> 1111 </div>
950 </div> 1112 </div>
951 </body> 1113 </body>
952 </html> 1114 </html>