mcabber/doc/mcabber.1.html
changeset 1842 cec7cbeb1c2e
parent 1759 921429804e20
child 1888 41699679b121
equal deleted inserted replaced
1841:8ad982f83fd6 1842:cec7cbeb1c2e
   860 <div class="paragraph"><p>Additional key bindings may be specified using the <em>/bind</em> command described
   860 <div class="paragraph"><p>Additional key bindings may be specified using the <em>/bind</em> command described
   861 in the COMMANDS section.</p></div>
   861 in the COMMANDS section.</p></div>
   862 </div>
   862 </div>
   863 <h2 id="_mcabber_8217_s_roster">MCABBER&#8217;S ROSTER</h2>
   863 <h2 id="_mcabber_8217_s_roster">MCABBER&#8217;S ROSTER</h2>
   864 <div class="sectionbody">
   864 <div class="sectionbody">
   865 <div class="paragraph"><p>The first listed resource on the roster is <em>[status]</em>, which keeps a log of
   865 <div class="paragraph"><p>The first listed item on the roster is <em>[status]</em>, which keeps a log of
   866 everything that appears in the short log window below the main chat area.
   866 everything that appears in the short log window below the main chat area.
   867 While the log window was designed for showing the latest few elements, the
   867 While the log window was designed for showing the latest few elements, the
   868 dedicated <em>[status]</em> buffer allows more comfortable viewing of the log, as
   868 dedicated <em>[status]</em> buffer allows more comfortable viewing of the log, as
   869 well as scrolling it in a standard manner.</p></div>
   869 well as scrolling it in a standard manner.</p></div>
   870 <div class="paragraph"><p>Group names are displayed above the resources that are within them, and are
   870 <div class="paragraph"><p>Group names are displayed above the items that are within them, and are
   871 indicated by <em>---</em> to the left of the name.</p></div>
   871 indicated by <em>---</em> to the left of the name.</p></div>
   872 <div class="paragraph"><p>For every real Jabber resource, the roster displays four pieces of information:
   872 <div class="paragraph"><p>For every real Jabber contact, the roster displays four pieces of information:
   873 the resource&#8217;s name or alias, its online status, its authorization status, and
   873 the buddy&#8217;s name or alias, its online status, its authorization status, and
   874 whether there are unread messages from the resource waiting for you.</p></div>
   874 whether there are unread messages from the buddy waiting for you.</p></div>
   875 <div class="paragraph"><p>The online status is one of the following:</p></div>
   875 <div class="paragraph"><p>The online status is one of the following:</p></div>
   876 <div class="dlist"><dl>
   876 <div class="dlist"><dl>
   877 <dt class="hdlist1">
   877 <dt class="hdlist1">
   878 <em>o</em>
   878 <em>o</em>
   879 </dt>
   879 </dt>
   933 <dt class="hdlist1">
   933 <dt class="hdlist1">
   934 <em>?</em>
   934 <em>?</em>
   935 </dt>
   935 </dt>
   936 <dd>
   936 <dd>
   937 <p>
   937 <p>
   938 unknown, usually meaning you are not authorized to see this resource&#8217;s status
   938 unknown, usually meaning you are not authorized to see this buddy&#8217;s status
   939 </p>
   939 </p>
   940 </dd>
   940 </dd>
   941 <dt class="hdlist1">
   941 <dt class="hdlist1">
   942 <em>x</em>
   942 <em>x</em>
   943 </dt>
   943 </dt>
   953 <p>
   953 <p>
   954 a conference room in which you are participating
   954 a conference room in which you are participating
   955 </p>
   955 </p>
   956 </dd>
   956 </dd>
   957 </dl></div>
   957 </dl></div>
   958 <div class="paragraph"><p>The authorization status indicates whether a resource is authorized to receive
   958 <div class="paragraph"><p>The authorization status indicates whether a buddy is authorized to receive
   959 your online status updates, and is displayed by the brackets surrounding the
   959 your online status updates, and is displayed by the brackets surrounding the
   960 resource&#8217;s online status.  Square brackets, like <em>[o]</em>, indicate that this
   960 buddy&#8217;s online status.  Square brackets, like <em>[o]</em>, indicate that this
   961 resource is authorized to receive your status.  Curly braces, like <em>{o}</em>,
   961 buddy is authorized to receive your status.  Curly braces, like <em>{o}</em>,
   962 indicate that they are not authorized to receive your status.</p></div>
   962 indicate that they are not authorized to receive your status.</p></div>
   963 <div class="paragraph"><p>When there are unread messages from the resource which you have not looked at,
   963 <div class="paragraph"><p>When there are unread messages from a buddy which you have not looked at,
   964 a hash mark (<em>#</em>) appears in the leftmost section of the roster for that
   964 a hash mark (<em>#</em>) appears in the leftmost section of the roster for that
   965 resource.  The hash mark disappears once you view that resource&#8217;s message log.</p></div>
   965 buddy.  The hash mark disappears once you view that buddy&#8217;s message
       
   966 buffer.
       
   967 When the user attention is requested (or when you receive a message containing
       
   968 your nickname in a MUC room), the hash mark is replaced with the <em>attention
       
   969 sign</em>, an exclamation mark (<em>!</em>).</p></div>
   966 <div class="paragraph"><p>Examples:</p></div>
   970 <div class="paragraph"><p>Examples:</p></div>
   967 <div class="dlist"><dl>
   971 <div class="dlist"><dl>
   968 <dt class="hdlist1">
   972 <dt class="hdlist1">
   969 <em>--- Buds</em>
   973 ' --- Buds'
   970 </dt>
   974 </dt>
   971 <dd>
   975 <dd>
   972 <p>
   976 <p>
   973 This is a group named <em>Buds</em>
   977 This is a group named <em>Buds</em>
   974 </p>
   978 </p>
   980 <p>
   984 <p>
   981 John is online, can see your status, and sent you a message that you did not read yet
   985 John is online, can see your status, and sent you a message that you did not read yet
   982 </p>
   986 </p>
   983 </dd>
   987 </dd>
   984 <dt class="hdlist1">
   988 <dt class="hdlist1">
   985 <em>{?} Sally</em>
   989 <em> {?} Sally</em>
   986 </dt>
   990 </dt>
   987 <dd>
   991 <dd>
   988 <p>
   992 <p>
   989 Neither you nor Sally have authorized each other to see your online status
   993 Neither you nor Sally have authorized each other to see your online status
   990 </p>
   994 </p>
   991 </dd>
   995 </dd>
   992 <dt class="hdlist1">
   996 <dt class="hdlist1">
   993 <em>{a} Jane</em>
   997 <em> {a} Jane</em>
   994 </dt>
   998 </dt>
   995 <dd>
   999 <dd>
   996 <p>
  1000 <p>
   997 Jane is away, but she cannot see your online status
  1001 Jane is away, but she cannot see your online status
   998 </p>
  1002 </p>
  1187 <dt class="hdlist1">
  1191 <dt class="hdlist1">
  1188 /buffer save filename
  1192 /buffer save filename
  1189 </dt>
  1193 </dt>
  1190 <dd>
  1194 <dd>
  1191 <p>
  1195 <p>
  1192         Buddy&#8217;s buffer manipulation command.  Eg. you can search through buffer for "text", clear chat window etc.
  1196         Buddy&#8217;s buffer manipulation command.  E.g. you can search through buffer for "text", clear chat window etc.
  1193 </p>
  1197 </p>
  1194 <div class="dlist"><dl>
  1198 <div class="dlist"><dl>
  1195 <dt class="hdlist1">
  1199 <dt class="hdlist1">
  1196 <em>clear</em>
  1200 <em>clear</em>
  1197 </dt>
  1201 </dt>
  1364 <dt class="hdlist1">
  1368 <dt class="hdlist1">
  1365 <em>roster</em> clear
  1369 <em>roster</em> clear
  1366 </dt>
  1370 </dt>
  1367 <dd>
  1371 <dd>
  1368 <p>
  1372 <p>
  1369 Remove all color rules for the roster. All roster items will get its default color.
  1373 Remove all color rules for the roster.  All roster items will get its default color.
  1370 </p>
  1374 </p>
  1371 </dd>
  1375 </dd>
  1372 <dt class="hdlist1">
  1376 <dt class="hdlist1">
  1373 <em>roster</em> status wildcard color
  1377 <em>roster</em> status wildcard color
  1374 </dt>
  1378 </dt>
  1375 <dd>
  1379 <dd>
  1376 <p>
  1380 <p>
  1377 Set a color rule (or overwrite, if it already exists). The status is string containing all statuses the roster item can have for the rule to match, or * if any status is OK. Wildcard is the file-matching wildcard that will be applied to JID. Color is the wanted color. If color is -, the rule is removed. If more than one rule matches, the color from the last created (not overwritten) is used.
  1381 Set a color rule (or overwrite, if it already exists).  The status is string containing all statuses the roster item can have for the rule to match, or * if any status is OK.  Wildcard is the file-matching wildcard that will be applied to JID.  Color is the wanted color. If color is -, the rule is removed. If more than one rule matches, the color from the last created (not overwritten) is used.
  1378 </p>
  1382 </p>
  1379 </dd>
  1383 </dd>
  1380 <dt class="hdlist1">
  1384 <dt class="hdlist1">
  1381 <em>mucnick</em> nick (color|-)
  1385 <em>mucnick</em> nick (color|-)
  1382 </dt>
  1386 </dt>
  1383 <dd>
  1387 <dd>
  1384 <p>
  1388 <p>
  1385 Marks the nick to be colored by given color. If a MUC has colored nicks, this one will be used. If color is -, the color is marked as chosen automatically, which means it will not be used in <em>preset</em> coloring mode, but will stay the same in <em>on</em> coloring mode.
  1389 Marks the nick to be colored by given color.  If a MUC has colored nicks, this one will be used.  If color is -, the color is marked as chosen automatically, which means it will not be used in <em>preset</em> coloring mode, but will stay the same in <em>on</em> coloring mode.
  1386 </p>
  1390 </p>
  1387 </dd>
  1391 </dd>
  1388 <dt class="hdlist1">
  1392 <dt class="hdlist1">
  1389 <em>muc</em> (jid|.|*) [on|preset|off|-]
  1393 <em>muc</em> (jid|.|*) [on|preset|off|-]
  1390 </dt>
  1394 </dt>
  1391 <dd>
  1395 <dd>
  1392 <p>
  1396 <p>
  1393 Sets a MUC nick coloring mode. If a jid (. means currently selected jid) is provided, the mode will apply to this specific MUC. If * is used, it will be applied to all MUCs, except the ones set by their jid. Mode <em>on</em> colors all nicks, <em>preset</em> only the ones manually set by /color mucnick command and <em>off</em> colors none. If not specified, defaults to <em>on</em>. Mode <em>-</em> removes the mode from given JID, which means the global one will apply. You can not remove the global mode. Default global coloring mode is <em>off</em>.
  1397 Sets a MUC nick coloring mode.  If a jid (. means currently selected jid) is provided, the mode will apply to this specific MUC.  If * is used, it will be applied to all MUCs, except the ones set by their jid. Mode <em>on</em> colors all nicks, <em>preset</em> only the ones manually set by /color mucnick command and <em>off</em> colors none.  If not specified, defaults to <em>on</em>.  Mode <em>-</em> removes the mode from given JID, which means the global one will apply.  You can not remove the global mode. Default global coloring mode is <em>off</em>.
  1394 </p>
  1398 </p>
  1395 </dd>
  1399 </dd>
  1396 </dl></div>
  1400 </dl></div>
  1397 </dd>
  1401 </dd>
  1398 <dt class="hdlist1">
  1402 <dt class="hdlist1">
  1436 </dt>
  1440 </dt>
  1437 <dd>
  1441 <dd>
  1438 <p>
  1442 <p>
  1439         Tell mcabber what to do about pending events.<br />
  1443         Tell mcabber what to do about pending events.<br />
  1440         If the first parameter is <em>*</em>, the command will apply to all queued events.<br />
  1444         If the first parameter is <em>*</em>, the command will apply to all queued events.<br />
  1441         Event-specific arguments will be interpreted on event-to event basis. The only built-in case, when argument is used is MUC invitation reject - argument, if present, will be interpreted as reject reason.
  1445         Event-specific arguments will be interpreted on event-to event basis.  The only built-in case, when argument is used is MUC invitation reject - argument, if present, will be interpreted as reject reason.
  1442 </p>
  1446 </p>
  1443 <div class="dlist"><dl>
  1447 <div class="dlist"><dl>
  1444 <dt class="hdlist1">
  1448 <dt class="hdlist1">
  1445 #N|* accept [event-specific arguments]
  1449 #N|* accept [event-specific arguments]
  1446 </dt>
  1450 </dt>
  1778 <dt class="hdlist1">
  1782 <dt class="hdlist1">
  1779 <em>load</em> [-f] module
  1783 <em>load</em> [-f] module
  1780 </dt>
  1784 </dt>
  1781 <dd>
  1785 <dd>
  1782 <p>
  1786 <p>
  1783 Loads specified module. If -f flag is specified, most of module loading errors will be ignored.
  1787 Loads specified module.  If -f flag is specified, most of module loading errors will be ignored.
  1784 </p>
  1788 </p>
  1785 </dd>
  1789 </dd>
  1786 <dt class="hdlist1">
  1790 <dt class="hdlist1">
  1787 <em>unload</em> [-f] module
  1791 <em>unload</em> [-f] module
  1788 </dt>
  1792 </dt>
  1789 <dd>
  1793 <dd>
  1790 <p>
  1794 <p>
  1791 Unloads specified module. Note: The force flag will not remove any dependent on this modules!
  1795 Unloads specified module. Note: The force flag will not remove any dependency on this module!
  1792 </p>
  1796 </p>
  1793 </dd>
  1797 </dd>
  1794 <dt class="hdlist1">
  1798 <dt class="hdlist1">
  1795 <em>info</em> module
  1799 <em>info</em> module
  1796 </dt>
  1800 </dt>
  1939 <dt class="hdlist1">
  1943 <dt class="hdlist1">
  1940 <em>fingerprint</em> [jid [fpr]]
  1944 <em>fingerprint</em> [jid [fpr]]
  1941 </dt>
  1945 </dt>
  1942 <dd>
  1946 <dd>
  1943 <p>
  1947 <p>
  1944 Show the active fingerprint of an OTR channel. If the fingerprint is provided instead of "fpr", the fingerprint will become trusted. If you replace "fpr" by some bogus string the fingerprint will loose the trusted status.
  1948 Show the active fingerprint of an OTR channel. If the fingerprint is provided instead of "fpr", the fingerprint will become trusted.  If you replace "fpr" by some bogus string the fingerprint will loose the trusted status.
  1945 </p>
  1949 </p>
  1946 </dd>
  1950 </dd>
  1947 <dt class="hdlist1">
  1951 <dt class="hdlist1">
  1948 <em>smpq</em> [jid] secret
  1952 <em>smpq</em> [jid] secret
  1949 </dt>
  1953 </dt>
  1992 <dt class="hdlist1">
  1996 <dt class="hdlist1">
  1993 (<em>default</em>|<em>jid</em>) (plain|manual|opportunistic|always)
  1997 (<em>default</em>|<em>jid</em>) (plain|manual|opportunistic|always)
  1994 </dt>
  1998 </dt>
  1995 <dd>
  1999 <dd>
  1996 <p>
  2000 <p>
  1997 Sets either the default policy or the policy for the given jid The plain policy should never be used, because you won&#8217;t be able to receive or send any OTR encrypted messages. If you set the policy to manual, you or your chat partner have to start the OTR encryption by hand (e.g. with /otr start). The policy "opportunistic" does that itself by sending a special whitespace-sequence at the end of unencrypted messages. So the other OTR-enabled chat client knows, that you want to use OTR. Note that the first message will always be unencryted, if you use this policy. With the policy "always" no message will be sent in plain text. If you try to sent the first message unencrypted, mcabber will try to establish an OTR channel. Please resend your message, when you get the information that the channel was established. If someone sends you plaintext messages while the policy is set to "always", you&#8217;ll be able to read the message but it won&#8217;t be saved to the history.
  2001 Sets either the default policy or the policy for the given jid The plain policy should never be used, because you won&#8217;t be able to receive or send any OTR encrypted messages. If you set the policy to manual, you or your chat partner have to start the OTR encryption by hand (e.g. with /otr start). The policy "opportunistic" does that itself by sending a special whitespace-sequence at the end of unencrypted messages.  So the other OTR-enabled chat client knows, that you want to use OTR.  Note that the first message will always be unencryted, if you use this policy. With the policy "always" no message will be sent in plain text.  If you try to sent the first message unencrypted, mcabber will try to establish an OTR channel.  Please resend your message, when you get the information that the channel was established.  If someone sends you plaintext messages while the policy is set to "always", you&#8217;ll be able to read the message but it won&#8217;t be saved to the history.
  1998 </p>
  2002 </p>
  1999 </dd>
  2003 </dd>
  2000 </dl></div>
  2004 </dl></div>
  2001 </dd>
  2005 </dd>
  2002 <dt class="hdlist1">
  2006 <dt class="hdlist1">
  2495 /say [-n|-h|--] text
  2499 /say [-n|-h|--] text
  2496 </dt>
  2500 </dt>
  2497 <dd>
  2501 <dd>
  2498 <p>
  2502 <p>
  2499         Send the "text" message to the currently selected buddy.  It can be useful if you want to send a message beginning with a slash, for example.<br />
  2503         Send the "text" message to the currently selected buddy.  It can be useful if you want to send a message beginning with a slash, for example.<br />
  2500         The "-n" flag turns the message to "normal" type, "-h" to "headline". "--" can be used to send chat message beginning with -n or -h.
  2504         The "-n" flag turns the message to "normal" type, "-h" to "headline".  "--" can be used to send chat message beginning with -n or -h.
  2501 </p>
  2505 </p>
  2502 </dd>
  2506 </dd>
  2503 <dt class="hdlist1">
  2507 <dt class="hdlist1">
  2504 /say_to [-n|-h] [-q] [-f file] jid text
  2508 /say_to [-n|-h] [-q] [-f file] jid text
  2505 </dt>
  2509 </dt>
  2519 <p>
  2523 <p>
  2520         Refresh the mcabber screen.
  2524         Refresh the mcabber screen.
  2521 </p>
  2525 </p>
  2522 </dd>
  2526 </dd>
  2523 <dt class="hdlist1">
  2527 <dt class="hdlist1">
  2524 /set option [= value]
  2528 /set [option [= value]]
  2525 </dt>
  2529 </dt>
  2526 <dd>
  2530 <dd>
  2527 <p>
  2531 <p>
  2528         Display or set an option value.
  2532         Display or set an option value.<br />
       
  2533         Without arguments prints a list of all set options with their values
  2529 </p>
  2534 </p>
  2530 </dd>
  2535 </dd>
  2531 <dt class="hdlist1">
  2536 <dt class="hdlist1">
  2532 /source pattern
  2537 /source pattern
  2533 </dt>
  2538 </dt>
  2602 <div class="paragraph"><p>Written by <a href="mailto:mikael@lilotux.net">Mikael BERTHE</a> and others
  2607 <div class="paragraph"><p>Written by <a href="mailto:mikael@lilotux.net">Mikael BERTHE</a> and others
  2603 (see AUTHORS file).<br /></p></div>
  2608 (see AUTHORS file).<br /></p></div>
  2604 </div>
  2609 </div>
  2605 <h2 id="_resources">RESOURCES</h2>
  2610 <h2 id="_resources">RESOURCES</h2>
  2606 <div class="sectionbody">
  2611 <div class="sectionbody">
  2607 <div class="paragraph"><p><a href="http://mcabber.com/">Main web site</a></p></div>
  2612 <div class="paragraph"><p><a href="http://mcabber.com/">Main web site</a><br />
       
  2613 <a href="http://wiki.mcabber.com/">Official wiki</a><br />
       
  2614 <a href="xmpp:mcabber@conf.lilotux.net">MCabber MUC room</a></p></div>
  2608 </div>
  2615 </div>
  2609 <h2 id="_copying">COPYING</h2>
  2616 <h2 id="_copying">COPYING</h2>
  2610 <div class="sectionbody">
  2617 <div class="sectionbody">
  2611 <div class="paragraph"><p>Copyright (C) 2005-2010 Mikael Berthe and others.<br /></p></div>
  2618 <div class="paragraph"><p>Copyright (C) 2005-2010 Mikael Berthe and others.<br /></p></div>
  2612 <div class="paragraph"><p>Free use of this software is granted under the terms of the GNU General Public
  2619 <div class="paragraph"><p>Free use of this software is granted under the terms of the GNU General Public
  2615 </div>
  2622 </div>
  2616 <div id="footnotes"><hr /></div>
  2623 <div id="footnotes"><hr /></div>
  2617 <div id="footer">
  2624 <div id="footer">
  2618 <div id="footer-text">
  2625 <div id="footer-text">
  2619 Version 0.10.0-dev<br />
  2626 Version 0.10.0-dev<br />
  2620 Last updated 2010-03-13 17:43:30 CEST
  2627 Last updated 2010-03-28 11:48:11 CEST
  2621 </div>
  2628 </div>
  2622 </div>
  2629 </div>
  2623 </body>
  2630 </body>
  2624 </html>
  2631 </html>