<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.1.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
  <!ENTITY kappname "&kit;">
  <!ENTITY AOL "<acronym><trademark class='registered'>AOL</trademark></acronym>">
  <!ENTITY package "kdenetwork">
  <!ENTITY % addindex "IGNORE">
  <!ENTITY % English "INCLUDE">
]>

<book lang="&language;">

<bookinfo>
<title>The &kit; Handbook</title>

<authorgroup>

<othercredit role="developer">
<firstname>Neil</firstname>
<surname>Stevens</surname>
<affiliation>
<address><email>neil@qualityassistant.com</email></address>
</affiliation>
</othercredit>

<author>
<firstname></firstname>
<othername></othername>
<surname></surname>
<affiliation>
<address><email></email></address>
</affiliation>
</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>

<copyright>
<year>1999</year>
<year>2000</year>
<year>2001</year>
<year>2002</year>
<holder>Neil Stevens</holder>
</copyright>

<legalnotice>&FDLNotice;</legalnotice>


<date>2002-04-08</date>
<releaseinfo>1.30.00</releaseinfo>

<abstract>
<para>
&kit; is an &AOL; chat program for &kde;.
</para>
</abstract>

<keywordset>
<keyword>KDE</keyword>
<keyword>kdenetwork</keyword>
<keyword>Kit</keyword>
<keyword>chat</keyword>
<keyword>IM</keyword>
<keyword>AIM</keyword>
</keywordset>

</bookinfo>

<chapter id="introduction"> 
<title>Introduction</title> <para>
The documentation for &kit; was incomplete when &kde; was installed on
this computer.</para> <para>If you need help, please check <ulink
url="http://www.kde.org">The &kde; Website</ulink> for updates, or by
submitting your question to <ulink url="mailto:kde-user@kde.org">The
&kde; User Mailing list</ulink>.</para> <para><emphasis>The &kde;
Team</emphasis></para>

</chapter>

<chapter id="first-run">
<title>Initial Configuration</title>

<para>When you first start &kit;, you will be asked to configure some
basic preferences.  A dialog will ask you <computeroutput>Would you like to
create a profile?</computeroutput>, to which you can answer
<guibutton>Yes</guibutton> or <guibutton>No</guibutton>.  Let us
assume you answer yes to this question.</para>

<para>The next question you are asked is <computeroutput>Would you
like to go to &AOL; and create a new account?</computeroutput>.  If you
already have an &AOL; Instant Messenger (<acronym>AIM</acronym>)
account, you should press the <guibutton>No</guibutton> button.</para>

<!-- More needs to be written here -->

</chapter>

<chapter id="preferences">
<title>Preferences</title>

<para>About the Preferences dialog</para>

<sect1 id="user-information">
<title>User Information</title>

<para>Here you can add your password, and customize how you appear to
other users.</para>

<variablelist>
<varlistentry>
<term><guilabel>Screen Name</guilabel></term>
<listitem>
<para>Here you can enter your screen name or nickname.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><guilabel>Password</guilabel></term>
<listitem>
<para>Enter your password here.  &kit; needs this to connect to the
server.  The password is not echoed as you type it, and is not visible
afterwards.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><guilabel>Save Password</guilabel></term>
<listitem>
<para>If you enable this option, &kit; will remember your password for
you between sessions, so you don't have to type it.  Your password is
not saved anywhere in a human readable form, however saving passwords
is always at your discretion.  If you are using a publicly accessible
computer, or you share your user account with another family member,
you probably should not save the password.</para>
<para>If you disable this option, &kit; will ask you for the password
any time it is needed, for example when connecting to the
server.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><guilabel>User Information</guilabel></term>
<listitem>
<para>Here you can enter any information you want people to see when
they look you up in the buddy list. <!-- Since I can't connect, I'm -->
<!-- not sure of the precise guilabel on the looking up bit 

The context menu for a buddy is:

Set nickname...
-
Open Chat...
Information
Directory (which never works anymore)
-
Delete Buddy...
-
Add Group...

Context menu for a group is:

Add Buddy...
-
Add Group...

Context menu for empty space is

Add Group...

-->
</para></listitem>
</varlistentry>
</variablelist>

</sect1>

<sect1 id="buddy-lists">
<title>Buddy Lists</title>

<para><quote>Buddies</quote> are people you talk to on &AOL;.  You
probably want &kit; to keep a watch for these people, so you know when
they are connected, and can send a message to them.</para>

