Use proper tags for references to man pages

diff --git a/doc/Makefile.am b/doc/Makefile.am
index 15a2f59..1852d85 100644 (file)
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,4 +1,4 @@
-## $Id: Makefile.am,v 1.33 2002-09-16 18:45:13 adam Exp $
+## $Id: Makefile.am,v 1.34 2002-09-17 20:17:44 adam Exp $

 
 docdir=$(datadir)/doc/@PACKAGE@
 
 
 docdir=$(datadir)/doc/@PACKAGE@
 

@@ -38,10 +38,10 @@ EXTRA_DIST = $(XMLFILES) $(SUPPORTFILES) $(DOCFILES) $(MANFILES) $(REFFILES)
 doc_DATA = $(DOCFILES)
 man_MANS = $(MANFILES)
 
 doc_DATA = $(DOCFILES)
 man_MANS = $(MANFILES)
 

-yaz-client.1: yaz-client.sgml
+yaz-client.1: yaz-client.sgml yaz-client-commands.xml

        cd $(srcdir); docbook2man yaz-client.sgml
 
        cd $(srcdir); docbook2man yaz-client.sgml
 

-yaz-ztest.8: yaz-ztest.sgml
+yaz-ztest.8: yaz-ztest.sgml ztest-options.xml

        cd $(srcdir); docbook2man yaz-ztest.sgml
 
 yaz-config.1: yaz-config.sgml
        cd $(srcdir); docbook2man yaz-ztest.sgml
 
 yaz-config.1: yaz-config.sgml

diff --git a/doc/frontend.xml b/doc/frontend.xml
index 65d21fc..99f4909 100644 (file)
--- a/doc/frontend.xml
+++ b/doc/frontend.xml
@@ -1,4 +1,4 @@
-<!-- $Id: frontend.xml,v 1.14 2002-09-16 14:16:31 adam Exp $ -->
+<!-- $Id: frontend.xml,v 1.15 2002-09-17 20:17:44 adam Exp $ -->

  <chapter id="server"><title>Generic server</title>
   <sect1><title>Introduction</title>
    
  <chapter id="server"><title>Generic server</title>
   <sect1><title>Introduction</title>
    

