
-- README --


Introduction
------------

Xstat is a statistics generator. It analyses a log file and makes a web page
with tables and charts. For now, 12 different sorts of statistics are
available but another could be add. Suggestions are welcomed at :
julien.lesouef@free.fr.

To launch Xstat, simply type : xstat. A simple interface will appear which
allows you to configure the paramaters used to generate a web page of
statistics. Each statsitic can be configured. Just select a statistic and
click on the 'Configure...' button. A dialog will appear.

Then, a click on the 'Generate web page' button will analyse the log file and
make a web page of statistics.

When you click on the 'Generate web page' button or when you exit the program,
the configuration is saved in the file '.xstat' at your home directory, so
that you don't need to reconfigure all parameters once again.

A speeder and easier method to generate a web page is to use the command
'statistic' which doesn't need the GTK+ librairy. To use it, simply type :
statistic. It will generate a web page of statistics from the parameters saved
in the '.xstat' file. So you must have launched Xstat once before using this
command.


Screenshots
-----------

Screenshots are available at :

http://upsilon.free.fr/xstat/


Examples
--------

Examples are available at :

http://upsilon.free.fr/xstat/


Requirements
------------

 - A UNIX computer (Linux/BSD etc) and C compiler (gcc)
 - X11 (X Window System)
 - GTK+ 1.0.0+ (this is available at http://www.gtk.org)

You can build 'statistic' without GTK+.


Updates
-------

See the file CHANGES.

Latest version is available at :

http://upsilon.free.fr/xstat/


Installation
------------

To build xstat, see the file INSTALL.


Icons and images
----------------

_ An icon (xstat.xpm) and a mini-icon (mini/xstat.xpm) are available in the
directory 'icons/'.
_ A vertical bar, a horizontal bar and a background are available in the
directory 'images/' but you can create your own images to customize your web
page.


Known bugs
----------

See the file BUGS.


To-do list
----------

See the file TODO.


License
-------

Xstat is released under the GNU GPL (General Public License).
For more details, see the file COPYING.

