========================================================================
This is the INSTALL file for libs11n (s11n).
http://s11n.net
maintainer: stephan@s11n.net
========================================================================

ACHTUNG:

While the core code is not platorm specific (well, the dll_loader is
currently Unix-ish-specific), the build tree and configure script are
*quite* GNU-specific, and REQUIRE "recent" versions of the most common
GNU tools, like sed, GNU make, GNU tar, gzip, etc. Complete docs
for the build tree can be found on the build tool's home page:

        http://toc.sourceforge.net

(shameless plug: i wrote that, too ;)


First, download s11n and it's build tools from:

        http://s11n.net

As of version 0.9.x you will need the s11n-VERSION *and* toc-VERSION
tarballs. (toc is the build tools tree.)

If you already have a compatible version of toc (>= 2004.05.28) then
you do not need to get the toc tarball.

Next, unpack the tarballs:

        tar xzf s11n-VERSION.tar.gz
        tar xzf toc-VERSION.tar.gz


You have 2 options for installing the build tools tree:

        1) set the TOC_HOME environment var to the directory which toc
        unpacks to. In the bash shell you use this command:

                export TOC_HOME=$PWD/toc-VERSION

        2) Copy the toc tree to the s11n tree, like so:

                cp toc-VERSION s11n-VERSION/toc


Now you're ready to build s11n:

        cd s11n-VERSION

s11n uses a conventional 'configure' script, which is run like so:

        ./configure [--options]

Run it with --help to see the complete list of options. None are
normally necessary, but setting a prefix is required if you want
to install s11n as a non-root user:

        ./configure --prefix=$HOME
(i.e., somewhere to which you have write access)

If configure finds problems then you won't be able to build s11n
without manual intervention - feel free to contact us if you
have build problems.

After configuring, simply:

        make
        make install

Files are installed under:

        PREFIX/bin (compiled bins and scripts)
        PREFIX/lib (libraries)
        PREFIX/include/s11n (headers)
        PREFIX/share/doc/s11n (API and library manual)


After installing s11n you must make sure it's lib directory
is in your LD_LIBRARY_PATH (or in /etc/ld.so.conf) in order
for s11n client applications to be able to link to them.

Use the libs11n-config tool to get information about the installed s11n
version, including version information and information necessary for
compiling/linking against it as a client.


========================================================================
Misc notes:

If you have the 'lyxport' tool installed (and configure found it) you
can build the library manual:

        cd doc; make lyxport

Run ./configure --help-lyxport for more details on lyxport.

If configure finds the doxygen [API doc generation tool] you can build
the API docs with:

        cd doc/api; make

The API docs are automatically created at install time if
configure finds doxygen. You can get doxygen at:

        http://www.stack.nl/~dimitri/doxygen/


========================================================================
the end
========================================================================