@@ -692,8 +692,8 @@ typedef struct bend_scan_rr {
     <sbr/>
     <arg choice="opt"><option>-k <replaceable>kilobytes</replaceable></option></arg>
     <arg choice="opt"><option>-d <replaceable>daemon</replaceable></option></arg>
     <sbr/>
     <arg choice="opt"><option>-k <replaceable>kilobytes</replaceable></option></arg>
     <arg choice="opt"><option>-d <replaceable>daemon</replaceable></option></arg>

-    <arg choice="opt"><option>-ziST1</option></arg>

     <arg choice="opt"><option>-w <replaceable>dir</replaceable></option></arg>
     <arg choice="opt"><option>-w <replaceable>dir</replaceable></option></arg>

+    <arg choice="opt"><option>-ziST1</option></arg>

     <arg choice="opt" rep="repeat">listener-spec</arg>
    </cmdsynopsis>
    
     <arg choice="opt" rep="repeat">listener-spec</arg>
    </cmdsynopsis>
    

@@ -726,23 +726,22 @@ typedef struct bend_scan_rr {
    <para>
     For UNIX, the address is the filename of socket.
    </para>
    <para>
     For UNIX, the address is the filename of socket.
    </para>

-   
+

    <para>
    <para>

-    Examples
+    For TCP/IP and SSL, the special hostname &quot;@&quot; is mapped to
+    the address <literal>INADDR_ANY</literal>, which causes the
+    server to listen on any local interface. 

    </para>
    </para>

-
+   
+   <para>
+    Examples:

    <screen>
    <screen>

-    tcp:dranet.dra.com
+    tcp:@:210

 
 

-    ssl:ssl.enterprise.com:3000
+    ssl:@:3000

 
     unix:/tmp/yaz
    </screen>
 
     unix:/tmp/yaz
    </screen>

-
-   <para>
-    For TCP/IP and SSL, the special hostname &quot;@&quot; is mapped to
-    the address <literal>INADDR_ANY</literal>, which causes the
-    server to listen on any local interface. 

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

diff --git a/doc/future.xml b/doc/future.xml
index 517ec3f..2533b8e 100644 (file)
--- a/doc/future.xml
+++ b/doc/future.xml
@@ -1,4 +1,4 @@
-<!-- $Id: future.xml,v 1.6 2001-10-26 20:13:44 adam Exp $ -->
+<!-- $Id: future.xml,v 1.7 2002-09-17 20:17:44 adam Exp $ -->

  <chapter id="future"><title>Future Directions</title>
   
   <para>
  <chapter id="future"><title>Future Directions</title>
   
   <para>

@@ -19,13 +19,13 @@
   <para>
    &yaz; is a BER toolkit and as such should support all protocols
    out there based on that. We'd like to see running ILL applications.
   <para>
    &yaz; is a BER toolkit and as such should support all protocols
    out there based on that. We'd like to see running ILL applications.

-   It shouldn't be that hard. Another thing that would be intersting is
+   It shouldn't be that hard. Another thing that would be interesting is

    LDAP. Maybe a generic framework for doing IR using both LDAP and
    Z39.50 transparently.
   </para>
   
   <para>
    LDAP. Maybe a generic framework for doing IR using both LDAP and
    Z39.50 transparently.
   </para>
   
   <para>

-   Other than that, YAZ generally moves in the directions which appear to
+   Other than that, &yaz; generally moves in the directions which appear to

    make the most people happy (including ourselves, as prime users of the
    software). If there's something you'd like to see in here, then drop
    us a note and let's see what we can come up with.
    make the most people happy (including ourselves, as prime users of the
    software). If there's something you'd like to see in here, then drop
    us a note and let's see what we can come up with.

diff --git a/doc/installation.xml b/doc/installation.xml
index 101ec67..4f89d4d 100644 (file)
--- a/doc/installation.xml
+++ b/doc/installation.xml
@@ -1,4 +1,4 @@
-<!-- $Id: installation.xml,v 1.12 2002-08-17 07:55:51 adam Exp $ -->
+<!-- $Id: installation.xml,v 1.13 2002-09-17 20:17:44 adam Exp $ -->

  <chapter id="installation"><title>Compilation and Installation</title>
   
   <sect1><title>Introduction</title>
  <chapter id="installation"><title>Compilation and Installation</title>
   
   <sect1><title>Introduction</title>

@@ -35,7 +35,7 @@
       <itemizedlist>
        <listitem><para>Apple Macintosh (using the Codewarrior programming
          environment and the GUSI socket libraries)</para></listitem>
       <itemizedlist>
        <listitem><para>Apple Macintosh (using the Codewarrior programming
          environment and the GUSI socket libraries)</para></listitem>

-       <listitem><para>MS Windows 95/98/NT/W2K (Win32)</para></listitem>
+       <listitem><para>MS Windows 95/98/NT/2K/XP (Win32)</para></listitem>

        <listitem><para>IBM AS/400</para></listitem>
       </itemizedlist></listitem>
     </itemizedlist>
        <listitem><para>IBM AS/400</para></listitem>
       </itemizedlist></listitem>
     </itemizedlist>

@@ -119,6 +119,16 @@
          TCP wrapper library</ulink>. It allows you to allow/deny
         clients depending on IP number. The TCP wrapper library is
         often used in Linux/BSD distributions.
          TCP wrapper library</ulink>. It allows you to allow/deny
         clients depending on IP number. The TCP wrapper library is
         often used in Linux/BSD distributions.

+        See
+        <citerefentry>
+         <refentrytitle>hosts_access</refentrytitle>
+         <manvolnum>5</manvolnum>
+        </citerefentry>
+        and 
+        <citerefentry>
+         <refentrytitle>tcpd</refentrytitle>
+         <manvolnum>8</manvolnum>
+        </citerefentry>.

        </para></listitem>
      </varlistentry>
      <varlistentry><term><literal>--enable-threads</literal></term>
        </para></listitem>
      </varlistentry>
      <varlistentry><term><literal>--enable-threads</literal></term>

@@ -155,7 +165,6 @@
     <screen>
      make
     </screen>
     <screen>
      make
     </screen>

-    

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

diff --git a/doc/yaz-client.sgml b/doc/yaz-client.sgml
index 3742846..0bef55b 100644 (file)
--- a/doc/yaz-client.sgml
+++ b/doc/yaz-client.sgml
@@ -1,7 +1,7 @@
 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
      <!ENTITY yaz-client-commands SYSTEM "yaz-client-commands.xml">
 ]>
 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
      <!ENTITY yaz-client-commands SYSTEM "yaz-client-commands.xml">
 ]>

