Fix typos, ensure EXAMPLE sections include everything in brief examples that have...

diff --git a/doc/auth_simple.xml b/doc/auth_simple.xml
index 8a2077a..3bd0f59 100644 (file)
--- a/doc/auth_simple.xml
+++ b/doc/auth_simple.xml
@@ -2,7 +2,7 @@
     "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd" [
  <!ENTITY copyright SYSTEM "copyright.xml">
 ]>
-<!-- $Id: auth_simple.xml,v 1.3 2006-03-27 13:44:07 adam Exp $ -->
+<!-- $Id: auth_simple.xml,v 1.4 2006-04-20 11:12:32 mike Exp $ -->
 <refentry>
  <refmeta>
   <refentrytitle>auth_simple</refentrytitle>
@@ -31,15 +31,16 @@
  
  <refsect1><title>EXAMPLES</title>
   <para>
-   A typical configuration looks as likes:
+   A typical configuration looks like this:
    <screen><![CDATA[
     <filter type="auth_simple">
-     <targetRegister>example.target-auth</targetRegister>
+     <userRegister>../etc/example.simple-auth</userRegister>
+     <targetRegister>../etc/example.target-auth</targetRegister>
      <discardUnauthorisedTargets/>
     </filter>
 ]]>
    </screen>
-   ### Show and describe examle.target-auth here ###
+   ### Show and describe example.target-auth
   </para>
  </refsect1> 
  

diff --git a/doc/backend_test.xml b/doc/backend_test.xml
index 41b16cc..44e4bf8 100644 (file)
--- a/doc/backend_test.xml
+++ b/doc/backend_test.xml
@@ -2,7 +2,7 @@
     "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd" [
  <!ENTITY copyright SYSTEM "copyright.xml">
 ]>
-<!-- $Id: backend_test.xml,v 1.1 2006-03-27 13:41:40 adam Exp $ -->
+<!-- $Id: backend_test.xml,v 1.2 2006-04-20 11:12:32 mike Exp $ -->
 <refentry>
  <refmeta>
   <refentrytitle>backend_test</refentrytitle>
@@ -17,12 +17,22 @@
  
  <refsect1><title>DESCRIPTION</title>
   <para>
-   A pseudo Z39.50 server for test purposes.. Similar to
-   yaz-ztest.
+   A pseudo Z39.50 server for test purposes.
+   Similar to yaz-ztest.
   </para>
  </refsect1>
 
-  <refsect1><title>SEE ALSO</title>
+ <refsect1><title>EXAMPLES</title>
+  <para>
+   A typical configuration looks like this:
+   <screen><![CDATA[
+    <filter type="backend_test"/>
+]]>
+   </screen>
+  </para>
+ </refsect1> 
+ 
+ <refsect1><title>SEE ALSO</title>
   <para>
    <citerefentry>
     <refentrytitle>metaproxy</refentrytitle>

diff --git a/doc/frontend_net.xml b/doc/frontend_net.xml
index 5d69f53..c229fda 100644 (file)
--- a/doc/frontend_net.xml
+++ b/doc/frontend_net.xml
@@ -2,7 +2,7 @@
     "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd" [
  <!ENTITY copyright SYSTEM "copyright.xml">
 ]>
-<!-- $Id: frontend_net.xml,v 1.1 2006-03-27 13:41:40 adam Exp $ -->
+<!-- $Id: frontend_net.xml,v 1.2 2006-04-20 11:12:32 mike Exp $ -->
 <refentry>
  <refmeta>
   <refentrytitle>frontend_net</refentrytitle>
@@ -24,7 +24,7 @@
  
  <refsect1><title>EXAMPLES</title>
   <para>
