File: README.html

package info (click to toggle)
tkabber 0.9.7-5
links: PTS
area: main
in suites: sarge
size: 4,756 kB
ctags: 1,593
sloc: tcl: 32,453; xml: 1,847; sh: 1,408; makefile: 72
file content (2389 lines) | stat: -rw-r--r-- 76,574 bytes
parent folder | download | duplicates (2)
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en"><head><title>Tkabber v0.9.6 (beta)</title>
<meta http-equiv="Expires" content="Tue, 27 Jul 2004 15:26:36 +0000">
<meta name="description" content="Tkabber v0.9.6 (beta)">
<meta name="generator" content="xml2rfc v1.21 (http://xml.resource.org/)">
<style type='text/css'>
<!--
    body {
        font-family: verdana, charcoal, helvetica, arial, sans-serif;
        font-size: small ; color: #000000 ; background-color: #ffffff ; }
    .title { color: #990000; font-size: x-large ;
        font-weight: bold; text-align: right;
        font-family: helvetica, monaco, "MS Sans Serif", arial, sans-serif;
        background-color: transparent; }
    .filename { color: #666666; font-size: 18px; line-height: 28px;
        font-weight: bold; text-align: right;
        font-family: helvetica, arial, sans-serif;
        background-color: transparent; }
    td.rfcbug { background-color: #000000 ; width: 30px ; height: 30px ; 
        text-align: justify; vertical-align: middle ; padding-top: 2px ; }
    td.rfcbug span.RFC { color: #666666; font-weight: bold; text-decoration: none;
        background-color: #000000 ;
        font-family: monaco, charcoal, geneva, "MS Sans Serif", helvetica, verdana, sans-serif;
        font-size: x-small ; }
    td.rfcbug span.hotText { color: #ffffff; font-weight: normal; text-decoration: none;
        text-align: center ;
        font-family: charcoal, monaco, geneva, "MS Sans Serif", helvetica, verdana, sans-serif;
        font-size: x-small ; background-color: #000000; }

     A { font-weight: bold; }
     A:link { color: #990000; background-color: transparent ; }
     A:visited { color: #333333; background-color: transparent ; }
     A:active { color: #333333; background-color: transparent ; }

    p { margin-left: 2em; margin-right: 2em; }
    p.copyright { font-size: x-small ; }
    p.toc { font-size: small ; font-weight: bold ; margin-left: 3em ;}

    span.emph { font-style: italic; }
    span.strong { font-weight: bold; }
    span.verb { font-family: "Courier New", Courier, monospace ; }

    ol.text { margin-left: 2em; margin-right: 2em; }
    ul.text { margin-left: 2em; margin-right: 2em; }
    li { margin-left: 3em;  }

    pre { margin-left: 3em; color: #333333;  background-color: transparent;
        font-family: "Courier New", Courier, monospace ; font-size: small ;
        }

    h3 { color: #333333; font-size: medium ;
        font-family: helvetica, arial, sans-serif ;
        background-color: transparent; }
    h4 { font-size: small; font-family: helvetica, arial, sans-serif ; }

    table.bug { width: 30px ; height: 15px ; }
    td.bug { color: #ffffff ; background-color: #990000 ;
        text-align: center ; width: 30px ; height: 15px ;
         }
    td.bug A.link2 { color: #ffffff ; font-weight: bold;
        text-decoration: none;
        font-family: monaco, charcoal, geneva, "MS Sans Serif", helvetica, sans-serif;
        font-size: x-small ; background-color: transparent }

    td.header { color: #ffffff; font-size: x-small ;
        font-family: arial, helvetica, sans-serif; vertical-align: top;
        background-color: #666666 ; width: 33% ; }
    td.author { font-weight: bold; margin-left: 4em; font-size: x-small ; }
    td.author-text { font-size: x-small; }
    table.data { vertical-align: top ; border-collapse: collapse ;
        border-style: solid solid solid solid ;
        border-color: black black black black ;
        font-size: small ; text-align: center ; }
    table.data th { font-weight: bold ;
        border-style: solid solid solid solid ;
        border-color: black black black black ; }
    table.data td {
        border-style: solid solid solid solid ;
        border-color: #333333 #333333 #333333 #333333 ; }

    hr { height: 1px }
-->
</style>
</head>
<body>
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&nbsp;TOC&nbsp;</a></td></tr></table>
<table summary="layout" width="66%" border="0" cellpadding="0" cellspacing="0"><tr><td><table summary="layout" width="100%" border="0" cellpadding="2" cellspacing="1">
<tr><td class="header"> </td><td class="header">A. Shchepin</td></tr>
<tr><td class="header">&nbsp;</td><td class="header">Innovation Center of Information</td></tr>
<tr><td class="header">&nbsp;</td><td class="header">Technologies (Sevcom)</td></tr>
<tr><td class="header">&nbsp;</td><td class="header">M. Rose</td></tr>
<tr><td class="header">&nbsp;</td><td class="header">Dover Beach Consulting, Inc.</td></tr>
<tr><td class="header">&nbsp;</td><td class="header">S. Golovan</td></tr>
<tr><td class="header">&nbsp;</td><td class="header">New Economic School</td></tr>
<tr><td class="header">&nbsp;</td><td class="header">M. Litvak</td></tr>
<tr><td class="header">&nbsp;</td><td class="header">Information Centre ISP</td></tr>
<tr><td class="header">&nbsp;</td><td class="header">July 27, 2004</td></tr>
</table></td></tr></table>
<div align="right"><span class="title"><br />Tkabber v0.9.6 (beta)</span></div>

<h3>Abstract</h3>

<p><span class="emph">Tkabber</span> is an open source Jabber client,
written in <span class="emph">Tcl/Tk</span>.
This memo describes the installation, configuration, and extension of
<span class="emph">Tkabber</span>.
</p><a name="toc"></a><br /><hr />
<h3>Table of Contents</h3>
<p class="toc">
<a href="#s.features">1.</a>&nbsp;
Features<br />
<a href="#s.requirements">2.</a>&nbsp;
Requirements<br />
<a href="#s.download">3.</a>&nbsp;
Download, install and run<br />
<a href="#s.configuration">4.</a>&nbsp;
Configuration<br />
<a href="#s.preload">4.1</a>&nbsp;
Pre-load<br />
<a href="#s.preload.tab">4.1.1</a>&nbsp;
Tabbed Interface<br />
<a href="#s.preload-looknfeel">4.1.2</a>&nbsp;
Primary Look-and-Feel<br />
<a href="#s.preload-crypto">4.1.3</a>&nbsp;
Cryptography by default<br />
<a href="#s.preload-tclxml">4.1.4</a>&nbsp;
Using of external TclXML library<br />
<a href="#s.preload-ispell">4.1.5</a>&nbsp;
Use ispell to check spelling<br />
<a href="#s.preload-debugoutput">4.1.6</a>&nbsp;
Debugging Output<br />
<a href="#s.preload-splashwindow">4.1.7</a>&nbsp;
Splash window<br />
<a href="#s.preload-sendempty">4.1.8</a>&nbsp;
Periodically send empty string to server<br />
<a href="#s.preload-internation">4.1.9</a>&nbsp;
I18n/L10n<br />
<a href="#s.postload">4.2</a>&nbsp;
Post-load<br />
<a href="#s.postload-looknfeel">4.2.1</a>&nbsp;
Look-and-Feel<br />
<a href="#s.postload-autoaway">4.2.2</a>&nbsp;
The Autoaway Module<br />
<a href="#s.postload-avatar">4.2.3</a>&nbsp;
The Avatar Module<br />
<a href="#s.postload-chat">4.2.4</a>&nbsp;
The Chat Module<br />
<a href="#s.postload-clientinfo">4.2.5</a>&nbsp;
The Clientinfo Module<br />
<a href="#s.postload-confinfo">4.2.6</a>&nbsp;
The Conferenceinfo Module<br />
<a href="#s.postload-crypto">4.2.7</a>&nbsp;
The Cryptographic Module<br />
<a href="#s.postload-emoti">4.2.8</a>&nbsp;
The Emoticons Module<br />
<a href="#s.postload-filexfer">4.2.9</a>&nbsp;
The File Transfer Module<br />
<a href="#s.postload-groupchat">4.2.10</a>&nbsp;
The Groupchat Module<br />
<a href="#s.postload-ispell">4.2.11</a>&nbsp;
The Ispell Module<br />
<a href="#s.postload-jidlink">4.2.12</a>&nbsp;
The Jidlink Module<br />
<a href="#s.postload-log">4.2.13</a>&nbsp;
The Logger Module<br />
<a href="#s.postload-login">4.2.14</a>&nbsp;
The Login Module<br />
<a href="#s.postload-message">4.2.15</a>&nbsp;
The Message Module<br />
<a href="#s.postload-rawxml">4.2.16</a>&nbsp;
The Raw XML Input Module<br />
<a href="#s.postload-roster">4.2.17</a>&nbsp;
The Roster Module<br />
<a href="#s.postload-sound">4.2.18</a>&nbsp;
The Sound Module<br />
<a href="#s.menuload">4.3</a>&nbsp;
Menu-load<br />
<a href="#s.menuload-avatar">4.3.1</a>&nbsp;
The Avatar Module<br />
<a href="#s.menuload-browser">4.3.2</a>&nbsp;
The Browser Module<br />
<a href="#s.menuload-groupchat">4.3.3</a>&nbsp;
The Groupchat Module<br />
<a href="#s.menuload-login">4.3.4</a>&nbsp;
The Login Module<br />
<a href="#s.menuload-message">4.3.5</a>&nbsp;
The Message Module<br />
<a href="#s.menuload-presence">4.3.6</a>&nbsp;
The Presence Module<br />
<a href="#s.menuload-miscellany">4.3.7</a>&nbsp;
Miscellany<br />
<a href="#s.finalload">4.4</a>&nbsp;
Final-Load<br />
<a href="#s.extensibility">5.</a>&nbsp;
Extensibility<br />
<a href="#anchor1">5.1</a>&nbsp;
Chat Hooks<br />
<a href="#anchor2">5.2</a>&nbsp;
Login Hooks<br />
<a href="#anchor3">5.3</a>&nbsp;
Presence Hooks<br />
<a href="#anchor4">5.4</a>&nbsp;
Roster Hooks<br />
<a href="#anchor5">5.5</a>&nbsp;
Miscellaneous Hooks<br />
<a href="#rfc.authors">&#167;</a>&nbsp;
Authors' Addresses<br />
<a href="#anchor6">A.</a>&nbsp;
Releases History<br />
<a href="#anchor7">A.1</a>&nbsp;
Main changes in 0.9.7<br />
<a href="#anchor8">A.2</a>&nbsp;
Main changes in 0.9.6beta<br />
<a href="#anchor9">A.3</a>&nbsp;
Main changes in 0.9.5beta<br />
<a href="#XRDB">B.</a>&nbsp;
XRDB<br />
<a href="#anchor10">C.</a>&nbsp;
Documentation TODO<br />
<a href="#anchor11">D.</a>&nbsp;
Acknowledgements<br />
<a href="#anchor12">E.</a>&nbsp;
Copyrights<br />
</p>
<br clear="all" />

<a name="s.features"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.1"></a><h3>1.&nbsp;Features</h3>

<p><a href="http://tkabber.jabberstudio.org/">Tkabber</a>
provides a <span class="emph">Tcl/Tk</span> interface to the
<a href="http://www.jabber.org/">Jabber</a> instant messaging
and presence service.
</p>
<p><span class="emph">Tcl/Tk</span> is a graphical scripting language that runs on the Unix,
Windows, and Macintosh platforms.
The choice of <span class="emph">Tcl/Tk</span> for a Jabber client is three-fold:
</p>
<ul class="text">
<li>it is portable:
once you install a <span class="emph">Tcl/Tk</span> interpreter on your system,
the <span class="emph">Tkabber</span> script "just runs" &#151; without having to compile
anything;
</li>
<li>it is customizable:
<span class="emph">Tkabber</span> reads a configuration file when it starts that tells it the
settings of various parameters;
and,
</li>
<li>it is extensible:
the configuration file is actually a <span class="emph">Tcl</span> script,
so you can replace or augment entire portions of <span class="emph">Tkabber</span>
(if you're so inclined).
</li>
</ul>

<p>Although relatively new software,
<span class="emph">Tkabber</span> is fully-featured:
	</p>
<blockquote class="text"><dl>
<dt>sessions:</dt>
<dd>
<ul class="text">
<li>hashed passwords
</li>
<li>encrypted sessions (if you install an optional extension)
</li>
<li>login via HTTP proxy
</li>
<li>
		user-defined hooks for connection establishment and
		release
	      
</li>
<li>XMPP/Jabber MIME type
</li>
</ul>
</dd>
<dt>messages:</dt>
<dd>
<ul class="text">
<li>emoticons
</li>
<li>
		signed/encrypted messages (if you install an optional
		extension)
	      
</li>
<li>file transfers (HTTP, DTCP and IBB transports)
</li>
<li>filters
</li>
<li>
		groupchat (GroupChat-1.0 and Multi-User Chat conferencing
		protocols)
	      
</li>
<li>headline messages
</li>
<li>message events
</li>
<li>completions of nick and commands
</li>
<li>hyperlinks
</li>
<li>user-defined hooks for chat window events
</li>
</ul>
</dd>
<dt>presence:</dt>
<dd>
<ul class="text">
<li>avatars
</li>
<li>browsing
</li>
<li>groupchat and roster invitations
</li>
<li>signed presence (if you install an optional extension)
</li>
<li>vCards
</li>
<li>user-defined hooks for presence changes
</li>
</ul>
</dd>
<dt>windowing:</dt>
<dd>
<ul class="text">
<li>configurable look-and-feel via a resources database
</li>
<li>unicode
</li>
<li>tabbed/non-tabbed interface
</li>
<li>sound notifications
</li>
<li>nested roster groups
</li>
<li>
		for Unix: auto-away, spell checking, KDE docking, and WMaker
		icons
	      
</li>
<li>
		for Windows: auto-away, and taskbar icons
	      
</li>
</ul>
</dd>
</dl></blockquote>

<a name="s.requirements"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.2"></a><h3>2.&nbsp;Requirements</h3>

<p>You should already have installed:
</p>
<ul class="text">
<li><a href="http://sourceforge.net/project/showfiles.php?group_id=10894">Tcl/Tk
version 8.3.3</a> (or later)
</li>
<li><a href="http://sourceforge.net/project/showfiles.php?group_id=12883">tcllib
version 1.2</a> (or later)
</li>
<li><a href="http://sourceforge.net/project/showfiles.php?group_id=12883">BWidget
1.3</a> (or later)
</li>
</ul><p>
Most systems already come with these packages pre-installed.
If not,
various Unix systems have them available as ready-made packages.
Otherwise,
go to the URLs above and click on the appropriate download link for
your system.
Both <span class="emph">tcllib</span> and <span class="emph">BWidget</span> are script libraries &#151;
no compiling is necessary.
In the case of <span class="emph">Tcl/Tk</span>,
there are many ready-made binary packages available on the download site.
</p>
<p>The <a href="http://www.activestate.com/Products/ActiveTcl">ActiveTcl</a>
distribution contains all three packages
(along with the <span class="emph">Img</span> package mentioned next);
so,
you may want to use that instead of three separate downloads.
</p>
<p>At your discretion,
there are several optional packages that you may also install.
<span class="emph">Tkabber</span> will run just fine without them,
but if they're available <span class="emph">Tkabber</span> will make additional features
available to you.
So,
here's the list:
</p>
<ul class="text">
<li><span class="emph">Tcl/Tk</span> supports only a small number of image formats
(i.e., bitmaps, GIFs and portable pixmaps).
If presence information contains avatars,
these may be in other formats
(e.g., PNGs or JPGs).
<br />
<br />

Accordingly,
you may want to install 
<a href="http://purl.oclc.com/net/nijtmans/img.html">Img version
1.2</a> (or later).
This package works on both Unix and Windows.
</li><br />
<br />

<li>By default,
communications between the server and client take place over a
plaintext connection.
While this may not be a problem in some local, wired environments,
if your server is distant or your client is wireless,
then you may want to encrypt all the client/server traffic.
<br />
<br />

Accordingly,
you may to install
<a href="http://sourceforge.net/project/showfiles.php?group_id=13248">tls
version 1.4.1</a> (or later).
This package works on both Unix and Windows.
Note that if you're using Unix,
then you'll also need to have <span class="emph">OpenSSL</span> installed.
Fortunately,
this comes preinstalled on many Unix systems.
If it's not on your system,
check <a href="http://www.openssl.org/source/">here</a>.
(The Windows distribution of <span class="emph">tls</span> comes with all the necessary DLLs.)
</li><br />
<br />

<li>By default,
end-to-end communications between two or more Jabber clients is
plaintext.
Depending on your environment,
this may not be a problem for you.
Alternatively,
you may want to digitally-sign all of your outgoing messages,
and allow others to encrypt their messages to you.
<br />
<br />

Accordingly,
you may want to install the <span class="emph">gpgme</span> package,
which,
at present,
works only on Unix.
Depending on what's already installed on your system,
you may have to download upto three files:

<ul class="text">
<li><a href="http://beepcore-tcl.sourceforge.net/tclgpgme-1.0.tgz">Tcl
GPGME version 1.0</a> (or later);
</li>
<li><a href="ftp://ftp.gnupg.org/gcrypt/alpha/gpgme/">GPGME
version 0.3.11</a> (or later); and,
</li>
<li><a href="http://www.gnupg.org/download.html">GPG version 1.0.7</a>
(or later).
</li>
</ul>
</li><br />
<br />

<li>If you're running Unix or Windows,
then you may want <span class="emph">Tkabber</span> to automatically mark you as away after a
priod of inactivity.
<br />
<br />

Accordingly,
on Unix,
you may want to install
<a href="http://beepcore-tcl.sourceforge.net/tkXwin-1.0.tgz">Tk
Xwin version 1.0</a> (or later),
whilst on WIndows,
you may want to install
<a href="http://sgolovan.nes.ru/jabber/tclWinidle/">Tcl
Winidle version 0.1</a> (or later).
</li><br />
<br />

<li>If you're running <span class="emph">KDE</span>,
then you may want <span class="emph">Tkabber</span> to use the docking tray.
<br />
<br />

Accordingly,
you may want to install
<a href="http://www.xmission.com/~georgeps/Tk_Theme/">Tk Theme
version 1.20</a> (or later).
</li><br />
<br />

<li>If you're running Windows,
then you may want <span class="emph">Tkabber</span> to use the system tray.
<br />
<br />

Accordingly,
you may want to install
<a href="http://ftp.bj-ig.de/pub/tcltk/winico31.zip">Winico
version 0.3</a> (or later).
Alternatiavely, Winico version 0.3 (with simpler installation) could be downloaded
<a href="http://sgolovan.nes.ru/jabber/tclWinidle/winico.zip">from here.</a>
</li><br />
<br />

<li>If you're a Tcl/Tk guru,
then you may want to access the Tk console to debug things.
<br />
<br />

Accordingly,
you may want to install
<a href="http://tkcon.sourceforge.net">tkcon version 2.3</a>
(or later).
</li>
</ul><p>
Please keep in mind that these are all "optional extras" &#151;
if they're not right for you or your environment,
don't bother with them!
</p>
<a name="s.download"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.3"></a><h3>3.&nbsp;Download, install and run</h3>

<p>Latest stable version is <a href="http://www.jabberstudio.org/projects/tkabber/releases/">0.9.7</a>.
</p>
<p>You can always find the latest development version via CVS. Do following steps:
</p>
<ul class="text">
<li>export CVSROOT=:pserver:anonymous@jabberstudio.org:/home/cvs
</li>
<li>cvs login
</li>
<li>Enter empty password
</li>
<li>cvs -z3 co tkabber/tkabber
</li>
<li>And if you want to test some plugins, then do cvs -z3 co tkabber/tkabber-plugins
</li>
</ul>

<p>If you use the Debian GNU/Linux distribution, you may want to get the latest 
stable version and all required packages using by <span class="emph">apt</span>. 
Just execute apt-get install tk tcllib bwidget tkabber

</p>
<p>No real installation is required, simply copy the <span class="verb">tkabber/</span> directory to a commonly-available area,
and then either:
</p>
<ul class="text">
<li>put this directory in your search-path; or,
</li>
<li>make a calling script/shortcut to the file <span class="verb">tkabber.tcl</span> in that directory.
</li>
</ul><p>
Although <span class="emph">Tkabber</span> comes with a Makefile,
there's really not much to do &#151; most folks prefer to simply copy
the distribution directory to somewhere in their home directory.
</p>
<p>From the shell,
you can invoke <span class="emph">Tkabber</span> as:
</p><pre>
% tkabber.tcl
</pre>

<p>whilst on a windowing system,
simply double-click on that file or a short-cut to it.
</p>
<p>If you're a Tcl/Tk guru and have installed <span class="emph">tkcon</span>,
then you may want to invoke <span class="emph">Tkabber</span> as:
</p><pre>
% tkcon.tcl -exec "" -root .tkconn -main "source tkabber.tcl"
</pre>

<p><span class="emph">Tkabber</span> will automatically know that it's running under <span class="emph">tkcon</span>
and will start by hiding the <span class="emph">Tk</span> console window.
Look under the <span class="verb">Help</span> menu to find the checkbutton to show the
console.
</p>
<p>
	    Also you can setup <span class="emph">Tkabber</span> as handler for
	    <a href="http://jabber.org/jeps/jep-0081.html">XMPP/Jabber MIME Type</a>.  For this you need to set hanler for
	    <span class="verb">application/xmpp+xml</span> MIME type in your
	    browser to something like this:
	  
</p><pre>
tkabber -mime %s
</pre>

<a name="s.configuration"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.4"></a><h3>4.&nbsp;Configuration</h3>

<p>One of the first thing that <span class="emph">Tkabber</span> does is read a file in your
home directory called <span class="verb">".tkabber/config.tcl"</span>.
This is a <span class="emph">Tcl</span> source file,
so obviously,
it's a lot easier to maintain this file if you know the Tcl
programming language.
If you're not familiar with it,
that's okay &#151; most things you'll need to do are pretty simple!
(In fact,
if you don't have your own configuration file,
you'll get the vanilla <span class="emph">Tkabber</span>,
which hopefully you'll find quite usable.)
</p>
<p><span class="emph">Tkabber</span> is configured in four stages:
</p>
<ul class="text">
<li>in the pre-load stage,
configuration options which guide the loading process are set;
</li>
<li>in the post-load stage,
configuration options for each module are set;
</li>
<li>in the menu-load stage,
the user is given an option to re-arrange <span class="emph">Tkabber's</span> menu bar; and,
</li>
<li>the final-load stage allows any last changes to be made before the
"login" dialog window is displayed to the user.
</li>
</ul><p>
Let's look at each,
in turn.
</p>
<a name="rfc.section.4.1"></a><h4><a name="s.preload">4.1</a>&nbsp;Pre-load</h4>

<p>There are a few things that <span class="emph">Tkabber</span> needs to know
immediately.
These are:
</p><pre>
# tabbed interface

set usetabbar 1


# primary look-and-feel

set pixmaps_theme default

set load_default_xrdb 1


# cryptography by default

set ssj::options(sign-traffic)    0
set ssj::options(encrypt-traffic) 0


# using of external tclxml library

set use_external_tclxml 0


# use ispell to check spelling

set use_ispell 0


# debugging output

set debug_lvls {jlib warning}


# splash window

set show_splash_window 0


# periodically send empty string to server

set keep_alive           0
set keep_alive_interval 10


# force english labels instead of native language

# ::msgcat::mclocale en
</pre>

<a name="rfc.section.4.1.1"></a><h4><a name="s.preload.tab">4.1.1</a>&nbsp;Tabbed Interface</h4>

<p>The first of these options,
<span class="verb">usetabbar</span>,
tells <span class="emph">Tkabber</span> whether you want a tabbed interface or not.
If not,
here's what to put in your configuration file:
</p><pre>
set usetabbar 0
</pre>

<p>Although tkabber is tolerant of a lot of configuration
changes,
the only time you're allowed to change <span class="verb">usetabbar</span> is at the
beginning of your configuration file.
After that,
it must not be changed!
</p>
<a name="rfc.section.4.1.2"></a><h4><a name="s.preload-looknfeel">4.1.2</a>&nbsp;Primary Look-and-Feel</h4>

<p><span class="emph">Tkabber</span> is shameless in borrowing icons from other Jabber
	    clients.  By setting <span class="verb">pixmaps_theme</span>, you can select a family of
	    related icons.  Besides <span class="verb">"default"</span>, you can choose one of
	    <span class="verb">"gabber"</span>, <span class="verb">"jajc"</span>, <span class="verb">"jarl"</span>, <span class="verb">"psi"</span>, or <span class="verb">"icq"</span>.
	  
</p>
<p>If you want,
you can have <span class="emph">Tkabber</span> use a different theme by setting
<span class="verb">pixmaps_theme</span> to a string that ends in
<span class="verb">"/"</span>, e.g.,
</p><pre>
set pixmaps_theme ~/.tkabber/pixmaps/
</pre>

<p>The theme directory should have four directories named
<span class="verb">"browser"</span>, <span class="verb">"roster"</span>, <span class="verb">"services"</span>,
and, <span class="verb">"tkabber"</span>.
Each of these directories contains the icons that make up the theme.
To find out the names of the icons that go in each directory,
go to where you installed <span class="emph">Tkabber</span> and take a look at the directory 
called <span class="verb">"pixmaps/default/"</span>.
</p>
<p>All of the windows, dialogs, etc.,
used by <span class="emph">Tkabber</span> are called "widgets".
Each widget determines most of its "look" from an "resource"
database.
On Unix,
try <span class="verb">man palette</span> to see what the primary "look-and-feel" options are,
and <span class="verb">man option</span> to see how to modify them.
(On Windows,
from the <span class="emph">Start</span> menu,
select <span class="emph">Tcl</span> and then <span class="emph">Tcl Help</span>,
and then enter either <span class="verb">"palette"</span> or <span class="verb">"option"</span>.)
</p>
<p>
	      Most folks who want to define a new look-and-feel put all their
	      options in an "xrdb" file, and then reference it this way:
	    
</p><pre>
    set load_default_xrdb 0
    option readfile ~/.tkabber/newlook.xrdb userDefault
</pre>

<p>
	      The first line tells <span class="emph">Tkabber</span> not to load its default "xrdb"
	      file, whilst the second line tells <span class="emph">Tkabber</span> the file to load
	      instead.
	    
</p>
<p>See <a href="#XRDB">Appendix B</a> for a list of all the resources that you
can set to control <span class="emph">Tkabber's</span> look-and-feel.
</p>
<p>Directory <span class="verb">"examples"</span> contains several
examples of resource database files <span class="verb">"*.xrdb"</span>.
</p>
<p>Alternatively,
if you're a Tcl "old timer", you can always do:

</p><pre>
    set load_default_xrdb 0
    tk_bisque
</pre>

<p>to set the palette to a pleasing color scheme.

</p>
<a name="rfc.section.4.1.3"></a><h4><a name="s.preload-crypto">4.1.3</a>&nbsp;Cryptography by default</h4>

<p>Next,
you may want to <span class="emph">Tkabber</span> to use cryptography by default.
There are two options:
</p>
<ul class="text">
<li>whether the traffic you send should be digitally-signed; and,
</li>
<li>if you have cryptographic information for someone,
should the default action be to encipher your traffic for them.
</li>
</ul><p>
(By defining these options early on,
<span class="emph">Tkabber</span> will complain immediately if it isn't able to load its
cryptographic module;
otherwise,
the default behavior is to proceed without any cryptographic buttons,
menus, and so on.)
</p>
<a name="rfc.section.4.1.4"></a><h4><a name="s.preload-tclxml">4.1.4</a>&nbsp;Using of external TclXML library</h4>

<p>
	      By default <span class="emph">Tkabber</span> use version of <span class="emph">TclXML</span> library that come
	      with it distribution.  This version is pure-Tcl, and it
	      performance can be not suitable.  Then you can install <span class="emph">TclXML</span>
	      with built-in <span class="emph">expat</span> support and set variable
	      <span class="verb">use_external_tclxml</span>:
	    
</p><pre>
set use_external_tclxml 0
</pre>

<a name="rfc.section.4.1.5"></a><h4><a name="s.preload-ispell">4.1.5</a>&nbsp;Use ispell to check spelling</h4>

<p>
	      On Unix, <span class="emph">Tkabber</span> can check spelling of what you entered by
	      calling an external program <span class="emph">ispell</span>.  To enable this feature, add
	      following line:
	    
</p><pre>
set use_ispell 1
</pre>

<a name="rfc.section.4.1.6"></a><h4><a name="s.preload-debugoutput">4.1.6</a>&nbsp;Debugging Output</h4>

<p><span class="emph">Tkabber</span> has a lot of debugging output.
By default,
it gets printed to the standard output by a Tcl procedure called
<span class="verb">debugmsg</span>.
However,
only information about those modules listed in a variable called
<span class="verb">debug_lvls</span> will be printed.
</p>
<p>If you know how to program Tcl,
then this will seem rather obvious:
</p><pre>
set debug_lvls [list message presence ssj warning]

# if you want a different behavior,
#     define your own...

proc debugmsg {module msg} {
#    ...
}
</pre>

<p>Most users won't care about <span class="verb">debugmsg</span> because they're
running <span class="emph">Tkabber</span> under an application launcher so the standard
output is never seen.
However,
if this isn't the case for you,
and you just don't want to see any of this stuff,
put this one line in your configuration file:
</p><pre>
set debug_lvls {}
</pre>

<a name="rfc.section.4.1.7"></a><h4><a name="s.preload-splashwindow">4.1.7</a>&nbsp;Splash window</h4>

<p>
	      By default, when <span class="emph">Tkabber</span> startup, it show loading process in
	      splash window.  To disable this feature, put this in your
	      configuration file:
	    
</p><pre>
set show_splash_window 0
</pre>

<a name="rfc.section.4.1.8"></a><h4><a name="s.preload-sendempty">4.1.8</a>&nbsp;Periodically send empty string to server</h4>

<p>
	      If you're using a proxy to talk to a Jabber server, after a
	      period of inactivity, the proxy may decide to disconnect you.  To
	      avoid this, you can tell <span class="emph">Tkabber</span> to send an empty
	      string to the server every <span class="emph">keep_alive_interval</span> minutes:
	    
</p><pre>
set keep_alive 1
set keep_alive_interval 10
</pre>

<a name="rfc.section.4.1.9"></a><h4><a name="s.preload-internation">4.1.9</a>&nbsp;I18n/L10n</h4>

<p><span class="emph">Tkabber</span> can show all messages in user's native language.  This
	      is done by using Tcl's built-in <span class="emph">msgcat</span> package which looks for
	      a directory called <span class="verb">msgs/</span> wherever you installed <span class="emph">Tkabber</span>,
	      and then uses the <span class="verb">LC_MESSAGES</span> environment variable
	      (or <span class="verb">LANG</span>
	      if <span class="verb">LC_MESSAGES</span> not set) to select the appropriate file.  If
	      you wish, you can force use of a particular language by putting a
	      line like this in your configuration file:
	    
</p><pre>
::msgcat::mclocale en
</pre>

<a name="rfc.section.4.2"></a><h4><a name="s.postload">4.2</a>&nbsp;Post-load</h4>

<p>After <span class="emph">Tkabber</span> reads your configuration file,
it loads all of its own modules,
it then invokes a procedure called <span class="verb">postload</span>.
This procedure is supposed to perform module-specific configuration.
</p>
<p>The default version of this procedure doesn't do anything.
If you want to configure one more module modules,
then you need to define the procedure in your configuration file,
e.g.,
</p><pre>
proc postload {} {
# look-and-feel

    global alert colors alert_lvls

    set alert_lvls(error)        1
    set alert_lvls(server)       1
    set alert_lvls(message)      2
    set alert_lvls(mesg_to_user) 3
    set alert_colors             {Black DarkBlue Blue Red}

    set raise_new_tab            1


# the autoaway module

    set plugins::autoaway::options(awaytime)      [expr  5*60*1000]
    set plugins::autoaway::options(xatime)        [expr 15*60*1000]
    set plugins::autoaway::options(status)        "Automatically away due to idle"
    set plugins::autoaway::options(drop_priority) 1


# the avatar module

    set avatar::options(announce) 0
    set avatar::options(share)    0


# the chat module

    set chat::options(default_message_type) chat
    set chat::options(stop_scroll)          0
    set plugins::options(timestamp_format)  {[%R]}


# the clientinfo module

    set plugins::clientinfo::options(autoask) 0


# the conferenceinfo module

    set plugins::conferenceinfo::options(autoask)         0
    set plugins::conferenceinfo::options(interval)       60
    set plugins::conferenceinfo::options(err_interval) 3600


# the cryptographic module

    set ssj::options(encrypt,fred@example.com) 1


# the emoticon module

    emoteicons::load_dir ~/.tkabber/emoticons/rythmbox


# the file transfer module

    set ft::options(download_dir) "/tmp"


# the groupchat module

    global gra_group gra_server
    global gr_nick gr_group gr_server gr_v2
    global defaultnick

    set defaultnick(adhoc@conference.example.com) publius
    set defaultnick(*@conference.example.com) cicerone


# the ispell module

    set plugins::ispell::options(executable)          /usr/bin/ispell
    set plugins::ispell::options(dictionary)          russian
    set plugins::ispell::options(dictionary_encoding) koi8-r
    set plugins::ispell::options(check_every_symbol)  1


# the jidlink module

    set jidlink::transport(allowed,dtcp-passive) 0


# the logger module

    set logger::options(logdir)        ~/.tkabber/logs
    set logger::options(log_chat)      1
    set logger::options(log_groupchat) 1


# the login module

    global loginconf loginconf1 loginconf2 autologin

    set loginconf(user)          ""
    set loginconf(password)      ""
    set loginconf(resource)      tkabber
    set loginconf(server)        example.com
    set loginconf(port)          5222
    set loginconf(priority)      8
    set loginconf(usessl)        1
    set loginconf(sslport)       5223
    set loginconf(useproxy)      0
    set loginconf(httpproxy)     localhost
    set loginconf(httpproxyport) 3128
    set loginconf(httplogin)     ""
    set loginconf(httppassword)  ""

    # The following variables are useful when your jabber-server
    # (example.com) does not have A-record in DNS
    set loginconf(usealtserver)  1
    set loginconf(altserver)     "jabber.example.com"

    set loginconf1(profile)      "Default Account"
    set loginconf1(user)         mrose

    set loginconf2(profile)      "Test Account"
    set loginconf2(user)         test

    array set loginconf          [array get loginconf1]

    set autologin 0


# the message module

    set message::options(headlines,cache)    1
    set message::options(headlines,multiple) 1


# the raw xml input module

    set plugins::rawxml::set options(pretty_print) 0
    set plugins::rawxml::set options(indent)       2


# the roster module

    set roster::show_only_online            1
    set roster::roster(collapsed,RSS)       1
    set roster::roster(collapsed,Undefined) 1

    set roster::aliases(friend@some.host) \
        {friend@other.host friend@another.host}
    set roster::use_aliases                 1


# the sound module

    set sound::options(sound)                  1
    set sound::options(mute)                   0
    set sound::options(mute_groupchat_delayed) 1
    set sound::options(mute_chat_delayed)      0
    set sound::options(external_play_program) /usr/bin/play
}
</pre>

<p>This isn't nearly as complicated as it seems.
Let's break it down by individual module
</p>
<a name="rfc.section.4.2.1"></a><h4><a name="s.postload-looknfeel">4.2.1</a>&nbsp;Look-and-Feel</h4>

<p>
	    If you're using the tabbed window interface, <span class="emph">Tkabber</span> needs a way
	    of telling you that something has changed in a window that's not on
	    top.  This is where the an array called <span class="emph">alert_lvls</span> and a list
	    called <span class="emph">alert_colors</span> come in.  The array maps an incoming message
	    to a priority number from zero to three.  The list, which is
	    indexed starting at <span class="emph">zero</span>, indicates what color the tab should
	    use to let you know that something's changed.  So, the way to read
	    the example is that receiving:
	    </p>
<ul class="text">
<li>
		an error or server message will cause the tab of a lowered
		window to go dark blue;
	      
</li>
<li>
		a groupchat or headline message will cause the tab to go blue;
		and,
	      
</li>
<li>
		a chat message addressed directly to you will cause the tab to
		go red.
	      
</li>
</ul>

<p>By default, whenever a tab has new activity,
it is automatically raised.
If you don't like this behavior,
add this line:
	    
</p><pre>set raise_new_tab 0</pre>

<a name="rfc.section.4.2.2"></a><h4><a name="s.postload-autoaway">4.2.2</a>&nbsp;The Autoaway Module</h4>

<p>This module is presently available only if either:
</p>
<ul class="text">
<li>on UNIX, if you have the <span class="emph">Tk Xwin</span> extension installed; or,
</li>
<li>On Windows, if you have the <span class="emph">Tcl Winidle</span> extension installed.
</li>
</ul>

<p>There are two variables that control when <span class="emph">Tkabber</span> automatically
marks you as away:
<span class="verb">plugins::autoaway::options(awaytime)</span> and
<span class="verb">plugins::autoaway::options(xatime)</span>.
Both define the idle threshold in milli-seconds.
</p>
<p>If variable <span class="verb">plugins::autoaway::options(drop_priority)</span> is set in 1 then
<span class="emph">Tkabber</span> will set priority to 0 when moving in extended away state.
</p>
<p>Variable <span class="verb">plugins::autoaway::options(status)</span> allows to specify text status, which
is set when <span class="emph">Tkabber</span> is moving in away state.
</p>
<a name="rfc.section.4.2.3"></a><h4><a name="s.postload-avatar">4.2.3</a>&nbsp;The Avatar Module</h4>

<p>There are two variables that you can set to control whether
<span class="emph">Tkabber</span> will allow others to see your avatar:
</p>
<ul class="text">
<li><span class="verb">avatar::options(announce)</span> determines whether your presence
information indicates that you have an avatar; and,
</li>
<li><span class="verb">avatar::options(share)</span> determines whether requests for your
avatar will be honored.
</li>
</ul>

<a name="rfc.section.4.2.4"></a><h4><a name="s.postload-chat">4.2.4</a>&nbsp;The Chat Module</h4>

<p>Most instant messaging users prefer to see all the back-and-forth
communication in a single window.
If you prefer to see each line sent back-and-forth in a separate
window,
here's what to put in your <span class="verb">postload</span>:
</p><pre>
set chat::options(default_message_type) normal
</pre>

<p>The variable named <span class="verb">chat::options(stop_scroll)</span> determines whether
a chat window should automatically scroll down to the bottom whenever
something new comes in.
</p>
<p>
	      You can also set format of time stamp that displayed in beginning
	      of each chat message.  Refer to <span class="emph">Tcl</span> documentation
	      for description of format.  E.g., to display it in
	      <span class="verb">"dd:mm:ss"</span> format, add this line:
	    
</p><pre>
set plugins::options(timestamp_format) {[%T]}
</pre>

<a name="rfc.section.4.2.5"></a><h4><a name="s.postload-clientinfo">4.2.5</a>&nbsp;The Clientinfo Module</h4>

<p>
	      This module shows in popup balloons information of used by this
	      user client name, version, and OS.  You can allow or deny
	      automatic asking of this info from users by setting this variable
	      to 1 or 0:
	    
</p><pre>set plugins::clientinfo::options(autoask) 1</pre>

<a name="rfc.section.4.2.6"></a><h4><a name="s.postload-confinfo">4.2.6</a>&nbsp;The Conferenceinfo Module</h4>

<p>After you join a conference that's listed in your
	    roster, then whenever you mouse over that roster entry,
	    you'll see a popup listing the conference's participants.
	    If you want to see this popup, regardless of whether you
	    are currently joined with the conference, add this line to
	    your post-load:
	    
</p><pre>set plugins::conferenceinfo::options(autoask) 1</pre>

<p>
	      You can also set interval between these requests with
	      these two variables:
	    
</p><pre>
set plugins::conferenceinfo::options(interval)       60
set plugins::conferenceinfo::options(err_interval) 3600
</pre>

<p>
	    The second variable defines how many seconds to wait after
	      receiving an error reply before trying again.
	      (Usually an error reply indicates that the server
	      hosting the conference doesn't support browsing,
	      so it makes sense not to try that often.
	    
</p>
<a name="rfc.section.4.2.7"></a><h4><a name="s.postload-crypto">4.2.7</a>&nbsp;The Cryptographic Module</h4>

<p><a href="#s.preload">Earlier</a> we saw an example where
the <span class="verb">ssj::options</span> array from the cryptographic module was set during
the preload.
</p>
<p>In addition to <span class="verb">signed-traffic</span>
and <span class="verb">encrypt-traffic</span>,
you can also tell <span class="emph">Tkabber</span> whether to encrypt for a particular JID,
e.g.,
</p><pre>
    set ssj::options(encrypt,fred@example.com) 1
</pre>

<a name="rfc.section.4.2.8"></a><h4><a name="s.postload-emoti">4.2.8</a>&nbsp;The Emoticons Module</h4>

<p>
	    The procedure called <span class="emph">emoteicons::load_dir</span> is used to load
	    emoticon definitions from a directory.  The directory contains a
	    file called <span class="verb">"icondef.xml"</span>, which defines the mapping between
	    each image and its textual emoticon (To find out what this file
	    looks like, go to where you installed <span class="emph">Tkabber</span> and take a look at
	    the file called <span class="verb">"emoticons-tkabber/icondef.xml"</span> or read <a href="http://www.jabber.org/jeps/jep-0038.html">JEP-0038</a>.)
	  
</p>
<p>If you have just a few icons,
and you don't want to create a directory and a textual mapping,
you can use the procedure called <span class="verb">emoteicons::add</span>, e.g.,
</p><pre>
    emoteicons::add ":beer:" [image create photo -file ~/.tkabber/beer.gif]
</pre>

<a name="rfc.section.4.2.9"></a><h4><a name="s.postload-filexfer">4.2.9</a>&nbsp;The File Transfer Module</h4>

<p>
	      You can set directory in which files will be saved by default:
	    
</p><pre>
    set ft::options(download_dir) "/tmp"
</pre>

<a name="rfc.section.4.2.10"></a><h4><a name="s.postload-groupchat">4.2.10</a>&nbsp;The Groupchat Module</h4>

<p>
	    There are several variables that set the dialog window defaults for
	    adding a groupchat to your roster, or joining a groupchat:
	    </p>
<blockquote class="text"><dl>
<dt>add to roster dialog window:</dt>
<dd><span class="verb">gra_group</span> and <span class="verb">gra_server</span> specify the default room and
		conference server, repectively; and,
	      
</dd>
<dt>join dialog window:</dt>
<dd><span class="verb">gr_nick</span>, <span class="verb">gr_group</span> and <span class="verb">gr_server</span> specify the default
		nickname, room, and conference server, respectively, whilst
		<span class="verb">gr_v2</span> indicates whether the version 2 protocol should be
		used.
	      
</dd>
</dl></blockquote><p>
	    Note that variables <span class="verb">gra_server</span>, <span class="verb">gr_nick</span> and <span class="verb">gr_server</span>
	    overriden in login procedure, so better place for changing them is
	    in <span class="verb">connected_hook</span> (see below).
	  
</p>
<p>You may want to have different nicknames for different groupchats.
Accordingly,
the array called <span class="emph">defaultnick</span> is used to set the default nickname
for when you enter a conference.
The array is indexed by the JID of the room, e.g.,
</p><pre>
    set defaultnick(adhoc@conference.example.com) publius
</pre>

<p>Another possibility is to put pattern in parentheses. The following example
shows how to specify default nickname for all conferences at <span class="emph">conference.example.com</span>:

</p><pre>
    set defaultnick(*@conference.example.com) ciceroni
</pre>

<p>
Exact JID's take the higher precedence than patterns.

</p>
<a name="rfc.section.4.2.11"></a><h4><a name="s.postload-ispell">4.2.11</a>&nbsp;The Ispell Module</h4>

<p>
	    If you enabled this module <a href="#s.preload-ispell">earlier</a>,
	    then you can define:
</p>
<ul class="text">
<li>the path to the <span class="emph">ispell</span> executable by setting
<span class="verb">plugins::ispell::options(executable)</span>
</li>
<li>the path to the dictionary by setting
<span class="verb">plugins::ispell::options(dictionary)</span>; and,
</li>
<li>the encoding of the output by setting
<span class="verb">plugins::ispell::options(dictionary_encoding)</span>.
</li>
</ul><p>
If you don't care about putting a large load on your process,
then you can also set
	    <span class="verb">plugins::ispell::options(check_every_symbol)</span> to 1 to check
	    correctness of current word after every entered symbol.  (Usually
	    you don't need to set this option.)
	  
</p>
<a name="rfc.section.4.2.12"></a><h4><a name="s.postload-jidlink">4.2.12</a>&nbsp;The Jidlink Module</h4>

<p>
	    Jidlink is a simple negotiation protocol for setting up a
	    bytestream between two JIDs.  With it you can specify what
	    transports you can use, and via negotiation choose more appropriate
	    one.  <span class="emph">Tkabber</span> comes with three transport implementations:
	    </p>
<blockquote class="text"><dl>
<dt>dtcp-active:</dt>
<dd>
	        that allows you to connect to any node that supports
	        <span class="verb">dtcp-passive</span>;
</dd>
<dt>dtcp-passive:</dt>
<dd>that allows any node that
	        supports <span class="verb">dtcp-active</span> to connect to you; and,
	      
</dd>
<dt>inband-bytestream:</dt>
<dd>that uses your
		<span class="verb">Jabber</span> connection to transmit the data (which may
		slowdown other traffic to you).
	      
</dd>
</dl></blockquote>

<p>
	      If your machine is behind a firewall, then you can't use the
	      <span class="verb">dtcp-passive</span> transport, so you should disable it:
	    
</p><pre>
    set jidlink::transport(allowed,dtcp-passive) 0
</pre>

<a name="rfc.section.4.2.13"></a><h4><a name="s.postload-log">4.2.13</a>&nbsp;The Logger Module</h4>

<p>
	      You can set directory to store logs:
	    
</p><pre>
    set logger::options(logdir) ~/.tkabber/logs
</pre>

<p>
	      Also you can allow or disallow storing of private and group chats
	      logs:
	    
</p><pre>
    set logger::options(log_chat)      1
    set logger::options(log_groupchat) 1
</pre>

<a name="rfc.section.4.2.14"></a><h4><a name="s.postload-login">4.2.14</a>&nbsp;The Login Module</h4>

<p>The first task is to initialize the configuration defaults for the
<span class="emph">login</span> module.
As you can see above,
the global array <span class="verb">loginconf</span> has a whole bunch of elements,
e.g., <span class="verb">user</span>, <span class="verb">password</span>, and so on.
This collection of elements,
which is termed a login profile,
is what populates the dialog window you'll see when <span class="emph">Tkabber</span> wants
to connect to the server.
</p>
<p>It turns out that <span class="emph">Tkabber</span> lets you have as many different login
profiles as you want.
If you want more than just one,
they're named <span class="verb">loginconf1</span>, <span class="verb">loginconf2</span>, and so on.
</p>
<p>What the example above shows is the default values for all profiles
being set in <span class="verb">loginconf</span>,
and then two profiles,
one called <span class="verb">"Default Account"</span> and the other
called <span class="verb">"Test Account"</span>
being created.
</p>
<p>
	    If you want to automatically login to server, then you can
	    set the <span class="verb">autologin</span> variable to
	    <span class="verb">1</span>.
	  
</p>
<p>
	    If you set the <span class="verb">autologin</span>
	    variable to <span class="verb">-1</span>, then <span class="emph">Tkabber</span>
	    will not automatically login and will not show login dialog.
	  
</p>
<p>
	    Default value for <span class="verb">autologin</span> is
	    <span class="verb">0</span>. In this case <span class="emph">Tkabber</span>
	    shows login dialog.
	  
</p>
<a name="rfc.section.4.2.15"></a><h4><a name="s.postload-message">4.2.15</a>&nbsp;The Message Module</h4>

<p>By default,
when you restart <span class="emph">Tkabber</span> it won't remember the headlines you received.
If you want <span class="emph">Tkabber</span> to remember headlines whenever you run it,
set <span class="verb">message::options(headlines,cache)</span> to
<span class="verb">1</span>.
</p>
<p>By default,
<span class="emph">Tkabber</span> will put all headline messages into a single window.
If you want <span class="emph">Tkabber</span> to use a seperate window for each headline source,
set <span class="verb">message::options(headlines,multiple)</span>
to <span class="verb">1</span>.
</p>
<a name="rfc.section.4.2.16"></a><h4><a name="s.postload-rawxml">4.2.16</a>&nbsp;The Raw XML Input Module</h4>

<p>
	    With this module you can monitor incoming/outgoing traffic from
	    connection to server and send custom XML stanzas.  Also you can
	    switch on <span class="verb">pretty print</span> option to see incoming and outgoing XML
	    stanzas pretty printed.  Note, that with this option they may be
	    drawed incorrectly, e.g. for XHTML tags.  Also you can set
	    indentation level via <span class="verb">indent</span> option.
	  
</p>
<a name="rfc.section.4.2.17"></a><h4><a name="s.postload-roster">4.2.17</a>&nbsp;The Roster Module</h4>

<p>
	    By default, your entire roster is shown, even those items that
	    aren't online.  The variable called <span class="verb">roster::show_only_online</span>
	    controls this.
	  
</p>
<p>
	    Similarly by default, each item in every category is shown in the
	    roster.  If you want to hide the items in a given category, the
	    array called <span class="verb">roster::roster</span> lets you do this.  In the example,
	    we see that two groups (<span class="verb">"RSS"</span>
	    and <span class="verb">"Undefined"</span>) start with
	    their items hidden.
	  
</p>
<p>
	    Some peoples use several JIDs.  <span class="emph">Tkabber</span> lets you
	    specify an alias for people like these, so it will show
	    only one entry in the roster.
	    In the example, we see that user <span class="verb">friend@some.host</span> have
	    aliases <span class="verb">friend@other.host</span> and
	    <span class="verb">friend@another.host</span>.
	    You can also disable all aliases by setting
	    <span class="verb">roster::use_aliases</span> to <span class="verb">0</span>. 
	  
</p>
<a name="rfc.section.4.2.18"></a><h4><a name="s.postload-sound">4.2.18</a>&nbsp;The Sound Module</h4>

<p><span class="emph">Tkabber</span> can play sounds on some events.  It can use for this
	      <span class="emph">snack</span> library or external program that can play <span class="emph">WAV</span> files.
	      To enable sound notifications, you can add following line:
	    
</p><pre>set sound::options(sound) 1</pre>

<p>
	      If you want to start <span class="emph">Tkabber</span> with sound muted
	      add the following line:
	    
</p><pre>set sound::options(mute) 1 </pre>

<p>
	      You can also mute sounds of delayed groupchat messages and
	      delayed personal chat messages:
	    
</p><pre>
set sound::options(mute_groupchat_delayed) 1
set sound::options(mute_chat_delayed)      0
</pre>

<p>
	      If you want to use external program for playing sounds, then also
	      add something like this:
	    
</p><pre>
set sound::options(external_play_program) /usr/bin/play
</pre>

<p>
	      You can also set minimal interval (in milliseconds) between
	      playing different sounds.
	    
</p><pre>set sound::options(delay) 200</pre>

<p>
	      If you want to use another sound theme, then you can add line
	      like this:
	    
</p><pre>set sound::options(theme) "sound_theme"</pre>

<p>
	      Then <span class="emph">Tkabber</span> load sound files from directory called
	      <span class="verb">tkabber/sounds/sound_theme</span>
	      if theme name not started with <span class="verb">/</span>
	      or <span class="verb">~</span>, else it consider theme name as path to theme directory.
	    
</p>
<a name="rfc.section.4.3"></a><h4><a name="s.menuload">4.3</a>&nbsp;Menu-load</h4>

<p>After <span class="emph">Tkabber</span> invokes your <span class="verb">postload</span> procedure,
it starts building the GUI.
One of the most important things it does is build up a list that
specifies its menu bar.
It then invokes a procedure called <span class="verb">menuload</span>,
which is allowed to modify that specification before <span class="emph">Tkabber</span> uses it.
</p>
<p>The default version of this procedure is the identity function,
i.e..,
</p><pre>
proc menuload {description} { return $description }
</pre>

<p>If you <span class="emph">really</span> want to change the menubar specification,
then here's how to get started:
</p>
<ol class="text">
<li>Go to where you installed the <span class="emph">BWidget</span> library and take a look at
the file called <span class="verb">"BWman/MainFrame.html"</span>.
The documentation for the <span class="verb">"-menu"</span> option explains the syntax of the
specification.
</li>
<li>Go to where you installed <span class="emph">Tkabber</span> and take a look at the file
called <span class="verb">"iface.tcl"</span>.
Look for the line that starts with <span class="verb">"set descmenu"</span>.
This will show you the specification given to your <span class="verb">menuload</span>
procedure.
</li>
<li>Go to where you installed <span class="emph">Tkabber</span> and take a look at the file
called
<span class="verb">"examples/mtr-config.tcl"</span>.
Look at the <span class="verb">menuload</span> procedure defined there.
It lays out <span class="emph">Tkabber's</span> menu bar similar to <span class="emph">Gabber's</span>.
</li>
<li>Finally,
study the procedures listed here.
</li>
</ol>

<a name="rfc.section.4.3.1"></a><h4><a name="s.menuload-avatar">4.3.1</a>&nbsp;The Avatar Module</h4>

<p>The procedure called <span class="verb">avatar::store_on_server</span> stores your avatar
on the server.
</p>
<a name="rfc.section.4.3.2"></a><h4><a name="s.menuload-browser">4.3.2</a>&nbsp;The Browser Module</h4>

<p>The procedure called <span class="verb">browser::open</span> opens a new browser window.
</p>
<a name="rfc.section.4.3.3"></a><h4><a name="s.menuload-groupchat">4.3.3</a>&nbsp;The Groupchat Module</h4>

<p>The procedure called <span class="verb">add_group_dialog</span> displays a dialog window
when you want to add a groupchat to your roster.
Similarly,
the procedure called <span class="verb">join_group_dialog</span> displays a dialog window
when you want to join a groupchat.
</p>
<a name="rfc.section.4.3.4"></a><h4><a name="s.menuload-login">4.3.4</a>&nbsp;The Login Module</h4>

<p>The procedure called <span class="verb">show_login_dialog</span> displays a dialog window
when you want to login to the server.
(Prior to attempting to login,
if necessary it will logout).
Naturally,
the procedure called <span class="verb">logout</span> does just that;
however,
if you want get a dialog window for confirmation,
use <span class="verb">show_logout_dialog</span> instead.
</p>
<a name="rfc.section.4.3.5"></a><h4><a name="s.menuload-message">4.3.5</a>&nbsp;The Message Module</h4>

<p>If you want to send a message to someone,
the procedure called <span class="verb">message::send_dialog</span> will put up a dialog window.
It takes upto three optional arguments:
the recipient JID, the subject, and the thread.
</p>
<p>If you want to get added to someone's roster,
the procedure called <span class="verb">message::send_subscribe_dialog</span> will put up a
dialog window.
It takes one optional argument:
the recipient JID.
</p>
<p>If you want to adjust your message filters,
the procecure called <span class="verb">filters::open</span> will put up a dialog window.
</p>
<a name="rfc.section.4.3.6"></a><h4><a name="s.menuload-presence">4.3.6</a>&nbsp;The Presence Module</h4>

<p>If you want to display information about a user,
the procecure called <span class="verb">userinfo::open</span> will put up a dialog window.
It takes two optional arguments:
the user's JID;
and,
whether or not the dialog window should be editable.
</p>
<p>Obviously,
the second argument makes sense only if it's your own information,
i.e.,
</p><pre>
    global loginconf

    userinfo::open \
        ${loginconf(user)}@$loginconf(server)/$loginconf(resource) 1
</pre>

<p>There are also two variables that you can use to set your own
presence:
<span class="verb">userstatus</span> and <span class="verb">textstatus</span>.
The first variable takes one of five values:
</p>
<ul class="text">
<li>available;
</li>
<li>chat;
</li>
<li>away;
</li>
<li>xa;
</li>
<li>dnd; or,
</li>
<li>invisible.
</li>
</ul><p>
The second variable takes any textual value.
</p>
<p>Changes to your presence information are propagated only
when <span class="verb">userstatus</span> is changed.
Accordingly,
if you make a change to <span class="verb">textstatus</span>,
be sure to write <span class="verb">userstatus</span> immediately afterwards,
even if it's a no-op,
e.g.,
</p><pre>
    global userstatus textstatus

    set textstatus "Out to lunch"
    set userstatus $userstatus
</pre>

<a name="rfc.section.4.3.7"></a><h4><a name="s.menuload-miscellany">4.3.7</a>&nbsp;Miscellany</h4>

<p>Finally,
you can use the procedure named <span class="verb">help_window</span> to display some textual
help.
This procedure takes two arguments:
the title for the window;
and,
the text to display.
</p>
<p>Also, instead of calling <span class="verb">exit</span> to terminate <span class="emph">Tkabber</span>,
please use the <span class="verb">quit</span> procedure instead.
</p>
<a name="rfc.section.4.4"></a><h4><a name="s.finalload">4.4</a>&nbsp;Final-Load</h4>

<p>Finally,
right before <span class="emph">Tkabber</span> goes to display the login dialog,
it invokes a procedure called <span class="verb">finload</span>,
which does whatever you want it to.
</p>
<a name="s.extensibility"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.5"></a><h3>5.&nbsp;Extensibility</h3>

<p>In addition to various configuration mechanisms,
<span class="emph">Tkabber</span> lets you define procedures,
termed "hooks" that get run when certain events happen.
</p>
<p>Here's an example.
When <span class="emph">Tkabber</span> receives a chat message,
how does it know what to process and what to draw?
The short answer is that it doesn't need to know anything,
all it does is:
</p><pre>
hook::run draw_message_hook $jid $from $type $body $extras
</pre>

<p>The <span class="verb">hook::run</span> procedure invokes whatever hooks have been
defined for <span class="verb">draw_message_hook</span>.
In fact,
upto ten procedures may get invoked to satisfy this hook!
</p>
<p>Here's how it works:
<span class="emph">Tkabber</span> comes with a number of plugins,
which get loaded automatically.
Each plugin makes one or more calls that look like this:
</p><pre>
hook::add draw_message_hook [namespace current]::my_draw_hook $prio
</pre>

<p>where the last two parameters are:
the name of a procedure to run;
and,
an relative integer priority.
</p>
<p>When <span class="verb">hook::run</span> is invoked for <span class="verb">draw_message_hook</span>,
each of these procedures is called,
in the priority order (from smallest to largest).
If one of the procedures wants to prevent the later procedures from
being called,
it returns the string <span class="verb">"stop"</span>.
</p>
<p>To continue with the example,
in between the pre-load and post-load stages of configuration,
the following calls get made by different plugins:
</p><pre>
hook::add draw_message_hook ...::draw_signed            6
hook::add draw_message_hook ...::draw_encrypted         7
hook::add draw_message_hook ...::handle_error          10
hook::add draw_message_hook ...::draw_timestamp        15
hook::add draw_message_hook ...::logger::log_message   15
hook::add draw_message_hook ...::handle_server_message 20
hook::add draw_message_hook ...::handle_me             50
hook::add draw_message_hook    ::wmdock::msg_recv      70
hook::add draw_message_hook ...::draw_normal_message   80
</pre>

<p>Many of these procedures look at the incoming chat message
and operate on only certain kinds of messages.
Some of these procedures may return <span class="verb">"stop"</span>,
e.g., <span class="verb">handle_me</span> which handles chat bodies
that start with <span class="verb">"/me"</span>.
(In this example,
the actual namespaces were replaced with <span class="verb">"...:"</span> to make it more
readable).
</p>
<p>Now let's look at the different kind of hooks that <span class="emph">Tkabber</span> knows
about.
</p>
<a name="rfc.section.5.1"></a><h4><a name="anchor1">5.1</a>&nbsp;Chat Hooks</h4>

<p>When <span class="emph">Tkabber</span> decides that it needs to open a (tabbed)
window for a chat or groupchat,
two hooks are run:
</p><pre>
open_chat_pre_hook  $jid $type
open_chat_post_hook $jid $type
</pre>

<p>Both hooks are given two parameters:
the JID of the user (or conference room);
and,
and the type of chat
(either <span class="verb">"chat"</span> or <span class="verb">"groupchat"</span>).
</p>
<p>Similarly,
when <span class="emph">Tkabber</span> encounters activity on a tabbed window,
a hook is run:
</p><pre>
raise_chat_tab_hook $path $jid
</pre>

<p>The hook is given two parameters:
the path of the <span class="emph">Tk</span> widget for the tabbed window;
and,
the JID of the user (or conference room).
</p>
<p>When you want to send a chat message,
a hook is run:
</p><pre>
chat_send_message_hook $jid $user $body $type
</pre>

<p>The hook is given four parameters:
the JID of the recipient;
the localpart of your login identity;
the body of the message;
and,
the type of chat.
</p><pre>
draw_message_hook $jid $from $type $body $extras
</pre>

<p>The hook is given five parameters:
the JID of the sender (including a resource);
the JID of the sender (without the resource);
the type of chat;
the body of the message;
and,
a nested-list of additional payload elements.
(This last parameter isn't documented in this version of the documentation.)

</p>
<p>
	    Chat windows have menubuttons, and two hooks is used to add items
	    in menu:
	  
</p><pre>
chat_create_user_menu_hook $path $jid
chat_create_conference_menu_hook $path $jid
</pre>

<p>
	    The first is used in user chat windows, and second in groupchat
	    ones.  Hooks is given two parameters: the path of the <span class="emph">Tk</span> menu
	    widget; and, the JID of user or conference.
	  
</p>
<p>
	    In groupchat windows possible to complete participant's nicks or
	    commands by pressing TAB key.  List of completions is generated by
	    running this hook:
	  
</p><pre>
generate_completions_hook $jid $compsvar $wordstart $line
</pre>

<p>
	    The hook is given four parameters: the JID of conference; name of
	    global variable, in which stored current list of possible
	    completions; index of position where completion must be inserted;
	    and, content of text widget where completion is requested.
	  
</p>
<p>
	    When someone enters/exits conference, next hooks called:
	  
</p><pre>
hook::run chat_user_enter $group $nick
hook::run chat_user_exit  $group $nick
</pre>

<p>
	    The hook is given two parameters: JID of conference and nick
	    participant.
	  
</p>
<a name="rfc.section.5.2"></a><h4><a name="anchor2">5.2</a>&nbsp;Login Hooks</h4>

<p>Two hooks are invoked whenever a session is connected or
disconnected:
</p><pre>
connected_hook

disconnected_hook
</pre>

<p>Neither hook is given any parameters.
</p>
<a name="rfc.section.5.3"></a><h4><a name="anchor3">5.3</a>&nbsp;Presence Hooks</h4>

<p>When our presence status changes,
a hook is run:
</p><pre>
change_our_presence_post_hook $status
</pre>

<p>The hook is given one parameter:
the new presence status value,
i.e., one of:
</p>
<ul class="text">
<li>available;
</li>
<li>chat;
</li>
<li>away;
</li>
<li>xa;
</li>
<li>dnd;
</li>
<li>invisible; or,
</li>
<li>unavailable.
</li>
</ul>

<p>Similarly,
when someone else's presence changes,
a hook is run:
</p><pre>
on_change_user_presence_hook $jid $status
</pre>

<p>The hook is given two parameters:
the label associated with the JID (e.g., "fred")
or the JID itself (e.g., "fred@example.com")
if no label exists in the roster;
and,
the user's new status.
</p>
<p>
	    And for all received presence packets, a hook is run:
	  
</p><pre>
client_presence_hook $from $type $x $args
</pre>

<p>
	    The hook is given three parameters: who send this presence, type of
	    presence (e.g., "error", "unavailable"), list of extended subtags
	    and parameters of this presence (e.g., "-show xa -status online").
	  
</p>
<a name="rfc.section.5.4"></a><h4><a name="anchor4">5.4</a>&nbsp;Roster Hooks</h4>

<p>
	    When a user is added to the roster window, a hook is run to add
	    stuff to the menu associated with that user:
	  
</p><pre>roster_create_user_menu_hook $path $jids</pre>

<p>
	    The hook is given two parameters: the path of the <span class="emph">Tk</span> menu
	    widget; and, a list of JIDs for which presence information is
	    available.
	  
</p>
<p>
	    Also next hook is run to add stuff to the menu in groupchats:
	  
</p><pre>roster_create_groupchat_user_menu_hook $path $jid</pre>

<p>
	    The hook is given two parameters: the path of the <span class="emph">Tk</span> menu
	    widget; and, a JID of user.
	  
</p>
<p>
	    Next hook is run to add stuff to the popup balloon for each roster
	    item:
	  
</p><pre>roster_user_popup_info_hook $varname $jid</pre>

<p>
	    The hook is given two parameters: the variable name in which
	    current popup text is stored, and the JID of the roster item.
	  
</p>
<a name="rfc.section.5.5"></a><h4><a name="anchor5">5.5</a>&nbsp;Miscellaneous Hooks</h4>

<p>There are three "obvious" hooks:
</p><pre>
postload_hook

finload_hook

quit_hook
</pre>

<p>The first two,
by default,
run the <span class="verb">postload</span> and <span class="verb">finload</span> procedures,
respectively.
The final hooks is called just before <span class="emph">Tkabber</span> terminates
(cf., <a href="#s.menuload-miscellany">Section 4.3.7</a>).
</p>
<a name="rfc.authors"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&nbsp;TOC&nbsp;</a></td></tr></table>
<h3>Authors' Addresses</h3>
<table width="99%" border="0" cellpadding="0" cellspacing="0">
<tr><td class="author-text">&nbsp;</td>
<td class="author-text">Alexey Yurievich Shchepin</td></tr>
<tr><td class="author-text">&nbsp;</td>
<td class="author-text">Innovation Center of Information Technologies (Sevcom)</td></tr>
<tr><td class="author" align="right">EMail:&nbsp;</td>
<td class="author-text"><a href="mailto:alexey@sevcom.net">alexey@sevcom.net</a></td></tr>
<tr cellpadding="3"><td>&nbsp;</td><td>&nbsp;</td></tr>
<tr><td class="author-text">&nbsp;</td>
<td class="author-text">Marshall T. Rose</td></tr>
<tr><td class="author-text">&nbsp;</td>
<td class="author-text">Dover Beach Consulting, Inc.</td></tr>
<tr><td class="author-text">&nbsp;</td>
<td class="author-text">POB 255268</td></tr>
<tr><td class="author-text">&nbsp;</td>
<td class="author-text">Sacramento, CA  95865-5268</td></tr>
<tr><td class="author-text">&nbsp;</td>
<td class="author-text">US</td></tr>
<tr><td class="author" align="right">Phone:&nbsp;</td>
<td class="author-text">+1 916 483 8878</td></tr>
<tr><td class="author" align="right">Fax:&nbsp;</td>
<td class="author-text">+1 916 483 8848</td></tr>
<tr><td class="author" align="right">EMail:&nbsp;</td>
<td class="author-text"><a href="mailto:mrose@dbc.mtview.ca.us">mrose@dbc.mtview.ca.us</a></td></tr>
<tr cellpadding="3"><td>&nbsp;</td><td>&nbsp;</td></tr>
<tr><td class="author-text">&nbsp;</td>
<td class="author-text">Sergei Vitalyevich Golovan</td></tr>
<tr><td class="author-text">&nbsp;</td>
<td class="author-text">New Economic School</td></tr>
<tr><td class="author" align="right">EMail:&nbsp;</td>
<td class="author-text"><a href="mailto:sgolovan@nes.ru">sgolovan@nes.ru</a></td></tr>
<tr cellpadding="3"><td>&nbsp;</td><td>&nbsp;</td></tr>
<tr><td class="author-text">&nbsp;</td>
<td class="author-text">Michail Yurievich Litvak</td></tr>
<tr><td class="author-text">&nbsp;</td>
<td class="author-text">Information Centre ISP</td></tr>
<tr><td class="author" align="right">EMail:&nbsp;</td>
<td class="author-text"><a href="mailto:mci@al.lg.ua">mci@al.lg.ua</a></td></tr>
</table>

<a name="anchor6"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.A"></a><h3>Appendix A.&nbsp;Releases History</h3>

<a name="rfc.section.A.1"></a><h4><a name="anchor7">A.1</a>&nbsp;Main changes in 0.9.7</h4>

<p></p>
<ul class="text">
<li>Updated support for file transfer (JEP-0095, JEP-0096, JEP-0047, JEP-0065)
</li>
<li>Support for colored nicks and messages in conference
</li>
<li>Better multiple logins support
</li>
<li>Updated support for xml:lang
</li>
<li>Support for IDNA (RFC3490)
</li>
<li>Many fixes and enhancements
</li>
</ul>

<a name="rfc.section.A.2"></a><h4><a name="anchor8">A.2</a>&nbsp;Main changes in 0.9.6beta</h4>

<p></p>
<ul class="text">
<li>Multiple logins support
</li>
<li>History now splitted by month
</li>
<li>Animated emoteicons support
</li>
<li>Many user interface improvements
</li>
<li>More XMPP support
</li>
<li>More translations
</li>
<li>Bugfixes
</li>
</ul>

<a name="rfc.section.A.3"></a><h4><a name="anchor9">A.3</a>&nbsp;Main changes in 0.9.5beta</h4>

<p></p>
<ul class="text">
<li>Nested roster groups
</li>
<li>Messages emphasizing
</li>
<li>User interface improvements
</li>
<li>Support for XMPP/Jabber MIME Type
</li>
<li>Bugfixes
</li>
</ul>

<a name="XRDB"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.B"></a><h3>Appendix B.&nbsp;XRDB</h3>

<p>
	Here is list of most <span class="emph">Tkabber</span>-specific <span class="emph">XRDB</span> resources that you
	need to change look:
	</p>
<blockquote class="text"><dl>
<dt>Tkabber.geometry</dt>
<dd>
	    Geometry of main window.
	  
</dd>
<dt>*Chat.chatgeometry</dt>
<dd>
</dd>
<dt>*Chat.groupchatgeometry</dt>
<dd>
</dd>
<dt>*Customize.geometry</dt>
<dd>
</dd>
<dt>*RawXML.geometry</dt>
<dd>
</dd>
<dt>*Stats.geometry</dt>
<dd>
</dd>
<dt>*Messages.geometry</dt>
<dd>
</dd>
<dt>*JBrowser.geometry</dt>
<dd>
</dd>
<dt>*JDisco.geometry</dt>
<dd>
	    Geometry of various windows (when not using tabs).
	  
</dd>
<dt>*Chat.inputheight</dt>
<dd>
</dd>
<dt>*RawXML.inputheight</dt>
<dd>
	    Height of input windows in chat and raw XML windows.
	  
</dd>
<dt>*Balloon.background</dt>
<dd>
</dd>
<dt>*Balloon.foreground</dt>
<dd>
	    Background and foreground colors of popup balloon.
	  
</dd>
<dt>*Balloon.style</dt>
<dd>
	    Behaviour of popup balloon: can be <span class="verb">delay</span> (balloon appeared
	    after some time) and <span class="verb">follow</span> (balloon appeared immediately and
	    follows mouse).
	  
</dd>
<dt>*JBrowser.fill</dt>
<dd>
	    Color of browser item name.
	  
</dd>
<dt>*JBrowser.nscolor</dt>
<dd>
	    Color of NS browser item.
	  
</dd>
<dt>*JBrowser*Tree*background</dt>
<dd>
	    Background of browser.
	  
</dd>
<dt>*Chat.meforeground</dt>
<dd>
	    Color of user's messages in chat windows.
	  
</dd>
<dt>*Chat.theyforeground</dt>
<dd>
	    Color of other peoples messages in chat windows.
	  
</dd>
<dt>*Chat.serverlabelforeground</dt>
<dd>
	    Color of label before server message.
	  
</dd>
<dt>*Chat.serverforeground</dt>
<dd>
	    Color of server messages in chat windows.
	  
</dd>
<dt>*Chat.errforeground</dt>
<dd>
	    Color of error messages in chat windows.
	  
</dd>
<dt>*Chat.urlforeground</dt>
<dd>
	    Color of URLs in chat windows.
	  
</dd>
<dt>*Chat.urlactiveforeground</dt>
<dd>
	    Color of mouse highlighted URLs in chat windows.
	  
</dd>
<dt>*JDisco.fill</dt>
<dd>
	    Default color of items in Service Discovery Browser.
	  
</dd>
<dt>*JDisco.featurecolor</dt>
<dd>
	    Default color of feature items in Service Discovery Browser.
	  
</dd>
<dt>*JDisco.identitycolor</dt>
<dd>
	    Default color of identity items in Service Discovery Browser.
	  
</dd>
<dt>*JDisco.optioncolor</dt>
<dd>
	    Default color of option items in Service Discovery Browser.
	  
</dd>
<dt>*JDisco*Tree*background</dt>
<dd>
	    Default color of background in Service Discovery Browser.
	  
</dd>
<dt>*NoteBook.alertColor0</dt>
<dd>
</dd>
<dt>*NoteBook.alertColor1</dt>
<dd>
</dd>
<dt>*NoteBook.alertColor2</dt>
<dd>
</dd>
<dt>*NoteBook.alertColor3</dt>
<dd>
	    Tabs alert colors.
	  
</dd>
<dt>*Roster.cbackground</dt>
<dd>
	    Roster background color.
	  
</dd>
<dt>*Roster.groupindent</dt>
<dd>
	    Indentation for group title.
	  
</dd>
<dt>*Roster.groupiconindent</dt>
<dd>
	    Indentation for group icon.
	  
</dd>
<dt>*Roster.jidindent</dt>
<dd>
	    Indentation for item name.
	  
</dd>
<dt>*Roster.jidmultindent</dt>
<dd>
	    Indentation for item with multiple resources.
	  
</dd>
<dt>*Roster.subjidindent</dt>
<dd>
	    Indentation for item resource.
	  
</dd>
<dt>*Roster.iconindent</dt>
<dd>
	    Indentation for item icon.
	  
</dd>
<dt>*Roster.subitemtype</dt>
<dd>
</dd>
<dt>*Roster.subiconindent</dt>
<dd>
	    Indentation for resource icon.
	  
</dd>
<dt>*Roster.textuppad</dt>
<dd>
	    Top pad for item's names.
	  
</dd>
<dt>*Roster.textdownpad</dt>
<dd>
	    Bottom pad for item's names.
	  
</dd>
<dt>*Roster.linepad</dt>
<dd>
	    Vertical distance between items.
	  
</dd>
<dt>*Roster.foreground</dt>
<dd>
	    Color of item's names.
	  
</dd>
<dt>*Roster.jidfill</dt>
<dd>
	    Background of roster item.
	  
</dd>
<dt>*Roster.jidhlfill</dt>
<dd>
	    Background of roster item when mouse is over.
	  
</dd>
<dt>*Roster.jidborder</dt>
<dd>
	    Color of item's border.
	  
</dd>
<dt>*Roster.groupfill</dt>
<dd>
</dd>
<dt>*Roster.grouphlfill</dt>
<dd>
</dd>
<dt>*Roster.groupborder</dt>
<dd>
	    The same to roster groups.
	  
</dd>
<dt>*Roster.groupcfill</dt>
<dd>
	    Background color of collapsed group.
	  
</dd>
<dt>*Roster.stalkerforeground</dt>
<dd>
</dd>
<dt>*Roster.unavailableforeground</dt>
<dd>
</dd>
<dt>*Roster.dndforeground</dt>
<dd>
</dd>
<dt>*Roster.xaforeground</dt>
<dd>
</dd>
<dt>*Roster.awayforeground</dt>
<dd>
</dd>
<dt>*Roster.availableforeground</dt>
<dd>
</dd>
<dt>*Roster.chatforeground</dt>
<dd>
	    Colors of item name for different presences.
	  
</dd>
</dl></blockquote>

<a name="anchor10"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.C"></a><h3>Appendix C.&nbsp;Documentation TODO</h3>

<p>The next revision of this documentation should discuss:
</p>
<ul class="text">
<li>Pre-load:

<ul class="text">
<li><span class="verb">browseurl</span>
</li>
</ul>
</li>
<li>Post-load:

<ul class="text">
<li><span class="verb">chat_height</span> and <span class="verb">chat_width</span> (appear to be no-ops).
</li>
</ul>
</li>
<li>Menu-load:

<ul class="text">
<li><span class="verb">change_password_dialog</span>
</li>
<li><span class="verb">conference::create_room_dialog</span>
</li>
<li><span class="verb">disco::browser::open_win</span>
</li>
<li><span class="verb">message::send_msg</span>
</li>
<li><span class="verb">privacy::request_lists</span>
</li>
<li><span class="verb">rawxml::open_window</span>
</li>
<li><span class="verb">userinfo::show_info_dialog</span>
</li>
</ul>
</li>
<li>Hooks: the additional payload format.
</li>
</ul>

<a name="anchor11"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.D"></a><h3>Appendix D.&nbsp;Acknowledgements</h3>

<p>Rebecca Malamud was kind enough to design the "enlightened feather"
motif used in the <span class="emph">Tkabber</span> look-and-feel.
</p>
<a name="anchor12"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.E"></a><h3>Appendix E.&nbsp;Copyrights</h3>

<p>(c) 2002--2004 Alexey Shchepin
</p>
<p>Hold harmless the authors, and any lawful use is allowed.
</p></body></html>