<para>You can also set up groups, for example <quote>Work</quote>
buddies and <quote>Home</quote> buddies. All buddies must be in a
group, and every group must have one item at least.  When you create a
group it'll prompt you for a buddy to add to it. 
</para>

<para>Choose the <guibutton>Add</guibutton> and type the name of the
group you are setting up into the dialog box that appears.  You can
press <guibutton>Clear</guibutton> to start over in the dialog,
<guibutton>Cancel</guibutton> if you change your mind about adding a
group and wish to exit, or more likely, <guibutton>OK</guibutton> to
close the dialog and add your group.</para>

<para>If you want to remove a group, select it in the list, and press
<guibutton>Remove</guibutton>.  You can change the name of the group
with <guibutton>Rename</guibutton>.</para>

<para>Once you have a group, you need to populate it with buddies.
This works in the same way as adding groups.</para>

<para>Select the group you wish to add a buddy to in the
<guilabel>Groups</guilabel> list, and press the
<guibutton>Add</guibutton> button in the <guilabel>Group
Members</guilabel> list.  Type in the name of the buddy you wish to
add in the resulting dialog.  Again you can
<guibutton>Clear</guibutton>, <guibutton>Cancel</guibutton> or accept
(with <guibutton>OK</guibutton> your change.)</para>

</sect1>

<sect1 id="permissions">
<title>Permissions</title>

<para>It is a fact of life on the Internet that not everyone is worth
talking to.  In this page you can set up lists of who has permission
to talk to you, and who does not.</para>

<para>The default setting is to allow any incoming conversations, with
<guilabel>Permit All</guilabel> selected.  You could also choose to
disallow anyone from starting a conversation with you, by selecting
<guilabel>Deny All</guilabel>.  In this case, you will have to
initiate all conversations.</para>

<para>A slightly less tough setting is to <guibutton>Add</guibutton>
people you don't mind talking with to your <guilabel>Permit
List</guilabel>, and select <guilabel>Use Permit
List</guilabel>.  In this case, anyone in the list will be able to
chat with you, but others will not.</para>

<para>An even more permissive choice is to <guibutton>Add</guibutton>
people who you definitely don't want to talk with to your
<guilabel>Deny List</guilabel>, and choose <guilabel>Use Deny
List</guilabel>.  In this case, anyone will be able to chat with you
except for the people specifically added to the list.  This is a good
setting if you are being bothered by someone, you simply won't see
their attempts to talk anymore.  It is the equivalent of a kill-file on
Usenet, or <command>ignore</command> on <acronym>IRC</acronym>.</para>

<para>Whichever you choose, you can <guibutton>Add</guibutton> and
<guibutton>Remove</guibutton> nicknames from your lists at any
time.</para>
</sect1>

<sect1 id="away-messages">
<title>Away Messages</title>

<para>If someone tries to talk to you, or looks up your information,
and you have set yourself <guimenuitem>Away</guimenuitem>, they will
see a short message.  You can use this, for example, to let others
know when you intend to be back, or alternate means of contacting you
urgently</para>

<para>You can have several messages preconfigured.  You might for
example set up a message with the <guilabel>Name</guilabel>
<quote>Lunch</quote> containing the text <quote>Out for lunch, back at
1 PM CST</quote>, and another message named <quote>Bed</quote> that
says <quote>It's late, I'm going to bed now, see you
tomorrow</quote>.</para>

<para>To add the <quote>Lunch</quote> message above, you would press
<guibutton>Add</guibutton> and type <userinput>Lunch</userinput> in
the dialog, then <guibutton>OK</guibutton> to save it.  Now you can
select <guilabel>Lunch</guilabel> in the <guilabel>Name</guilabel>
list, and type your text in the <guilabel>Message</guilabel>
field.</para>

<para>You can rename messages with the <guibutton>Rename</guibutton>
button and remove them with the <guibutton>Remove</guibutton>
button.</para>

<para>Now when you set yourself away, you can choose one of your
preconfigured messages, instead of having to type the reason every
time.</para>

</sect1>

<sect1 id="main-window">
<title>Main Window</title>

<para>This is where you can customize the behavior of the main window,
where you have your buddy list.</para>

<para>You can choose which of the available columns of information to
display from these:</para>

