Doc: update a few URLs; introduce soversion entity

soversion is major .so/DLL version of YAZ library.

diff --git a/doc/common b/doc/common
index 0dd54ee..b864825 160000 (submodule)
--- 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 (file)
--- a/doc/entities.ent
+++ b/doc/entities.ent
@@ -26,3 +26,4 @@
 <!ENTITY reference-tools-cql-map "<xref linkend='cql.to.rpn'/>">
 <!ENTITY reference-tools-ccl-qualifiers "<xref linkend='ccl.qualifiers'/>">
 <!ENTITY copyright-year "1995-2014">
 <!ENTITY reference-tools-cql-map "<xref linkend='cql.to.rpn'/>">
 <!ENTITY reference-tools-ccl-qualifiers "<xref linkend='ccl.qualifiers'/>">
 <!ENTITY copyright-year "1995-2014">

+<!ENTITY soversion "5">

diff --git a/doc/installation.xml b/doc/installation.xml
index 53c5e6c..7a1b906 100644 (file)
--- a/doc/installation.xml
+++ b/doc/installation.xml
@@ -21,7 +21,7 @@
     <ulink url="&url.freebsd;">FreeBSD (i386)</ulink>,
     <ulink url="&url.macosx;">MAC OSX</ulink>,
     <ulink url="&url.solaris;">Solaris</ulink>,
     <ulink url="&url.freebsd;">FreeBSD (i386)</ulink>,
     <ulink url="&url.macosx;">MAC OSX</ulink>,
     <ulink url="&url.solaris;">Solaris</ulink>,

-    Windows 7, Windows Xp.
+    Windows 7, Windows XP.

    </para>
 
    <para>
    </para>
 
    <para>