-<!-- $Id: yaz-client.sgml,v 1.1 2002-09-16 14:16:31 adam Exp $ -->
+<!-- $Id: yaz-client.sgml,v 1.2 2002-09-17 20:17:44 adam Exp $ -->

 <refentry id="yaz-client">
  
  <refmeta>
 <refentry id="yaz-client">
  
  <refmeta>

@@ -101,7 +101,12 @@
    </para>
   </refsect1>
   <refsect1><title>SEE ALSO</title>
    </para>
   </refsect1>
   <refsect1><title>SEE ALSO</title>

-   <para>yaz(7)</para>
+   <para>
+    <citerefentry>
+     <refentrytitle>yaz</refentrytitle>
+     <manvolnum>1</manvolnum>
+    </citerefentry>
+   </para>

    <para>
     Section "The YAZ Client" in the YAZ manual.
    </para>
    <para>
     Section "The YAZ Client" in the YAZ manual.
    </para>

diff --git a/doc/yaz-man.sgml b/doc/yaz-man.sgml
index 0bb8517..93c15d0 100644 (file)
--- a/doc/yaz-man.sgml
+++ b/doc/yaz-man.sgml
@@ -1,5 +1,5 @@
 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">

-<!-- $Id: yaz-man.sgml,v 1.2 2002-09-16 18:45:13 adam Exp $ -->
+<!-- $Id: yaz-man.sgml,v 1.3 2002-09-17 20:17:44 adam Exp $ -->

 <refentry id="yaz">
  <refmeta>
   <refentrytitle>yaz</refentrytitle>
 <refentry id="yaz">
  <refmeta>
   <refentrytitle>yaz</refentrytitle>

@@ -62,10 +62,23 @@
  </refsect1>
  
  <refsect1><title>SEE ALSO</title>
  </refsect1>
  
  <refsect1><title>SEE ALSO</title>

-  <para><command>yaz-client(1)</command>, 
-   <command>yaz-ztest(8)</command>, 
-   <command>yaz-config(1)</command>,
-   <command>zoomsh(1)</command>
+  <para>
+    <citerefentry>
+     <refentrytitle>yaz-client</refentrytitle>
+     <manvolnum>1</manvolnum>
+    </citerefentry>,
+    <citerefentry>
+     <refentrytitle>yaz-ztest</refentrytitle>
+     <manvolnum>8</manvolnum>
+    </citerefentry>,
+    <citerefentry>
+     <refentrytitle>yaz-config</refentrytitle>
+     <manvolnum>1</manvolnum>
+    </citerefentry>,
+    <citerefentry>
+     <refentrytitle>zoomsh</refentrytitle>
+     <manvolnum>1</manvolnum>
+    </citerefentry>

   </para>
   <para>YAZ manual (
    <filename><replaceable>prefix</replaceable>/share/yaz/doc</filename>)
   </para>
   <para>YAZ manual (
    <filename><replaceable>prefix</replaceable>/share/yaz/doc</filename>)

