tdeutils/doc/ktimer/index.docbook

<?xml version="1.0" ?>
<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
  <!ENTITY kappname "&ktimer;">
  <!ENTITY package "tdeutils">
  <!ENTITY Stefan.Schimanski "<personname><firstname>Stefan</firstname><surname>Schimanski</surname></personname>">
  <!ENTITY A.L.Spehr "<personname><firstname>A. L.</firstname><surname>Spehr</surname></personname>">
  <!ENTITY % English "INCLUDE">
  <!ENTITY % addindex "IGNORE">
]>

<article lang="&language;">
<title>The &ktimer; Handbook</title>

<articleinfo>

<authorgroup>
<author><firstname>A. L.</firstname><surname>Spehr</surname></author>
<author>&tde-authors;</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>

<releaseinfo>&tde-release-version;</releaseinfo>
<date>Reviewed: &tde-release-date;</date>

<copyright>
<year>2010</year>
<holder>A. L. Spehr</holder>
</copyright>
<copyright>
<year>&tde-copyright-date;</year>
<holder>&tde-team;</holder>
</copyright>

<!-- <legalnotice>&FDLNotice;</legalnotice> -->

<abstract>
<para>
&ktimer; is a simple countdown timer.
</para>
</abstract>

<keywordset>
<keyword>TDE</keyword>
<keyword>tdeutils</keyword>
<keyword>ktimer</keyword>
</keywordset>

</articleinfo>

<sect1 id="introduction">
<title>Introduction</title>
<para>&ktimer; allows you to enter several tasks and to set a timer for each of them.
When the timer reaches zero, the task is executed. The timers for each task can be started,
stopped, changed, or looped.</para> 

</sect1>

<sect1 id="using-ktimer">
<title>Using &ktimer;</title>

<screenshot>
<screeninfo>Here's a screenshot of &ktimer; when you start it for the first
time</screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="main.png" format="PNG"/>
    </imageobject>
      <textobject>
      <phrase>&ktimer; main window</phrase>
    </textobject>
  </mediaobject>
</screenshot>

<para>To start, first add a task by selecting <guibutton>New</guibutton>. Then type the
command you wish to execute into the <guilabel>Command line:</guilabel> box. You can then
adjust the settings, or start the timer countdown. When the time is up, the command
will be run.</para>

<screenshot>
<screeninfo>Here's a screenshot of &ktimer; after you have told it to run &konqueror;.</screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="first.png" format="PNG"/>
    </imageobject>
      <textobject>
      <phrase>add a task</phrase>
    </textobject>
  </mediaobject>
</screenshot>

<para>Let's use &konqueror; as an example. By default, &konqueror; will start in 100 seconds
after the timer countdown is started.</para>

<screenshot>
<screeninfo>Here it is counting down: in 56 seconds &konqueror; will be run.</screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="running.png" format="PNG"/>
    </imageobject>
      <textobject>
      <phrase>56 seconds to go</phrase>
    </textobject>
  </mediaobject>
</screenshot>

<para>Now let's start the task. Here it has been running for a bit and is partway through the
countdown. In 56 seconds, &konqueror; will be started.</para>

<para>See that sliding bar? You can use it to quickly increase or decrease the amount of time
on a task.</para>

<screenshot>
<screeninfo>Let's add a second task.</screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="two_at_once.png" format="PNG"/>
    </imageobject>
      <textobject>
      <phrase>start another &konqueror;, you can never have too many!</phrase>
    </textobject>
  </mediaobject>
</screenshot>

<para>Now two &konqueror;s are scheduled to be run. The top one will be run in 20 seconds,
and the bottom one is currently stopped. You can add more commands. While you can never have
too many &konqueror;s, you probably want to use other executables. Your own shell script, perhaps.</para>

</sect1>

<sect1 id="settings">
<title>Settings</title>
<para>

<variablelist>
  <varlistentry>
    <term><guibutton>New</guibutton></term>
    <listitem><para><action>Adds a new task.</action></para></listitem>
    </varlistentry>

    <varlistentry>
    <term><guibutton>Remove</guibutton></term>
    <listitem><para><action>Removes the current task.</action></para></listitem>
    </varlistentry>
 
    <varlistentry>
    <term><guibutton>Help</guibutton></term>
    <listitem><para><action>Opens the Handbook.</action></para></listitem>
    </varlistentry>
</variablelist>

</para>

</sect1>

<sect1 id="credits">
<title>Credits and License</title>

<para>
&ktimer;
</para>

<!--List all the copyright holders here-->
<para>Program Copyright 2001 &Stefan.Schimanski;</para>

<para>Documentation Copyright 2008 &A.L.Spehr;</para>

<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
&underFDL;               <!-- FDL: do not remove -->
&underGPL;           <!-- GPL License -->

</sect1>

</article>