<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.1-Based Variant V1.0//EN" "dtd/kdex.dtd" [
  <!ENTITY kdevmon "&kdevmon;">
  <!ENTITY % addindex "IGNORE">
  <!ENTITY % English "INCLUDE">
]>

<book lang="&language;">

<bookinfo>
<title>The Kdevmon Handbook</title>

<authorgroup>
<author>
<firstname>Henning</firstname>
<surname>Burchardt</surname>
<affiliation>
<address><email>h_burchardt@gmx.de</email></address>
</affiliation>
</author>
</authorgroup>

<copyright>
<year>2001</year>
<holder>Henning Burchardt</holder>
</copyright>

<date>16/03/2001</date>
<releaseinfo>0.04.03</releaseinfo>

<abstract>
<para>
Kdevmon is a utility for KDE that monitors the throughput of a network device.
</para>
</abstract>

<keywordset>
<keyword>kdevmon</keyword>
<keyword>network</keyword>
<keyword>traffic</keyword>
</keywordset>

</bookinfo>

<chapter id="introduction">
<title>Introduction</title>

<para>
Kdevmon is a utility for KDE that monitors the throughput of a network device.
It docks in Kicker (the panel of KDE 2) and shows the current network traffic
as a diagram. There also is a resizable main window that provides a larger
traffic diagram and displays the current net speed in bits per second.
Middle-clicking on the dock window or on the main window offers you an
overview of the amount of incoming/outgoing bits and the current and the
maximum bit rate.
</para>

<para>
Please report
any problems or feature requests to Henning Burchardt
<email>h_burchardt@gmx.de</email>
</para>

</chapter>

<chapter id="installation">
<title>Installation</title>

<sect1 id="howtoobtain">
<title>How to obtain Kdevmon</title>
<para>
Kdevmon can be found on
<ulink url="http://www.Informatik.Uni-Oldenburg.DE/~bigboss/kdevmon/">
http://www.Informatik.Uni-Oldenburg.DE/~bigboss/kdevmon/
</ulink>
</para>
</sect1>

<sect1 id="requirements">
<title>Requirements</title>
<para>
In order to succesfully compile Kdevmon, you need 2.x libraries
(can be found on
<ulink url="ftp://ftp.kde.org/pub/kde/">
ftp://ftp.kde.org/pub/kde/
</ulink>
</para>
<para>
It is important that you have the qt and KDE headers installed,
otherwise Kdevmon will not compile.
).
</para>
</sect1>

<sect1 id="compilationandinstallation">
<title>Compilation and installation</title>
<para>
In order to compile and install Kdevmon on your system, execute the
following commands in the base  directory of the Kdevmon distribution:
</para>
<para>
<screen>
&gt; ./configure
&gt; make
&gt; make install
</screen>
</para>
<para>
Kdevmon uses <literal remap="tt">autoconf</literal> package and you should
have not trouble compiling it.
Should you run into problems please report them to the author of program.
</para>
</sect1>

</chapter>

<chapter id="workingwith">
<title>Working with Kdevmon</title>

<sect1 id="windows">
<title>Windows</title>
<para>
Kdevmon has three windows: The main window, the dock window and a small stats
window
</para>
<para>
The main window shows a diagram for the network traffic and small frames
with a text and bar representation of the current throughput rate.
If you hold the mouse over
the diagram a tooltip appears that shows the throughput rate of a time a
few moments ago.
</para>
<para>
The dock window is a small window that shows the current traffic as a
diagram or as text. You can hide the dock window by selecting
"Hide dock window" in the popup menu.
Left-clicking on the dock window will show the main window.
</para>
<para>
The stats window shows the current and maximum traffic rate, and the total
amount of bytes which went through the network device. You can move the
stats window by dragging with the left mouse button pressed and close it by
right-clicking.
The stats window can be shown by middle-clicking on the main window or
dock window, or by selecting "Show stats window" from the popup menu.
</para>
</sect1>

<sect1 id="dialog">
<title>The preferences dialog</title>
<para>
You can invoke a preferences dialog by right-clicking on the dock window
or the main window and selecting "Preferences..." from the popup menu.
The options in the dialog are described in the dialog itself. Click on the
small "?" in the dialog title bar and then click on one of the labels.
</para>
</sect1>

<sect1 id="loading_saving">
<title>Loading and saving config files</title>
<para>
You can save a configuration by selecting "Save as..." from the popup menu.
Select a file name that ends with "rc". You can reload the configuration by
selecting "Load..." from the popup menu or by using a command line option
(See <link linkend="invoking">Invoking kdevmon</link>).
</para>
</sect1>

<sect1 id="invoking">
<title>Invoking kdevmon</title>
<para>
If you have different configuration files you can start multiple sessions of
kdevmon with the command line option "--config file".
"file" is the name of the configuration file (i.e "eth0rc") or
- if you did not store the file at the default location - the full path
(i.e. "/stuff/trash/eth0rc").
</para>
</sect1>

</chapter>

</book>