1@chapter Summary
2
3@section Summary
4  Xnee is a suite of programs that can record, replay and
5  distribute user actions under the X11 environment.
6  Think of it as a robot that can imitate the job you just
7  did.
8
9Xnee consists of one library and two applications
10
11  @b{cnee} - command line program
12
13  @b{gnee} - graphical user interface program
14
15  @b{pnee} - a Gnome Panel Applet
16
17  @b{libxnee} - library used by xnee and gnee
18
19
20
21@section Xnee features
22@cindex features
23
24Xnee can be used for multiple purposes, although it was initially designed as a test tool. The most used features are the foloowing:
25
26@b{Test tool} -
27        Instead of performing test cases for a GUI (or CLI program)
28        over and over again, the test cases can be automated. Simply record
29        a user session and replay it later.
30
31@b{Performance test tool} -
32	If you want to simulate lots of simultaneous users in a network (or
33	a local machine) you can use Xnee. Simply record a user
34	session and start multiple instances of Xnee.
35
36@b{Demonstration tool} -
37	You can use Xnee to demonstrate the features of your program. Simply
38	record a user session and replay it later.
39
40@b{Distribution tool} -
41	If you want to send over your mouse/keyboard actions to another display
42	you can use the built-in distribution mechanism in Xnee.
43
44@b{Macro recorder/replayer} -
45	By binding a key and modifier combination (e.g using xrebind)
46  to replay a recorded session you will have a Window Manager and
47  application independent macro.
48
49@b{File retyper} -
50   Xnee can retype the contents of a file. This can be useful
51   during tests or if you want xnee to answer some command
52   session without having to record the session.
53
54@b{X11 protocol sniffer} -
55   Xnee can be used as a sniffer for the X11 protocol.
56
57
58@section Background
59@cindex background
60In order to verify that a program does the job it's supposed to do,
61certain tests have to be made.
62These tests are, IMHO, perhaps the most boring things a programmer
63can do. Xnee is designed to reduce the programmer from this burden.
64@*
65
66Xnee started out as a commad line program. During the development
67phase the main functionality was broken out to a library, called
68libxnee. The command line program was renamed cnee. The thought behind
69making the library was to enable the writing of other clients than
70just the command line. Today there is a GUI program, gnee, and a Gnome
71panel applet, pnee, that uses the library.
72@*
73
74By using xnee your testcase(s) can be recorded and later on replayed.
75Xnee comes with other features For more information about these, read the
76Introduction.
77
78This manual mainly focuses on the command line program, cnee. There
79are however a seperate chapters for the other programs.
80
81
82
83