@@ -127,13 +127,14 @@
      <ulink url="&url.icu;">ICU</ulink>
      (International Components for Unicode).
      In order to use this, the developer version of the ICU library
      <ulink url="&url.icu;">ICU</ulink>
      (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.

     </para>
 
     <para>
      The <ulink url="&url.libxslt;">libxslt</ulink>,
      <ulink url="&url.libxml2;">libxml2</ulink> librararies are required
     </para>
 
     <para>
      The <ulink url="&url.libxslt;">libxslt</ulink>,
      <ulink url="&url.libxml2;">libxml2</ulink> 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.
      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 @@
      <ulink url="&url.libtool;">Libtool</ulink>
      are used to generate Makefiles and configure &yaz; for the system.
      You do <emphasis>not</emphasis> these tools unless you're using the
      <ulink url="&url.libtool;">Libtool</ulink>
      are used to generate Makefiles and configure &yaz; for the system.
      You do <emphasis>not</emphasis> these tools unless you're using the

-     git version of &yaz;.
+     Git version of &yaz;.

     </para>
 
     <para>
      The CQL parser for &yaz; is built using
      GNU <ulink url="&url.bison;">Bison</ulink>.
     </para>
 
     <para>
      The CQL parser for &yaz; is built using
      GNU <ulink url="&url.bison;">Bison</ulink>.

-     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;.

     </para>
 
     <para>
      &yaz; includes a tiny ASN.1 compiler. This compiler is
      written in <ulink url="&url.tcl;">Tcl</ulink>.
     </para>
 
     <para>
      &yaz; includes a tiny ASN.1 compiler. This compiler is
      written in <ulink url="&url.tcl;">Tcl</ulink>.

-     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.
     </para>
      version of &yaz; or you're using the compiler to built own codecs
      for private ASN.1.
     </para>

@@ -274,7 +275,7 @@
        <listitem><para>Compile &yaz; with
          <ulink url="&url.libxml2;">libxml2</ulink> in directory
          <replaceable>prefix</replaceable>.
        <listitem><para>Compile &yaz; with
          <ulink url="&url.libxml2;">libxml2</ulink> in directory
          <replaceable>prefix</replaceable>.

-         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,
          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 @@
         </para></listitem>
       </varlistentry>
 
         </para></listitem>
       </varlistentry>
 

+      <varlistentry><term><filename>util/yaz-url</filename></term>
+       <listitem><para>This program is a simple HTTP page fetcher ala
+         wget or curl.
+        </para></listitem>
+      </varlistentry>
+

      <varlistentry><term><filename>zoom/zoomsh</filename></term>
        <listitem><para>
          A simple shell implemented on top of the
      <varlistentry><term><filename>zoom/zoomsh</filename></term>
        <listitem><para>
          A simple shell implemented on top of the

@@ -592,7 +599,7 @@
        <listitem><para>
          If GNU Bison is present, you might set <literal>HAVE_BISON</literal>
          to 1 and specify the Bison executable in <literal>BISON</literal>.
        <listitem><para>
          If GNU Bison is present, you might set <literal>HAVE_BISON</literal>
          to 1 and specify the Bison executable in <literal>BISON</literal>.

-         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
          (<filename>cql.y</filename>).
         </para>
          YAZ or if you modify the grammar for CQL
          (<filename>cql.y</filename>).
         </para>

@@ -703,44 +710,44 @@
      The following files are generated upon successful compilation:
 
      <variablelist>
      The following files are generated upon successful compilation:
 
      <variablelist>

-      <varlistentry><term><filename>bin/yaz5.dll</filename> /
-         <filename>bin/yaz5d.dll</filename></term>
+      <varlistentry><term><filename>bin/yaz&soversion;.dll</filename> /
+         <filename>bin/yaz&soversion;d.dll</filename></term>

        <listitem><para>
          &yaz; Release/Debug DLL.
         </para></listitem></varlistentry>
 
        <listitem><para>
          &yaz; Release/Debug DLL.
         </para></listitem></varlistentry>
 

-      <varlistentry><term><filename>lib/yaz5.lib</filename> /
-         <filename>lib/yaz5d.lib</filename></term>
+      <varlistentry><term><filename>lib/yaz&soversion;.lib</filename> /
+         <filename>lib/yaz&soversion;d.lib</filename></term>

        <listitem><para>
        <listitem><para>

-         Import library for <filename>yaz5.dll</filename> /
-        <filename>yaz5d.dll</filename>.
+         Import library for <filename>yaz&soversion;.dll</filename> /
+        <filename>yaz&soversion;d.dll</filename>.

         </para></listitem></varlistentry>
 
         </para></listitem></varlistentry>
 

-      <varlistentry><term><filename>bin/yaz_cond5.dll</filename> /
-         <filename>bin/yaz_cond5d.dll</filename></term>
+      <varlistentry><term><filename>bin/yaz_cond&soversion;.dll</filename> /
+         <filename>bin/yaz_cond&soversion;d.dll</filename></term>

        <listitem><para>
         Release/Debug DLL for condition variable utilities (condvar.c).
         </para></listitem></varlistentry>
 
        <listitem><para>
         Release/Debug DLL for condition variable utilities (condvar.c).
         </para></listitem></varlistentry>
 

-      <varlistentry><term><filename>lib/yaz_cond5.lib</filename> /
-         <filename>lib/yaz_cond5d.lib</filename></term>
+      <varlistentry><term><filename>lib/yaz_cond&soversion;.lib</filename> /
+         <filename>lib/yaz_cond&soversion;d.lib</filename></term>

        <listitem><para>
        <listitem><para>

-         Import library for <filename>yaz_cond5.dll</filename> /
-        <filename>yaz_cond5d.dll</filename>.
+         Import library for <filename>yaz_cond&soversion;.dll</filename> /
+        <filename>yaz_cond&soversion;d.dll</filename>.

         </para></listitem></varlistentry>
 
         </para></listitem></varlistentry>
 

-      <varlistentry><term><filename>bin/yaz_icu5.dll</filename> /
-          <filename>bin/yaz_icu5d.dll</filename></term>
+      <varlistentry><term><filename>bin/yaz_icu&soversion;.dll</filename> /
+          <filename>bin/yaz_icu&soversion;d.dll</filename></term>

        <listitem><para>
          Release/Debug DLL for the ICU wrapper utility.
         Only build if HAVE_ICU is 1.
         </para></listitem></varlistentry>
 
        <listitem><para>
          Release/Debug DLL for the ICU wrapper utility.
         Only build if HAVE_ICU is 1.
         </para></listitem></varlistentry>
 

-      <varlistentry><term><filename>lib/yaz_icu5.lib</filename> /
-         <filename>lib/yaz_icu5d.lib</filename></term>
+      <varlistentry><term><filename>lib/yaz_icu&soversion;.lib</filename> /
+         <filename>lib/yaz_icu&soversion;d.lib</filename></term>

        <listitem><para>
        <listitem><para>

-         Import library for <filename>yaz_icu5.dll</filename> /
-        <filename>yaz_icu5d.dll</filename>.
+         Import library for <filename>yaz_icu&soversion;.dll</filename> /
+        <filename>yaz_icu&soversion;d.dll</filename>.

         </para></listitem></varlistentry>
 
       <varlistentry><term><filename>bin/yaz-ztest.exe</filename></term>
         </para></listitem></varlistentry>
 
       <varlistentry><term><filename>bin/yaz-ztest.exe</filename></term>

@@ -800,14 +807,15 @@
       <varlistentry><term>include path</term><listitem><para>
          Set it to the <filename>include</filename> directory of &yaz;.
         </para></listitem></varlistentry>
       <varlistentry><term>include path</term><listitem><para>
          Set it to the <filename>include</filename> directory of &yaz;.
         </para></listitem></varlistentry>

-      <varlistentry><term>import library <filename>yaz5.lib</filename>
+      <varlistentry><term>import library <filename>yaz&soversion;.lib</filename>

        </term><listitem><para>
          You must link with this library. It's located in the
          sub directory <filename>lib</filename> of &yaz;.
         If you want to link with the debug version of &yaz;, you must
        </term><listitem><para>
          You must link with this library. It's located in the
          sub directory <filename>lib</filename> of &yaz;.
         If you want to link with the debug version of &yaz;, you must

-        link against <filename>yaz5d.lib</filename> instead.
+        link against <filename>yaz&soversion;d.lib</filename> instead.

         </para></listitem></varlistentry>
         </para></listitem></varlistentry>

-      <varlistentry><term>dynamic link library <filename>yaz5.dll</filename>
+      <varlistentry><term>dynamic link library
+         <filename>yaz&soversion;.dll</filename>

        </term><listitem><para>
          This DLL must be in your execution path when you invoke
          your application. Specifically, you should distribute this
        </term><listitem><para>
          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 (file)
--- a/doc/introduction.xml
+++ b/doc/introduction.xml
@@ -36,7 +36,7 @@
      </para></listitem>
     <listitem><para>
       Secure Socket Layer support using
      </para></listitem>
     <listitem><para>
       Secure Socket Layer support using

-      <ulink url="&url.gnutls;">GNU TLS</ulink>.
+      <ulink url="&url.gnutls;">GnuTLS</ulink>.

       If enabled, &yaz; uses HTTPS transport (for SOAP) or
       "Secure BER" (for Z39.50).
      </para></listitem>
       If enabled, &yaz; uses HTTPS transport (for SOAP) or
       "Secure BER" (for Z39.50).
      </para></listitem>