X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=doc%2Finstallation.xml;h=7a1b9060c630bba7b10bfc26d6e268b9bfa3e0d9;hp=116c19326984d62aa1a16a035331e10011a5788a;hb=d9849e03a9313647aa81846cf9cb05a06394e9ea;hpb=6a8bbb0642cc2256976e0f2e0203c4b61bd7f3ad diff --git a/doc/installation.xml b/doc/installation.xml index 116c193..7a1b906 100644 --- a/doc/installation.xml +++ b/doc/installation.xml @@ -21,7 +21,7 @@ FreeBSD (i386), MAC OSX, Solaris, - Windows 7, Windows Xp. + Windows 7, Windows XP. @@ -127,13 +127,14 @@ ICU (International Components for Unicode). In order to use this, the developer version of the ICU library - must be available. + must be available. ICU support is recommended for applications + such as Pazpar2 and Zebra. The libxslt, libxml2 librararies are required - if &yaz; is to support SRU. + if &yaz; is to support SRU/Solr. 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. @@ -146,19 +147,19 @@ 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;. + Git 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;. + This tool is only needed if you're using the Git 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 + But as for Bison you do not need it unless you're using Git version of &yaz; or you're using the compiler to built own codecs for private ASN.1. @@ -274,7 +275,7 @@ Compile &yaz; with libxml2 in directory prefix. - Use this option if you want &yaz; to use XML and support SRU. + Use this option if you want &yaz; to use XML and support SRU/Solr. By default, configure will search for libxml2 on the system. Use this option if it libxml2 is not found automatically. Alternatively, @@ -299,21 +300,33 @@ - --with-openssl[=prefix] + --with-icu[=prefix] - &yaz; will be linked with the OpenSSL libraries and - an SSL COMSTACK will be provided. If OpenSSL is enabled, GNU TLS - is automatically disabled. + &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. - --with-icu[=prefix] + --with-libgcrypt[=prefix] - &yaz; will be linked the - ICU library in the prefix if given. + &yaz; will be linked with + Libgcrypt in the prefix if given. If prefix is not given, the libraries exposed by the script - icu-config will be used if found. + libgcrypt-config will be used if found. + + + + + --with-memcached + + &yaz; will be linked with + libMemcached to allow + for result-set caching for ZOOM. + The prefix can not be given. Note that YAZ will only search + for libMemcached if Libgcrypt is also enabled. @@ -399,6 +412,12 @@ + util/yaz-url + This program is a simple HTTP page fetcher ala + wget or curl. + + + zoom/zoomsh A simple shell implemented on top of the @@ -530,7 +549,7 @@ an installer from here. The installer comes with source too - in case you wish to - compile YAZ with different Compiler options etc. + compile YAZ with different compiler options, etc. @@ -538,9 +557,8 @@ &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. + Microsoft Visual Studio. It has been tested with + Microsoft Visual Studio 2003/2005/2008. Start a command prompt and switch the sub directory @@ -566,7 +584,8 @@ 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. + interpreter. A Windows version of Tcl is part of + Git for Windows. If you do not have Tcl installed, set @@ -578,15 +597,15 @@ HAVE_BISON, BISON - If GNU Bison is present, you might set HAVE_ICONV + If GNU Bison is present, you might set HAVE_BISON to 1 and specify the Bison executable in BISON. - Bison is only required if you use the CVS version of + Bison is only required if you use the Git version of YAZ or if you modify the grammar for CQL (cql.y). A Windows version of GNU Bison is part of - unxutils. + Git for Windows. @@ -691,44 +710,44 @@ The following files are generated upon successful compilation: - bin/yaz4.dll / - bin/yaz4d.dll + bin/yaz&soversion;.dll / + bin/yaz&soversion;d.dll &yaz; Release/Debug DLL. - lib/yaz4.lib / - lib/yaz4d.lib + lib/yaz&soversion;.lib / + lib/yaz&soversion;d.lib - Import library for yaz4.dll / - yaz4d.dll. + Import library for yaz&soversion;.dll / + yaz&soversion;d.dll. - bin/yaz_cond4.dll / - bin/yaz_cond4d.dll + bin/yaz_cond&soversion;.dll / + bin/yaz_cond&soversion;d.dll Release/Debug DLL for condition variable utilities (condvar.c). - lib/yaz_cond4.lib / - lib/yaz_cond4d.lib + lib/yaz_cond&soversion;.lib / + lib/yaz_cond&soversion;d.lib - Import library for yaz_cond4.dll / - yaz_cond4d.dll. + Import library for yaz_cond&soversion;.dll / + yaz_cond&soversion;d.dll. - bin/yaz_icu4.dll / - bin/yaz_icu4d.dll + bin/yaz_icu&soversion;.dll / + bin/yaz_icu&soversion;d.dll Release/Debug DLL for the ICU wrapper utility. Only build if HAVE_ICU is 1. - lib/yaz_icu4.lib / - lib/yaz_icu4d.lib + lib/yaz_icu&soversion;.lib / + lib/yaz_icu&soversion;d.lib - Import library for yaz_icu4.dll / - yaz_icu4d.dll. + Import library for yaz_icu&soversion;.dll / + yaz_icu&soversion;d.dll. bin/yaz-ztest.exe @@ -788,14 +807,15 @@ include path Set it to the include directory of &yaz;. - import library yaz4.lib + import library yaz&soversion;.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 yaz4d.lib instead. + link against yaz&soversion;d.lib instead. - dynamic link library yaz4.dll + dynamic link library + yaz&soversion;.dll This DLL must be in your execution path when you invoke your application. Specifically, you should distribute this