diff --git a/doc/yaz-ztest.sgml b/doc/yaz-ztest.sgml
index a1c4471..1a164ad 100644 (file)
--- a/doc/yaz-ztest.sgml
+++ b/doc/yaz-ztest.sgml
@@ -1,7 +1,7 @@
 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
      <!ENTITY ztest-options SYSTEM "ztest-options.xml">
 ]>
 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
      <!ENTITY ztest-options SYSTEM "ztest-options.xml">
 ]>

-<!-- $Id: yaz-ztest.sgml,v 1.1 2002-09-16 14:16:31 adam Exp $ -->
+<!-- $Id: yaz-ztest.sgml,v 1.2 2002-09-17 20:17:44 adam Exp $ -->

 <refentry id="yaz-ztest">
  
  <refmeta>
 <refentry id="yaz-ztest">
  
  <refmeta>

@@ -25,8 +25,8 @@
    <arg choice="opt"><option>-t <replaceable>minutes</replaceable></option></arg>
    <arg choice="opt"><option>-k <replaceable>kilobytes</replaceable></option></arg>
    <arg choice="opt"><option>-d <replaceable>daemon</replaceable></option></arg>
    <arg choice="opt"><option>-t <replaceable>minutes</replaceable></option></arg>
    <arg choice="opt"><option>-k <replaceable>kilobytes</replaceable></option></arg>
    <arg choice="opt"><option>-d <replaceable>daemon</replaceable></option></arg>

-   <arg choice="opt"><option>-ziST1</option></arg>

    <arg choice="opt"><option>-w <replaceable>dir</replaceable></option></arg>
    <arg choice="opt"><option>-w <replaceable>dir</replaceable></option></arg>

+   <arg choice="opt"><option>-ziST1</option></arg>

    <arg choice="opt" rep="repeat">listener-spec</arg>
   </cmdsynopsis>
 
    <arg choice="opt" rep="repeat">listener-spec</arg>
   </cmdsynopsis>
 

@@ -40,7 +40,7 @@
    <para>
     <command>yaz-ztest</command> is a Z39.50 test server. 
     The server acts as a real Z39.50 server but does not use a database.
    <para>
     <command>yaz-ztest</command> is a Z39.50 test server. 
     The server acts as a real Z39.50 server but does not use a database.

-    It returns a random hit count and returns a subset of a few build-in
+    It returns a random hit count and returns a subset of a few built-in

     records.
    </para>
    <para>
     records.
    </para>
    <para>

@@ -51,7 +51,7 @@
     The <replaceable>listener-spec</replaceable> consists of a transport
     mode followed by a colon, followed by a listener address. The
     transport mode is either <literal>tcp</literal>, <literal>unix</literal>,
     The <replaceable>listener-spec</replaceable> consists of a transport
     mode followed by a colon, followed by a listener address. The
     transport mode is either <literal>tcp</literal>, <literal>unix</literal>,

-    or <literal>ssl</literal>.
+    or <literal>ssl</literal> (<command>yaz-ztest-ssl</command> only).

    </para>
    <para>
     For TCP and SSL, an address has the form:
    </para>
    <para>
     For TCP and SSL, an address has the form:

@@ -77,7 +77,9 @@
   </refsect1>
   <refsect1><title>SEE ALSO</title>
    <para>
   </refsect1>
   <refsect1><title>SEE ALSO</title>
    <para>

-    yaz(7)
+    <citerefentry>
+     <refentrytitle>yaz</refentrytitle>
+     <manvolnum>1</manvolnum></citerefentry>

    </para>
    <para>
     Section "Generic server" in the YAZ manual.
    </para>
    <para>
     Section "Generic server" in the YAZ manual.

