Xesam Tools, README
==========================================

LICENSE:
Xesam-tools is copyright Mikkel Kamstrup Erlandsen, March 2007
It is releassed under the GNU LGPL 2.1, please read the file COPYING
and make sure you understand the license.


ABOUT:
This software package provides Python packages to interface with Xesam[1]
compliant services as well as a command line tool to use directly.

It also features a framework for easily implementing xesam compliant
servers via the xesam.server package. There are two examples bundled
with this distribution. Namely demo/xesam-yahoo-service and
demo/xesam-dummy-service. Both include a small header describing
their usage.

The implementation uses gobject and the Python dbus bindings for the gobject
mainloop. There's no gui, only a command line application (xesam-tool).



INSTALLING:
Installing is done via the standard Python distutils. Run as root:

	python setup.py install


RUNNING:
To get help on the command line options run:

	xesam-tool help

To perform a search using the Xesam User Search Language[2] run:

	xesam-tool search foo bar

Note that you will have to escape quotation marks on phrases. To run a full
xml query as specified by the Xesam Query Language[3] run:

	xesam-tool query my_query.xml

Here my_query.xml is a file containing a valid Xesam query.

Session properties: Both the search and query options allow you to set
session properties via -P switches. Fx:

	xesam-tool query -Psearch.live=true Phit.fields=dc:title,snippet queries/hendrix_music.xml


REFERENCES:
[1]: http://wiki.freedesktop.org/wiki/XesamAbout
[2]: http://wiki.freedesktop.org/wiki/XesamUserSearchLanguage
[3]: http://wiki.freedesktop.org/wiki/XesamQueryLanguage


