$Id: README,v 1.3 2004/04/09 17:31:24 flacoste Exp $

This directory contains examples which can serve as
a starting point for your Lire customization:

Writing a new DLF converter
---------------------------

myschema.xml            A DLF schema specification. This is used to 
                        describe the logging data model of different 
                        applications.

                        This would be installed in $HOME/.lire/schemas or
                        <datadir>/lire/schemas

MyConverter.pm          An DLF converter. The MyConverter uses the
                        myschema DLF schema.
        
                        This would need to be installed in a directory
                        listed in perl's @INC. (See perl -V for the default
                        list.) You can use the PERL5LIB environment variable
                        to add directories to that search list:

                        $ mkdir $HOME/perl5lib
                        $ cp MyConverter.pm $HOME/perl5lib
                        $ PERL5LIB=$HOME/perl5lib
                        $ export PERL5LIB

myconverter_init        The DLF converter registration script.

                        This would installed in $HOME/.lire/converters or
                        <datadir>/lire/converers

myconverter_cfg_spec.xml 

                        The MyConverter example uses two configuration
                        variables. This file defines the configuration
                        structured used by this DlfConverter.

                        This would be installed in <datadir>/lire/config-spec

myconverter_cfg_default.xml

                        Sets the default values for the converter's
                        configuration variables.

                        This would be installed in <datadir>/lire/defaults


These are really trivial examples which are only meant as a starting
point for modules which actually do something useful. These files are
basically templates with documentation embedded as comments.

For more realistic examples, you should took a look at the existing DLF
converters (altough most of them weren't updated to the new API; the ones using
the API described here are listed in the files .../etc/lire/convertors/*_init)
and the other schemas.

