*doc/xmlcatalog_man.xml, xmlcatalog_man.html, xmlcatalog.1 finishing up

Sat Oct  6 16:25:52 MDT 2001 John Fleck <jfleck@inkstain.net>

	*doc/xmlcatalog_man.xml, xmlcatalog_man.html, xmlcatalog.1
	finishing up fix to
	https://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=54392, making
	the xmlcatalog man page display more elegantly

1 files changed, 191 insertions, 115 deletions

diff --git a/doc/xmlcatalog_man.xml b/doc/xmlcatalog_man.xml
index 95fe58ae..cb794fe8 100644
--- a/doc/xmlcatalog_man.xml
+++ b/doc/xmlcatalog_man.xml
@@ -15,11 +15,10 @@
     <address><email>jfleck@inkstain.net</email></address>
     <legalnotice id="legalnotice">
       <para>Permission is granted to copy, distribute and/or modify this document
-	under the terms of the <ulink type="help" url="gnome-help:fdl"><citetitle>GNU Free Documentation
-	    License</citetitle></ulink>, Version 1.1 or any later version 
+	under the terms of the GNU Free Documentation
+	    License, Version 1.1 or any later version 
 	published by the Free Software Foundation with no Invariant Sections, 
-	no Front-Cover Texts, and no Back-Cover Texts.  A copy of the license
-	can be found <ulink type="help" url="gnome-help:fdl">here</ulink>.
+	no Front-Cover Texts, and no Back-Cover Texts.
       </para>
       <para>Many of the names used by companies to distinguish their products and
 	services are claimed as trademarks. Where those names appear in any
@@ -76,58 +75,83 @@
   
   <refsect1 id="cloptions">
     <title>Command Line Options</title>
-    <para>
-      <option>--shell</option> <replaceable>filename</replaceable> - Run a shell
-      allowing interactive queries on catalog file
-      <replaceable>filename</replaceable>.
-    </para>
-
-    <para>
-      <option>--create</option> <replaceable>filename</replaceable> - Create a new
-      <acronym>XML</acronym> catalog. Outputs to stdout, ignoring
-      <replaceable>filename</replaceable> unless <option>--noout</option> is
-      used, in which case it creates a new catalog file
-      <replaceable>filename</replaceable>.
-    </para>
+    <variablelist>
+      <varlistentry>
+	<term><option>--shell</option> <replaceable>filename</replaceable></term>
+	<listitem>
+	  <para>
+	    Run a shell
+	    allowing interactive queries on catalog file
+	    <replaceable>filename</replaceable>.
+	  </para>
+	</listitem>
+      </varlistentry>
+      <varlistentry>
+	<term><option>--create</option> <replaceable>filename</replaceable></term>
+	<listitem>
+	  <para>
+	    Create a new
+	    <acronym>XML</acronym> catalog. Outputs to stdout, ignoring
+	    <replaceable>filename</replaceable> unless <option>--noout</option> is
+	    used, in which case it creates a new catalog file
+	    <replaceable>filename</replaceable>.
+	  </para>
+	</listitem>
+      </varlistentry>
 
-    <para>
-      <option>--add</option> <replaceable>'type'</replaceable>
-      <replaceable>'orig'</replaceable> <replaceable>'replace'</replaceable>
-      <replaceable>filename</replaceable> - Add an entry to catalog file
-      <filename>filename</filename>. <replaceable>type</replaceable> indicates
-      the type of entry. Possible types are 'public', 'system', 'rewriteSystem',
-      'delegatePublic' and 'delegateSystem'. <replaceable>'orig'</replaceable>
-      is the original reference to 
-      be replaced, and <replaceable>'replace'</replaceable> is the
-      <acronym>URI</acronym> of the replacement entity to be used. The
-      <option>-add</option> option will not overwrite
-      <replaceable>filename</replaceable>, outputing to stdout, unless
-      <option>--noout</option> is used. The <option>--add</option> will always
-      take three parameters even if some of the <acronym>XML</acronym> catalog
-      constructs will have only a single argument.
+      <varlistentry>
+	<term><option>--add</option> <replaceable>'type'</replaceable> <replaceable>'orig'</replaceable> <replaceable>'replace'</replaceable> <replaceable>filename</replaceable></term>
+	<listitem>
+	  <para>
+	    Add an entry to catalog file
+	    <filename>filename</filename>. <replaceable>type</replaceable> indicates
+	    the type of entry. Possible types are 'public', 'system', 'rewriteSystem',
+	    'delegatePublic' and 'delegateSystem'. <replaceable>'orig'</replaceable>
+	    is the original reference to 
+	    be replaced, and <replaceable>'replace'</replaceable> is the
+	    <acronym>URI</acronym> of the replacement entity to be used. The
+	    <option>-add</option> option will not overwrite
+	    <replaceable>filename</replaceable>, outputing to stdout, unless
+	    <option>--noout</option> is used. The <option>--add</option> will always
+	    take three parameters even if some of the <acronym>XML</acronym> catalog
+	    constructs will have only a single argument.
 <!--
 FIXME - Is my list of possible types correct? Are SGML types the same? 
 -->
