Warning, /games/amor/doc/index.docbook is written in an unsupported language. File is not indexed.

0001 <?xml version="1.0" ?>
0002 <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
0003   <!ENTITY kappname "&amor;">
0004   <!ENTITY % addindex "IGNORE">
0005   <!ENTITY % English "INCLUDE">
0006 ]>
0007 
0008 <book id="amor" lang="&language;">
0009 <bookinfo>
0010 <title>The &amor; Handbook</title>
0011 
0012 <authorgroup>
0013 <author>
0014 &Karl.Garrison; &Karl.Garrison.mail;
0015 </author>
0016 
0017 <!-- TRANS:ROLES_OF_TRANSLATORS -->
0018 </authorgroup>
0019 
0020 <copyright>
0021 <year>2001</year>
0022 <holder>&Karl.Garrison;</holder>
0023 </copyright>
0024 
0025 <legalnotice>&FDLNotice;</legalnotice>
0026 
0027 <date>2021-10-09</date>
0028 <releaseinfo>2.4.0 (KDE Gear 21.08)</releaseinfo>
0029 
0030 <abstract>
0031 <para>
0032 &amor; is a small animation which sits on top of your active window.
0033 </para>
0034 </abstract>
0035 
0036 <keywordset>
0037 <keyword>KDE</keyword>
0038 <keyword>amor</keyword>
0039 <keyword>helper</keyword>
0040 <keyword>assistant</keyword>
0041 </keywordset>
0042 
0043 </bookinfo>
0044 
0045 <chapter id="introduction">
0046 <title>Introduction</title>
0047 
0048 <sect1 id="whats-amor">
0049 <title>What's &amor;?</title>
0050 <para>
0051 &amor; is an acronym which stands for Amusing Misuse of Resources.  It is
0052 actually an animation which sits on top of your active window.  In its default
0053 configuration, &amor; takes the form of a yellow spot which performs many
0054 tricks.  &amor; also has many different themes which change the appearance
0055 and behavior of the animation.
0056 </para>
0057 
0058 <note><para>Since &amor; works with the &kde; window manager &kwin;, the
0059 application will only work from within &plasma;.  It is possible that &amor;
0060 would work from within another &plasma;-compliant window manager, but none are
0061 known to work at the time of this writing.</para></note>
0062 </sect1>
0063 </chapter>
0064 
0065 <chapter id="configuration">
0066 <title>Configuration</title>
0067 <sect1 id="configuring-amor">
0068 <title>Configuring &amor;</title>
0069 <para>To configure &amor;, click on the animation using your &RMB;.  A menu
0070 will appear containing three items:
0071 <guimenuitem>Configure...</guimenuitem>,
0072 <guisubmenu>Help</guisubmenu>, and
0073 <guimenuitem>Quit</guimenuitem>.</para>
0074 <para>Choose <guimenuitem>Configure...</guimenuitem> to configure &amor;.</para>
0075 </sect1>
0076 
0077 <sect1 id="general-options">
0078 <title>General Options</title>
0079 <para>The following settings for &amor; can be changed from the Options
0080 dialog:</para>
0081 <variablelist>
0082 <varlistentry><term><guilabel>Theme:</guilabel></term>
0083 <listitem><para>This determines the appearance and behavior of &amor;.
0084 Themes are described in the next section.</para></listitem>
0085 </varlistentry>
0086 <varlistentry><term><guilabel>Offset:</guilabel></term>
0087 <listitem><para>This slider controls where the animation appears in
0088 relation to the top of the active window.  The default middle setting will
0089 place the animation right above the window title bar, whereas setting the
0090 slider all the way to the top or bottom will result in the animation
0091 appearing a fair distance above or below the title bar, respectively.</para>
0092 <tip><para>Setting this slider to a lower setting will allow the
0093 animation to be visible even when the active window is maximized.</para>
0094 </tip></listitem>
0095 </varlistentry>
0096 <varlistentry><term><guilabel>Always on top</guilabel></term>
0097 <listitem><para>Checking this option will cause the animation to always
0098 appear in front of any existing windows on the screen, including the
0099 panel.</para></listitem>
0100 </varlistentry>
0101 <varlistentry><term><guilabel>Show random tips</guilabel></term>
0102 <listitem><para>If checked, the animation will display various
0103 &kde;-related tips at random intervals.</para></listitem>
0104 </varlistentry>
0105 <varlistentry><term><guilabel>Use random character</guilabel></term>
0106 <listitem><para>If checked, the theme selection is disabled, it will be
0107 changed randomly.</para></listitem>
0108 </varlistentry>
0109 <varlistentry><term><guilabel>Allow application tips</guilabel></term>
0110 <listitem><para>Any &kde; application can be designed to display helpful
0111 tips via &amor;.  If this option is checked, and an appropriate
0112 application is the active window, the animation will display tips for that
0113 application.</para>
0114 <note><para>At the time of this writing, no &kde; applications make use of
0115 this functionality.</para></note></listitem>
0116 </varlistentry>
0117 </variablelist>
0118 </sect1>
0119 
0120 <sect1 id="amor-themes">
0121 <title>&amor; Themes</title>
0122 <para>&amor; comes with many built-in themes, which change the appearance and
0123 behavior of the animation.  In addition, it is possible to create new
0124 &amor; themes.  The built-in themes for &amor; are described in the table
0125 below</para>
0126 
0127 <table>
0128 <title>Available &amor; Themes</title>
0129 <tgroup cols="3">
0130 <thead>
0131 <row>
0132 <entry>Theme</entry>
0133 <entry>Name</entry>
0134 <entry>Description</entry>
0135 </row>
0136 </thead>
0137 <tbody>
0138 
0139 <row>
0140 <entry><mediaobject><imageobject>
0141           <imagedata  format="PNG" fileref="spot.png"/>
0142         </imageobject></mediaobject>
0143 </entry>
0144 <entry><phrase>Multi-Talented Spot</phrase></entry>
0145 <entry><para>This is the default theme for &amor;, and also the one with
0146 the most <quote>tricks</quote>.  This theme was created by &Martin.R.Jones;.  The jet-pack, beaming, and fire animations were contributed by
0147 <personname><firstname>Mark</firstname><surname>Grant</surname></personname>.</para></entry>
0148 </row>
0149 
0150 <row>
0151 <entry>
0152 <mediaobject><imageobject>
0153 <imagedata format="PNG" fileref="ghost.png"/>
0154 </imageobject></mediaobject>
0155 </entry>
0156 <entry><phrase>Spooky Ghost</phrase></entry>
0157 <entry><para>A ghost theme based-on the &kde;
0158 <application>ghostview</application> icon.  Spooky Ghost was created by
0159 &Martin.R.Jones;.</para></entry>
0160 </row>
0161 
0162 <row>
0163 <entry>
0164 <mediaobject><imageobject>
0165 <imagedata format="PNG" fileref="eyes.png"/>
0166 </imageobject></mediaobject>
0167 </entry>
0168 <entry><phrase>Crazy Eyes</phrase></entry>
0169 <entry><para>This theme consists of a moving pair of eyes, and was created
0170 by <personname><firstname>Jean-Claude</firstname><surname>Dumas</surname></personname>.</para></entry>
0171 </row>
0172 
0173 <row>
0174 <entry>
0175 <mediaobject><imageobject>
0176 <imagedata format="PNG" fileref="bonhomme.png"/>
0177 </imageobject></mediaobject>
0178 </entry>
0179 <entry><phrase>Bonhomme</phrase></entry>
0180 <entry><para>A stick-figure animation, created by <personname><firstname>Jean-Claude</firstname><surname>Dumas</surname></personname>.</para></entry>
0181 </row>
0182 
0183 <row>
0184 <entry>
0185 <mediaobject><imageobject>
0186 <imagedata format="PNG" fileref="neko.png"/>
0187 </imageobject></mediaobject>
0188 </entry>
0189 <entry><phrase>Neko</phrase></entry>
0190 <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
0191 <personname><firstname>Masayuki</firstname><surname>Koba</surname></personname>.</para>
0192 <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="http://www.daidouji.com/oneko/">oneko-sakura</ulink> is a modified version.</para></note></entry>
0193 </row>
0194 
0195 <row>
0196 <entry>
0197 <mediaobject><imageobject>
0198 <imagedata format="PNG" fileref="pingus.png"/>
0199 </imageobject></mediaobject>
0200 </entry>
0201 <entry><phrase>Tux</phrase></entry>
0202 <entry><para>This theme features Tux, the &Linux; mascot.  The actual
0203 graphics come from a <application>Lemmings</application>-style game
0204 called <ulink url="https://pingus.seul.org/">
0205 <application>Pingus</application></ulink>.  The Tux theme was created by
0206 <personname><firstname>Frank</firstname><surname>Pieczynski</surname></personname>.</para></entry>
0207 </row>
0208 
0209 <row>
0210 <entry>
0211 <mediaobject><imageobject>
0212 <imagedata format="PNG" fileref="worm.png"/>
0213 </imageobject></mediaobject>
0214 </entry>
0215 <entry><phrase>Little Worm</phrase></entry>
0216 <entry><para>A small inchworm theme.  Created by <personname><firstname>Bartosz</firstname><surname>Trudnowski</surname></personname> for
0217 his wife.</para></entry>
0218 </row>
0219 
0220 <row>
0221 <entry>
0222 <mediaobject><imageobject>
0223 <imagedata format="PNG" fileref="billy.png"/>
0224 </imageobject></mediaobject>
0225 </entry>
0226 <entry><phrase>Little Billy</phrase></entry>
0227 <entry><para>A static image taken from the game
0228 <ulink url="http://www.xbill.org/"><application>XBill</application>
0229 </ulink>.</para></entry>
0230 </row>
0231 
0232 <row>
0233 <entry>
0234 <mediaobject><imageobject>
0235 <imagedata format="PNG" fileref="bsd.png"/>
0236 </imageobject></mediaobject>
0237 </entry>
0238 <entry><phrase>FreeBSD Mascot</phrase></entry>
0239 <entry><para>A static image of Beastie, the FreeBSD daemon.</para></entry>
0240 </row>
0241 
0242 <row>
0243 <entry>
0244 <mediaobject><imageobject>
0245 <imagedata format="PNG" fileref="tux.png"/>
0246 </imageobject></mediaobject>
0247 </entry>
0248 <entry><phrase>Unanimated Tux</phrase></entry>
0249 <entry><para>An unanimated version of the Tux theme.</para></entry>
0250 </row>
0251 
0252 <row>
0253 <entry>
0254 <mediaobject><imageobject>
0255 <imagedata format="PNG" fileref="tao.png"/>
0256 </imageobject></mediaobject>
0257 </entry>
0258 <entry><phrase>Tao</phrase></entry>
0259 <entry><para>The Tao theme is an animated Yin Yang symbol.  This theme was
0260 created by <personname><firstname>Daniel</firstname><surname>Pfeiffer</surname></personname> <email>occitan@esperanto.org</email>, and was
0261 inspired by his Tai Chi practice.</para></entry>
0262 </row>
0263 </tbody>
0264 </tgroup>
0265 </table>
0266 
0267 </sect1>
0268 </chapter>
0269 
0270 <chapter id="credits">
0271 <title>Credits and License</title>
0272 
0273 <para>&amor;</para>
0274 
0275 <para>Program Copyright &copy; 1999-2001 &Martin.R.Jones;
0276 &Martin.R.Jones.mail;</para>
0277 
0278 <para>Documentation Copyright &copy; 2001 &Karl.Garrison;
0279 &Karl.Garrison.mail;</para>
0280 
0281 <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
0282 &underFDL;
0283 &underGPL;
0284 </chapter>
0285 
0286 &documentation.index;
0287 
0288 </book>
0289 
0290 <!--
0291 Local Variables:
0292 mode: sgml
0293 sgml-minimize-attributes:nil
0294 sgml-general-insert-case:lower
0295 sgml-indent-step:0
0296 sgml-indent-data:nil
0297 End:
0298 
0299 // vim:ts=0:sw=2:tw=78:noet
0300 -->