xmlcatalog.1, the man file, has not yet been included in the build.

Mon Sep  3 09:10:08 MDT 2001 John Fleck <jfleck@inkstain.net>

	* doc/xmlcatalog_man.xml, xmlcatalog_man.html, xmlcatalog.1
	adding documentation for xmlcatalog. Note: xmlcatalog.1, the man
	file, has not yet been included in the build.
This commit is contained in:
MDT 2001 John Fleck 2001-09-03 15:14:19 +00:00 committed by John Fleck
parent 99784ff899
commit 5bd39dc7ea
4 changed files with 570 additions and 0 deletions

View File

@ -1,3 +1,9 @@
Mon Sep 3 09:10:08 MDT 2001 John Fleck <jfleck@inkstain.net>
* doc/xmlcatalog_man.xml, xmlcatalog_man.html, xmlcatalog.1
adding documentation for xmlcatalog. Note: xmlcatalog.1, the man
file, has not yet been included in the build.
Sat Sep 1 18:17:47 CEST 2001 Daniel Veillard <daniel@veillard.com>
* catalog.c: removed a duplicate affectation Justin Fletcher

176
doc/xmlcatalog.1 Normal file
View File

@ -0,0 +1,176 @@
.\"
.\" This page was created on 2001-09-03 9:00:42 by makeman.pl
.\" ``makeman.pl'' is part of the ``MakeMan'' project.
.\" For more information, please see http://mama.sourceforge.net
.\"
.TH xmlcatalog 1
.SH NAME
xmlcatalog \- Command line tool to parse and manipulate XML or SGML catalog files.
.SH SYNOPSIS
\fBxmlcatalog\fR
[ \fI\-\-shell\fR ] [ \fI\-\-create\fR ] [ \fI\-\-add \fR ] [ \fI\-\-del \fR ] [ \fI\-\-noout\fR ] [ \fI\-\-verbose\fR ] [ \fIcatalogfile\fR ] [ \fIentities\fR ]
.SH "Introduction"
.PP
xmlcatalog is a command line application
allowing users to monitor and manipulate XML and
SGML catalogs. It is included in
libxml2.
.PP
Its functions can be invoked from a single command from the command line,
or it can perform multiple functions in interactive mode. It can operate
on both XML and SGML files.
.SH "Command Line Options"
.PP
\-\-shell \fIfilename\fR \- Run a shell
allowing interactive queries on catalog file
\fIfilename\fR.
.PP
\-\-create \fIfilename\fR \- Create a new
XML catalog. Outputs to stdout, ignoring
\fIfilename\fR unless \-\-noout is
used, in which case it creates a new catalog file
\fIfilename\fR.
.PP
\-\-add \fI'type'\fR
\fI'orig'\fR \fI'replace'\fR
\fIfilename\fR \- Add an entry to catalog file
\fIfilename\fR. \fItype\fR indicates
the type of entry. Possible types are 'public', 'system', 'rewriteSystem',
'delegatePublic' and 'delegateSystem'. \fI'orig'\fR
is the original reference to
be replaced, and \fI'replace'\fR is the
URI of the replacement entity to be used. The
\-add option will not overwrite
\fIfilename\fR, outputing to stdout, unless
\-\-noout is used. The \-\-add will always
take three parameters even if some of the XML catalog
constructs will have only a single argument.
.PP
\-\-del \fI'values'\fR
\fIfilename\fR \- Remove entries from the catalog file
\fIfilename\fR matching
\fI'values'\fR. The \-\-del option
will not overwrite \fIfilename\fR, outputing to
stdout, unless \-\-noout is used.
.PP
\-\-noout \- Save output to the named file rather than
outputing to stdout.
.PP
\-v or \-\-verbose \- output debugging
information.
.SH "Shell Commands"
.PP
Invoking xmlcatalog with the
\-\-shell \fIfilename\fR option opens
a command line shell allowing interactive access to the catalog file
identified by \fIfilename\fR. Invoking the shell
provides a command line prompt after which commands can be entered.
.PP
public \fI'PublicID'\fR \- Execute a
public identifier lookup of the catalog entry for
\fI'PublicID'\fR. The corresponding entry will be
output to the command line.
.PP
system \fI'SystemID'\fR \- Execute a
public identifier lookup of the catalog entry for
\fI'SystemID'\fR. The corresponding entry will be
output to the command line.
.PP
add \fI'type'\fR
\fI'orig'\fR \fI'replace'\fR \-
Add an entry to the catalog
file. \fItype\fR indicates the type of
entry. Possible types are 'public', 'system', 'rewriteSystem',
'delegatePublic' and 'delegateSystem'. \fI'orig'\fR
is the original reference to be replaced, and
\fI'replace'\fR is the URI of the
replacement entity to be used.
.PP
del \fI'values'\fR \- Remove the
catalog entry corresponding to \fI'values'\fR.
.PP
dump \- Print the current catalog.
.PP
debug \- Print debugging statements showing the steps
xmlcatalog is executing.
.PP
quiet \- Stop printing debugging statements.
.PP
exit \- Quit the shell.
.SH "References"
.PP
.IP
libxml web page: http://www.xmlsoft.org/ (Link to \fIhttp://www.xmlsoft.org/\fR)
.IP
libxml catalog support web page: http://www.xmlsoft.org/catalog.html (Link to \fIhttp://www.xmlsoft.org/catalog.html\fR)
.IP
James Clark's SGML catalog page: http://www.jclark.com/sp/catalog.htm (Link to \fIhttp://www.jclark.com/sp/catalog.htm\fR)
.IP
OASIS XML catalog
specification: http://www.oasis\-open.org/committees/entity/spec.html (Link to \fIhttp://www.oasis-open.org/committees/entity/spec.html\fR)

