<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook V3.1-Based Variant V1.0//EN" [
 <!ENTITY korn "<application>korn</application>">
]>
<book lang="en">
<bookinfo>
<title>The KOrn Handbook</title>
<authorgroup>
<author>
<surname>Sirtaj Singh Kang, </surname>
<affiliation>
<address><email><ulink url="mailto:taj@kde.org">taj@kde.org</ulink></email></address>
</affiliation>
</author>
</authorgroup>
<date>Version 0.3, 14 September 1998</date>
<releaseinfo><!-- information about this particular version --></releaseinfo>
<abstract>
<para>This documentation was last updated for KOrn version 0.3. Please make any comments and additions to the author.</para>
<para>The KOrn Handbook</para><!-- Merge this with the previous paragraph; it comes from <META NAME="description" CONTENT="..."> --></abstract>
<keywordset>
<keyword>KDE</keyword>
<keyword>KOrn</keyword>
<keyword>e-mail</keyword>
<keyword>notification</keyword>
</keywordset>
</bookinfo>

<chapter id="introduction">
<title>Introduction</title>

<sect1 id="whatiskorn">
<title>What is KOrn?</title>

<para>KOrn is a <ulink url="http://www.kde.org/">KDE</ulink>-compliant X11 program that
monitors UNIX mailbox files for incoming and unread messsages. It periodically
scans each mailbox and displays the number of unread messages it contains in a
small on-screen button. Features include:</para>

<para><itemizedlist>
<listitem>
<para>Per-box scan frequency (poll time)</para>
</listitem>
<listitem>
<para>Horizontal or vertical layout of buttons</para>
</listitem>
<listitem>
<para>Per-box customization of commands to be executed on new mail notification and button click</para>
</listitem>
<listitem>
<para>Fairly simple dialog for setup and customization </para>
</listitem>
<listitem>
<para>Doesn't use Xt/Xaw :-)</para>
</listitem>
</itemizedlist>
</para>
</sect1>

<sect1 id="whyisitnamedkorn">
<title>Why is it named "KOrn"?</title>

<para>For those who asked, it is named KOrn because:</para>

<para><itemizedlist>
<listitem>
<para><literal remap="tt">1.</literal> it begins with K</para>
</listitem>
<listitem>
<para><literal remap="tt">2.</literal> there are too many KDE programs with serious-sounding functional names</para>
</listitem>
<listitem>
<para><literal remap="tt">3.</literal> I attended a fabulous <ulink url="http://www.korn.com/">KoRn</ulink> concert around the time 0.1 was written.</para>
</listitem>
</itemizedlist>
</para>
</sect1>

<sect1 id="forwhomiskornwritten">
<title>For whom is KOrn written?</title>

<para>People who are subscribed to several internet mailing lists and/or filter received email messages into
separate folders (with <emphasis>procmail</emphasis>, for example). No need to run 10 xbiffs or qbiffs... just run one
KOrn.</para>
</sect1>
</chapter>

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

<sect1 id="howtoobtainkorn">
<title>How to obtain KOrn</title>

<para>The latest version of KOrn is <emphasis>0.3</emphasis>. It can be fetched from</para>

<para><itemizedlist>
<listitem>
<para>The KDE FTP Site and mirrors, in <ulink url="ftp://ftp.kde.org/pub/kde/unstable/apps/network/">ftp://ftp.kde.org/pub/kde/unstable/apps/network/</ulink>.</para>
</listitem>
<listitem>
<para>From the author's FTP repository, at <ulink url="ftp://ftp.ph.unimelb.edu.au/pub/users/taj/kde/">ftp://ftp.ph.unimelb.edu.au/pub/users/taj/kde/</ulink>.</para>
</listitem>
</itemizedlist>
</para>
</sect1>

<sect1 id="requirements">
<title>Requirements</title>

<para>You will also require a computer running X11, UNIX and the
<ulink url="http://www.kde.org/">K Desktop Environment</ulink>
and <ulink url="http://www.troll.no/">Qt</ulink> libraries. So far it has only been tested on
Linux/x86 with XFree86, and MkLinux/PPC with X11R6.</para>
</sect1>

<sect1 id="compilationandinstallation">
<title>Compilation and installation</title>

<para>Compiling and installing instructions are generic to the KDE.</para>
</sect1>
</chapter>

<chapter id="fundamentals">
<title>Fundamentals</title>

<sect1 id="howdoisetupkorn">
<title>How do I set up KOrn?</title>

<para>To configure KOrn to your taste once it is installed, simply run KOrn (or type &quot;korn&quot; at the UNIX
command line). You will be lead through a (hopefully) simple installation procedure. Here are the
explanations for the various options you can set:</para>

<para><itemizedlist>
<listitem>
<para><literal remap="tt">Name</literal> A short <emphasis remap="bf">unique</emphasis> reference name for the box. Do not put commas in this name.</para>
</listitem>
<listitem>
<para><literal remap="tt">Caption</literal> The message to be displayed in the tooltip for the box.</para>
</listitem>
<listitem>
<para><literal remap="tt">Path</literal> The pathname of the mailbox to monitor</para>
</listitem>
<listitem>
<para><literal remap="tt">Poll time</literal> The interval, in seconds, between scans of this box.
It is not wise to make this value much smaller than 20 seconds, since smaller intervals
mean higher CPU usage.</para>
</listitem>
<listitem>
<para><literal remap="tt">Notify Command</literal> The shell command to be executed when new mail is received in this box.
This is useful for playing sounds, for example.</para>
</listitem>
<listitem>
<para><literal remap="tt">Click Command</literal> The shell command to be executed when the button for the box is
double clicked
or left-clicked when there is new mail</para>
</listitem>
</itemizedlist>
</para>
</sect1>

<sect1 id="command-lineoptions">
<title>Command-line options</title>

<para><itemizedlist>
<listitem>
<para><literal remap="tt">--nomouse</literal> If KOrn is executed with this option, it will ignore all mouse events.
This is useful for running KOrn swallowed by KPanel or FVWM.</para>
</listitem>
</itemizedlist>
</para>
</sect1>
</chapter>

<chapter id="knownbugsandlimitations">
<title>Known bugs and limitations</title>

<para><itemizedlist>
<listitem>
<para>Old boxes are not removed from the configuration file when they are renamed.
A duplicate box entry is created with the new name.
This cannot be fixed till a method to remove groups in the KDE <emphasis>KConfig</emphasis> class.</para>
</listitem>
<listitem>
<para>Needs to restart completely to reload new configuration.</para>
</listitem>
<listitem>
<para>Lots of others.</para>
</listitem>
</itemizedlist>
</para>
</chapter>

<chapter id="epilogue">
<title>Epilogue</title>

<sect1 id="developers">
<title>Developers</title>

<para><literal remap="tt"><ulink url="mailto:taj@kde.org">Sirtaj Singh Kang</ulink> - Author, maintainer
<ulink url="http://www.ph.unimelb.edu.au/~ssk/">(Home page)</ulink></literal></para>
</sect1>

<sect1 id="authors">
<title>Authors</title>

<para><literal remap="tt"><ulink url="mailto:taj@kde.org">Sirtaj Singh Kang</ulink> - Redactor</literal></para>

<para><literal remap="tt"><ulink url="mailto:ebisch@cybercable.tm.fr">Eric Bischoff</ulink> - Editor</literal></para>
</sect1>
</chapter>
</book>
<!--
Local Variables:
mode: sgml
sgml-omittag: nil
sgml-shorttag: t
End:
-->