<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook V3.1-Based Variant V1.0//EN" [
 <!ENTITY kappname "&kodo;" -- this only *seems* redundant -->
 <!ENTITY % addindex "IGNORE">
 <!ENTITY % English "INCLUDE">
 <!ENTITY % ents PUBLIC "-//KDE//ENTITIES Documentation V1.0//EN">
 %ents;
]>

<book lang="&language;">
<bookinfo>
<title>The &kodo; Handbook</title>
<authorgroup>
<author>
<firstname>Armen</firstname>
<surname>Nakashian</surname>
<affiliation>
<address><email>armen@tourismo.com</email></address>
</affiliation>
</author>
</authorgroup>
<date>23/07/1999</date>
<releaseinfo>1.00.00</releaseinfo>
<abstract>
<para>This Handbook describes KOdometer</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="WhatsKOdometer">
<title>What's KOdometer</title>

<para>Kodometer <emphasis remap="bf">Measures your Desktop Milage</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.  Its most exciting
feature is the tripometer, and its utter uselessness.</para>

<para><emphasis remap="bf">Note: The next version will be USEFUL!</emphasis></para>
</sect1>
</chapter>

<chapter id="Installation">
<title>Installation</title>
<sect1 id="HowtoobtainKOdometer">
<title>How to obtain KOdometer</title>

<para>KOdometer is a toy application of the KDE project <ulink url="http://www.kde.org">http://www.kde.org</ulink>.
It can be found on <ulink url="ftp://ftp.kde.org/pub/kde/">ftp://ftp.kde.org/pub/kde/</ulink>, the main ftp site
of the KDE project, in the kdenonbeta snapshots. Please consider using your nearest mirror ftp site to get the load away from the server.</para>
</sect1>
<sect1 id="Compilationandinstallation">
<title>Compilation and installation</title>

<para>In order to compile and install KOdometer on your system, type the following in the base directory of the KOdometer distribution:
<screen>% ./configure
% make
% make install
</screen>
</para>

<para>Since KOdometer uses <literal remap="tt">autoconf</literal> you should have not trouble compiling it.
Should you run into problems, please report them to my email address <ulink url="mailto:armen@tourismo.com">armen@tourismo.com</ulink>.</para>
</sect1>
</chapter>

<chapter id="Onscreenoperation">
<title>Onscreen operation</title>

<para><emphasis>A screen shot. Note the fashionable lack of a titlebar.</emphasis></para>

    <screenshot>
      <mediaobject>
	<imageobject>
	  <imagedata fileref="guide.png" format="PNG">
	</imageobject>
      </mediaobject>
    </screenshot>


<para>The <emphasis remap="bf">Odometer</emphasis> is the total distance traveled by the mouse since
the last odometer reset.  The <emphasis remap="bf">Tripometer</emphasis> is the distance
traveled by the mouse since:
<itemizedlist>
<listitem>
<para> The Tripometer was reset.</para>
</listitem>
<listitem>
<para> Kodometer was restarted, with the Auto Reset Trip flag on.</para>
</listitem>
</itemizedlist>
</para>
<sect1 id="MenuOptions">
<title>Menu Options</title>

<para>If you've gotten this far, you already know that there is a
mouse-button context menu on Kodometer, which contains a number of
choices.</para>

<para><itemizedlist>
<listitem>
<para><emphasis remap="bf">Enable</emphasis>
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>
<listitem>
<para><emphasis remap="bf">Metric Display</emphasis>
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>
<listitem>
<para><emphasis remap="bf">Auto Reset Trip</emphasis>
This option will cause Kodometer to set the Tripometer back
to zero every time it starts up. </para>
</listitem>
<listitem>
<para><emphasis remap="bf">Reset Trip</emphasis>
Set the tripometer to zero.</para>
</listitem>
<listitem>
<para><emphasis remap="bf">Reset Odometer</emphasis>
Set the odometer back to zero. <emphasis>You might get in trouble
for this!</emphasis></para>
</listitem>
</itemizedlist>
</para>
</sect1>
</chapter>

<chapter id="HowItWorks">
<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 remap="bf">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&percnt; off!  The
original author's response to this complaint was 'who cares?'.</para>
</chapter>
</book>
<!--
Local Variables:
mode: sgml
sgml-omittag: nil
sgml-shorttag: t
End:
-->
