What is it?
-----------

wmtrace is a window manager tracer for a X11/UNIX system. It logs your
activity, but preserve your private life (e.g., the logs say that you
use mozilla, but the web pages you browse are not logged; the logs say
when you type a key, but the key is not specified ...etc.).

The idea is to study these logs (with some tools) and to use this study
(among other things) to improve our window managers.

wmtrace is a free software developed under the GNU General Public License
(http://www.gnu.org/copyleft/gpl.html) and the CeCILL License
(http://www.cecill.info/index.fr.html). This program is distributed
under the GNU General Public License.  The source code contains a
copy of the GNU GPL, COPYING, and copies of the CeCILL, one in french
CeCILL.fr and one in english CeCILL.en.

wmtrace is developed by Olivier Chapuis and Matthieu Langet as part of
the In Situ research project (http://insitu.lri.fr/).


Download:
---------

Latest source code and RPM here:

  http://insitu.lri.fr/~chapuis/software/wmtrace/


Install:
--------

With the tarball:
	
	cd some_where
	tar xjvf where_you_download/wmtrace-x.y.tar.bz2
	cd wmtrace-x.y
	./configure [--prefix=where_you_want_to_install]
	make
	su (if needed)
	make install

With the rpm:

	su
	rpm -Uvh where_you_download/wmtrace-x.y-z.i586.rpm
	exit


Using:
------

wmtrace need the XRecord extension. You should have the line

	load "record"

in the module section of your X configuration file (/etc/X11/XF86Config[-4]
or /etc/X11/xorg.conf[-4] if you use XFree or Xorg).

Moreover, you should use an EWMH compliant window manager (as kwin
(KDE), metacity (GNOME), FVWM 2.5.x, sawfish, IceWM, latest E16,
latest WindowMaker, ...etc.).

The first time you run wmtrace, run it from a console as:

	wmtrace -u

If one of the two previous requirement is not satisfied, then an error
message is printed. Edit your X configuration file or upgrade your
window manager, restart your X server and try again.

In any case abort "wmtrace -u" (by typing Ctl-C). If you get no
errors, start again wmtrace as:

	wmtrace &

for this first session. 

Then, you may want to start wmtrace automatically for the next X
sessions.

First method: you use the ~/.xession or ~/.xinitrc file for starting
your X session. Then, just add "wmtrace-autostart" at the beginning of
this file. See below to enable/disable wmtrace.

Second method: you have installed wmtrace from the rpm and you use a
Fedora-Mandrake like distribution. Nothing to do, see below to enable
wmtrace.

Last method: you have installed from source and you use a
Fedora-Mandrake like distribution. Then, copy the file
etc/wmtrace-xinit that you can found in the source into one of the
following directory:

	/etc/X11/xinit.d/
	/etc/X11/xinit/xinitrc.d/

use the one which exists (or both). See below to enable/disable wmtrace.


Enabling and disabling logs:
----------------------------

Type "wmtrace-on" in a console to enable wmtrace for the next X
sessions. If, later, you want to disable wmtrace just type
"wmtrace-off" in a console.


And After:
----------

wmtrace puts its logs under ~/.wmtrace/. If it has the time it
compresses these logs and move them under ~/.wmtrace/archive/.

The logs are large, typically several Megabits. If you have some
uncompressed logs under ~/.wmtrace/ you can compress and move
them under ~/.wmtrace/archive/. BUT DO NOT COMPRESS THE CURRENT LOG
FILE (type ls -l ~/.wmtrace/ and do not compress and move the file
with the more recent date).

Then, someday (after one week of use), puts all these logs somewhere in
the Internet and send the URL to chapuis@lri.fr (with a valid From or
Reply address so that I can ask you a few questions).

Thanks!