<variablelist>
<varlistentry>
<term><guilabel>Idle Time</guilabel></term>
<listitem>
<para>The time since this person last sent a message (to anyone).
This may be an indication that they are not at their computer, or not
watching.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><guilabel>User Class</guilabel></term>
<listitem>
<para>There are four classes of user that could be displayed here:
<simplelist>
<member>&AOL; User</member>
<member>Trial <acronym>AIM</acronym> User</member>
<member>Registered <acronym>AIM</acronym> User</member>
<member>Admin</member>
</simplelist>
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><guilabel>Warning Level</guilabel></term>
<listitem>
<para>It's a percentage.  If someone send you a message and you want
them to stop, you can warn them.  The more someone gets warned the
higher the level is. High levels prevent people from talking as much.
Warning level goes down over time.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><guilabel>Signon Time</guilabel></term>
<listitem>
<para>The time this person connected to the network.</para></listitem>
</varlistentry>

<varlistentry>
<term><guilabel>Nickname</guilabel></term>
<listitem>
<para>If you see only a number in the buddy list window, enable this,
in order to be able to add a nickname.</para>
</listitem>
</varlistentry>
</variablelist>

<para>Next you can choose how your buddies are grouped, in the
<guilabel>Show Buddies by</guilabel> section.  The choices are to
display them based on their <guilabel>Group</guilabel> so all members
of a group are shown together, or to display them based on
<guilabel>Status</guilabel>, so all people who are set away are
together, all those online are together, &etc;.</para>

</sect1>

<sect1 id="chat-windows">
<title>Chat Windows</title>

<para>On this page you can customize how chat windows behave.</para>

<para>The first option is if you wish to <guilabel>Log
Chats</guilabel> or not.  If you enable this, a record of your
conversation is saved to a file on your hard drive.  This is
common practice, and very useful for some conversations, for example,
if you are looking up a friendly &kde; developer to ask a question,
you might want to record their advice.  It is less useful, and
potentially embarrassing, for personal conversations, so use with
discretion, especially if other people have access to your
computer.  If enabled, logs are saved to
<filename>$<envar>KDEHOME</envar>/share/apps/Kit/<replaceable>your
screen name</replaceable>/<replaceable>buddy's screen name in
lowercase</replaceable>>.html</filename>
</para>

<para>You can also choose whether or not a time is printed next to
each message, with the <guilabel>Timestamp Chats</guilabel> option.
This is normally very useful, and is on by default.  With this option
enabled, you can see what time someone left you a message, or tried to
open a conversation with you, if you weren't at your computer at the
time.</para>

<para>Normally, &kit;, like other &AOL; messaging clients, uses
<acronym>HTML</acronym> to format the messages.  If you are connecting
to a non-&AOL; server (for example, <application>ICQ</application>)
this is very annoying, since those clients will show the raw
<acronym>HTML</acronym> instead of formatting the text with it.  If
you have complaints that people you are chatting with are getting
garbage in their clients, you an enable this option, and turn off the
<acronym>HTML</acronym>.</para>

<para>Finally, you can customize the formatting of your own messages.
Used in moderation, this can be fun, but do remember that not everyone
has your taste in colors, and cyan text on a blue background is
probably not a good idea.  Just press the colored button next to the
<guilabel>Text Color</guilabel> or <guilabel>Background
Color</guilabel> labels to change the color of the text and
backgrounds respectively.  You can also make the text
<guilabel>Bold</guilabel></para>

</sect1>

<sect1 id="network">
<title>Network</title>

<para>On this page you can customize how &kit; connects to the
server.</para>

<variablelist>
<varlistentry>
<term><guilabel>Keep Connection Alive</guilabel></term>
<listitem>
<para><action>Send a packet now and then to the server, to keep the
connection active.</action>  Sometimes if you don't do this, the
connection will close. If you find yourself being disconnected on a
regular basis, try enabling this option.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><guilabel>Automatically Connect on Startup</guilabel></term>
<listitem>
<para><action>Connect to the server immediately</action> when &kit; is
started.  You may want to disable this option if you are not
permanently connected to the Internet.  Then you can start &kit;
automatically with &kde;, without it trying to connect.  If you have a
permanent connection, you probably will have this option enabled.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><guilabel>Specify custom server, rather than default (AOL)
server</guilabel></term>
<listitem>
<para>&kit; may be able to connect to other networks than &AOL;, if
they use <acronym>TOC</acronym> as their protocol.  In the past it was
possible to use &kit; to connect to <application>ICQ</application> for
example.  
<!-- FIXME: check, this isn't working right now, it might -->
<!-- again at some point.

