Typos. Configure options. nmem_init/nmem_exit deal..
authorAdam Dickmeiss <adam@indexdata.dk>
Wed, 24 Oct 2001 12:50:44 +0000 (12:50 +0000)
committerAdam Dickmeiss <adam@indexdata.dk>
Wed, 24 Oct 2001 12:50:44 +0000 (12:50 +0000)
doc/Makefile.am
doc/installation.xml
doc/tools.xml

index d35992d..bdeba17 100644 (file)
@@ -1,4 +1,4 @@
-## $Id: Makefile.am,v 1.16 2001-10-24 09:27:59 adam Exp $
+## $Id: Makefile.am,v 1.17 2001-10-24 12:50:44 adam Exp $
 
 docdir=$(pkgdatadir)/doc
 
 
 docdir=$(pkgdatadir)/doc
 
@@ -30,7 +30,7 @@ doc_DATA = $(DOCFILES)
 $(srcdir)/yaz.html: $(XMLFILES) $(srcdir)/yazhtml.dsl
        cd $(srcdir); jade -E14 -d yazhtml.dsl -t sgml xml.dcl yaz.xml
 
 $(srcdir)/yaz.html: $(XMLFILES) $(srcdir)/yazhtml.dsl
        cd $(srcdir); jade -E14 -d yazhtml.dsl -t sgml xml.dcl yaz.xml
 
-$(srcdir)/book1.php: $(XMLFILES) $(srcdir)/yazphp.dsl
+$(srcdir)/yaz.php: $(XMLFILES) $(srcdir)/yazphp.dsl
        cd $(srcdir); jade -E14 -d yazphp.dsl -t sgml xml.dcl yaz.xml
 
 $(srcdir)/yaz.pdf: $(srcdir)/yaz.tex
        cd $(srcdir); jade -E14 -d yazphp.dsl -t sgml xml.dcl yaz.xml
 
 $(srcdir)/yaz.pdf: $(srcdir)/yaz.tex
index 7c9c6e3..448bed4 100644 (file)
@@ -1,4 +1,4 @@
-<!-- $Id: installation.xml,v 1.3 2001-10-24 09:27:59 adam Exp $ -->
+<!-- $Id: installation.xml,v 1.4 2001-10-24 12:50:44 adam Exp $ -->
  <chapter id="installation"><title>Compilation and Installation</title>
   
   <para>
  <chapter id="installation"><title>Compilation and Installation</title>
   
   <para>
        <literal>/usr/local</literal> if not specified.
        </para></listitem>
      </varlistentry>
        <literal>/usr/local</literal> if not specified.
        </para></listitem>
      </varlistentry>
-     <varlistentry>
-      <term><literal>--enable-comp </literal></term>
-      <listitem><para> &yaz; will be built using the ASN.1 compiler for &yaz;
-       (default). If you wish to use the old decoders (in sub directory asn)
-       use <literal>--disable-comp</literal> instead.
+     <varlistentry><term><literal>--enable-tcpd</literal></term>
+      <listitem><para>The front end server will be built using the TCP
+        wrapper library. It allows you to disallow/deny clients depending
+        on IP.
        </para></listitem>
      </varlistentry>
      <varlistentry><term><literal>--enable-threads</literal></term>
        </para></listitem>
      </varlistentry>
      <varlistentry><term><literal>--enable-threads</literal></term>
        </row>
       </thead>
       <tbody>
        </row>
       </thead>
       <tbody>
-       
-       <row>
-       <entry><literal>NEW_Z3950</literal></entry>
-       <entry> If 1, the auto-generated decoder/encoders
-        for Z39.50 as written by the ASN.1 compiler will be used. If 0,
-        the old decoders for Z39.50 will be used. Note, when 1, the
-        setting TCL should point to the Tcl shell on your system.
-       </entry>
-       </row>
-       
        <row>
        <entry><literal>DEBUG</literal></entry>
        <entry> If set to 1, the software is
        <row>
        <entry><literal>DEBUG</literal></entry>
        <entry> If set to 1, the software is
index 47af988..850a6fc 100644 (file)
@@ -1,4 +1,4 @@
-<!-- $Id: tools.xml,v 1.6 2001-10-24 09:27:59 adam Exp $ -->
+<!-- $Id: tools.xml,v 1.7 2001-10-24 12:50:44 adam Exp $ -->
  <chapter id="tools"><title>Supporting Tools</title>
   
   <para>
  <chapter id="tools"><title>Supporting Tools</title>
   
   <para>
@@ -660,6 +660,7 @@ typedef struct oident
     void nmem_reset(NMEM n);
     int nmem_total(NMEM n);
     void nmem_init(void);
     void nmem_reset(NMEM n);
     int nmem_total(NMEM n);
     void nmem_init(void);
+    void nmem_exit(void);
    </screen>
 
    <para>
    </screen>
 
    <para>
@@ -675,15 +676,18 @@ typedef struct oident
     allocated on the handle.
    </para>
 
     allocated on the handle.
    </para>
 
-   <note>
-    <para>
-     The nibble memory pool is shared amongst threads. POSIX
-     mutex'es and WIN32 Critical sections are introduced to keep the
-     module thread safe. On WIN32 function <function>nmem_init()</function>
-     initializes the Critical Section handle and should be called once
-     before any other nmem function is used.
-    </para>
-   </note>
+   <para>
+    The nibble memory pool is shared amongst threads. POSIX
+    mutex'es and WIN32 Critical sections are introduced to keep the
+    module thread safe. Function <function>nmem_init()</function>
+    initializes the nibble memory library and it is called automatically
+    the first time the <literal>YAZ.DLL</literal> is loaded. &yaz; uses
+    function <function>DllMain</function> to achieve this. You should
+    <emphasis>not</emphasis> call <function>nmem_init</function> or
+    <function>nmem_exit</function> unless you're absolute sure what
+    you're doing. Note that in previous &yaz; versions you'd have to call
+    <function>nmem_init</function> yourself. 
+   </para>
 
   </sect1>
  </chapter>
 
   </sect1>
  </chapter>