-    </para>
-
-    <para>
-      <option>--del</option> <replaceable>'values'</replaceable>
-      <replaceable>filename</replaceable> - Remove entries from the catalog file
-      <replaceable>filename</replaceable> matching
-      <replaceable>'values'</replaceable>. The <option>--del</option> option
-      will not overwrite <replaceable>filename</replaceable>, outputing to
-      stdout, unless <option>--noout</option> is used.
-    </para>
-
-    <para>
-      <option>--noout</option> - Save output to the named file rather than
-      outputing to stdout.
-    </para>
-
-    <para>
-      <option>-v</option> or <option>--verbose</option> - output debugging
-      information.
-    </para>
+	  </para>
+	</listitem>
+      </varlistentry>
+      <varlistentry>
+	<term><option>--del</option> <replaceable>'values'</replaceable> <replaceable>filename</replaceable></term>
+	<listitem>
+	 <para>
+	    Remove entries from the catalog file
+	    <replaceable>filename</replaceable> matching
+	    <replaceable>'values'</replaceable>. The <option>--del</option> option
+	    will not overwrite <replaceable>filename</replaceable>, outputing to
+	    stdout, unless <option>--noout</option> is used.
+	  </para>
+	</listitem>
+      </varlistentry>
+      <varlistentry>
+	<term><option>--noout</option></term>
+	<listitem>
+	  <para>
+	    Save output to the named file rather than
+	    outputing to stdout.
+	  </para>
+	</listitem>
+      </varlistentry>
+      <varlistentry>
+	<term><option>-v</option> or <option>--verbose</option></term>
+	<listitem>
+	  <para>
+	    output debugging
+	    information.
+	  </para>
+	</listitem>
+      </varlistentry>
+    </variablelist>
   </refsect1>
 
   <refsect1 id="shell">
@@ -139,89 +163,141 @@ FIXME - Is my list of possible types correct? Are SGML types the same?
     provides a command line prompt after which commands can be entered.
     </para>
 
-    <para>
-      <option>public</option> <replaceable>'PublicID'</replaceable> - Execute a
-      public identifier lookup of the catalog entry for
-      <replaceable>'PublicID'</replaceable>. The corresponding entry will be
-      output to the command line.
-    </para>
-
-    <para>
- <option>system</option> <replaceable>'SystemID'</replaceable> - Execute a
-      public identifier lookup of the catalog entry for
-      <replaceable>'SystemID'</replaceable>. The corresponding entry will be
-      output to the command line.
-    </para>
-
-    <para>
-      <option>add </option> <replaceable>'type'</replaceable>
-      <replaceable>'orig'</replaceable> <replaceable>'replace'</replaceable> -
-      Add an entry to the catalog
-      file. <replaceable>type</replaceable> indicates the type of
-      entry. Possible types are 'public', 'system', 'rewriteSystem',
-      'delegatePublic' and 'delegateSystem'. <replaceable>'orig'</replaceable>
-      is the original reference to  be replaced, and
-      <replaceable>'replace'</replaceable> is the <acronym>URI</acronym> of the
-      replacement entity to be used.
-    </para>
-
-    <para>
-      <option>del</option> <replaceable>'values'</replaceable> - Remove the
-      catalog entry corresponding to <replaceable>'values'</replaceable>.
-    </para>
-
-    <para>
-      <option>dump</option> - Print the current catalog.
-    </para>
-
-    <para>
-      <option>debug</option> - Print debugging statements showing the steps
-      <application>xmlcatalog</application> is executing.
-    </para>
+    <variablelist>
+      <varlistentry>
+	<term><option>public</option> <replaceable>'PublicID'</replaceable></term>
+	<listitem>
+	  <para>
+	    Execute a
+	    public identifier lookup of the catalog entry for
+	    <replaceable>'PublicID'</replaceable>. The corresponding entry will be
+	    output to the command line.
+	  </para>
+	</listitem>
+      </varlistentry>
+    
+      <varlistentry>
+	<term><option>system</option> <replaceable>'SystemID'</replaceable></term>
+	<listitem>
+	 <para>
+	    Execute a
+	    public identifier lookup of the catalog entry for
+	    <replaceable>'SystemID'</replaceable>. The corresponding entry will be
+	    output to the command line.
+	  </para>
+	</listitem>
+      </varlistentry>
+      <varlistentry>
+	<term><option>add </option> <replaceable>'type'</replaceable> <replaceable>'orig'</replaceable> <replaceable>'replace'</replaceable></term>
+	<listitem>
+	  <para>
+	    Add an entry to the catalog
+	    file. <replaceable>type</replaceable> indicates the type of
+	    entry. Possible types are 'public', 'system', 'rewriteSystem',
+	    'delegatePublic' and 'delegateSystem'. <replaceable>'orig'</replaceable>
+	    is the original reference to  be replaced, and
+	    <replaceable>'replace'</replaceable> is the <acronym>URI</acronym> of the
+	    replacement entity to be used.
+	  </para>
+	</listitem>
+      </varlistentry>
+      <varlistentry>
+	<term><option>del</option> <replaceable>'values'</replaceable></term>
+	<listitem>
+	  <para>
+	    Remove the
+	    catalog entry corresponding to <replaceable>'values'</replaceable>.
+	  </para>
+	</listitem>
+      </varlistentry>
 