161
doc/xmlcatalog_man.html Normal file
View File

@ -0,0 +1,161 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
<html>
<head>
<meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type">
<title>xmlcatalog</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.41">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry">
<h1 class="title">
<a name="id2707557"></a>xmlcatalog</h1>
<div class="refnamediv">
<a name="id2707759"></a><h2>Name</h2>xmlcatalog &#x2014; Command line tool to parse and manipulate XML or
SGML catalog files.</div>
<div class="refsynopsisdiv">
<a name="id2700082"></a><h2>Synopsis</h2>
<div class="cmdsynopsis" id="id2702384">
<a name="id2702384"></a><tt>xmlcatalog</tt> [--shell | --create | --add <i><tt>type</tt></i>
<i><tt>orig</tt></i> <i><tt>replace</tt></i> | --del <i><tt>values</tt></i> | --noout | --verbose] [<tt><i><tt>catalogfile</tt></i></tt>] [<tt><i><tt>entities</tt></i></tt>]</div>
</div>
<div class="refsect1">
<a name="introduction"></a><h2>
<a name="introduction"></a>Introduction</h2>
<p>
xmlcatalog is a command line application
allowing users to monitor and manipulate XML and
SGML catalogs. It is included in
libxml2.
</p>
<p>
Its functions can be invoked from a single command from the command line,
or it can perform multiple functions in interactive mode. It can operate
on both XML and SGML files.
</p>
</div>
<div class="refsect1">
<a name="cloptions"></a><h2>
<a name="cloptions"></a>Command Line Options</h2>
<p>
<tt>--shell</tt> <i><tt>filename</tt></i> - Run a shell
allowing interactive queries on catalog file
<i><tt>filename</tt></i>.
</p>
<p>
<tt>--create</tt> <i><tt>filename</tt></i> - Create a new
XML catalog. Outputs to stdout, ignoring
<i><tt>filename</tt></i> unless <tt>--noout</tt> is
used, in which case it creates a new catalog file
<i><tt>filename</tt></i>.
</p>
<p>
<tt>--add</tt> <i><tt>'type'</tt></i>
<i><tt>'orig'</tt></i> <i><tt>'replace'</tt></i>
<i><tt>filename</tt></i> - Add an entry to catalog file
<tt>filename</tt>. <i><tt>type</tt></i> indicates
the type of entry. Possible types are 'public', 'system', 'rewriteSystem',
'delegatePublic' and 'delegateSystem'. <i><tt>'orig'</tt></i>
is the original reference to
be replaced, and <i><tt>'replace'</tt></i> is the
URI of the replacement entity to be used. The
<tt>-add</tt> option will not overwrite
<i><tt>filename</tt></i>, outputing to stdout, unless
<tt>--noout</tt> is used. The <tt>--add</tt> will always
take three parameters even if some of the XML catalog
constructs will have only a single argument.
</p>
<p>
<tt>--del</tt> <i><tt>'values'</tt></i>
<i><tt>filename</tt></i> - Remove entries from the catalog file
<i><tt>filename</tt></i> matching
<i><tt>'values'</tt></i>. The <tt>--del</tt> option
will not overwrite <i><tt>filename</tt></i>, outputing to
stdout, unless <tt>--noout</tt> is used.
</p>
<p>
<tt>--noout</tt> - Save output to the named file rather than
outputing to stdout.
</p>
<p>
<tt>-v</tt> or <tt>--verbose</tt> - output debugging
information.
</p>
</div>
<div class="refsect1">
<a name="shell"></a><h2>
<a name="shell"></a>Shell Commands</h2>
<p>Invoking xmlcatalog with the
<tt>--shell</tt> <i><tt>filename</tt></i> option opens
a command line shell allowing interactive access to the catalog file
identified by <i><tt>filename</tt></i>. Invoking the shell
provides a command line prompt after which commands can be entered.
</p>
<p>
<tt>public</tt> <i><tt>'PublicID'</tt></i> - Execute a
public identifier lookup of the catalog entry for
<i><tt>'PublicID'</tt></i>. The corresponding entry will be
output to the command line.
</p>
<p>
<tt>system</tt> <i><tt>'SystemID'</tt></i> - Execute a
public identifier lookup of the catalog entry for
<i><tt>'SystemID'</tt></i>. The corresponding entry will be
output to the command line.
</p>
<p>
<tt>add </tt> <i><tt>'type'</tt></i>
<i><tt>'orig'</tt></i> <i><tt>'replace'</tt></i> -
Add an entry to the catalog
file. <i><tt>type</tt></i> indicates the type of
entry. Possible types are 'public', 'system', 'rewriteSystem',
'delegatePublic' and 'delegateSystem'. <i><tt>'orig'</tt></i>
is the original reference to be replaced, and
<i><tt>'replace'</tt></i> is the URI of the
replacement entity to be used.
</p>
<p>
<tt>del</tt> <i><tt>'values'</tt></i> - Remove the
catalog entry corresponding to <i><tt>'values'</tt></i>.
</p>
<p>
<tt>dump</tt> - Print the current catalog.
</p>
<p>
<tt>debug</tt> - Print debugging statements showing the steps
xmlcatalog is executing.
</p>
<p>
<tt>quiet</tt> - Stop printing debugging statements.
</p>
<p>
<tt>exit</tt> - Quit the shell.
</p>
</div>
<div class="refsect1">
<a name="references"></a><h2>
<a name="references"></a>References</h2>
<p>
<div class="itemizedlist"><ul>
<li><p>
<a name="id2708320"></a>libxml web page: <a href="http://www.xmlsoft.org/" target="_top">http://www.xmlsoft.org/</a>
</p></li>
<li><p>
<a name="id2705398"></a>
libxml catalog support web page: <a href="http://www.xmlsoft.org/catalog.html" target="_top">http://www.xmlsoft.org/catalog.html</a>
</p></li>
<li><p>
<a name="id2708614"></a>
James Clark's SGML catalog page: <a href="http://www.jclark.com/sp/catalog.htm" target="_top">http://www.jclark.com/sp/catalog.htm</a>
</p></li>
<li><p>
<a name="id2708638"></a>
OASIS XML catalog
specification: <a href="http://www.oasis-open.org/committees/entity/spec.html" target="_top">http://www.oasis-open.org/committees/entity/spec.html</a>
</p></li>
</ul></div>
</p>
</div>
</div></body>
</html>

