libudmsearch usage
==================

General information
-------------------
Beginning from version 3.0.7 libudmsearch is available for
using it in third party applications. You can easily
add search into your own application using library
and include files installed in  /lib and /include
mnoGoSearch directories. Each application which uses 
libudmsearch must have "udmsearch.h" header file
included.


udm-config script
-----------------
When compiled with one of supported SQL backend, 
libudmsearch requires some dependent libraries, 
for example libmysqlclient. You can find "udm-config"
script in /bin directory of mnoGoSearch installation. 
This script helps to take in account required dependencies.
udm-config script can take several options in it's command 
line. By default udm-config outputs all available options:

Usage: ./udm-config [OPTIONS]
Options:
        [--version]
        [--libs]
        [--cflags]

When executed with --libs command line option udm-config
outputs all required to linbudmsearch linker flags, for example:

# ./udm-config --libs
-lm -L/usr/local/mysql/lib/mysql -lmysqlclient \
-L/usr/local/udmsearch/lib -ludmsearch

So you may insert `udm-config --libs` into CC compiler command line:

cc myprog.c -o myprog `udm-config --libs`



mnoGoSearch API
-------------

There is no detailed description of mnoGoSearch API yet. This
is because API is currently under rapid development and may 
have major changes from version to version. You may use search.c 
as an example of application which uses libudmsearch library.
