X-Git-Url: http://git.indexdata.com/?p=yazproxy-moved-to-github.git;a=blobdiff_plain;f=doc%2Finstallation.xml;h=364e4fdb7acf942c66eba2924f42accf21deabd5;hp=fab423e87bd27a8803dff461af4ee3478816a10b;hb=36b087dfdcfd7d098d170ea72b29a1b0690032d2;hpb=101d9c2ca072f3cd7fb6cb89c67573318b14b8c1 diff --git a/doc/installation.xml b/doc/installation.xml index fab423e..364e4fd 100644 --- a/doc/installation.xml +++ b/doc/installation.xml @@ -1,9 +1,9 @@ - Installation You need a C++ compiler to compile and use YAZ proxy. - The software was implemented using GCC so we know that works + The software was implemented using + GCC so we know that works well with YAZ proxy. From time to time the software has been compiled on Windows using Visual C++. Other compilers should work too. Let us know of portability problems, etc. with @@ -11,19 +11,29 @@ YAZ proxy is built on top of the - YAZ and - YAZ++ + YAZ and + YAZ++ toolkits. You need to install these first. - For some platforms there are binary packages for YAZ/YAZ++. + For some platforms there are binary packages available for YAZ/YAZ++. We also highly recommend that - libxml2 and - libxslt are installed. + libxml2 and + libXSLT are installed. YAZ must be configured with libxml2 support. - If not, SRW/SRU is not supported. - The YAZ Proxy uses libxslt for record conversions via XSLT. + If not, + SRU + is not supported. + The YAZ Proxy uses libXSLT for record conversions via XSLT. + + + YAZ proxy may also use USEMARCON to convert between MARC + formats. This is useful if you want the proxy to offer more + MARC record types than the backend target supports. Get USEMARCON + from: + British Library USEMARCON page + .
Building on Unix @@ -47,16 +57,16 @@ - --with-yazppconfig directory + --with-yazpp directory - Specifies the location of yaz++-config. - The yaz++-config program is generated in + Specifies the location of yazpp-config. + The yazpp-config program is generated in the source directory of YAZ++ as well as the binaries directory when YAZ++ is installed (via make install). If you don't supply this option, configure will - look for yaz++-config in directories of the + look for yazpp-config in directories of the PATH environment - which is nearly always what you want. @@ -64,12 +74,21 @@ --with-xslt directory - Specifies prefix for libxslt (and libxml2). + Specifies prefix for libXSLT (and libxml2). configure must be able to locate xslt-config in PREFIX/bin. If this option is omitted, configure looks for xslt-config in the current PATH. + + --with-usemarcon directory + + Specifies USEMARCON installation prefix. + configure must be able to locate usemarcon-config + in PREFIX/bin. If this option is omitted, configure looks + for usemarcon-config in the current PATH. + + For the whole list of configure options, refer to the help: @@ -117,8 +136,11 @@ etc - Various files that may be read by YAZ proxy - including - configuration file, XSLT files, CQL to RPN conversion. + Various files such as + configuration files, XSLT files, CQL to RPN conversion files, + a sample start/stop control script + yazproxy.ctl.sh that can be used as + template for an /etc/init.d script. These files are installed in the YAZ proxy's data area (prefix/share/yazproxy). @@ -131,7 +153,7 @@ Building on Windows 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. @@ -184,7 +206,7 @@ If HAVE_LIBXSLT is set to 1, the proxy is compiled with XSLT and XML support. In this configuration, set LIBXSLT_DIR to the - libxslt source + libXSLT source directory. @@ -196,8 +218,8 @@ - Windows versions of libxslt, libxml2, zlib and iconv can be found - + Windows versions of libXSLT, libxml2, zlib and iconv can be found + here. @@ -221,7 +243,7 @@ If HAVE_LIBXML2 is set to 1, the proxy is compiled with XML support. In this configuration, set LIBXML2_DIR to the - libxml2 source directory + libxml2 source directory and ZLIB_DIR to the zlib directory.