X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=doc%2Finstallation.xml;h=aed87c07136ff08f1196aaf45f5a5f874c693794;hp=47202983ec07e3f82199a95a6ba154ae16e9d9b9;hb=aa4c03825ae6767274bc70aff8332a7c3b61cfc0;hpb=a17a363a19bd13793c0d40dafa5a51eabf073513 diff --git a/doc/installation.xml b/doc/installation.xml index 4720298..aed87c0 100644 --- a/doc/installation.xml +++ b/doc/installation.xml @@ -1,7 +1,6 @@ - - Compilation and Installation +Compilation and Installation - Introduction + Introduction The latest version of the software will generally be found at: @@ -18,10 +17,10 @@ The software is regularly tested on Debian GNU/Linux, Redhat Linux, - Gentoo Linux, + Ubuntu Linux, FreeBSD (i386), MAC OSX, - SunOS 5.8 (sparc), + SunOS 5.10 (sparc), Windows 2000, Windows 2003 server. @@ -42,7 +41,7 @@ let us know about it. If you run into difficulties, we will try to help if we can, and if you solve the problems, we would be happy to include your fixes in the next release. So far, we have mostly avoided - #ifdefs for individual platforms, and we'd + #ifdefs for individual platforms, and we'd like to keep it that way as far as it makes sense. @@ -87,9 +86,18 @@ - The XML C library libxml2 - is required if &yaz; is to support SRW and SRU. - This library is very portable and should compile out-of-the + YAZ 3.0.16 and later includes a wrapper for the + ICU + (International Components for Unicode). + In order to use this, the developer version of the ICU library + must be available. + + + + The libxslt, + libxml2 librararies are required + if &yaz; is to support SRU. + These libraries are very portable and should compile out-of-the box on virtually all Unix platforms. It is available in binary forms for Linux and others. @@ -179,11 +187,11 @@ - --enable-shared - The make process will create shared + --disable-shared + The make process will not create shared libraries (also known as shared objects .so). - By default, no shared libraries are created - - equivalent to --disable-shared. + By default, shared libraries are created - + equivalent to --enable-shared. @@ -200,25 +208,56 @@ Compile &yaz; with iconv library in directory prefix. By default configure will - search for iconv on your system. Use this option if it - doesn't find iconv. Alternatively you can use - --without-iconv to force &yaz; not to use - iconv. + search for iconv on the system. Use this option if it + doesn't find iconv. Alternatively, + --without-iconv, can be uset to force &yaz; + not to use iconv. + --with-xslt[=prefix] + + Compile &yaz; with + libxslt in directory + prefix. + Use this option if you want XSLT and XML support. + By default, configure will + search for libxslt on the system. Use this option if it + libxslt is not found automatically. Alternatively, + --without-xslt, can be used to force &yaz; + not to use libxslt. + + + + + --with-xml2[=prefix] Compile &yaz; with libxml2 in directory prefix. - Use this option if you want SOAP support. - By default configure will - search for libxml2 on your system. Use this option if it - doesn't find libxml2. Alternatively you can use - --without-xml2 to force &yaz; not to use - libxml2. + Use this option if you want &yaz; to use XML and support SRU. + By default, configure will + search for libxml2 on the system. Use this option if it + libxml2 is not found automatically. Alternatively, + --without-xml2, can be used to force &yaz; + not to use libxml2. + + + Note that option --with-xslt + also enables libxml2. + + + + + + --with-gnutls[=prefix] + + &yaz; will be linked with the GNU TLS libraries and + an SSL COMSTACK will be provided. By default configure enables + SSL support for YAZ if the GNU TLS development libraries are found + on the system. @@ -226,11 +265,21 @@ --with-openssl[=prefix] &yaz; will be linked with the OpenSSL libraries and - an SSL COMSTACK will be provided. Note that SSL support is still - experimental. + an SSL COMSTACK will be provided. If OpenSSL is enabled, GNU TLS + is automatically disabled. - + + + --with-icu[=prefix] + + &yaz; will be linked the + ICU library in the prefix if given. + If prefix is not given, the libraries exposed by the script + icu-config will be used if found. + + + @@ -253,11 +302,17 @@ - src/libyazthread.la + src/libyaz_server.la - When threading is supported/enabled by configure this Libtool - library is created. It includes functions that allows &yaz; - to use threads. + Generic Frontend server. This is an add-on for libyaz.la. + Code in this library uses POSIX threads functions - if POSIX + threads are available on the platform. + + + + src/libyaz_icu.la + + Functions that wrap the ICU library. @@ -268,11 +323,11 @@ client/yaz-client Z39.50 client for testing the protocol. - See chapter + See chapter YAZ client for more information. - + util/yaz-config A Bourne-shell script, generated by configure, that specifies how external applications should compile - and link with @@ -300,6 +355,13 @@ + util/yaz-icu + This program exposes the ICU wrapper library if that + is enabled for YAZ. Only if ICU is available this program is + useful. + + + zoom/zoomsh A simple shell implemented on top of the @@ -352,7 +414,8 @@ - How to make apps using YAZ on UNIX + + How to make apps using YAZ on UNIX This section describes how to compile - and link your own applications using the &yaz; toolkit. @@ -404,7 +467,7 @@ For Libtool users, the yaz-config script provides a different variant of option --libs, called --lalibs that returns the name of the - Libtool acrhive(s) for &yaz; rather than the ordinary ones. + Libtool archive(s) for &yaz; rather than the ordinary ones. For applications using the threaded version of &yaz;, @@ -506,7 +569,7 @@ If HAVE_LIBXML2 is set to 1, YAZ is compiled - with SRW and SRU support. In this configuration, set + with SRU support. In this configuration, set LIBXML2_DIR to the libxml2 source directory and @@ -514,19 +577,53 @@ - Windows versions of libxml2, zlib and iconv can be found + Windows versions of libxslt, libxml2, zlib and iconv can be found Igor Zlatković' site. - YAZ is not using ZLIB. But libxml2 is. + YAZ is not using zlib but libxml2 is depending on it. + + HAVE_LIBXSLT, + LIBXSLT_DIR + + + If HAVE_LIBXSLT is set to 1, YAZ is compiled + with XSLT support. In this configuration, set + LIBXSLT_DIR to the + libxslt source directory. + + + + + libxslt depends libxml2. + + + + + + + HAVE_ICU, + ICU_DIR + + + If HAVE_ICU is set to 1, YAZ is compiled + with ICU support. + In this configuration, set + ICU_DIR to the + ICU source directory. + + + + + @@ -557,39 +654,52 @@ The following files are generated upon successful compilation: - bin/yaz.dll + bin/yaz3.dll / + bin/yaz3d.dll - &yaz; release mode multi-threaded Dynamic Link Library. + &yaz; Release/Debug DLL. - lib/yaz.lib + lib/yaz3.lib / + lib/yaz3d.lib - Import library for yaz.dll. + Import library for yaz3.dll / + yaz3d.dll. - bin/yazd.dll + bin/yaz_icu3.dll / + bin/yaz_icu3d.dll - &yaz; debug mode multi-threaded Dynamic Link Library. + Release/Debug DLL for the ICU wrapper utility. + Only build if HAVE_ICU is 1. - lib/yazd.lib + lib/yaz_icu3.lib / + lib/yaz_icu3d.lib + + Import library for yaz_icu3.dll / + yaz_icu3d.dll. + + + bin/yaz-ztest.exe - Import library for yazd.dll. + Z39.50 multi-threaded test/example server. It's a WIN32 + console application. bin/yaz-client.exe &yaz; Z39.50 client application. It's a WIN32 console application. - See chapter YAZ client for more + See chapter YAZ client for more information. - bin/yaz-ztest.exe - - Z39.50 multi-threaded test/example server. It's a WIN32 - console application. + bin/yaz-icu.exe + This program exposes the ICU wrapper library if that + is enabled for YAZ. Only if ICU is available this program is + build. - + bin/zoomsh.exe Simple console application implemented on top of the @@ -609,7 +719,8 @@ - How to make apps using YAZ on WIN32 + + How to make apps using YAZ on WIN32 This section will go though the process of linking your WIN32 applications with &yaz;. @@ -627,14 +738,14 @@ include path Set it to the include directory of &yaz;. - import library yaz.lib + import library yaz3.lib You must link with this library. It's located in the sub directory lib of &yaz;. If you want to link with the debug version of &yaz;, you must - link with yazd.dll instead. + link against yaz3d.lib instead. - dynamic link library yaz.dll + dynamic link library yaz3.dll This DLL must be in your execution path when you invoke your application. Specifically, you should distribute this