-    <para>
-      <option>quiet</option> - Stop printing debugging statements.
-    </para>
+      <varlistentry>
+	<term><option>dump</option></term>
+	<listitem>
+	   <para>
+	    Print the current catalog.
+	  </para> 
+	</listitem>
+      </varlistentry>
 
-    <para>
-      <option>exit</option> - Quit the shell.
-    </para>
+      <varlistentry>
+	<term><option>debug</option></term>
+	<listitem>
+	  <para>
+	    Print debugging statements showing the steps
+	    <application>xmlcatalog</application> is executing.
+	  </para>
+	</listitem>
+      </varlistentry>
+    
+      <varlistentry>
+	<term><option>quiet</option></term>
+	<listitem>
+	<para>
+	    Stop printing debugging statements.
+	  </para>
+	</listitem>
+      </varlistentry>
+    
+      <varlistentry>
+	<term><option>exit</option></term>
+	<listitem>
+	  <para>
+	    Quit the shell.
+	  </para>
+	</listitem>
+      </varlistentry>
+    </variablelist>
 
   </refsect1>
 
 
   <refsect1 id="references">
     <title>References</title>
-    <para>
+    <variablelist>
+   
 
-      <itemizedlist>
+      <varlistentry>
+	<term>libxml web page:</term>
 	<listitem>
-	  <para><application>libxml web page: </application><ulink
+	  <simpara>
+	  <ulink
 	  url="http://www.xmlsoft.org/">http://www.xmlsoft.org/</ulink>
-	  </para>
+	  </simpara>
 	</listitem>
+      </varlistentry>
+
+      <varlistentry>
+	<term><application>libxml</application> catalog support web page:</term>
 	<listitem>
-	  <para>
-	    <application>libxml</application> catalog support web page: <ulink
-									       url="http://www.xmlsoft.org/catalog.html">http://www.xmlsoft.org/catalog.html</ulink>
-	  </para>
+	<simpara>
+	    <ulink url="http://www.xmlsoft.org/catalog.html">http://www.xmlsoft.org/catalog.html</ulink>
+	  </simpara>
 	</listitem>
+      </varlistentry>
+
+ 
+      <varlistentry>
+	<term>James Clark's <acronym>SGML</acronym> catalog page:</term>
 	<listitem>
-	  <para>
-	    James Clark's <acronym>SGML</acronym> catalog page: <ulink
+	 <simpara>
+	     <ulink
 								       url="http://www.jclark.com/sp/catalog.htm">http://www.jclark.com/sp/catalog.htm</ulink>
-	  </para>
+	  </simpara>
 	</listitem>
+      </varlistentry>
+
+      <varlistentry>
+	<term><acronym>OASIS</acronym> <acronym>XML</acronym> catalog specification:</term>
 	<listitem>
-	  <para>
-	    <acronym>OASIS</acronym> <acronym>XML</acronym> catalog
-	    specification: <ulink
+	  <simpara>
+	     <ulink
 				  url="http://www.oasis-open.org/committees/entity/spec.html">http://www.oasis-open.org/committees/entity/spec.html</ulink>
-	  </para>
+	  </simpara>
 	</listitem>
-      </itemizedlist>
-
-    </para>
+      </varlistentry>
+    </variablelist>
+    
   </refsect1>
 
 </refentry>
\ No newline at end of file