227
doc/xmlcatalog_man.xml Normal file
View File

@ -0,0 +1,227 @@
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
]>
<refentry>
<refentryinfo>
<title>xmlcatalog Manual</title>
<copyright>
<year>2001</year>
</copyright>
<author>
<firstname>John</firstname>
<surname>Fleck</surname>
</author>
<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
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>.
</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
GNOME documentation, and those trademarks are made aware to the members
of the GNOME Documentation Project, the names have been printed in caps
or initial caps.
</para>
</legalnotice>
<releaseinfo>This is release 0.1 of the xmlcatalog Manual.</releaseinfo>
</refentryinfo>
<refmeta>
<refentrytitle>xmlcatalog</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>xmlcatalog</refname>
<refpurpose>Command line tool to parse and manipulate <acronym>XML</acronym> or
<acronym>SGML</acronym> catalog files.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>xmlcatalog</command>
<group>
<arg>--shell</arg>
<arg>--create</arg>
<arg>--add <replaceable>type</replaceable>
<replaceable>orig</replaceable> <replaceable>replace</replaceable></arg>
<arg>--del <replaceable>values</replaceable></arg>
<arg>--noout</arg>
<arg>--verbose</arg>
</group>
<arg><option><replaceable>catalogfile</replaceable></option></arg>
<arg><option><replaceable>entities</replaceable></option></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="introduction">
<title>Introduction</title>
<para>
<application>xmlcatalog</application> is a command line application
allowing users to monitor and manipulate <acronym>XML</acronym> and
<acronym>SGML</acronym> catalogs. It is included in
<application>libxml2</application>.
</para>
<para>
Its functions can be invoked from a single command from the command line,
or it can perform multiple functions in interactive mode. It can operate
on both <acronym>XML</acronym> and <acronym>SGML</acronym> files.
</para>
</refsect1>
<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>
<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.
<!--
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>
</refsect1>
<refsect1 id="shell">
<title>Shell Commands</title>
<para>Invoking <application>xmlcatalog</application> with the
<option>--shell</option> <replaceable>filename</replaceable> option opens
a command line shell allowing interactive access to the catalog file
identified by <replaceable>filename</replaceable>. Invoking the shell
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>
<para>
<option>quiet</option> - Stop printing debugging statements.
</para>
<para>
<option>exit</option> - Quit the shell.
</para>
</refsect1>
<refsect1 id="references">
<title>References</title>
<para>
<itemizedlist>
<listitem>
<para><application>libxml web page: </application><ulink
url="http://www.xmlsoft.org/">http://www.xmlsoft.org/</ulink>
</para>
</listitem>
<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>
</listitem>
<listitem>
<para>
James Clark's <acronym>SGML</acronym> catalog page: <ulink
url="http://www.jclark.com/sp/catalog.htm">http://www.jclark.com/sp/catalog.htm</ulink>
</para>
</listitem>
<listitem>
<para>
<acronym>OASIS</acronym> <acronym>XML</acronym> catalog
specification: <ulink
url="http://www.oasis-open.org/committees/entity/spec.html">http://www.oasis-open.org/committees/entity/spec.html</ulink>
</para>
</listitem>
</itemizedlist>
</para>
</refsect1>
</refentry>