From 2b8cf9ebca151f84ca793fc66747ddb62917e0ac Mon Sep 17 00:00:00 2001 From: Adam Dickmeiss Date: Wed, 19 Feb 2014 11:39:06 +0100 Subject: [PATCH] Doc: update a few URLs; introduce soversion entity soversion is major .so/DLL version of YAZ library. --- doc/common | 2 +- doc/entities.ent | 1 + doc/installation.xml | 66 ++++++++++++++++++++++++++++---------------------- doc/introduction.xml | 2 +- 4 files changed, 40 insertions(+), 31 deletions(-) diff --git a/doc/common b/doc/common index 0dd54ee..b864825 160000 --- a/doc/common +++ b/doc/common @@ -1 +1 @@ -Subproject commit 0dd54ee87b2cd8b9bee9403df676c42dbbf8d735 +Subproject commit b864825869c7e4c3061952b64afc99a7268be4f8 diff --git a/doc/entities.ent b/doc/entities.ent index 695ffe5..eabcb33 100644 --- a/doc/entities.ent +++ b/doc/entities.ent @@ -26,3 +26,4 @@ "> "> + diff --git a/doc/installation.xml b/doc/installation.xml index 53c5e6c..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 - git 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 git 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 git + 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, @@ -411,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 @@ -592,7 +599,7 @@ 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 git version of + Bison is only required if you use the Git version of YAZ or if you modify the grammar for CQL (cql.y). @@ -703,44 +710,44 @@ The following files are generated upon successful compilation: - bin/yaz5.dll / - bin/yaz5d.dll + bin/yaz&soversion;.dll / + bin/yaz&soversion;d.dll &yaz; Release/Debug DLL. - lib/yaz5.lib / - lib/yaz5d.lib + lib/yaz&soversion;.lib / + lib/yaz&soversion;d.lib - Import library for yaz5.dll / - yaz5d.dll. + Import library for yaz&soversion;.dll / + yaz&soversion;d.dll. - bin/yaz_cond5.dll / - bin/yaz_cond5d.dll + bin/yaz_cond&soversion;.dll / + bin/yaz_cond&soversion;d.dll Release/Debug DLL for condition variable utilities (condvar.c). - lib/yaz_cond5.lib / - lib/yaz_cond5d.lib + lib/yaz_cond&soversion;.lib / + lib/yaz_cond&soversion;d.lib - Import library for yaz_cond5.dll / - yaz_cond5d.dll. + Import library for yaz_cond&soversion;.dll / + yaz_cond&soversion;d.dll. - bin/yaz_icu5.dll / - bin/yaz_icu5d.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_icu5.lib / - lib/yaz_icu5d.lib + lib/yaz_icu&soversion;.lib / + lib/yaz_icu&soversion;d.lib - Import library for yaz_icu5.dll / - yaz_icu5d.dll. + Import library for yaz_icu&soversion;.dll / + yaz_icu&soversion;d.dll. bin/yaz-ztest.exe @@ -800,14 +807,15 @@ include path Set it to the include directory of &yaz;. - import library yaz5.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 yaz5d.lib instead. + link against yaz&soversion;d.lib instead. - dynamic link library yaz5.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 diff --git a/doc/introduction.xml b/doc/introduction.xml index 5ba265f..5be0472 100644 --- a/doc/introduction.xml +++ b/doc/introduction.xml @@ -36,7 +36,7 @@ Secure Socket Layer support using - GNU TLS. + GnuTLS. If enabled, &yaz; uses HTTPS transport (for SOAP) or "Secure BER" (for Z39.50). -- 1.7.10.4