Replace indexdata.dk/gils with z3950.indexdata.com MP-624

[metaproxy-moved-to-github.git] / doc / metaproxy.xml

diff --git a/doc/metaproxy.xml b/doc/metaproxy.xml
index 8f4f8d7..6f05dde 100644 (file)
--- a/doc/metaproxy.xml
+++ b/doc/metaproxy.xml
@@ -1,35 +1,47 @@
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN" 
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
     "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  <!ENTITY copyright SYSTEM "copyright.xml">
+ <!ENTITY % local SYSTEM "local.ent">
+     %local;
  <!ENTITY % idcommon SYSTEM "common/common.ent">
      %idcommon;
 ]>
 <refentry id="ref-metaproxy">
+ <refentryinfo>
+  <productname>Metaproxy</productname>
+  <productnumber>&version;</productnumber>
+  <info><orgname>Index Data</orgname></info>
+ </refentryinfo>
+
  <refmeta>
   <refentrytitle>metaproxy</refentrytitle>
   <manvolnum>1</manvolnum>
+  <refmiscinfo class="manual">Commands</refmiscinfo>
  </refmeta>
- 
+
  <refnamediv>
   <refname>metaproxy</refname>
   <refpurpose>Metaproxy - server</refpurpose>
  </refnamediv>
- 
+
  <refsynopsisdiv>
   <cmdsynopsis>
    <command>metaproxy</command>
    <arg choice="opt"><option>--help</option></arg>
    <arg choice="opt"><option>--version</option></arg>
+   <arg choice="opt"><option>-v <replaceable>loglevel</replaceable></option></arg>
    <arg choice="opt"><option>--config <replaceable>config</replaceable></option></arg>
    <arg choice="opt"><option>-D</option></arg>
    <arg choice="opt"><option>-l <replaceable>logfile</replaceable></option></arg>
+   <arg choice="opt"><option>-m <replaceable>timeformat</replaceable></option></arg>
    <arg choice="opt"><option>-p <replaceable>pidfile</replaceable></option></arg>
+   <arg choice="opt"><option>-t</option></arg>
    <arg choice="opt"><option>-u <replaceable>ID</replaceable></option></arg>
    <arg choice="opt"><option>-w <replaceable>dir</replaceable></option></arg>
    <arg choice="opt"><option>-X</option></arg>
   </cmdsynopsis>
  </refsynopsisdiv>
- 
+
  <refsect1><title>DESCRIPTION</title>
 
   <para>
@@ -37,9 +49,9 @@
   </para>
 
  </refsect1>
- 
+
  <refsect1><title>OPTIONS</title>
-  
+
   <variablelist>
    <varlistentry>
     <term>--help</term>
@@ -56,6 +68,13 @@
    </varlistentry>
 
    <varlistentry>
+    <term>-v <replaceable>loglevel</replaceable></term>
+    <listitem><para>
+     Specify YAZ log level (all, debug, log)
+    </para></listitem>
+   </varlistentry>
+
+   <varlistentry>
     <term>--config <replaceable>config</replaceable></term>
     <listitem><para>
       Specify the configuration.
@@ -77,6 +96,18 @@
    </varlistentry>
 
    <varlistentry>
+    <term>-m <replaceable>timeformat</replaceable></term>
+    <listitem><para>
+     Sets the format of time-stamps for all logging performed via yaz_log.
+     Refer to
+       <ulink
+          url="http://pubs.opengroup.org/onlinepubs/009695399/functions/strftime.html">
+       strftime(3)</ulink>
+       man page for the format.
+    </para></listitem>
+   </varlistentry>
+
+   <varlistentry>
     <term>-p <replaceable>pidfile</replaceable></term>
     <listitem><para>
       Specifies file which holds PID after startup.
@@ -84,6 +115,13 @@
    </varlistentry>
 
    <varlistentry>
+    <term>-t</term>
+    <listitem><para>
+      Tests configuration. Returns exit code 0 on success; non-zero on failure.
+     </para></listitem>
+   </varlistentry>
+
+   <varlistentry>
     <term>-u <replaceable>ID</replaceable></term>
     <listitem><para>
       Makes Metaproxy changes its identity to ID after startup.
@@ -138,7 +176,7 @@
         <term>filters</term>
         <listitem>
           <para>
-            Specifies all filters. Includes one ore more 
+            Specifies all filters. Includes one ore more
             <literal>filter</literal> elements with filter-specific
             configuration material.
           </para>
@@ -178,10 +216,10 @@
     </filter>
     <filter id="backend" type="z3950_client">
      <timeout>30</timeout>
-     <default_target>z3950.indexdata.dk</default_target>
+     <default_target>z3950.indexdata.com</default_target>
     </filter>
   </filters>
-  <routes>  
+  <routes>
     <route id="start">
       <filter refid="frontend"/>
       <filter type="log">
@@ -200,7 +238,15 @@
        metaproxy --config my.xml
      </screen>
    </para>
- </refsect1> 
+ </refsect1>
+
+ <refsect1><title>SCHEMA</title>
+   <literallayout><xi:include
+                    xi:href="../xml/schema/metaproxy.rnc"
+                    xi:parse="text"
+                    xmlns:xi="http://www.w3.org/2001/XInclude" />
+   </literallayout>
+ </refsect1>
 
  <refsect1><title>FILES</title>
   <para>
@@ -279,15 +325,7 @@
 
 <!-- Keep this comment at the end of the file
 Local variables:
-mode: sgml
-sgml-omittag:t
-sgml-shorttag:t
-sgml-minimize-attributes:nil
-sgml-always-quote-attributes:t
-sgml-indent-step:1
-sgml-indent-data:t
-sgml-parent-document:nil
-sgml-local-catalogs: nil
-sgml-namecase-general:t
+mode: nxml
+nxml-child-indent: 1
 End:
 -->