X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=doc%2Finstallation.xml;h=e07f1c944b88400a037e31ccfb0fce820d9a2dc4;hp=101ec670dcbe122068e7dedf8ccdcdf3ac9d8087;hb=e26f2eaefc5fae6784beb45a1435a4fbfa25f25c;hpb=d82eeac05d2899fa30704e2c40e9dd603ff2c581 diff --git a/doc/installation.xml b/doc/installation.xml index 101ec67..e07f1c9 100644 --- a/doc/installation.xml +++ b/doc/installation.xml @@ -1,4 +1,4 @@ - + Compilation and Installation Introduction @@ -6,41 +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/W2K (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 . + If you move the software to other platforms, we'd be grateful if you'd let us know about it. If you run into difficulties, we will try to help @@ -52,200 +48,310 @@ 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. UNIX - - - Note that if your system doesn't have a native ANSI C compiler, you may - have to acquire one separately. We recommend - GCC. - - - For UNIX, the GNU tools - 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;. - Generally it should be sufficient to run configure without options, - like this: - - - - ./configure - - + - The configure script attempts to use use the C compiler specified by - the CC environment variable. If not set, GNU C will be - used if it is available. The CFLAGS environment - variable holds options to be passed to the C compiler. If you're using - Bourne-compatible shell you may pass something like this to use a - particular C compiler with optimization enabled: + We provide + Debian GNU/Linux + and + 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. - - CC=/opt/ccs/bin/cc CFLAGS=-O ./configure - - - - To customize &yaz;, the configure script also accepts a set of options. - The most important are: + + Compiling from source on Unix - - --prefix path - Specifies installation prefix. This is - only needed if you run make install later to - perform a "system" installation. The prefix is - /usr/local if not specified. - - - --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. - - - --enable-threads - &yaz; will be built using POSIX threads. - Specifically, _REENTRANT will be defined during - compilation. - - - --with-openssl - &yaz; will be linked with the OpenSSL libraries and - an SSL COMSTACK will be provided. Note that SSL support is still - experimental. - - - --enable-shared - The make process will create shared - libraries (also known as shared objects .so). - By default, no shared libraries are created - - equivalent to --disable-shared. - - - --disable-shared - The make process will not create - static libraries (.a). - By default, static libraries are created - - equivalent to --enable-static. - - - + + Note that if your system doesn't have a native ANSI C compiler, you may + have to acquire one separately. We recommend + GCC. + + + + If you wish to use character set conversion facilities in &yaz; or if you + 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 libiconv. + + + + 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 + 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;. + + + + The CQL parser for &yaz; is built using + 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. + 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. + + + + Generally it should be sufficient to run configure without options, + like this: + - - - When configured, build the software by typing: - make + ./configure - - - - The following files are generated by the make process: - - lib/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 - - 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 - A Bourne-shell script, generated by configure, that - specifies how external applications should compile - and link with - &yaz;. - + + The configure script attempts to use use the C compiler specified by + the CC environment variable. If not set, GNU C will be + used if it is available. The CFLAGS environment + variable holds options to be passed to the C compiler. If you're using + Bourne-compatible shell you may pass something like this to use a + particular C compiler with optimization enabled: + + + + CC=/opt/ccs/bin/cc CFLAGS=-O ./configure + + + + To customize &yaz;, the configure script also accepts a set of options. + The most important are: - yaz-comp - The ASN.1 compiler for &yaz;. Requires the - Tcl Shell, tclsh, in - PATH to operate. - + + + --prefix=prefix + Specifies installation prefix for &yaz;. This is + only needed if you run make install later to + perform a "system" installation. The prefix is + /usr/local if not specified. + + + --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 GNU/Linux and + BSD distributions. + See + + hosts_access + 5 + + and + + tcpd + 8 + . + + - 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. - + --enable-threads + &yaz; will be built using POSIX threads. + Specifically, _REENTRANT will be defined during + compilation. + + + + --enable-shared + The make process will create shared + libraries (also known as shared objects .so). + By default, no shared libraries are created - + equivalent to --disable-shared. + + - zoom/zoomtst1, - zoom/zoomtst2, .. - - Several small applications that demonstrates the ZOOM API. - - + --disable-shared + The make process will not create + static libraries (.a). + By default, static libraries are created - + equivalent to --enable-static. + + + + + --with-iconv[=prefix] + + Compile &yaz; with iconv library in directory + prefix. By default configure will + 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 SRU 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-openssl[=prefix] + + &yaz; will be linked with the OpenSSL libraries and + an SSL COMSTACK will be provided. Note that SSL support is still + experimental. + + + + + + + + When configured, build the software by typing: + + make + + - - - - If you wish to install &yaz; in system directories - /usr/local/bin, - /usr/local/lib .. etc, you can type: - - - - make install - - - - You probably need to have root access in order to perform this. - You must specify the --prefix option for configure if - you wish to install &yaz; in other directories than the default - /usr/local/. - - - - If you wish to perform an un-installation of &yaz;, use: - - - - make uninstall - + + The following files are generated by the make process: + + 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. + + + + 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. + + + + util/yaz-config + A Bourne-shell script, generated by configure, that + specifies how external applications should compile - and link with + &yaz;. + + + + util/yaz-asncomp + The ASN.1 compiler for &yaz;. Requires the + Tcl Shell, tclsh, in + PATH to operate. + + + + 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. + + + + + + + + If you wish to install &yaz; in system directories + /usr/local/bin, + /usr/local/lib .. etc, you can type: + + + + make install + - - This will only work if you haven't reconfigured &yaz; (and therefore - changed installation prefix). Note that uninstall will not - remove directories created by make install, e.g. - /usr/local/include/yaz. - + + You probably need to have root access in order to perform this. + You must specify the --prefix option for configure if + you wish to install &yaz; in other directories than the default + /usr/local/. + + + + If you wish to perform an un-installation of &yaz;, use: + + + + make uninstall + + + + This will only work if you haven't reconfigured &yaz; (and therefore + changed installation prefix). Note that uninstall will not + remove directories created by make install, e.g. + /usr/local/include/yaz. + + How to make apps using YAZ on UNIX @@ -321,102 +427,209 @@ 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; should compile with version 5 as well. + The easiest way to install YAZ on Windows is by downloading + an installer from + here. + The installer comes with source too - in case you wish to + compile YAZ with different Compiler options etc. - - Start a command prompt and switch the sub directory - WIN where the file makefile - is located. Customize the installation by editing the - makefile file (for example by using notepad). - - The following summarizes the most important settings in that file: - - - DEBUG - - If set to 1, the software is - compiled with debugging libraries (code generation is - multi-threaded debug DLL). - If set to 0, the software is compiled with release libraries - (code generation is multi-threaded DLL). - - - TCL - - Specifies the name of the Tcl shell (EXE-file). - You do not need setting this or installing Tcl unless you wish - to change or add ASN.1 for &yaz;. - - - - - - When satisfied with the settings in the makefile, type - - nmake - - If command nmake is not found on your system - you probably haven't defined the environment variables required to - use that tool. To fix that, find and run the batch file - vcvars32.bat. You need to run it from within - the command prompt or set the environment variables "globally"; - otherwise it doesn't work. - - - If you wish to recompile &yaz; - for example if you modify - settings in the makefile you can delete - object files, etc by running. - - nmake clean - - - - The following files are generated upon successful compilation: - - - bin/yaz.dll - - &yaz; multi-threaded Dynamic Link Library. - - - lib/yaz.lib - - Import library for yaz.dll. - - - bin/yaz-client.exe - - &yaz; Z39.50 client application. It's a WIN32 console application. - See chapter YAZ client for more - information. - + + + Compiling from Source on WIN32 + + &yaz; is shipped with "makefiles" for the NMAKE tool that comes + with + Microsoft Visual Studio. + Version 6 and .NET has been tested. We expect that &yaz; compiles + with version 5 as well. + + + Start a command prompt and switch the sub directory + WIN where the file makefile + is located. Customize the installation by editing the + makefile file (for example by using notepad). - bin/yaz-ztest.exe - - Z39.50 multi-threaded test/example server. It's a WIN32 - console application. - + The following summarizes the most important settings in that file: - bin/zoomsh.exe - - Simple console application implemented on top of the - ZOOM functions. - The application is a command line shell that allows you to enter - simple commands perform to perform ZOOM operations. - + + DEBUG + + If set to 1, the software is + compiled with debugging libraries (code generation is + multi-threaded debug DLL). + If set to 0, the software is compiled with release libraries + (code generation is multi-threaded DLL). + + + + HAVE_TCL, TCL + + If HAVE_TCL is set to 1, nmake will + use the ASN.1 compiler (Tcl based). You must set + TCL to the full path of the Tcl + interpreter. + + + If you do not have Tcl installed, set + HAVE_TCL to 0. + + + + + 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 + + If HAVE_ICONV is set to 1, YAZ is compiled + with iconv support. In this configuration, set + ICONV_DIR to the iconv source directory. + + + + + HAVE_LIBXML2, + LIBXML2_DIR + + + If HAVE_LIBXML2 is set to 1, YAZ is compiled + with SRU support. In this configuration, set + LIBXML2_DIR to the + 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 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. + + + + + + + + + + When satisfied with the settings in the makefile, type + + nmake + + + + + If the nmake command is not found on your system + you probably haven't defined the environment variables required to + use that tool. To fix that, find and run the batch file + vcvars32.bat. You need to run it from within + the command prompt or set the environment variables "globally"; + otherwise it doesn't work. + + + + If you wish to recompile &yaz; - for example if you modify + settings in the makefile you can delete + object files, etc by running. + + nmake clean + + + + The following files are generated upon successful compilation: - bin/zoomtst1.exe, - bin/zoomtst2.exe, .. - - Several small applications that demonstrates the ZOOM API. - + + bin/yaz.dll + + &yaz; release mode multi-threaded Dynamic Link Library. + + + lib/yaz.lib + + 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. + 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/zoomsh.exe + + Simple console application implemented on top of the + ZOOM functions. + The application is a command line shell that allows you to enter + simple commands to perform ZOOM operations. + + + bin/zoomtst1.exe, + bin/zoomtst2.exe, .. + + Several small applications that demonstrates the ZOOM API. + + + - - - + + + How to make apps using YAZ on WIN32 This section will go though the process of linking your WIN32 @@ -439,6 +652,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