It seems really variable.

-->
The default is to leave this option disabled, and connect directly to
&AOL;</para>
</listitem>
</varlistentry>

<varlistentry>
<term><guilabel>TOC Server and port</guilabel></term>
<listitem>
<para>If you have selected to specify a custom server, enter its
address (as an <acronym>IP</acronym> number, or hostname) into the
first field, and the port to connect to into the second.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><guilabel>Authorization server</guilabel></term>
<listitem>
<para>If you have selected to specify a custom server, enter the
address of the authorization server to use into the first field, and
the port to connect to into the second.</para>
</listitem>
</varlistentry>
</variablelist>

</sect1>

</chapter>

<chapter id="profiles">
<title>Profiles</title>

<para>About profiles</para>

</chapter>

<chapter id="menu-reference">
<title>Menu Reference</title>

<sect1 id="file-menu">
<title>The <guimenu>File</guimenu> Menu</title>

<variablelist>
<varlistentry>
<term>
<menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Online</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Connect to the network and mark yourself as
online</action> (available to chat.)</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Away...</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Mark yourself as away</action> (not available to chat.)</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Offline</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Disconnect from the network</action>.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Open Chat</guimenuitem>
</menuchoice></term>
<listitem>
<para>
<action>Open a chat window with a person on your buddy
list.</action></para>
</listitem>
</varlistentry>

<varlistentry>
<term><menuchoice><guimenu>File</guimenu>
<guimenuitem>Change Password...</guimenuitem>
</menuchoice></term>
<listitem>
<para><action>Change your password for this service, on the
server.</action></para>
</listitem>
</varlistentry>

<varlistentry>
<term><menuchoice><guimenu>File</guimenu>
<guimenuitem>Search Directory</guimenuitem>
</menuchoice></term>
<listitem>
<para><action>Search the directory for a friend.</action></para>
</listitem>
</varlistentry>

<varlistentry>
<term><menuchoice><guimenu>File</guimenu>
<guimenuitem>Exit</guimenuitem>
</menuchoice></term>
<listitem>
<para><action>Exit</action> &kit;</para>
</listitem>
</varlistentry>
</variablelist>

</sect1>

<sect1 id="settings">
<title>The <guimenu>Settings</guimenu> Menu</title>

<variablelist>
<varlistentry>
<term>
<menuchoice><guimenu>Settings</guimenu>
<guimenuitem>Preferences...</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Open the preferences dialog</action> where you can
configure &kit;. See the <link
linkend="preferences">Preferences</link> section for more information.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><menuchoice><guimenu>Settings</guimenu>
<guimenuitem>Profiles...</guimenuitem>
</menuchoice></term>
<listitem>
<para><action>Opens the profiles dialog</action> where you may choose
another profile to log in with.  See the <link
linkend="profiles">Profiles</link> section for more
information.</para>
</listitem>
</varlistentry>
</variablelist>

</sect1>

<sect1 id="help-menu">
<title>The <guimenu>Help</guimenu> Menu</title>

&help.menu.documentation;
<!-- FIXME: Kit has no what's this help, we should add some. -->

</sect1>

</chapter>

<chapter id="credits-and-licenses">
<title>Credits and Licenses</title>

<para>&kit; copyright 1999-2002 Neil Stevens
<email>neil@qualityassistant.com</email>.</para>

<itemizedlist>
<title>Contributors</title>
<listitem><para>Benjamin Meyer - Password Changing</para></listitem>
</itemizedlist>

<para>Documentation copyright 2002, Lauri Watts</para>

<!-- TRANS:CREDIT_FOR_TRANSLATORS -->

&underGPL;
&underFDL;

</chapter>

<appendix id="installation">
<title>Installation</title>

&install.intro.documentation;

<para>&kit; is also available from its own homepage, <ulink
url="http://kitclient.sourceforge.net">http://kitclient.sourceforge.net</ulink>.</para>

&install.compile.documentation;

</appendix>

&documentation.index; 
</book>

<!--
Local Variables:
mode: sgml
sgml-minimize-attributes:nil
sgml-general-insert-case:lower
sgml-indent-step:0
sgml-indent-data:nil
End:

// vim:ts=2:sw=2:tw=78:noet
-->
