# The &korn; Documentation

Nick
Betcher

    nbetcher@uswest.net

Sirtaj
Kang

    taj@kde.org

Developer
Cristian
Tibirna

    tibirna@kde.org

Developer
Kurt
Granroth

    granroth@kde.org

Developer
Rik
Hemsley

    rik@kde.org

Developer
Lauri
Watts

    lauri@kde.org

Reviewer
2002-02-05
0.03.00
2000
Nick Betcher
&FDLNotice;

This Documentation describes &korn; Version 0.0.1

KDE
KOrn
File searching

## Introduction

&korn; is a KDE Mail Checker that has the capabilities to dock itself to Kicker. &korn; can check the following types of mailboxes:

- mbox type (i.e.:`/var/spool/mail/root`)

- qmail

- POP3

- Imap4

- nntp

- and the ability to check on a process

&korn;, checks your mail on an interval that is user specified for each separate account. Once mail is received you can have &korn; run a 3rd party program of your wishes or change the color/icon of &korn; while docked in &kicker;. In addition to this you can have &korn; run a program once you click on the docked icon in &kicker;.

The rest of this chapter relies on the user to &RMB; click on the &korn; icon in the &kicker; panel to access the appropriate menus.

## The Preferences Dialog

### The buttons

The Preferences window is the most powerful part of &korn;. At a first glimpse you may underestimate its capabilities, but further under-the-hood you will find many ways to use &korn;.

The first tab lists your current mailboxes. As default &korn; installs Inbox as the default mailbox. The default Inbox may not fit most users needs. With this default mailbox in place &korn; will check the path `/var/spool/mail/user` for new mail.

The New... button will be covered in the next section. Please jump ahead if that is the section you need assistance with.

If you would like to remove the selected mailbox, click the Remove button on the right. You can also copy the selected mailbox if you don't wish to create two similar mailboxes twice.

Finally, after you have created a mailbox (see the next section), you can modify it by selecting the mailbox you wish to edit and then clicking Modify.... This dialog contains the same options as when you click New....

### The Display Tab

The display tab contains the options to change where &korn; will show itself.

The first option, Horizontal, will create a window and the contents of the window will contain the options you specified in the View tab (which you can get to by selecting your mailbox and clicking Modify...). On the other hand, selecting Docked will dock &korn; into the &kicker; panel.

The option Vertical is not yet implemented.

### The New... Dialog

The New... button will load a window showing you what mailboxes can be created for checking on a interval. Select your appropriate mailbox type. If you don't know what type you should use, and you currently use Netscape to check your mail, use POP3.

Following that window the modify options appear, allowing you to change all aspects of the mail checking, including interval.

Each mailbox type (&ie;: Pop3, nntp, imap) has different server options, but the rest of the options (including Poll, Commands, and View) are the same (excluding mailbox type process). In these server options dialogs you need to enter the appropriate information to fit your situation. Keep in mind the default ports that are entered some of the server options tabs are the normal ones used by the majority of the Internet.

The commands Poll tab contains one option that changes the time interval between each check. Keep in mind this is in seconds, not minutes.

Next, the view tab has options for changing the icon or icon color while &korn; is docked in &kicker;. There are two options: Use color or Use icon. Selecting Use color will allow you to modify the colors. Selecting Use icon will allow you to change which icon is used for both Normal and New mail. Keep in mind that &korn; can only use a icon or color, not both.

In the commands tab you can specify a command to be run once you receive new mail in the New mail line. Also, the Click line can contain a command to be run when you left click on &korn;.

## Credits and License

&korn;. Program copyright 2000:

- Sirtaj Singh Kang taj@kde.org

- Cristian Tibirna tibirna@kde.org

- Kurt Granoth granroth@kde.org

- Rik Hemsley rik@kde.org

Documentation copyright 2000 Nick Betcher nbetcher@uswest.net

We hope this documentation helped you. If you need to contact me, the document writer, you can at nbetcher@uswest.net. If you wish to contact the developers of &korn;, you can find their names in the About Korn... option or above.

&underFDL; &underGPL;