X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=doc%2Finstallation.xml;h=9f00af7c9b6498a52c41fcfe2e9c59123373972a;hp=9e445d4bc9ae3922fe218ebd285abc66b77de6f4;hb=23403c6f31b26b0e819a47980c42f3fc8c57d84d;hpb=10e81e043068151fd32d623ace21222ab6c91ea3 diff --git a/doc/installation.xml b/doc/installation.xml index 9e445d4..9f00af7 100644 --- a/doc/installation.xml +++ b/doc/installation.xml @@ -1,4 +1,4 @@ - + Compilation and Installation Introduction @@ -6,40 +6,37 @@ 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 platforms, you should be able to compile everything with little or - no changes. - So far, the software has been ported to the following platforms with - little or no difficulties. - - - Unix systems - - HP/UX - SunOS/Solaris - DEC Unix - BSDs: FreeBSD, OpenBSD, NetBSD - MAC OSX - Linux - IBM AIX - Data General DG/UX (with some CFLAGS tinkering) - - SGI/IRIX - DDE Supermax - - Non-unix systems - - Apple Macintosh (using the Codewarrior programming - environment and the GUSI socket libraries) - MS Windows 95/98/NT/2K/XP (Win32) - IBM AS/400 - - - + no changes. + + + + The software is regularly tested on + Debian GNU/Linux, + Redhat Linux, + Gentoo Linux, + FreeBSD (i386), + MAC OSX, + SunOS 5.8 (sparc), + , + Windows 2000, + , + Windows 2003 server. + + + + Some versions have be known to work on HP/UX, + DEC Unix, NetBSD, + OpenBSD, + IBM AIX, + Data General DG/UX (with some CFLAGS tinkering), + SGI/IRIX, DDE Supermax, Apple Macintosh (using the Codewarrior programming + environment and the GUSI socket libraries), + IBM AS/400 . @@ -53,16 +50,12 @@ 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. @@ -70,11 +63,11 @@ 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 CPU's by building them from the source + create packages for other CPUs by building them from the source package. @@ -84,7 +77,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. @@ -92,12 +85,12 @@ 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). + 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 box on virtually all Unix platforms. It is available in binary forms for Linux and others. @@ -105,9 +98,9 @@ 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;. @@ -115,13 +108,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. @@ -164,10 +157,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 @@ -220,7 +213,7 @@ --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 @@ -253,56 +246,77 @@ The following files are generated by the make process: - lib/libyaz.la + src/libyaz.la Main &yaz; library. This is no ordinary library. It's a Libtool archive. By default, &yaz; creates a static library in lib/.libs/libyaz.a. - + + - lib/libyazthread.la + src/libyazthread.la When threading is supported/enabled by configure this Libtool library is created. It includes functions that allows &yaz; to use threads. - + + ztest/yaz-ztest Test Z39.50 server. - + + client/yaz-client Z39.50 client for testing the protocol. See chapter YAZ client for more information. - + + - yaz-config + util/yaz-config A Bourne-shell script, generated by configure, that specifies how external applications should compile - and link with &yaz;. - + + - yaz-comp + util/yaz-asncomp The ASN.1 compiler for &yaz;. Requires the Tcl Shell, tclsh, in PATH to operate. - + + - zoom/zoomsh + util/yaz-iconv + This program converts data in one character set to + another. This command exercises the YAZ character set + conversion API. + + + + util/yaz-marcdump + This program parses ISO2709 encoded MARC records + and prints them in line-format or XML. + + + + zoom/zoomsh A simple shell implemented on top of the ZOOM functions. The shell is a command line application that allows you to enter simple commands to perform ZOOM operations. - + + zoom/zoomtst1, zoom/zoomtst2, .. Several small applications that demonstrates the ZOOM API. - + + @@ -416,7 +430,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. @@ -425,9 +439,9 @@ Compiling from Source on WIN32 &yaz; is shipped with "makefiles" for the NMAKE tool that comes - with - Microsoft Visual C++. - Version 6 has been tested. We expect that &yaz; compiles + with + Microsoft Visual Studio. + Version 6 and .NET has been tested. We expect that &yaz; compiles with version 5 as well. @@ -463,6 +477,22 @@ + HAVE_BISON, + BISON + + If GNU Bison is present, you might set HAVE_ICONV + to 1 and specify the Bison executable in BISON. + Bison is only required if you use the CVS version of + YAZ or if you modify the grammar for CQL + (cql.y). + + + A Windows version of GNU Bison is part of + unxutils. + + + + HAVE_ICONV, ICONV_DIR @@ -471,23 +501,31 @@ ICONV_DIR to the iconv source directory. - + HAVE_LIBXML2, LIBXML2_DIR If HAVE_LIBXML2 is set to 1, YAZ is compiled - with SRW (and SOAP) support. In this configuration, set + with SRW and SRU support. In this configuration, set LIBXML2_DIR to the - libxml2 source directory. + libxml2 source directory + and + ZLIB_DIR to the zlib directory. - You can get libxml2 and iconv binaries from - - here. + Windows versions of libxml2, zlib and iconv can be found + + Igor Zlatković' site. + + + + YAZ is not using ZLIB. But libxml2 is. + + @@ -523,7 +561,7 @@ bin/yaz.dll - &yaz; multi-threaded Dynamic Link Library. + &yaz; release mode multi-threaded Dynamic Link Library. lib/yaz.lib @@ -531,6 +569,16 @@ Import library for yaz.dll. + bin/yazd.dll + + &yaz; debug mode multi-threaded Dynamic Link Library. + + + lib/yazd.lib + + Import library for yazd.dll. + + bin/yaz-client.exe &yaz; Z39.50 client application. It's a WIN32 console application. @@ -585,6 +633,8 @@ 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. dynamic link library yaz.dll