xfconf-4.8.0.0: README

Summary
=======

Haskell bindings to XFCE 4.8 xfconf settings daemon.

Original xfconf API documentation can be found on:
	http://docs.xfce.org/api/xfconf/

Requirement
===========

GHC and xfconf-devel/libxfconf obviously :)

You will need a fairly new version of haddock too (>= 2.8).

Cabal should take care of the rest.

Status
======

Presently, the whole thing is (almost) no more hackish. The system was
integrated with cabal, a set of QuickCheck tests prove the storing and
retrieving of large data sets to work properly and the XfconfChannel*
objects inherit from regular gtk2hs-glib.GObjects.

Only Tests/TestGlib.hs appears broken.

Example
=======

An application of this library can be found with hThemes[0], a small
utility to quickly save and load pre-configured xfconf settings (notably
wallpapers, gtk+2 & xfwm4 themes).

[0]: https://patch-tag.com/r/obbele/hThemes/home

How to build
============

Just try this:

	bash $ make            # shortcut for cabal configure -f buildTests
	                       #          and cabal build

How to use the Tests/*.hs binaries
==================================

Those tests require a working version of XFCE >= 4.8, as well as the
haskell packages test-framework, test-framework-hunit, HUnit,
test-framework-quickcheck2 and QuickCheck. The demo program requires the
haskell binding for gtk. You can ask cabal to build it for you by
specifying the flag "buildTests":

	bash $ cabal configure -fbuildTests
	bash $ cabal build
	bash $ ./dist/build/tests/tests
	bash $ ./dist/build/testGlib/testGlib
	bash $ runghc Demo/Demo.hs

Or you can just quickly run them with one of the following shortcuts:
	
	bash $ make test(s)         # run with 500 test samples
	bash $ make testGlib        # test glib signals
	                            # (need a -threaded binary)
	bash $ make demo            # run the small xfconf bindings demo

You're welcomed to report any suggestions / bug reports to john obbele
AT gmail.

© Copyright 2010-2011 John Obbele. All Rights Reserved.