-   A typical configuration looks as likes:
+   A typical configuration looks like this:
    <screen><![CDATA[
     <filter type="frontend_net">
      <port>@:9000</port>

diff --git a/doc/http_file.xml b/doc/http_file.xml
index 04a9411..c2a306c 100644 (file)
--- a/doc/http_file.xml
+++ b/doc/http_file.xml
@@ -2,7 +2,7 @@
     "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd" [
  <!ENTITY copyright SYSTEM "copyright.xml">
 ]>
-<!-- $Id: http_file.xml,v 1.1 2006-03-27 13:41:40 adam Exp $ -->
+<!-- $Id: http_file.xml,v 1.2 2006-04-20 11:12:32 mike Exp $ -->
 <refentry>
  <refmeta>
   <refentrytitle>http_file</refentrytitle>
@@ -26,12 +26,14 @@
  
  <refsect1><title>EXAMPLES</title>
   <para>
-   A typical configuration looks as likes:
+   A typical configuration looks like this:
    <screen><![CDATA[
    <filter type="http_file">
     <mimetypes>/etc/mime.types</mimetypes>
-    <documentroot>/var/www/metaproxy/html</port>
-    <prefix>/etc</prefixs>
+    <area>
+     <documentroot>/var/www/metaproxy/html</port>
+     <prefix>/etc</prefixs>
+    </area>
    </filter>
 ]]>
    </screen>

diff --git a/doc/log.xml b/doc/log.xml
index 34be60e..4c55955 100644 (file)
--- a/doc/log.xml
+++ b/doc/log.xml
@@ -2,7 +2,7 @@
     "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd" [
  <!ENTITY copyright SYSTEM "copyright.xml">
 ]>
-<!-- $Id: log.xml,v 1.1 2006-03-27 13:41:40 adam Exp $ -->
+<!-- $Id: log.xml,v 1.2 2006-04-20 11:12:32 mike Exp $ -->
 <refentry>
  <refmeta>
   <refentrytitle>log</refentrytitle>
@@ -23,7 +23,7 @@
  
  <refsect1><title>EXAMPLES</title>
   <para>
-   A typical configuration looks as likes:
+   A typical configuration looks like this:
    <screen><![CDATA[
     <filter type="log">
      <message>B</message>

diff --git a/doc/multi.xml b/doc/multi.xml
index db80beb..73d2072 100644 (file)
--- a/doc/multi.xml
+++ b/doc/multi.xml
@@ -2,7 +2,7 @@
     "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd" [
  <!ENTITY copyright SYSTEM "copyright.xml">
 ]>
-<!-- $Id: multi.xml,v 1.1 2006-03-27 13:41:40 adam Exp $ -->
+<!-- $Id: multi.xml,v 1.2 2006-04-20 11:12:32 mike Exp $ -->
 <refentry>
  <refmeta>
   <refentrytitle>multi</refentrytitle>
@@ -23,7 +23,7 @@
  
  <refsect1><title>EXAMPLES</title>
   <para>
-   A typical configuration looks as likes:
+   A typical configuration looks like this:
    <screen><![CDATA[
     <filter type="multi">
     </filter>

diff --git a/doc/query_rewrite.xml b/doc/query_rewrite.xml
index c22a577..d967d3d 100644 (file)
--- a/doc/query_rewrite.xml
+++ b/doc/query_rewrite.xml
@@ -2,7 +2,7 @@
     "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd" [
  <!ENTITY copyright SYSTEM "copyright.xml">
 ]>
-<!-- $Id: query_rewrite.xml,v 1.1 2006-03-30 13:11:11 mike Exp $ -->
+<!-- $Id: query_rewrite.xml,v 1.2 2006-04-20 11:12:32 mike Exp $ -->
 <refentry>
  <refmeta>
   <refentrytitle>query_rewrite</refentrytitle>
@@ -37,7 +37,7 @@
  
  <refsect1><title>EXAMPLES</title>
   <para>
-   A typical configuration looks as likes:
+   A typical configuration looks like this:
    <screen><![CDATA[
    <filter type="query_rewrite">
     <xslt>pqf2pqf.xsl</xslt>

diff --git a/doc/session_shared.xml b/doc/session_shared.xml
index 734167e..5bc35ca 100644 (file)
--- a/doc/session_shared.xml
+++ b/doc/session_shared.xml
@@ -2,7 +2,7 @@
     "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd" [
  <!ENTITY copyright SYSTEM "copyright.xml">
 ]>
-<!-- $Id: session_shared.xml,v 1.1 2006-04-19 15:41:56 mike Exp $ -->
+<!-- $Id: session_shared.xml,v 1.2 2006-04-20 11:12:32 mike Exp $ -->
 <refentry>
  <refmeta>
   <refentrytitle>session_shared</refentrytitle>
@@ -23,7 +23,19 @@
   </para>
  </refsect1>
 
-  <refsect1><title>SEE ALSO</title>
+ <refsect1><title>EXAMPLES</title>
+  <para>
+   A typical configuration looks like this:
+   <screen><![CDATA[
+    <filter type="session_shared">
+     ### Not yet defined
+    </filter>
+]]>
+   </screen>
+  </para>
+ </refsect1> 
+ 
+ <refsect1><title>SEE ALSO</title>
   <para>
    <citerefentry>
     <refentrytitle>metaproxy</refentrytitle>

diff --git a/doc/template.xml b/doc/template.xml
index 0fa00f5..f4a281e 100644 (file)
--- a/doc/template.xml
+++ b/doc/template.xml
@@ -2,7 +2,7 @@
     "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd" [
  <!ENTITY copyright SYSTEM "copyright.xml">
 ]>
-<!-- $Id: template.xml,v 1.1 2006-04-19 15:42:06 mike Exp $ -->
+<!-- $Id: template.xml,v 1.2 2006-04-20 11:12:32 mike Exp $ -->
 <refentry>
  <refmeta>
   <refentrytitle>template</refentrytitle>
@@ -23,6 +23,16 @@
   </para>
  </refsect1>
 
+ <refsect1><title>EXAMPLES</title>
+  <para>
+   A typical configuration looks like this:
+   <screen><![CDATA[
+    <filter type="template"/>
+]]>
+   </screen>
+  </para>
+ </refsect1> 
+ 
   <refsect1><title>SEE ALSO</title>
   <para>
    <citerefentry>

diff --git a/doc/virt_db.xml b/doc/virt_db.xml
index 497ab37..6ec47f7 100644 (file)
--- a/doc/virt_db.xml
+++ b/doc/virt_db.xml
@@ -2,7 +2,7 @@
     "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd" [
  <!ENTITY copyright SYSTEM "copyright.xml">
 ]>
-<!-- $Id: virt_db.xml,v 1.1 2006-03-27 13:41:40 adam Exp $ -->
+<!-- $Id: virt_db.xml,v 1.2 2006-04-20 11:12:32 mike Exp $ -->
 <refentry>
  <refmeta>
   <refentrytitle>virt_db</refentrytitle>
@@ -24,7 +24,7 @@
  
  <refsect1><title>EXAMPLES</title>
   <para>
-   A typical configuration looks as likes:
+   A typical configuration looks like this:
    <screen><![CDATA[
     <filter type="virt_db">
       <virtual>

diff --git a/doc/z3950_client.xml b/doc/z3950_client.xml
index 56ac2f8..b3457d3 100644 (file)
--- a/doc/z3950_client.xml
+++ b/doc/z3950_client.xml
@@ -2,7 +2,7 @@
     "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd" [
  <!ENTITY copyright SYSTEM "copyright.xml">
 ]>
-<!-- $Id: z3950_client.xml,v 1.1 2006-03-27 13:41:40 adam Exp $ -->
+<!-- $Id: z3950_client.xml,v 1.2 2006-04-20 11:12:32 mike Exp $ -->
 <refentry>
  <refmeta>
   <refentrytitle>z3950_client</refentrytitle>
@@ -23,7 +23,7 @@
  
  <refsect1><title>EXAMPLES</title>
   <para>
-   A typical configuration looks as likes:
+   A typical configuration looks like this:
    <screen><![CDATA[
     <filter type="z3950_client">
      <timeout>30</timeout>