# The &kteatime; Handbook

## Introduction

### What's &kteatime;?

&kteatime; is a handy timer for steeping tea. No longer will you have to guess at how long it takes for your tea to be ready. Simply select the type of tea you have, and it will alert you when the tea is ready to drink.

## How to Use &kteatime;

When you start up &kteatime;, it will automatically dock itself in your panel. To access the menu, right click on the docked icon. This will present a list of options which are covered in more detail in the next chapter.

### Timing Your Tea

Upon starting, the panel icon will be that of a tea mug. If you click on the mug, a tea bag will appear in it. After the specified amount of seconds, the tea will be finished, and the icon will reflect this by transforming into a steaming mug of tea. At this point, the timer can be reset by clicking on the icon again.

the timer should only be reset by those who really enjoy tea.

## Menu Options

The following section describes the menu options that are available in KTeaTime.

### Select Your Tea

At the top of the menu are four options. Here, you can select what kind of tea you are preparing to drink. Three of the options are: Black Tea, Earl Grey, and Fruit Tea. These teas are preconfigured with a default time. Many people have complained that the times are not correct. Please be aware that the amount of time it takes to steep a cup of tea is based on personal preference. The times chosen are approximations. If you read on, you will learn how to set your own time. Once a custom time is defined, Other Tea can be used to select it.

### Start

This option will start the tea timer. As confirmation that you have indeed selected Start, the panel icon will change into a mug with a teabag in it.

### Configure

This option opens up the configuration dialog box. A screenshot is shown below:

The &kteatime; configuration dialog box. The &kteatime; configuration dialog box.

As shown in the picture, you may enter a customized tea time in the first text box. This is useful if you are brewing a cup of tea that is not on the list, or if you do not agree with the default times.

The second text box is the Action field. This contains an action that will be executed when the time is up. Any valid system command can be entered into this box. Probably, you will want to leave it blank.

The two checkboxes at the bottom are built-in actions that will be executed when the time is up. If Beep is selected, the system alarm will sound. If Popup is selected, a popup dialog box will appear alerting you to the fact that your tea is now ready.

## Credits

&kteatime; Copyright 1998-1999 by Matthias Hoelzer-Kluepfel hoelzer@kde.org

Documentation by Michael Korman michael.korman@uconn.edu

&underFDL; &underGPL;

## Installation

### How to obtain &kteatime;

&install.intro.documentation;

### Compilation and Installation

&install.compile.documentation;

By default, &kteatime; will install itself in the Toys subfolder of your K menu.

&documentation.index;