diff --git a/doc/zoomsh.sgml b/doc/zoomsh.sgml
index 4d56535..fac41c0 100644 (file)
--- a/doc/zoomsh.sgml
+++ b/doc/zoomsh.sgml
@@ -1,7 +1,7 @@
 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
      <!ENTITY zoomsh-commands SYSTEM "zoomsh-commands.xml">
 ]>
 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
      <!ENTITY zoomsh-commands SYSTEM "zoomsh-commands.xml">
 ]>

-<!-- $Id: zoomsh.sgml,v 1.1 2002-09-16 18:45:13 adam Exp $ -->
+<!-- $Id: zoomsh.sgml,v 1.2 2002-09-17 20:17:44 adam Exp $ -->

 <refentry id="zoomsh">
  
  <refmeta>
 <refentry id="zoomsh">
  
  <refmeta>

@@ -126,7 +126,16 @@ ZOOM>quit
    
   </refsect1>
   <refsect1><title>SEE ALSO</title>
    
   </refsect1>
   <refsect1><title>SEE ALSO</title>

-   <para>yaz(7), <command>yaz-ztest(8)</command></para>
+   <para>
+    <citerefentry>
+     <refentrytitle>yaz</refentrytitle>
+     <manvolnum>7</manvolnum>
+    </citerefentry>,
+    <citerefentry>
+     <refentrytitle>yaz-ztest</refentrytitle>
+     <manvolnum>8</manvolnum>
+    </citerefentry>,
+   </para>

    <para>
     Section "Building clients with ZOOM" in the YAZ manual.
    </para>
    <para>
     Section "Building clients with ZOOM" in the YAZ manual.
    </para>

diff --git a/doc/ztest-options.xml b/doc/ztest-options.xml
index 3d08766..cbcd2d8 100644 (file)
--- a/doc/ztest-options.xml
+++ b/doc/ztest-options.xml
@@ -1,5 +1,5 @@
 <!-- 
 <!-- 

-   $Id: ztest-options.xml,v 1.1 2002-09-16 14:16:31 adam Exp $
+   $Id: ztest-options.xml,v 1.2 2002-09-17 20:17:44 adam Exp $

    Options for generic frontend server and yaz-ztest.
    Included in both manual and man page for yaz-ztest
 -->
    Options for generic frontend server and yaz-ztest.
    Included in both manual and man page for yaz-ztest
 -->

@@ -59,7 +59,7 @@
  <varlistentry><term><literal>-c </literal>
    <replaceable>config</replaceable></term>
   <listitem><para>A user option that serves as a specifier for some
  <varlistentry><term><literal>-c </literal>
    <replaceable>config</replaceable></term>
   <listitem><para>A user option that serves as a specifier for some

-    sort of configuration, e.g. a filename.
+    sort of configuration, usually a filename.

     The argument to this option is transferred to member
     <literal>configname</literal>of the
     <literal>statserv_options_block</literal>.
     The argument to this option is transferred to member
     <literal>configname</literal>of the
     <literal>statserv_options_block</literal>.

@@ -121,6 +121,23 @@
     Maximum record size/message size, in kilobytes.
    </para></listitem>
  </varlistentry>
     Maximum record size/message size, in kilobytes.
    </para></listitem>
  </varlistentry>

+
+ <varlistentry><term><literal>-d </literal>
+   <replaceable>daemon</replaceable></term>
+  <listitem><para>
+    Set name of daemon to be used in hosts access file.
+    See
+    <citerefentry>
+     <refentrytitle>hosts_access</refentrytitle>
+     <manvolnum>5</manvolnum>
+    </citerefentry>
+    and 
+    <citerefentry>
+     <refentrytitle>tcpd</refentrytitle>
+     <manvolnum>8</manvolnum>
+    </citerefentry>.
+   </para></listitem>
+ </varlistentry>

  
 </variablelist>
 
  
 </variablelist>