<?xml version="1.0" ?> <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.1.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> <firstname>Karl</firstname> <surname>Garrison</surname> <affiliation> <address><email>karl@indy.rr.com</email></address> </affiliation> </author> </authorgroup> <!-- TRANS:ROLES_OF_TRANSLATORS --> <copyright> <year>2001</year> <holder>Karl Garrison</holder> </copyright> <legalnotice>&FDLNotice;</legalnotice> <date>2001-07-20</date> <releaseinfo>2.20.00</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 Mark Grant.</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 Jean-Claude Dumas.</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 Jean-Claude Dumas.</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 Chris Spiegel. The graphics are originally from <application>Oneko</application>, which was written by Masayuki Koba.</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 Frank Pieczynski.</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 Bartosz Trudnowski 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 Chuck, 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 Daniel Pfeiffer <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 <email>mjones@kde.org </email></para> <para>Documentation copyright 2001 Karl Garrison <email>karl@indy.rr.com </email></para> <!-- TRANS:CREDIT_FOR_TRANSLATORS --> &underFDL; &underGPL; </chapter> <appendix id="installation"> <title>Installation</title> <sect1 id="getting-amor"> <title>How to obtain &amor;</title> &install.intro.documentation; </sect1> <sect1 id="amor-requirements"> <title>Requirements</title> <para>You will need to have the kdelibs package installed in order to successfully compile the kdetoys package that contains &amor;. The kdelibs package may be found at the same location as the kdetoys package.</para> </sect1> <sect1 id="compilation"> <title>Compilation and Installation</title> &install.compile.documentation; </sect1> </appendix> </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 -->
