X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=doc%2Finstallation.xml;h=aed87c07136ff08f1196aaf45f5a5f874c693794;hp=218b001dc001505f5999301a8126dc4370671915;hb=aa4c03825ae6767274bc70aff8332a7c3b61cfc0;hpb=2750b61cf8ee6cf2632fbd57e6764559ae6e56cc diff --git a/doc/installation.xml b/doc/installation.xml index 218b001..aed87c0 100644 --- a/doc/installation.xml +++ b/doc/installation.xml @@ -1,13 +1,11 @@ - - Compilation and Installation +Compilation and Installation - Introduction + Introduction The latest version of the software will generally be found at: - - http://ftp.indexdata.dk/pub/yaz/ + We have tried our best to keep the software portable, and on many @@ -17,21 +15,20 @@ The software is regularly tested on - Debian GNU/Linux, - Redhat Linux, - Gentoo Linux, - FreeBSD (i386), - MAC OSX, - - SunOS 5.8 (sparc), - - Windows 2000. + Debian GNU/Linux, + Redhat Linux, + Ubuntu Linux, + FreeBSD (i386), + MAC OSX, + SunOS 5.10 (sparc), + Windows 2000, + Windows 2003 server. Some versions have be known to work on HP/UX, - DEC Unix, NetBSD, - OpenBSD, + DEC Unix, NetBSD, + OpenBSD, IBM AIX, Data General DG/UX (with some CFLAGS tinkering), SGI/IRIX, DDE Supermax, Apple Macintosh (using the Codewarrior programming @@ -44,22 +41,18 @@ 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. We maintain a mailing-list for the purpose of announcing new releases and - bug-fixes, as well as general discussion. Subscribe by sending mail to - - yaz-request@indexdata.dk - or fill-in the form - - here. + bug-fixes, as well as general discussion. Subscribe by + filling-in the form + here. General questions and problems can be directed at - - yaz-help@indexdata.dk - , or the address given at the top of this document. + , or the address given at the top of + this document. @@ -67,9 +60,9 @@ We provide - Debian GNU/Linux + Debian GNU/Linux and - Redhat packages for &yaz;. + Redhat packages for &yaz;. Only i386 binary packages are available. You should be able to create packages for other CPUs by building them from the source package. @@ -81,7 +74,7 @@ Note that if your system doesn't have a native ANSI C compiler, you may have to acquire one separately. We recommend - GCC. + GCC. @@ -89,22 +82,31 @@ are compiling &yaz; for use with Zebra it is a good idea to ensure that the iconv library is installed. Some Unixes today already have it - if not, we suggest - GNU iconv. + GNU libiconv. - The XML C library libxml2 - is required if &yaz; is to support SRW (and SOAP). - 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. The GNU tools - Autoconf, - Automake and - Libtool + Autoconf, + Automake and + Libtool are used to generate Makefiles and configure &yaz; for the system. You do not these tools unless you're using the CVS version of &yaz;. @@ -112,13 +114,13 @@ The CQL parser for &yaz; is built using - GNU Bison. + GNU Bison. This tool is only needed if you're using the CVS version of &yaz;. &yaz; includes a tiny ASN.1 compiler. This compiler is - written in Tcl. + written in Tcl. But as for Bison you do not need it unless you're using CVS version of &yaz; or you're using the compiler to built own codecs for private ASN.1. @@ -161,10 +163,10 @@ --enable-tcpd The front end server will be built using Wietse's - - TCP wrapper library. It allows you to allow/deny - clients depending on IP number. The TCP wrapper library is - often used in Linux/BSD distributions. + TCP wrapper library. + It allows you to allow/deny clients depending on IP number. + The TCP wrapper library is often used in GNU/Linux and + BSD distributions. See hosts_access @@ -185,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. @@ -206,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 + 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. @@ -232,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. + + + @@ -259,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. @@ -274,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 @@ -306,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 @@ -358,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. @@ -410,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;, @@ -434,7 +491,7 @@ The easiest way to install YAZ on Windows is by downloading an installer from - here. + here. The installer comes with source too - in case you wish to compile YAZ with different Compiler options etc. @@ -443,7 +500,7 @@ Compiling from Source on WIN32 &yaz; is shipped with "makefiles" for the NMAKE tool that comes - with + with Microsoft Visual Studio. Version 6 and .NET has been tested. We expect that &yaz; compiles with version 5 as well. @@ -492,7 +549,7 @@ A Windows version of GNU Bison is part of - unxutils. + unxutils. @@ -512,25 +569,59 @@ If HAVE_LIBXML2 is set to 1, YAZ is compiled - with SRW (and SOAP) support. In this configuration, set + with SRU support. In this configuration, set LIBXML2_DIR to the - libxml2 source directory + libxml2 source directory and ZLIB_DIR to the zlib directory. + + 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 + - Windows versions of libxml2, zlib and iconv can be found - - here. + If HAVE_ICU is set to 1, YAZ is compiled + with ICU support. + In this configuration, set + ICU_DIR to the + ICU source directory. + @@ -563,21 +654,31 @@ The following files are generated upon successful compilation: - bin/yaz.dll + bin/yaz3.dll / + bin/yaz3d.dll - &yaz; 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/yaz-client.exe + bin/yaz_icu3.dll / + bin/yaz_icu3d.dll - &yaz; Z39.50 client application. It's a WIN32 console application. - See chapter YAZ client for more - information. + Release/Debug DLL for the ICU wrapper utility. + Only build if HAVE_ICU is 1. + + + lib/yaz_icu3.lib / + lib/yaz_icu3d.lib + + Import library for yaz_icu3.dll / + yaz_icu3d.dll. bin/yaz-ztest.exe @@ -586,6 +687,19 @@ console application. + bin/yaz-client.exe + + &yaz; Z39.50 client application. It's a WIN32 console application. + See chapter YAZ client for more + information. + + + 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 @@ -605,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;. @@ -623,12 +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 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