diff --git a/doc/ktimer/first.png b/doc/ktimer/first.png new file mode 100644 index 0000000..6fba62e Binary files /dev/null and b/doc/ktimer/first.png differ diff --git a/doc/ktimer/index.docbook b/doc/ktimer/index.docbook index bd96f68..5e10747 100644 --- a/doc/ktimer/index.docbook +++ b/doc/ktimer/index.docbook @@ -2,6 +2,8 @@ + StefanSchimanski"> + A. L.Spehr"> ]> @@ -10,9 +12,9 @@ The &ktimer; Handbook -The &ktimer; Handbook +A. L.Spehr &tde-authors; @@ -20,6 +22,10 @@ &tde-release-version; Reviewed: &tde-release-date; + +2010 +A. L. Spehr + &tde-copyright-date; &tde-team; @@ -36,29 +42,132 @@ TDE tdeutils -kcharselect +ktimer - -We Apologize -No documentation has yet been written for &ktimer;. + +Introduction +&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. + + + + +Using &ktimer; + + +Here's a screenshot of &ktimer; when you start it for the first +time + + + + + + &ktimer; main window + + + + +To start, first add a task by selecting New. Then type the +command you wish to execute into the Command line: box. You can then +adjust the settings, or start the timer countdown. When the time is up, the command +will be run. + + +Here's a screenshot of &ktimer; after you have told it to run &konqueror;. + + + + + + add a task + + + + +Let's use &konqueror; as an example. By default, &konqueror; will start in 100 seconds +after the timer countdown is started. + + +Here it is counting down: in 56 seconds &konqueror; will be run. + + + + + + 56 seconds to go + + + + +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. + +See that sliding bar? You can use it to quickly increase or decrease the amount of time +on a task. + + +Let's add a second task. + + + + + + start another &konqueror;, you can never have too many! + + + + +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. + + + + +Settings + + + + + New + Adds a new task. + + + + Remove + Removes the current task. + + + + Help + Opens the Handbook. + + -If you need help, please check The &tde; -web site, submit questions to the -&tde; mail lists, or file a bug report at the -&tde; bug tracker. + + + + + +Credits and License + + +&ktimer; + -If you are interested in helping, please consider writing the help file. -Submitting a basic text file is acceptable as the &tde-team; will convert the text. + +Program Copyright 2001 &Stefan.Schimanski; -Thank you for helping and thank you for your patience. +Documentation Copyright 2008 &A.L.Spehr; -&underFDL; -&underGPL; + +&underFDL; +&underGPL; -&documentation.index; diff --git a/doc/ktimer/main.png b/doc/ktimer/main.png new file mode 100644 index 0000000..ace0f79 Binary files /dev/null and b/doc/ktimer/main.png differ diff --git a/doc/ktimer/running.png b/doc/ktimer/running.png new file mode 100644 index 0000000..d8ddc67 Binary files /dev/null and b/doc/ktimer/running.png differ diff --git a/doc/ktimer/two_at_once.png b/doc/ktimer/two_at_once.png new file mode 100644 index 0000000..b622404 Binary files /dev/null and b/doc/ktimer/two_at_once.png differ diff --git a/ktimer/ktimer.desktop b/ktimer/ktimer.desktop index 8137098..a7cc1fe 100644 --- a/ktimer/ktimer.desktop +++ b/ktimer/ktimer.desktop @@ -61,3 +61,4 @@ Name[zh_TW]=TDE 計時器 X-TDE-StartupNotify=true X-DCOP-ServiceType=Multi Categories=Qt;TDE;Utility; +DocPath=ktimer/index.html