diff options
Diffstat (limited to 'doc')
40 files changed, 1853 insertions, 0 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 0000000..6812bd2 --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1,5 @@ + +KDE_LANG = en +KDE_DOCS = AUTO +SUBDIRS = $(AUTODIRS) + diff --git a/doc/amor/Makefile.am b/doc/amor/Makefile.am new file mode 100644 index 0000000..3f20a1e --- /dev/null +++ b/doc/amor/Makefile.am @@ -0,0 +1,5 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + +KDE_MANS = AUTO diff --git a/doc/amor/billy.png b/doc/amor/billy.png Binary files differnew file mode 100644 index 0000000..89d5d28 --- /dev/null +++ b/doc/amor/billy.png diff --git a/doc/amor/bonhomme.png b/doc/amor/bonhomme.png Binary files differnew file mode 100644 index 0000000..d9a031b --- /dev/null +++ b/doc/amor/bonhomme.png diff --git a/doc/amor/bsd.png b/doc/amor/bsd.png Binary files differnew file mode 100644 index 0000000..77d3b2a --- /dev/null +++ b/doc/amor/bsd.png diff --git a/doc/amor/eyes.png b/doc/amor/eyes.png Binary files differnew file mode 100644 index 0000000..0c843e2 --- /dev/null +++ b/doc/amor/eyes.png diff --git a/doc/amor/ghost.png b/doc/amor/ghost.png Binary files differnew file mode 100644 index 0000000..59ab8d3 --- /dev/null +++ b/doc/amor/ghost.png diff --git a/doc/amor/index.docbook b/doc/amor/index.docbook new file mode 100644 index 0000000..8b72736 --- /dev/null +++ b/doc/amor/index.docbook @@ -0,0 +1,318 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kappname "&amor;"> + <!ENTITY package "kdetoys"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE"> +]> + +<book lang="&language;"> +<bookinfo> +<title>The &amor; Handbook</title> + +<authorgroup> +<author> +&Karl.Garrison; &Karl.Garrison.mail; +</author> +</authorgroup> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +<copyright> +<year>2001</year> +<holder>&Karl.Garrison;</holder> +</copyright> + +<legalnotice>&FDLNotice;</legalnotice> + +<date>2003-09-16</date> +<releaseinfo>2.2</releaseinfo> + +<abstract> +<para> +&amor; is a small animation which sits on top of your active window. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>kdetoys</keyword> +<keyword>amor</keyword> +<keyword>helper</keyword> +<keyword>assistant</keyword> +</keywordset> + +</bookinfo> + +<chapter id="introduction"> +<title>Introduction</title> + +<sect1 id="whats-amor"> +<title>What's &amor;?</title> +<para> +&amor; is an acronym which stands for Amusing Misuse of Resources. It is +actually an animation which sits on top of your active window. In its default +configuration, &amor; takes the form of a yellow spot which performs many +tricks. &amor; also has many different themes which change the appearance +and behavior of the animation. +</para> + +<note><para>Since &amor; works with the &kde; window manager &kwin;, the +application will only work from within &kde;. It is possible that &amor; +would work from within another &kde;-compliant window manager, but none are +known to work at the time of this writing.</para></note> +</sect1> +</chapter> + +<chapter id="configuration"> +<title>Configuration</title> +<sect1 id="configuring-amor"> +<title>Configuring &amor;</title> +<para>To configure &amor;, click on the animation using your &RMB;. A menu +will appear containing three items: +<guimenuitem>Options...</guimenuitem>, +<guimenuitem>About...</guimenuitem>, and +<guimenuitem>Quit</guimenuitem>. Choose +<guimenuitem>Options...</guimenuitem> to configure &amor; +</para> +</sect1> + +<sect1 id="general-options"> +<title>General Options</title> +<para>The following settings for &amor; can be changed from the Options +dialog:</para> +<variablelist> +<varlistentry><term><guilabel>Theme</guilabel></term> +<listitem><para>This determines the appearance and behavior of &amor;. +Themes are described in the next section.</para></listitem> +</varlistentry> +<varlistentry><term><guilabel>Offset</guilabel></term> +<listitem><para>This slider controls where the animation appears in +relation to the top of the active window. The default middle setting will +place the animation right above the window title bar, whereas setting the +slider all the way to the top or bottom will result in the animation +appearing a fair distance above or below the title bar, respectively.</para> +<tip><para>Setting this slider to a lower setting will allow the +animation to be visible even when the active window is maximized.</para> +</tip></listitem> +</varlistentry> +<varlistentry><term><guilabel>Always on top</guilabel></term> +<listitem><para>Checking this option will cause the animation to always +appear in front of any existing windows on the screen, including the +panel.</para></listitem> +</varlistentry> +<varlistentry><term><guilabel>Show random tips</guilabel></term> +<listitem><para>If checked, the animation will display various +&kde;-related tips at random intervals.</para></listitem> +</varlistentry> +<varlistentry><term><guilabel>Allow application tips</guilabel></term> +<listitem><para>Any &kde; application can be designed to display helpful +tips via &amor;. If this option is checked, and an appropriate +application is the active window, the animation will display tips for that +application.</para> +<note><para>At the time of this writing, no &kde; applications make use of +this functionality.</para></note></listitem> +</varlistentry> +</variablelist> +</sect1> + +<sect1 id="amor-themes"> +<title>&amor; Themes</title> +<para>&amor; comes with many built-in themes, which change the appearance and +behavior of the animation. In addition, it is possible to create new +&amor; themes. The built-in themes for &amor; are described in the table +below</para> + +<table> +<title>Available &amor; Themes</title> +<tgroup cols="2"> +<thead> +<row> +<entry>Theme</entry> +<entry>Description</entry> +</row> +</thead> +<tbody> + +<row> +<entry><mediaobject> +<imageobject> +<imagedata format="PNG" fileref="spot.png"/> +</imageobject> +<textobject><para>Multi-talented Spot</para></textobject> +<caption><para>Multi-talented Spot</para></caption> +</mediaobject></entry> +<entry><para>This is the default theme for &amor;, and also the one with +the most <quote>tricks</quote>. This theme was created by &Martin.R.Jones;. The jet-pack, beaming, and fire animations were contributed by +<personname><firstname>Mark</firstname><surname>Grant</surname></personname>.</para></entry> +</row> + +<row> +<entry><mediaobject> +<imageobject> +<imagedata format="PNG" fileref="ghost.png"/> +</imageobject> +<textobject><para>Spooky Ghost</para></textobject> +<caption><para>Spooky Ghost</para></caption> +</mediaobject></entry> +<entry><para>A ghost theme based-on the &kde; +<application>ghostview</application> icon. Spooky Ghost was created by +&Martin.R.Jones;.</para></entry> +</row> + +<row> +<entry><mediaobject> +<imageobject> +<imagedata format="PNG" fileref="eyes.png"/> +</imageobject> +<textobject><para>Crazy Eyes</para></textobject> +<caption><para>Crazy Eyes</para></caption> +</mediaobject></entry> +<entry><para>This theme consists of a moving pair of eyes, and was created +by <personname><firstname>Jean-Claude</firstname><surname>Dumas</surname></personname>.</para></entry> +</row> + +<row> +<entry><mediaobject> +<imageobject> +<imagedata format="PNG" fileref="bonhomme.png"/> +</imageobject> +<textobject><para>Bonhomme</para></textobject> +<caption><para>Bonhomme</para></caption> +</mediaobject></entry> +<entry><para>A stick-figure animation, created by <personname><firstname>Jean-Claude</firstname><surname>Dumas</surname></personname>.</para></entry> +</row> + +<row> +<entry><mediaobject> +<imageobject> +<imagedata format="PNG" fileref="neko.png"/> +</imageobject> +<textobject><para>Neko</para></textobject> +<caption><para>Neko</para></caption> +</mediaobject></entry> +<entry><para>Neko is a cat theme by <personname><firstname>Chris</firstname><surname>Spiegel</surname></personname>. The graphics are +originally from <application>Oneko</application>, which was written by +<personname><firstname>Masayuki</firstname><surname>Koba</surname></personname>.</para> +<note><para><application>Oneko</application> is a small application which +features a cat chasing the mouse cursor. The application appears to no +longer be maintained, but the +<ulink url="ftp://sunsite.unc.edu/pub/Linux/X11/demos/oneko-1.1b.tar.gz"> +source code</ulink> from the last version is still +available.</para></note></entry> +</row> + +<row> +<entry><mediaobject> +<imageobject> +<imagedata format="PNG" fileref="pingus.png"/> +</imageobject> +<textobject><para>Tux</para></textobject> +<caption><para>Tux</para></caption> +</mediaobject></entry> +<entry><para>This theme features Tux, the &Linux; mascot. The actual +graphics come from a <application>Lemmings</application>-style game +called <ulink url="http://pingus.seul.org/"> +<application>Pingus</application></ulink>. The Tux theme was created by +<personname><firstname>Frank</firstname><surname>Pieczynski</surname></personname>.</para></entry> +</row> + +<row> +<entry><mediaobject> +<imageobject> +<imagedata format="PNG" fileref="worm.png"/> +</imageobject> +<textobject><para>Little Worm</para></textobject> +<caption><para>Little Worm</para></caption> +</mediaobject></entry> +<entry><para>A small inchworm theme. Created by <personname><firstname>Bartosz</firstname><surname>Trudnowski</surname></personname> for +his wife.</para></entry> +</row> + +<row> +<entry><mediaobject> +<imageobject> +<imagedata format="PNG" fileref="billy.png"/> +</imageobject> +<textobject><para>Little Billy</para></textobject> +<caption><para>Little Billy</para></caption> +</mediaobject></entry> +<entry><para>A static image taken from the game +<ulink url="http://www.xbill.org/"><application>XBill</application> +</ulink>.</para></entry> +</row> + +<row> +<entry><mediaobject> +<imageobject> +<imagedata format="PNG" fileref="bsd.png"/> +</imageobject> +<textobject><para>BSD Mascot</para></textobject> +<caption><para>BSD Mascot</para></caption> +</mediaobject></entry> +<entry><para>A static image of Beastie, the FreeBSD daemon.</para></entry> +</row> + +<row> +<entry><mediaobject> +<imageobject> +<imagedata format="PNG" fileref="tux.png"/> +</imageobject> +<textobject><para>Unanimated Tux</para></textobject> +<caption><para>Unanimated Tux</para></caption> +</mediaobject></entry> +<entry><para>An unanimated version of the Tux theme.</para></entry> +</row> + +<row> +<entry><mediaobject> +<imageobject> +<imagedata format="PNG" fileref="tao.png"/> +</imageobject> +<textobject><para>Tao</para></textobject> +<caption><para>Tao</para></caption> +</mediaobject></entry> +<entry><para>The Tao theme is an animated Yin Yang symbol. This theme was +created by <personname><firstname>Daniel</firstname><surname>Pfeiffer</surname></personname> <email>occitan@esperanto.org</email>, and was +inspired by his Tai Chi practice.</para></entry> +</row> + +</tbody> +</tgroup> +</table> + +</sect1> +</chapter> + +<chapter id="credits"> +<title>Credits and License</title> + +<para>&amor;</para> + +<para>Program Copyright © 1999-2001 &Martin.R.Jones; +&Martin.R.Jones.mail;</para> + +<para>Documentation Copyright © 2001 &Karl.Garrison; +&Karl.Garrison.mail;</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; +&underGPL; +</chapter> + +&documentation.index; + +</book> + +<!-- +Local Variables: +mode: sgml +sgml-minimize-attributes:nil +sgml-general-insert-case:lower +sgml-indent-step:0 +sgml-indent-data:nil +End: + +// vim:ts=0:sw=2:tw=78:noet +--> diff --git a/doc/amor/man-amor.6.docbook b/doc/amor/man-amor.6.docbook new file mode 100644 index 0000000..17dca2f --- /dev/null +++ b/doc/amor/man-amor.6.docbook @@ -0,0 +1,72 @@ +<?xml version="1.0" ?> +<!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ +<!-- <!ENTITY kdeoptions SYSTEM "kdeoptions.docbook"> --> +<!-- <!ENTITY qtoptions SYSTEM "qtoptions.docbook"> --> +<!ENTITY % English "INCLUDE"> +]> + +<refentry lang="&language;"> +<refentryinfo> +<date>March 7, 2003</date> +</refentryinfo> + +<refmeta> +<refentrytitle><command>amor</command></refentrytitle> +<manvolnum>6</manvolnum> +</refmeta> + +<refnamediv> +<refname><command>amor</command></refname> +<refpurpose>A &kde; creature for your desktop</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<cmdsynopsis> +<command>amor</command> +<group><option>KDE Generic Options</option></group> +<group><option>Qt Generic Options</option></group> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1> +<title>Description</title> + +<para><acronym>AMOR</acronym> stands for <quote>Amusing Misuse Of +Resources</quote>. It provides several different characters who +prance around your X screen doing tricks and giving you tips.</para> + +<para>&amor; is part of the &kde; toys package.</para> + +</refsect1> + +<refsect1> +<title>Options</title> + +<para>&amor; is configured graphically, and does not have any +commandline options other than the standard &kde; and &Qt; +options.</para> + +</refsect1> + +<refsect1> +<title>See Also</title> + +<para>Within &kde; you can enter +<userinput>help:/amor</userinput> in &konqueror; to see the +comprehensive user manual.</para> + +</refsect1> + +<refsect1> +<title>Bugs</title> + +<para>&amor; currently only works with the &kwin; window manager.</para> +</refsect1> + +<refsect1> +<title>Authors</title> +<para>&amor; was written by <personname><firstname>Martin</firstname><othername>R.</othername><surname>Jones</surname></personname> <email>mjones@kde.org</email>. + This manual page was prepared by <personname><firstname>Ben</firstname><surname>Burton</surname></personname> <email>bab@debian.org</email> for the Debian GNU/Linux system (but may be used by others).</para> +</refsect1> + +</refentry> diff --git a/doc/amor/neko.png b/doc/amor/neko.png Binary files differnew file mode 100644 index 0000000..25e9ea6 --- /dev/null +++ b/doc/amor/neko.png diff --git a/doc/amor/pingus.png b/doc/amor/pingus.png Binary files differnew file mode 100644 index 0000000..368d6a9 --- /dev/null +++ b/doc/amor/pingus.png diff --git a/doc/amor/spot.png b/doc/amor/spot.png Binary files differnew file mode 100644 index 0000000..e9a6c06 --- /dev/null +++ b/doc/amor/spot.png diff --git a/doc/amor/tao.png b/doc/amor/tao.png Binary files differnew file mode 100644 index 0000000..3813ce8 --- /dev/null +++ b/doc/amor/tao.png diff --git a/doc/amor/tux.png b/doc/amor/tux.png Binary files differnew file mode 100644 index 0000000..924c569 --- /dev/null +++ b/doc/amor/tux.png diff --git a/doc/amor/worm.png b/doc/amor/worm.png Binary files differnew file mode 100644 index 0000000..42d5ed5 --- /dev/null +++ b/doc/amor/worm.png diff --git a/doc/kmoon/Makefile.am b/doc/kmoon/Makefile.am new file mode 100644 index 0000000..085981d --- /dev/null +++ b/doc/kmoon/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kmoon/carlosmail b/doc/kmoon/carlosmail new file mode 100644 index 0000000..760845b --- /dev/null +++ b/doc/kmoon/carlosmail @@ -0,0 +1,74 @@ +From rabaca@nova.ov.ufrj.br Fri Oct 20 23:12:11 2000 +Return-Path: <rabaca@nova.ov.ufrj.br> +Delivered-To: coolo@master.kde.org +Received: (qmail 22568 invoked by uid 1055); 20 Oct 2000 21:12:11 -0000 +Delivered-To: kde.org-coolo@kde.org +Received: (qmail 22489 invoked from network); 20 Oct 2000 21:12:07 -0000 +Received: from nova.ov.ufrj.br (root@146.164.112.17) + by max.tat.physik.uni-tuebingen.de with SMTP; 20 Oct 2000 21:12:07 -0000 +Received: from localhost (localhost [[UNIX: localhost]]) + by nova.ov.ufrj.br (8.9.3/8.9.3) id TAA09140 + for coolo@kde.org; Fri, 20 Oct 2000 19:14:00 -0200 +From: Carlos Roberto Raba<E7>a <rabaca@nova.ov.ufrj.br> +Reply-To: rabaca@nova.ov.ufrj.br +Organization: Observatorio do Valongo - UFRJ +To: Stephan Kulow <coolo@kde.org> +Subject: Re: Moon tool +Date: Fri, 20 Oct 2000 17:10:39 -0200 +X-Mailer: KMail [version 1.0.29] +Content-Type: text/plain +References: <00102016004500.08951@nova.ov.ufrj.br> <39F09247.5715C35D@kde.org> +In-Reply-To: <39F09247.5715C35D@kde.org> +MIME-Version: 1.0 +Message-Id: <00102019130700.09050@nova.ov.ufrj.br> +Content-Transfer-Encoding: 8bit +Status: O +X-Status: + +Stephan, + +> In KDE2 I implemented free choice view angle, so I could also slide +> it some degrees off to see it like I see it here :) + +It is nice to hear that! Unfortunately, I still use KDE 1.1.2.... By the way, +when is the final release o 2.0? + +> But if you're an expert, I would like your advise on the correct +> terms. Where on the earth you see the moon in the the default view +> you can see on web pages etc.? + +As you know, the moon keeps always the same face turned to earth (the so called +near side). This is a composition of its period of orbital motion and rotation: +they are approximately the same. The moon's orbit is inclined with respect to +the equator by (only) 5 degrees, and for our purposes, keeps the polar +orientation in the sky unchanged. This means that the angle that you +see the moon in the sky changes by a composition of two factors only: 1) +latitude of the observer, and 2) time of the day that you look at the moon. If +you look at the moon over many hours, the change of orientation in the sky is +moon's orbital plane is close to the equator (as I said before) the discussion +of orientation looses any meaning. At these positions, the passage by the +meridian happens very close to the top of your head. So, I can be facing east +and move my head up to see the moon, or I can be facing west and move my head +up. Which rotation should I addopt? That is why I told you to use 0 or 180 +degrees. Otherwise, you would need to incorporate in your code many otherif he +relations, including the latitude of the observer.he will see the first quarter +moon as a C and the last quater moon as a D (see +> The current kmoon uses the pictures of this site:l) when the moon is over +> http://timbeauchamp.tripod.com/moon/, but a (german) colleague ofes over his +> yours pointed out that the images are mirrored horizontally, son is reversed. +> we corrected that (the larger craters appear on the left ontor. Since the +> the moon I see in the sky, while they are right on the web). + +My colleague is correct. The east-west sides in the pictures are wrong, so you +should flip them sideways. For an observer in the northern hemisthere this is +all you need to do. For an observer in the southern hemisphere, you need to +rotate this new set of images by 180 degrees. Keep in mind that in the sky if +north is up east is to the left, if south is up east is to the right. You can +easily see this if you lay down ;-/ on the floor with you head/legs pointing to +the north/south line. Now, try to point your left arm to the geographic +east while facing up. + +I hope this helps you. If you like more info, it will be a pleasure to +help. Best wishes, + +Carlos diff --git a/doc/kmoon/index.docbook b/doc/kmoon/index.docbook new file mode 100644 index 0000000..5debf5c --- /dev/null +++ b/doc/kmoon/index.docbook @@ -0,0 +1,131 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kappname "&kmoon;"> + <!ENTITY package "kdetoys"> + <!ENTITY % English "INCLUDE"> + <!ENTITY % addindex "IGNORE"> +]> + +<book lang="&language;"> + +<bookinfo> +<title>The &kmoon; Handbook</title> + +<authorgroup> +<author> +<personname> +<firstname>Pam</firstname> +<othername></othername> +<surname>Roberts</surname> +</personname> +<email>pamroberts@blueyonde.co.uk</email> +</author> +</authorgroup> +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +<copyright> +<year>2003</year> +<holder>Pam Roberts</holder> +</copyright> +<!-- Translators: put here the copyright notice of the translation --> +<legalnotice>&FDLNotice;</legalnotice> + +<date>2003-09-16</date> +<releaseinfo>1.0</releaseinfo> + +<abstract> +<para> +&kmoon; is an applet that shows the current phase of the moon. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>kdetoys</keyword> +<keyword>kmoon</keyword> +<keyword>moon phase</keyword> +</keywordset> + +</bookinfo> + +<chapter id="using"> +<title>Using &kmoon;</title> +<para>&kmoon; is a little applet that docks into the System Tray and shows an +image of the current phase of the moon. Hovering the mouse cursor over the +image brings up a tooltip to display more information.</para> + +<para>&kmoon; can be added to the panel by &RMB; clicking on an empty space +on the panel and choosing <menuchoice><guimenu>Add to +Panel</guimenu><guisubmenu>Applet</guisubmenu><guimenuitem>Moon Phase +Display</guimenuitem></menuchoice>. If you can't find an empty space, you +can access the panel menu from an &RMB; click on any existing applet or +icon.</para> + +<para>To close &kmoon; <mousebutton>right</mousebutton> click on the applet +handle beside the image and choose <guimenuitem>Quit</guimenuitem>.</para> + +<sect1 id="settings"> +<title>Settings</title> +<para>If you <mousebutton>right</mousebutton> click on the image and choose +<guimenuitem>Settings...</guimenuitem> a small dialog box will appear that +lets you adjust the image to suit the latitude and hemisphere you are living +in.</para> +</sect1> + +</chapter> + +<chapter id="credits"> + +<title>Credits and License</title> + +<para> +&kmoon; +</para> +<para> +Program copyright 1998,2000 &Stephan.Kulow; &Stephan.Kulow.mail; +</para> +<para> +Contributors: +<itemizedlist> +<listitem><para>Lunar code by Chris Osburn <email>chris@speakeasy.org</email></para> +</listitem> +<listitem><para>Moon graphics by Tom Beauchamp <email>timb@googol.com</email></para> +</listitem> +</itemizedlist> +</para> + +<para> +Documentation copyright 2003 Pam Roberts <email>pamroberts@blueyonder.co.uk</email> +</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; +&underGPL; + +</chapter> +<appendix id="installation"> +<title>Installation</title> + +<para>&kmoon; is part of &kde;'s &package; package.</para> +<para>Most &Linux; / &UNIX; distributions that include &kde; will include &package; as an option to be installed if the user wishes.</para> +<para>&kmoon; and the &package; package may also be compiled from source code. +Visit <ulink url="http://www.kde.org"> http://www.kde.org</ulink> for instructions on how to download, compile and install &kde; programs.</para> + +</appendix> + +&documentation.index; +</book> + +<!-- +Local Variables: +mode: xml +sgml-minimize-attributes:nil +sgml-general-insert-case:lower +sgml-indent-step:0 +sgml-indent-data:nil +End: + +vim:tabstop=2:shiftwidth=2:expandtab +--> + diff --git a/doc/kodo/Makefile.am b/doc/kodo/Makefile.am new file mode 100644 index 0000000..085981d --- /dev/null +++ b/doc/kodo/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kodo/guide.png b/doc/kodo/guide.png Binary files differnew file mode 100644 index 0000000..18b820e --- /dev/null +++ b/doc/kodo/guide.png diff --git a/doc/kodo/index.docbook b/doc/kodo/index.docbook new file mode 100644 index 0000000..20cd0be --- /dev/null +++ b/doc/kodo/index.docbook @@ -0,0 +1,225 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kappname "&kodometer;"> + <!ENTITY package "kdetoys"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE"> +]> + +<book lang="&language;"> +<bookinfo> +<title>The &kodometer; Handbook</title> +<authorgroup> +<author> +&Armen.Nakashian; &Armen.Nakashian.mail; +</author> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +</authorgroup> + +<copyright> +<year>1999</year><year>2001</year> +<holder>&Armen.Nakashian;</holder> +</copyright> + +<legalnotice>&FDLNotice;</legalnotice> + +<date>2003-09-17</date> +<releaseinfo>3.2</releaseinfo> + +<abstract> +<para>&kodometer; is a little gadget to measure your desktop mileage</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KOdometer</keyword> +<keyword>odometer</keyword> +<keyword>mouse</keyword> +<keyword>mileage</keyword> +</keywordset> +</bookinfo> + +<chapter id="introduction"> +<title>Introduction</title> + +<sect1 id="whats-kodo"> +<title>What is &kodometer;?</title> + +<para> +&kodometer; <emphasis>measures your desktop mileage</emphasis>. It tracks the +movement of your mouse pointer across your desktop, and renders it in +inches/feet/miles! It can do cm/meters/km too. The most exciting +feature is the tripometer, and its utter uselessness.</para> + +<note> +<para>The next version will be USEFUL!</para> +</note> + +</sect1> + +</chapter> + +<chapter id="onscreen-operation"> +<title>On screen operation</title> + +<screenshot> +<screeninfo>A labeled screen-shot of &kodometer; in action</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="guide.png" format="PNG"/> +</imageobject> +<textobject> +<phrase>A labeled screen-shot of &kodometer; in action</phrase></textobject> +<caption><para>A screen shot. Note the fashionable lack of a +titlebar.</para></caption> +</mediaobject> +</screenshot> + +<para> +The <guilabel>Odometer</guilabel> is the total distance traveled by the +mouse since the last odometer reset. The +<guilabel>Tripometer</guilabel> is the distance traveled by the mouse +since it last stopped moving. +</para> + +<sect1 id="menu-options"> +<title>Menu Options</title> + +<para> +If you've gotten this far, you probably already know that there is a +&RMB; mouse button context menu on &kodometer;, which contains a number of +choices. +</para> + +<variablelist> +<varlistentry> +<term><guimenuitem>Enable</guimenuitem></term> +<listitem> +<para> +Toggle mileage tracking. This is good if you want to cheat on your +mileage. <emphasis>Note: This is illegal in most countries</emphasis> +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Metric Display</guimenuitem></term> +<listitem> +<para> +Because &kodometer; was written by an American, it obnoxiously assumes you +want to use Inches/Feet/Miles for measurement. If you come from some +more modern country in Europe, to use metric measurements, turn on this +option. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Auto Reset Trip</guimenuitem></term> +<listitem> +<para> +This option will cause &kodometer; to set the Tripometer back to zero every +time it starts up. </para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Reset Trip</guimenuitem></term> +<listitem> +<para> +Set the tripometer to zero. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Reset Odometer</guimenuitem></term> +<listitem> +<para> +Set the odometer back to zero. <emphasis>You might get in trouble for +this!</emphasis></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>About Mousepedometa</guimenuitem></term> +<listitem> +<para> +Pops up a little dialog box with information on who to blame for the +program. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Help</guimenuitem></term> +<listitem> +<para> +This menu entry opens up the &kodometer; help - this very document. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Quit</guimenuitem></term> +<listitem> +<para> +Quit &kodometer; +</para> +</listitem> +</varlistentry> +</variablelist> + +</sect1> + +</chapter> + +<chapter id="how-it-works"> +<title>How It Works</title> + +<para>&X-Window; displays are usually configured with a screen-size +variable. That is, how big your screen is in real-world measurements, +not pixels. &kodometer; grabs this value and uses it come up with a +&dpi; (dots per inch) value for your display, and thus +can relate the number of pixels you've traversed to the number of inches +the pointer appears to have moved on the screen.</para> + +<para>But lets be real! Its horribly <emphasis>inaccurate!</emphasis> +&kodometer; makes no pretense of being even remotely accurate. In fact, +someone has measured the movement of their mouse across the screen with +a ruler, and found that the distance algorithm is almost 25% off! +The original author's response to this complaint was <quote>who +cares?</quote>.</para> +</chapter> + +<chapter id="license-and-credits"> +<title>Credits and Licenses</title> + +<para>&kodometer; Copyright © 1998-2001, &Armen.Nakashian;.</para> + +<para>Documentation copyright 1998 &Armen.Nakashian;, with small updates +and markup cleanup for &kde; 2.2, &Lauri.Watts; &Lauri.Watts.mail; +</para> + +&underFDL; +&underGPL; + +</chapter> + +&documentation.index; + +</book> + +<!-- +Local Variables: +mode: sgml +sgml-minimize-attributes:nil +sgml-general-insert-case:lower +sgml-indent-step:0 +sgml-indent-data:nil +End: + +// vim:ts=0:sw=2:tw=78:noet +--> diff --git a/doc/kteatime/Makefile.am b/doc/kteatime/Makefile.am new file mode 100644 index 0000000..085981d --- /dev/null +++ b/doc/kteatime/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kteatime/config.png b/doc/kteatime/config.png Binary files differnew file mode 100644 index 0000000..9c875e5 --- /dev/null +++ b/doc/kteatime/config.png diff --git a/doc/kteatime/index.docbook b/doc/kteatime/index.docbook new file mode 100644 index 0000000..a1a4664 --- /dev/null +++ b/doc/kteatime/index.docbook @@ -0,0 +1,148 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kappname "&kteatime;"> + <!ENTITY package "kdetoys"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE"> +]> + +<book lang="&language;"> +<bookinfo> +<title>The &kteatime; Handbook</title> +<authorgroup> +<author> +&Michael.Korman; &Michael.Korman.mail; +</author> + +<othercredit role="developer"> +&Matthias.Hoelzer-Kluepfel; &Matthias.Hoelzer-Kluepfel.mail; +<!-- <contrib>Developer</contrib> --> +</othercredit> + +<othercredit role="reviewer"> +&Lauri.Watts; &Lauri.Watts.mail; +<!-- <contrib>Reviewer</contrib> --> +</othercredit> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<copyright> +<year>2000</year> +<holder>&Michael.Korman;</holder> +</copyright> + +<legalnotice>&FDLNotice;</legalnotice> + +<date>2006-10-25</date> +<releaseinfo>1.1.0</releaseinfo> + +<abstract> +<para>This Handbook describes &kteatime;, the &kde; Tea Cooker.</para> +</abstract> +<keywordset> +<keyword>KDE</keyword> +<keyword>kdetoys</keyword> +<keyword>kteatime</keyword> +<keyword>tea</keyword> +<keyword>cooker</keyword> +<keyword>timer</keyword> +</keywordset> +</bookinfo> + +<chapter id="introduction"> +<title>Introduction</title> + +<sect1 id="whats-kteatime"> +<title>What's &kteatime;?</title> + +<para>&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.</para> +</sect1> + +</chapter> + +<chapter id="how-to-use"> +<title>How to Use &kteatime;</title> + +<para>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.</para> + +<sect1 id="timing-your-tea"> +<title>Timing Your Tea</title> + +<para>Upon starting, the panel icon will be that of an empty tea mug. If you click on the mug and select your tea, the icon will change to a filled mug. After the specified time, the tea will be finished, and a suitable message box will be shown. At this point, you can close the message box by clicking on it and reset the timer by clicking on the icon. The mug will be shown as empty again.</para> + +<note><para>The timer should only be reset by those who really enjoy tea.</para></note> + +</sect1> +</chapter> + +<chapter id="menu-options"> +<title>Menu Options</title> + +<para>The following section describes the menu options that are available in &kteatime;.</para> + +<sect1 id="select-your-tea"> +<title>Select Your Tea</title> + +<para>Clicking on the icon with the &RMB; will bring up a menu. At the top of the menu there are three menu items. Here, you can select what kind of tea you are preparing to drink. There are: <guimenuitem>Black Tea</guimenuitem>, <guimenuitem>Earl Grey</guimenuitem>, and <guimenuitem>Fruit Tea</guimenuitem>. 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 change or delete these predefined times and to set your own time. A quick-and-easy way to set a custom time is to choose <guimenuitem>Anonymous...</guimenuitem> from the menu.</para> +</sect1> + +<sect1 id="start"> +<title>Start</title> + +<para>This menu item will start the tea timer for the tea marked above. As confirmation that you have indeed selected <guimenuitem>Start</guimenuitem>, the panel icon will change into a filled mug.</para></sect1> + +<sect1 id="configure"> +<title><guimenuitem>Configure</guimenuitem></title> + +<para>This menu item opens up the configuration dialog box. A screenshot is shown below:</para> + +<screenshot> +<screeninfo>The &kteatime; configuration dialog box.</screeninfo> +<mediaobject> +<imageobject><imagedata fileref="config.png" format="PNG"/></imageobject> +<textobject><phrase>The &kteatime; configuration dialog +box.</phrase></textobject> +</mediaobject> +</screenshot> + +<para>As shown in the picture, you may add new entries for other tea or change names, times and the order of existing entries. 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 predefined times. To edit one entry, mark it in the <guilabel>Tea List</guilabel> on the left and change the values in the <guilabel>Tea Properties</guilabel> on the right.</para> + +<para>The box below is the <guilabel>Action</guilabel> field. Here you can define an action that will be executed when the time is up. The button <guibutton>Configure Events...</guibutton> brings up the &kde; Notification Settings for &kteatime;. The <guilabel>Event</guilabel> check box below enables the event selected in the &kde; Notification Settings. If <guilabel>Popup</guilabel> is selected, a message box will appear alerting you to the fact that your tea is ready. The third check box can hold any valid system command. Probably, you will want to leave it blank.</para> + +<para>If you enable the check box labeled <guilabel>Visualize progress in icon tray</guilabel>, the progress will be shown as a little animated pie chart inside the icon.</para> + +</sect1> +</chapter> + +<chapter id="credits"> +<title>Credits</title> + +<para>&kteatime; Copyright © 1998-1999 by +&Matthias.Hoelzer-Kluepfel; &Matthias.Hoelzer-Kluepfel.mail; +</para> + +<para>Documentation by &Michael.Korman; &Michael.Korman.mail;</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> +&underFDL; <!-- FDL: do not remove --> +&underGPL; <!-- GPL License --> + +</chapter> + +&documentation.index; + +</book> + +<!-- +Local Variables: +mode: sgml +sgml-minimize-attributes:nil +sgml-general-insert-case:lower +sgml-indent-step:0 +sgml-indent-data:nil +End: + +// vim:ts=2:sw=2:tw=78:noet +--> + + diff --git a/doc/kweather/Makefile.am b/doc/kweather/Makefile.am new file mode 100644 index 0000000..085981d --- /dev/null +++ b/doc/kweather/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kweather/index.docbook b/doc/kweather/index.docbook new file mode 100644 index 0000000..e545a5a --- /dev/null +++ b/doc/kweather/index.docbook @@ -0,0 +1,260 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kweather "<application>kweather</application>"> + <!ENTITY package "kdetoys"> + <!ENTITY % English "INCLUDE"> + <!ENTITY % addindex "IGNORE"> +]> + +<book lang="&language;"> + +<bookinfo> +<title>The KWeather Handbook</title> + +<authorgroup> +<author> +<firstname></firstname> +<othername></othername> +<surname></surname> +<affiliation> +<address><email></email></address> +</affiliation> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<legalnotice>&GPLNotice;</legalnotice> + +<date>2004-05-31</date> +<releaseinfo>3.00.00</releaseinfo> + +<abstract> +<para> +KWeather is part of the kdetoys package. +</para> +</abstract> + + +<keywordset> +<keyword>KDE</keyword> +<keyword>KWeather</keyword> +</keywordset> + +</bookinfo> + +<chapter id="introduction"> +<title>Introduction</title> + +<para>KWeather is an application that provides both a panel icon, +allowing you to watch the weather as reported by a local weather +station, and providing a weather service that can track multiple +weather stations and provide this information to other +applications including &konqueror;'s sidebar and &kontact;'s +summary page.</para> + +</chapter> + +<chapter id="adding-applet"> +<title>Using KWeather as a Panel Applet</title> + +<para>&RMB; click on an empty space in the panel and choose +<menuchoice><guimenu>Add</guimenu><guisubmenu>Applet</guisubmenu> +<guimenuitem>KWeather</guimenuitem></menuchoice></para> + +<para>A configuration dialog will open up. Initially the only +configuration required to make KWeather work is the <guilabel>ICAO +location code:</guilabel>.</para> + +<para>This is a four character code used by the weather reporting +service to uniquely identify weather stations around the world.</para> + +<para>As it's unlikely that most people will happen to know this +directly, there is a link to a search engine where you can look it +up.</para> + +<note><para>While the weather stations available are fairly +comprehensive, not every town in every country will be represented, +simply because not every town has an appropriate weather station. If +your own town is not represented, you should choose the one nearest +you. Since flying planes safely requires accurate weather data, most +towns with an airport will be in the list, so a good bet +is to look for the nearest airport to you.</para></note> + +<para>At this point, you can press the <guibutton>OK</guibutton> button +and the dialog will close. You will now have an icon displaying the +current weather graphically on your panel. Clicking it once will open +a window that shows the weather in detail.</para> + +<para>Further configuration is described in the next chapter.</para> + +</chapter> + +<chapter id="configuring-kweather"> +<title>Configuring KWeather</title> + +<sect1 id="display"> +<title>Display</title> + +<variablelist> +<varlistentry> +<term><guilabel>Weather Station Options</guilabel></term> +<listitem> + <variablelist> + <varlistentry> + <term><guilabel>ICAO location code:</guilabel></term> + <listitem><para>ICAO stands for the International Civil Aviation +Organization. The ICAO location code is a four character +alphanumeric code that uniquely identifies airports worldwide. The first +two letters of the ICAO code ususally identify the coutry. However, codes for +airports in the United States usually start with "K", followed by a three +character IATA (International Air Transport Assocation) code. For example, +KORD is the ICAO code for Ohare International Airport in Chicago, Illinois. +If you don't know the ICAO code for the airport nearest to you, you can click +on the link labeled <guilabel>Lookup Your ICAO Code</guilabel> to use a web based +search engine to find it.</para></listitem> + </varlistentry> + </variablelist> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Panel Display Options</guilabel></term> +<listitem> + <variablelist> + <varlistentry> + <term><guilabel>Show icon only</guilabel></term> + <term><guilabel>Show icon and temperature</guilabel></term> + <term><guilabel>Show icon, temperature, wind and pressure information</guilabel></term> + <listitem><para>You can choose here if the temperature should be +displayed beside the icon, or if the current wind speed, direction, and +air pressure are also displayed.</para> + <para>The icon is always shown.</para> + </listitem> + </varlistentry> + </variablelist> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Logging Options</guilabel></term> +<listitem> +<variablelist> +<varlistentry> +<term><guilabel>Enable logging</guilabel></term> +<listitem><para>By default KWeather does not retain old weather +information, and each time it updates the weather the old information +is discarded. If you wish instead to keep a record of the weather, +enable this option. Then, each time the weather is checked, KWeather +will append a new line to the log file containing the current weather +conditions in comma separated value form. The information written +will be the date, wind speed and direction, temperature, pressure, cover, +visibility, and "current weather".</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Log file</guilabel></term> +<listitem><para>If you have enabled the <guilabel>Enable +logging</guilabel> check box, this option will become available. Enter +or browse to the location you would like KWeather to keep it's log +file.</para> +</listitem> +</varlistentry> +</variablelist> +</listitem> +</varlistentry> +</variablelist> + +</sect1> + +<sect1 id="weather-service"> +<title><guilabel>Weather Service</guilabel></title> + +<variablelist> +<varlistentry> +<term><guilabel>Station Manager</guilabel></term> +<listitem><para></para></listitem> +</varlistentry> +<varlistentry> +<term><guibutton>Update All Stations</guibutton></term> +<listitem><para>Update all the listed stations +immediately.</para></listitem> +</varlistentry> +<varlistentry> +<term><guibutton>Exit Weather Service</guibutton></term> +<listitem><para>Stop fetching weather updates for all +listed stations, and stop providing weather +information to the &konqueror; sidebar and &kontact;</para></listitem> +</varlistentry> </variablelist> </sect1> + +</chapter> + +<chapter id="kweather-interfaces"> +<title>KWeather Interfaces</title> + +<para>While the most obvious KWeather interface is the panel icon, +there are several other places where you can access KWeather's +information. These are particularly useful if you need to watch +multiple weather stations. While &kweather; allows you to track +multiple weather stations, the panel icon displays only one at a +time.</para> + +<para>These additional services are plug-ins to their respective +applications, and not provided with KWeather itself.</para> + +<!-- FIXME: write some stuff and show some screenies of the konq and +kontact plugins --> + +</chapter> + +<chapter id="credits-and-licenses"> +<title>Credits and Licenses</title> + +<para>KWeather copyright © Ian Reinhart Geiser +<email>geiseri@users.sourceforge.net</email></para> + +<variablelist> +<title>Contributors</title> +<varlistentry><term>Will Andrews +<email>wca@users.sourceforge.net</email></term> +<listitem><para>Fixes for BSD port</para></listitem> +</varlistentry> +<varlistentry> +<term>Ben Burton <email>benb@acm.org</email></term> +<listitem><para>Debian fixes</para></listitem> +</varlistentry> +<varlistentry> +<term>Otto Bruggeman <email>bruggie@home.nl</email></term> +<listitem><para>Fixed the i18n stuff and source style +cleanups</para></listitem> +</varlistentry> +<varlistentry> +<term>Nadeem Hasan <email>nhasan@nadmm.com</email></term> +<listitem><para>Lots of bug fixes, improvements and +cleanups.</para></listitem> +</varlistentry> +<varlistentry> +<term>Carles Carbonell Bernado <email>mail@carlitus.net</email></term> +<listitem><para>Great new weather icons</para></listitem> +</varlistentry> +<varlistentry> +<term>John Ratke <email>jratke@comcast.net</email></term> +<listitem><para>Improvements and more code cleanups</para></listitem> +</varlistentry> +</variablelist> + +&underGPL; +&underFDL; + +</chapter> + +&documentation.index; +</book> + +<!-- +Local Variables: +mode: sgml +sgml-minimize-attributes:nil +sgml-general-insert-case:lower +sgml-indent-step:0 +sgml-indent-data:nil +End: + +// vim:ts=2:sw=2:tw=78:noet +--> diff --git a/doc/kworldclock/Makefile.am b/doc/kworldclock/Makefile.am new file mode 100644 index 0000000..da8216a --- /dev/null +++ b/doc/kworldclock/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO +KDE_MANS = AUTO diff --git a/doc/kworldclock/index.docbook b/doc/kworldclock/index.docbook new file mode 100644 index 0000000..33b5e8a --- /dev/null +++ b/doc/kworldclock/index.docbook @@ -0,0 +1,503 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kappname "&kworldclock;"> + <!ENTITY package "kdetoys"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE"> +]> + +<book lang="&language;"> + +<bookinfo> +<title>The &kworldclock; Handbook</title> + +<authorgroup> +<author> +&Brad.Hards; +&Brad.Hards.mail; +</author> +</authorgroup> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +<copyright> +<year>2004</year> +<holder>Brad Hards</holder> +</copyright> +<legalnotice>&FDLNotice;</legalnotice> + + +<date>2004-01-22</date> +<releaseinfo>0.00.00</releaseinfo> + +<abstract> +<para> +&kworldclock; is an application that shows which parts of the world +are currently experiencing daylight, and which parts are currently in +night. It also shows the current time in a range of cities around the +world. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>kdetoys</keyword> +<keyword>kworldwatch</keyword> +<keyword>World Clock</keyword> +<keyword>day / night clock</keyword> +</keywordset> + +</bookinfo> + +<chapter id="introduction"> +<title>Introduction</title> + + +<para> +&kworldclock; is an application that shows which parts of the world +are currently experiencing daylight, and which parts are currently in +night. It also shows the current time in a range of cities around the +world. +</para> + +<para> +Please report any problems or feature requests to the &kde; mailing lists. +</para> +</chapter> + +<chapter id="using-kapp"> +<title>Using &kworldclock;</title> + +<sect1><title>The main display</title> +<para> +When you start &kworldclock;, you will see a small window appear, as +shown below. +</para> + +<para> +<screenshot> +<screeninfo>Here's a screenshot of &kworldclock;</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="screenshot.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Screenshot</phrase> + </textobject> + </mediaobject> +</screenshot> +</para> + +<para> +The light section (which in the screenshot above covers Antartica, +Australia, eastern and southern Africa and most of Asia; plus the +Indian Ocean and the western part of the Pacific Ocean) shows the area +that is currently experiencing daylight, while the darker section +(which in the screenshot above covers western Europe, North and South +America, and the Arctic zone) shows the area that is currently +experiencing night. The border between the dark and light section +is the area that is experiencing morning or evening twilight. +</para> + +<para> +Each small black square indicates a city or population centre. If you +locate the mouse over (or near) one of the black squares, you will see +the date and time that is current for that location. In the +screenshot above, the tiny island of Pitcairn is shown. +</para> + +<para> +You may find it more convenient to expand the window, so that there is +more space between the various squares. Remember that you can expand the window by +either clicking on the maximise button (second button from the right in the +top right hand corner) or by using the mouse to drag the corner of the +main window. An expanded window, with Melbourne (Australia) now +selected, is shown below. +</para> + +<para> +<screenshot> +<screeninfo>Screenshot of &kworldclock; with expanded window</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="screenshot-mlb.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Screenshot showing expanded window, with Melbourne +selected.</phrase> + </textobject> + </mediaobject> +</screenshot> +</para> + +</sect1> + +<sect1 id="kworldclock-clocks"><title>Configuring &kworldclock; with timezone clocks</title> + +<para> +If you need to know the time in a number of areas around the world, it +may be useful to have &kworldclock; show the applicable times. An +example of how this can look is shown below. +</para> + +<para> +<screenshot> +<screeninfo>Screenshot of &kworldclock; with clocks</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="screenshot-withclocks.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Screenshot showing expanded window, with three clocks.</phrase> + </textobject> + </mediaobject> +</screenshot> +</para> + +<para> +Note the clocks for Perth, Sydney and Berlin at the bottom of the main +&kworldclock; window. +</para> + +<para> +These clocks are added by using the right mouse button, and selecting +the <guilabel>Clock</guilabel> entry, as shown below. +</para> + +<para> +<screenshot> +<screeninfo>Screenshot of &kworldclock; &RMB; clock</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="screenshot-rmb-clock.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Screenshot showing &RMB; menu, with +<guilabel>Clock</guilabel> selected.</phrase> + </textobject> + </mediaobject> +</screenshot> +</para> + +<para> +This will allow access to the <guilabel>Add...</guilabel> selection, +which will bring up a dialog box as shown below. The contents of the +dialog box are determined from the closest city to the mouse cursor +when you make the selection. +</para> + +<para> +<screenshot> +<screeninfo>Screenshot of &kworldclock; <guilabel>Edit Clock +Settings</guilabel> dialog</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="screenshot-clock-dialog.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Screenshot showing<guilabel>Edit Clock +Settings</guilabel> dialog.</phrase> + </textobject> + </mediaobject> +</screenshot> +</para> + + +<para> +You can now make an appropriate selection for the clock label and the +timezone. Note that you can change the label to whatever is +appropriate, and the timezone as required. An example, for the small +Australian town of Quairading, is shown below. +</para> + +<para> +<screenshot> +<screeninfo>Screenshot of &kworldclock; <guilabel>Edit Clock +Settings</guilabel> dialog changed to Quairading</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="screenshot-quairading-dialog.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Screenshot showing <guilabel>Edit Clock +Settings</guilabel> dialog for Quairading.</phrase> + </textobject> + </mediaobject> +</screenshot> +</para> + +<para> +When you select OK, the clock entry is added to those at the bottom of +the main window. A screenshot, with the extra entry for Quairading, is +shown below. +</para> + +<para> +<screenshot> +<screeninfo>Screenshot of &kworldclock; with Quairading clock</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="screenshot-quairading-clock.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Screenshot showing Quairading clock.</phrase> + </textobject> + </mediaobject> +</screenshot> +</para> + +<para> +You might notice that Perth and Quairading are now showing the same +information (since they are in the same timezone). In this case, the +Perth entry is no longer required, so it can be removed. This can be +done by again using the right mouse button on the clock display, and selecting +the <guilabel>Remove</guilabel> item. +</para> + +<para> +You can also edit entries by using the <guilabel>Edit...</guilabel> +entry on right mouse button menu, which may be useful for making +minor changes. +</para> + +</sect1> + +<sect1 id="kworldclock-flags"><title>Adding Flags to the &kworldclock; display</title> + +<para> +As shown in the screenshot below, you can add flags to places on the +map (in this case, Fremantle near Perth, Western Australia; near +Moscow in Russia; and the Azores in the mid-Atlantic). These flags +don't affect any other functionality - they just allows you to quickly +locate places of interest. +</para> + +<para> +<screenshot> +<screeninfo>Screenshot of &kworldclock; with flags</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="screenshot-withflags.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Screenshot showing expanded window, with three flags.</phrase> + </textobject> + </mediaobject> +</screenshot> +</para> + +<para> +You add flags by locating the mouse at the point where you want to +appear, and using the right mouse button to select the the +<guilabel>Flags...</guilabel> entry. You can select one of the three +pre-defined flag colours (that is, <guilabel>Add Red</guilabel>, +<guilabel>Add Green</guilabel> or <guilabel>Add Blue</guilabel>), or +you can select a custom colour. +</para> + +<para> +You use the same menu action to remove just one flag (whichever one is +closest to the mouse when you make the <guilabel>Remove +Flag</guilabel> selection; or to remove all the flags, using the +<guilabel>Remove All Flags</guilabel>. +</para> + +</sect1> + +<sect1 id="kworldclock-display"><title>Changing the &kworldclock; display</title> + +<para> +In addition to the additional clocks and flags, there are other minor +variations you can make to the main &kworldclock; display, such as not +showing the flags, not showing the small black city squares, and not +showing the day/night areas. Each of these is selected using the right +mouse button menu. +</para> + +<para> +To enable and disable the display of the day / night sections, you use +the right mouse button, and select the <guilabel>Show +Daylight</guilabel> item from the menu. Each time you select it, the +selection will be toggled. When showing day and night is enabled +(normal mode on first startup), there will be a small check mark +(tick symbol) next to the <guilabel>Show Daylight</guilabel>. An +example of the menu item (with day / night not enabled, hence no check +mark) is shown below. +</para> + +<para> +<screenshot> +<screeninfo>Screenshot of &kworldclock; &RMB; daylight</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="screenshot-rmb-daylight.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Screenshot showing &RMB; menu, with +<guilabel>Show Daylight</guilabel> selected.</phrase> + </textobject> + </mediaobject> +</screenshot> +</para> + + +<para> +To enable and disable the display of the small black city squares, you use +the right mouse button, and select the <guilabel>Show +Cities</guilabel> item from the menu. Each time you select it, the +selection will be toggled. When showing cities is enabled +(normal mode on first startup), there will be a small check mark +(tick symbol) next to the <guilabel>Show Cities</guilabel>. An +example of the menu item (with city display enabled, hence a check +mark) is shown below. +</para> + +<para> +<screenshot> +<screeninfo>Screenshot of &kworldclock; &RMB; show cities</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="screenshot-rmb-cities.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Screenshot showing &RMB; menu, with +<guilabel>Show Cities</guilabel> selected.</phrase> + </textobject> + </mediaobject> +</screenshot> +</para> + +<para> +To enable and disable the display of the flags, you use +the right mouse button, and select the <guilabel>Show +Flags</guilabel> item from the menu. Each time you select it, the +selection will be toggled. When showing flags is enabled +(normal mode on first startup), there will be a small check mark +(tick symbol) next to the <guilabel>Show Flags</guilabel>. An +example of the menu item (with flags enabled, hence a check +mark) is shown below. +</para> + +<para> +<screenshot> +<screeninfo>Screenshot of &kworldclock; &RMB; show flags</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="screenshot-rmb-flags.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Screenshot showing &RMB; menu, with +<guilabel>Show Flags</guilabel> selected.</phrase> + </textobject> + </mediaobject> +</screenshot> +</para> + +<para> +After reconfiguring &kworldclock;, you may wish to save your +settings. This is done using the right mouse button, and selecting the +<guilabel>Save Settings</guilabel> option. +</para> + +</sect1> + +<sect1 id="kworldclock-maps"><title>Selecting alternative maps</title> +<para> +In addition to the normal surface depth map, you can add additional +maps, which can be selected using the <guilabel>Map Theme</guilabel> +item from the right mouse button menu. &kworldclock; comes with a +single map, which provides surface depth (relief). Additional maps can be obtained from +<ulink url="http://www.radcyberzine.com/xglobe">http://www.radcyberzine.com/xglobe</ulink>. +Maps need to be appropriately installed - typically into +<filename>share/apps/kworldclock/maps</filename> under the main &kde; +directory. Consult your system administrator for assistance in doing +this, if required. +</para> + +<para> +If you want to use your own map, you should make sure +that Greenwich is exactly in the middle of the map, and provide an +appropriate desktop file. +</para> + +</sect1> + +</chapter> + +<chapter id="developers"> +<title>Developer's Guide to &kworldclock;</title> + +<para> +The most common requirement for development of &kworldclock; is to add +additional cities to the map. The cities are determined by a file +named <filename>zone.tab</filename>, which is located under +<filename>share/apps/kworldclock</filename> under the main &kde; +directory. +</para> + +<para> +To add an additional city, you need to know the latitude and +longitude, and also the applicable time zone information. There is +additional information on the exact format required in the +<filename>zone.tab</filename> file. +</para> + +</chapter> + +<chapter id="credits"> +<title>Credits and License</title> + +<para> +&kworldclock; +</para> +<para> +Program copyright 2000 Matthias Hoelzer-Kluepfel. +</para> + +<para> +Documentation Copyright © 2004 &Brad.Hards; &Brad.Hards.mail;. +</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; <!-- FDL: do not remove --> + + +&underGPL; <!-- GPL License --> +</chapter> + +<appendix id="installation"> +<title>Installation</title> + +<sect1 id="getting-kapp"> +<title>How to obtain &kworldclock;</title> + + + +&install.intro.documentation; + +</sect1> + +<sect1 id="compilation"> +<title>Compilation and Installation</title> + + +&install.compile.documentation; + +</sect1> + +</appendix> + +&documentation.index; +</book> + +<!-- +Local Variables: +mode: xml +sgml-minimize-attributes:nil +sgml-general-insert-case:lower +sgml-indent-step:0 +sgml-indent-data:nil +End: + +--> diff --git a/doc/kworldclock/man-kworldclock.1.docbook b/doc/kworldclock/man-kworldclock.1.docbook new file mode 100644 index 0000000..a002159 --- /dev/null +++ b/doc/kworldclock/man-kworldclock.1.docbook @@ -0,0 +1,92 @@ +<?xml version="1.0" ?> +<!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ +<!ENTITY % English "INCLUDE"> +]> + +<refentry lang="&language;"> +<refentryinfo> + <author><personname><firstname>Ben</firstname><surname>Burton</surname></personname> <email>bab@debian.org</email></author> +<date>April 8, 2003</date> +</refentryinfo> + +<refmeta> +<refentrytitle><command>kworldclock</command></refentrytitle> +<manvolnum>1</manvolnum> +</refmeta> + +<refnamediv> +<refname><command>kworldclock</command></refname> +<refpurpose>Earth watcher for &kde;</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<cmdsynopsis> +<command>kworldclock</command> + +<group><option>--dump</option></group> +<group><option>--theme</option> +<replaceable>file</replaceable></group> +<group><option>-o</option> <replaceable>file</replaceable></group> +<group><option>--size</option> +<arg>WxH</arg></group> +<group><option>KDE Generic Options</option></group> +<group><option>Qt Generic Options</option></group> + +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1> +<title>Description</title> + +<para>&kworldclock; displays where in the world it is light and dark +depending on time, as well as offering the time in all of the major +cities of the world. This can be run standalone, as an applet in the +&kde; panel, or configured to draw the desktop background.</para> + +<para>&kworldclock; is part of the official &kde; kdetoys +package.</para> + +</refsect1> + +<refsect1> +<title>Options</title> + +<variablelist> +<varlistentry> +<term><option>--dump</option></term> +<listitem><para>Write out a file containing the actual +map</para></listitem> +</varlistentry> +<varlistentry> +<term><option>--theme</option> <replaceable>file</replaceable></term> +<listitem><para>The name of the theme to use for a map dump (default: +earth).</para></listitem> +</varlistentry> +<varlistentry> +<term><option>-o</option> <replaceable>file</replaceable></term> +<listitem><para>The name of the file to write to for a map dump +(default: dump.ppm).</para></listitem> +</varlistentry> +<varlistentry> +<term><option>--size</option> <replaceable>WxH</replaceable></term> +<listitem><para>The size of the map to dump.</para></listitem> +</varlistentry> +</variablelist> + +</refsect1> + +<refsect1> +<title>See Also</title> + +<para>More detailed user documentation is available from <ulink +url="help:/kworldclock">help:/kworldclock</ulink> (either enter this +<acronym>URL</acronym> into &konqueror;, or run +<userinput><command>khelpcenter</command> +<parameter>help:/kworldclock</parameter></userinput>).</para> + +</refsect1> +<refsect1><title>Authors</title><para>&kworldclock; was written by +&Matthias.Hoelzer-Kluepfel; +&Matthias.Hoelzer-Kluepfel.mail;</para><para>This manual page was +prepared by <personname><firstname>Ben</firstname><surname>Burton</surname></personname> <email>bab@debian.org</email></para></refsect1> +</refentry> diff --git a/doc/kworldclock/screenshot-clock-dialog.png b/doc/kworldclock/screenshot-clock-dialog.png Binary files differnew file mode 100644 index 0000000..7477ef6 --- /dev/null +++ b/doc/kworldclock/screenshot-clock-dialog.png diff --git a/doc/kworldclock/screenshot-mlb.png b/doc/kworldclock/screenshot-mlb.png Binary files differnew file mode 100644 index 0000000..8d3c54c --- /dev/null +++ b/doc/kworldclock/screenshot-mlb.png diff --git a/doc/kworldclock/screenshot-quairading-clock.png b/doc/kworldclock/screenshot-quairading-clock.png Binary files differnew file mode 100644 index 0000000..8ab7d23 --- /dev/null +++ b/doc/kworldclock/screenshot-quairading-clock.png diff --git a/doc/kworldclock/screenshot-quairading-dialog.png b/doc/kworldclock/screenshot-quairading-dialog.png Binary files differnew file mode 100644 index 0000000..17bda5e --- /dev/null +++ b/doc/kworldclock/screenshot-quairading-dialog.png diff --git a/doc/kworldclock/screenshot-rmb-cities.png b/doc/kworldclock/screenshot-rmb-cities.png Binary files differnew file mode 100644 index 0000000..14c6048 --- /dev/null +++ b/doc/kworldclock/screenshot-rmb-cities.png diff --git a/doc/kworldclock/screenshot-rmb-clock.png b/doc/kworldclock/screenshot-rmb-clock.png Binary files differnew file mode 100644 index 0000000..4f35d24 --- /dev/null +++ b/doc/kworldclock/screenshot-rmb-clock.png diff --git a/doc/kworldclock/screenshot-rmb-daylight.png b/doc/kworldclock/screenshot-rmb-daylight.png Binary files differnew file mode 100644 index 0000000..6371b88 --- /dev/null +++ b/doc/kworldclock/screenshot-rmb-daylight.png diff --git a/doc/kworldclock/screenshot-rmb-flags.png b/doc/kworldclock/screenshot-rmb-flags.png Binary files differnew file mode 100644 index 0000000..17eec15 --- /dev/null +++ b/doc/kworldclock/screenshot-rmb-flags.png diff --git a/doc/kworldclock/screenshot-withclocks.png b/doc/kworldclock/screenshot-withclocks.png Binary files differnew file mode 100644 index 0000000..73f71a1 --- /dev/null +++ b/doc/kworldclock/screenshot-withclocks.png diff --git a/doc/kworldclock/screenshot-withflags.png b/doc/kworldclock/screenshot-withflags.png Binary files differnew file mode 100644 index 0000000..d1efbec --- /dev/null +++ b/doc/kworldclock/screenshot-withflags.png diff --git a/doc/kworldclock/screenshot.png b/doc/kworldclock/screenshot.png Binary files differnew file mode 100644 index 0000000..3b342ff --- /dev/null +++ b/doc/kworldclock/screenshot.png |
