<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<link rel="stylesheet" href="style.css"/>
<title>Advanced Stuff</title>
</head>
<body>
<table width="100%" cellpadding="15">
<tr>
<td>
<div class="intro">
<h1>
Advanced Stuff
</h1>
</div>
</td>
<td class="navigation" rowspan="12">
<div>
<p class="intro"><strong class="heading">Navigation</strong>:<br/><br/>
<a href="../index.html">Home</a><br/>
<a href="news.html">IMCom News</a><br/>
<a href="whatis.html">What is IMCom</a><br/>
<a href="download.html">Download</a><br/>
<a href="commands.html">Commands</a><br/>
<a href="advanced.html">Advanced</a><br/>
<a href="CHANGELOG">ChangeLog</a><br/>
<a href="imcomrc.html">Example Config</a><br/>
<br/>
<a href="http://www.jabber.org/"><img src="jabberbutton.png" alt="Jabber Open IM"/></a>
</p>
</div>
</td>
</tr>
<tr>
<td>
<a name="international"/>
<div>
<h1>International Support</h1> <p>IMCom now handles
international characters from what I've been told. Simply
open your ~/.imcom/imcomrc file and add encoding tags to
your profile. Example:
<encoding>iso-8859-1</encoding>. Set it to
the appropriate encoding for your locale and it should, in
theory, be all happy.</p>
</div>
</td>
</tr>
<tr>
<td>
<a name="colors"/>
<div>
<h1>How to change you color settings</h1>
<p>
IMCom allows for customization of colors by editing
your configuration file. There are two distinct places
you can specify colors. If you place a <color>
block outside of a <profile> block then the
colors specified in that block are teh defaults for
all profiles. A <color> block inside a profile
will override the default colors.
</p>
<p>The following are the list of available colors</p>
<ul>
<li>black</li>
<li>white</li>
<li>darkgray</li>
<li>lightgray</li>
<li>red</li>
<li>brightred</li>
<li>green</li>
<li>brightgreen</li>
<li>blue</li>
<li>brightblue</li>
<li>purple</li>
<li>magenta</li>
<li>brown</li>
<li>yellow</li>
<li>cyan</li>
<li>brightcyan</li>
<li>clear (Can only be used as a background color)</li>
</ul>
<p>The follow is a list of element types that can be colors</p>
<ul>
<li><strong>background</strong> Used as the background color. If you want to use a white background set your terminal's background color to white and use the "clear" color as your background.</li>
<li><strong>default</strong> Used as the default color for all text.</li>
<li><strong>user</strong> Used as the color for displaying nicknames and jids.</li>
<li><strong>status</strong> Used as the color for displaying the status.</li>
<li><strong>desc</strong> Used as the color for various descriptions such as status-message.</li>
<li><strong>time</strong> Used as the color for all timestamps.</li>
<li><strong>sep</strong> Used as the color for separators.</li>
<li><strong>key</strong> Used as the color for dictionary keys and resources.</li>
<li><strong>messagebody</strong> Used as the color for the text in messages received.</li>
<li><strong>error</strong> Used as the color for all error message.</li>
</ul>
<div class="example">
<p>Here is an example color block, which may be placed either at the top level or inside a profile.</p>
<pre>
<color>
<background>black</background>
<default>white</default>
<user>brightgreen</user>
<status>yellow</status>
<messagebody>yellow</messagebody>
<time>brightcyan</time>
<desc>purple</desc>
<sep>brightblue</sep>
<key>brightcyan</key>
<error>brightred</error>
</color>
</pre>
<p>Here is another example color block that uses Black text on white background. It assumes you have your terminal configured for Black text on a White background.</p>
<pre>
<color>
<background>clear</background>
<default>black</default>
<user>blue</user>
<status>magenta</status>
<messagebody>brown</messagebody>
<time>blue</time>
<desc>purple</desc>
<sep>brightblue</sep>
<key>cyan</key>
<error>red</error>
</color>
</pre>
</div>
</div>
</td>
</tr>
<tr>
<td>
<a name="group"/>
<div>
<h1>What do you mean group support?</h1>
<div class="example">
<p>Each user can belong to zero or more groups. To show the groups a
particular person belongs to use the membership command.<br/>
Example:</p>
<pre> IMCom> /membership airog</pre>
<p class="noi">This would return the list of groups the user airog belongs to.</p>
</div>
<div class="example">
<p>To see which users belong to a particular group use the show command.<br/>
Example:</p>
<pre> IMCom> /show lurker</pre>
<p class="noi">This would return a list which looks very similar to the roster list except that it only shows users which are
members of the group lurker.</p>
</div>
<div class="example">
<p>To see a list of the groups that you have just use the show command
with no arguments.<br/>
Example:</p>
<pre> IMCom> /show</pre>
<p class="noi">This would return the list of groups currently in existance.</p>
</div>
<div class="example">
<p>Note that you never actually have to create a group. Simply adding a user to a non-existing group will create that group.</p>
</div>
<div class="example">
<p>There are currently two special groups: lurker and ignore. </p>
<br/>
<p>The lurker group is used for people who you want to have Nick<->JID matching on, but don't want to see status updates for or
even on your roster at all. For instance, I use the lurker group for people who I have on my list twice, once with their icq
user and once with their jabber user. I add their icq user to my lurker group so I never see it unless I really want to. I also
use it for people who I very rarely talk to. People who are a member of the lurker group will only ever show up if you use the
show command to show the members of group lurker. If a user (bob) belongs to both lurker group and school group, and you use the
show command to list the members of the school group bob will not appear in that list because he is a lurker. The only list a
lurker will show up in is the lurker list.</p>
<br/>
<p>The ignore group is used for people who you never want to see anything from.</p>
</div>
<div class="example">
<p>Summary:</p><br/>
<ul>
<li>To add a user to a group use the addgroup command. It will create the group if necessary.</li>
<li>To remove a user from a group use the delgroup command. It will remove the group if no users exist in the group anymore.</li>
<li>To set a user belonging to just one group use the setgroup command. It will create the group if necessary.</li>
</ul>
</div>
</div>
</td>
</tr>
<tr>
<td>
<a name="0t9"/>
<div>
<h1>$0 through $9</h1>
<p>The person who most recently evented you is stored in $0 through $9.
Events include messages, auth requests, file requests, basically everything
EXCEPT status changes.</p>
<br/>
<p>This is an advanced feature and not yet well tested at of version 0.62.
It is useful when random3409783408@jabber.org messages you because you
can then just</p>
<pre> IMCom> /info $0</pre>
<p class="noi">To get info on random3409783408@jabber.org.</p>
</div>
</td>
</tr>
<tr>
<td>
<a name="aliases"/>
<div>
<h1>Aliases</h1>
<p>This is another advanced feature that was requested. Basically aliases are textual-substitution commands. That is, you can
shorten one command line to a single command. For instance, say you are running on a unix system and want to bind the command
/cls to clear the screen. You could</p>
<pre> IMCom> /alias /clear ! clear</pre>
<p class="noi">Which would create the alias <em>/clear</em>, which would literally run <em>! clear</em></p>
<br/>
<div class="example">
<p>Let say I message user bob often. I could</p>
<pre> IMCom> /alias /bob /msg bob</pre>
<p class="noi">which would allow me to</p>
<pre> IMCom> /bob hi!</pre>
<p class="noi">Sending the message "hi!" to bob.</p>
</div>
<br/>
<div class="example">
<p>Summary:</p><br/>
<ul>
<li>To get a list of aliases use just /alias</li>
<li>To remove an alias use /unalias [alias-name] <br/>eg: /unalias /bob</li>
<li>To save aliases to your preferences issue a saveprefs command, which defaults to /saveprefs</li>
</ul>
</div>
</div>
</td>
</tr>
<tr>
<td>
<a name="modules"/>
<div>
<h1>Modules</h1>
<p>
This is another advanced feature that was
requested. Modules are a generic way of adding new user
interface features to IMCom. A module can register for
events and add commands to IMCom. In the modules
directory there are a few example modules. If you are
interested in extended the user interface of imcom to do
new things, take a look at the examplemodule. I'm
willing to help those who want to write modules figure
it out, just IM me or email me.
</p>
<p>
There are currently two working modules that ship with IMCom: awaylogmodule and conferencecolorsmodule.
</p>
<div>
<h2>awaylogmodule</h2>
<p>This module will record messages received while you are away and provide a command for you to play back the messages.</p>
<p>Load the module by typing <em>/loadmod awaylogmodule</em>. There is no configuration necessary. The command to display the queue of messages received is: /awaylog</p>
<p>If you want this module automatically loaded at IMCom startup /saveprefs after loading it during a session.</p>
</div>
<div>
<h2>conferencecolorsmodule</h2>
<p>This module changes the colors of conference messages so that it is easy to distinguish between conference messages and normal messages.</p>
<p>Load the module by typeing <em>/loadmod conferencecolorsmodule</em>. You can configure the colors it uses by typing <em>/configmod conferencecolorsmodule</em>. This will bring you through an interactive configuration of the module.</p>
<p>If you want this module automatically loaded at IMCom startup /saveprefs after loading it during a session.</p>
</div>
</div>
</td>
</tr>
<tr>
<td>
<a name="tipsandtricks"/>
<div>
<h1>Tips and Tricks</h1>
<p>
There are a few random little tricks in IMCom that don't seem to have a home in the documentation. This is the spot for them.
</p>
<ul>
<li>
When you have readline support hitting [Tab] on a
empty line will prefill with "/msg
last-person-you-messaged ". This is similar to the //
command.
</li>
<li>
Similarly if you hit [Space] then [Tab] IMCom will
prefill with "/msg last-person-who-messaged-you
". This is similar to the /r command, but safer.
</li>
<li>
There are two special groups: lurker and ignore. The
ignore group does what you think it does. The lurker
group is for people whom you never want to see in your
roster list, but want a jid<-> mapping. See the
<a href="#group">groups section</a> for more details
</li>
<li>
You can customize commands by editing your
~/.imcom/imcomrc file. First thing to do is issue a
/saveprefs from within imcom. This will output a
complete config file. Then open up the
~/.imcom/imcomrc file with a text editor capable of
reading and writing with UTF8 encoding. You'll see two
giant command blocks. The block outside the profile
tag applies to all profiles. The block inside your
profile applies to only your profile overrides the
block outside. Just find the command you want to
modify by searching for it. Change it to whatever you
want. Remember that XML encodings apply to the
following special characters: < > " ' &.
</li>
</ul>
</div>
</td>
</tr>
</table>
</body>
</html>
