embedaddon/libxml2/doc/xmlcatalog.1 - diff

Return to xmlcatalog.1 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / libxml2 / doc

Diff for /embedaddon/libxml2/doc/xmlcatalog.1 between versions 1.1.1.1 and 1.1.1.2

version 1.1.1.1, 2012/02/21 23:37:59	version 1.1.1.2, 2013/07/22 01:22:24
Line 1	Line 1
.\" You probably do not want to edit this file directly	'\" t
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).	.\" Title: xmlcatalog
.\" Instead of manually editing it, you probably should edit the DocBook XML	.\" Author: John Fleck <jfleck@inkstain.net>
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.	.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.TH "XMLCATALOG" "1" "$Date$" "libxml2" ""	.\" Date: $Date$
	.\" Manual: xmlcatalog Manual
	.\" Source: libxml2
	.\" Language: English
	.\"
	.TH "XMLCATALOG" "1" "$Date$" "libxml2" "xmlcatalog Manual"
	.\" -----------------------------------------------------------------
	.\" * Define some portability stuff
	.\" -----------------------------------------------------------------
	.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	.\" http://bugs.debian.org/507673
	.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
	.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	.ie \n(.g .ds Aq \(aq
	.el .ds Aq '
	.\" -----------------------------------------------------------------
	.\" * set default formatting
	.\" -----------------------------------------------------------------
.\" disable hyphenation	.\" disable hyphenation
.nh	.nh
.\" disable justification (adjust text to left margin only)	.\" disable justification (adjust text to left margin only)
.ad l	.ad l
	.\" -----------------------------------------------------------------
	.\" * MAIN CONTENT STARTS HERE *
	.\" -----------------------------------------------------------------
.SH "NAME"	.SH "NAME"
xmlcatalog \- Command line tool to parse and manipulate XML or SGML catalog files.	xmlcatalog \- Command line tool to parse and manipulate XML or SGML catalog files\&.
.SH "SYNOPSIS"	.SH "SYNOPSIS"
.HP 11	.HP \w'\fBxmlcatalog\fR\ 'u
\fBxmlcatalog\fR [\fB\-\-sgml\fR \fB\-\-shell\fR \fB\-\-create\fR \fB\-\-del\ \fR\fB\fIVALUE(S)\fR\fR [\ \fB\-\-add\ \fR\fB\fITYPE\fR\fR\fB\ \fR\fB\fIORIG\fR\fR\fB\ \fR\fB\fIREPLACE\fR\fR\fB\ \fR\ \fB\-\-add\ \fR\fB\fIFILENAME\fR\fR] \fB\-\-noout\fR \fB\-\-no\-super\-update\fR [\fB\-v\fR\ \fB\-\-verbose\fR]] {\fICATALOGFILE\fR} {\fIENTITIES\fR...}	\fBxmlcatalog\fR [\fB\-\-sgml\fR \| \fB\-\-shell\fR \| \fB\-\-create\fR \| \fB\-\-del\ \fR\fB\fIVALUE(S)\fR\fR \| [\ \fB\-\-add\ \fR\fB\fITYPE\fR\fR\fB\ \fR\fB\fIORIG\fR\fR\fB\ \fR\fB\fIREPLACE\fR\fR\fB\ \fR\ \|\ \fB\-\-add\ \fR\fB\fIFILENAME\fR\fR] \| \fB\-\-noout\fR \| \fB\-\-no\-super\-update\fR \| [\fB\-v\fR\ \|\ \fB\-\-verbose\fR]] {\fICATALOGFILE\fR} {\fIENTITIES\fR...}
.SH "DESCRIPTION"	.SH "DESCRIPTION"
.PP	.PP

\fBxmlcatalog\fR	\fBxmlcatalog\fR
is a command line application allowing users to monitor and manipulate	is a command line application allowing users to monitor and manipulate
XML	XML
and	and
SGML	SGML
catalogs. It is included in	catalogs\&. It is included in
\fBlibxml\fR(3).	\fBlibxml\fR(3)\&.
.PP	.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	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	XML
and	and
SGML	SGML
files.	files\&.
.SH "OPTIONS"	.SH "OPTIONS"
.PP	.PP

\fBxmlcatalog\fR	\fBxmlcatalog\fR
accepts the following options (in alphabetical order):	accepts the following options (in alphabetical order):
.TP	.PP
\fB\-\-add \fR\fB\fITYPE\fR\fR\fB \fR\fB\fIORIG\fR\fR\fB \fR\fB\fIREPLACE\fR\fR\fB \fR	\fB\-\-add \fR\fB\fITYPE\fR\fR\fB \fR\fB\fIORIG\fR\fR\fB \fR\fB\fIREPLACE\fR\fR\fB \fR
	.RS 4
Add an entry to	Add an entry to
\fICATALOGFILE\fR.	CATALOGFILE\&.
\fITYPE\fR	\fITYPE\fR
indicates the type of entry. Possible types are:	indicates the type of entry\&. Possible types are:
\fIpublic\fR, \fIsystem\fR, \fIrewriteSystem\fR, \fIrewriteURI\fR, \fIdelegatePublic\fR, \fIdelegateSystem\fR, \fInextCatalog\fR.	\fIpublic\fR, \fIsystem\fR, \fIuri\fR, \fIrewriteSystem\fR, \fIrewriteURI\fR, \fIdelegatePublic\fR, \fIdelegateSystem\fR, \fIdelegateURI\fR, \fInextCatalog\fR\&.
\fIORIG\fR	\fIORIG\fR
is the original reference to be replaced, and	is the original reference to be replaced, and
\fIREPLACE\fR	\fIREPLACE\fR
is the	is the
URI	URI
of the replacement entity to be used. The	of the replacement entity to be used\&. The
\fB\-\-add\fR	\fB\-\-add\fR
option will not overwrite	option will not overwrite
\fICATALOGFILE\fR, outputting to	CATALOGFILE, outputting to
\fIstdout\fR, unless	stdout, unless
\fB\-\-noout\fR	\fB\-\-noout\fR
is used. The	is used\&. The
\fB\-\-add\fR	\fB\-\-add\fR
will always take three parameters even if some of the	will always take three parameters even if some of the
XML	XML
catalog constructs will have only a single argument.	catalog constructs will have only a single argument\&.
.TP	.RE
	.PP
\fB\-\-add \fR\fB\fIFILENAME\fR\fR	\fB\-\-add \fR\fB\fIFILENAME\fR\fR
	.RS 4
If the	If the
\fB\-\-add\fR	\fB\-\-add\fR
option is used following the	option is used following the
\fB\-\-sgml\fR	\fB\-\-sgml\fR
option, only a single argument, a	option, only a single argument, a
\fIFILENAME\fR, is used. This is used to add the name of a catalog file to an	\fIFILENAME\fR, is used\&. This is used to add the name of a catalog file to an
SGML	SGML
supercatalog, a file that contains references to other included	supercatalog, a file that contains references to other included
SGML	SGML
catalog files.	catalog files\&.
.TP	.RE
	.PP
\fB\-\-create\fR	\fB\-\-create\fR
	.RS 4
Create a new	Create a new
XML	XML
catalog. Outputs to	catalog\&. Outputs to
\fIstdout\fR, ignoring	stdout, ignoring
\fIfilename\fR	\fIfilename\fR
unless	unless
\fB\-\-noout\fR	\fB\-\-noout\fR
is used, in which case it creates a new catalog file	is used, in which case it creates a new catalog file
\fIfilename\fR.	\fIfilename\fR\&.
.TP	.RE
	.PP
\fB\-\-del \fR\fB\fIVALUE(S)\fR\fR	\fB\-\-del \fR\fB\fIVALUE(S)\fR\fR
	.RS 4
Remove entries from	Remove entries from
\fICATALOGFILE\fR	\fICATALOGFILE\fR
matching	matching
\fIVALUE(S)\fR. The	\fIVALUE(S)\fR\&. The
\fB\-\-del\fR	\fB\-\-del\fR
option will not overwrite	option will not overwrite
\fICATALOGFILE\fR, outputting to	\fICATALOGFILE\fR, outputting to
\fIstdout\fR, unless	stdout, unless
\fB\-\-noout\fR	\fB\-\-noout\fR
is used.	is used\&.
.TP	.RE
	.PP
\fB\-\-noout\fR	\fB\-\-noout\fR
	.RS 4
Save output to the named file rather than outputting to	Save output to the named file rather than outputting to
\fIstdout\fR.	stdout\&.
.TP	.RE
	.PP
\fB\-\-no\-super\-update\fR	\fB\-\-no\-super\-update\fR
	.RS 4
Do not update the	Do not update the
SGML	SGML
super catalog.	super catalog\&.
.TP	.RE
	.PP
\fB\-\-shell\fR	\fB\-\-shell\fR
	.RS 4
Run a shell allowing interactive queries on catalog file	Run a shell allowing interactive queries on catalog file
\fICATALOGFILE\fR. For the set of available commands see	\fICATALOGFILE\fR\&. For the set of available commands see
the section called \(lqSHELL COMMANDS\(rq.	the section called \(lqSHELL COMMANDS\(rq\&.
.TP	.RE
	.PP
\fB\-\-sgml\fR	\fB\-\-sgml\fR
	.RS 4
Uses	Uses
SGML	SGML
super catalogs for	super catalogs for
\fB\-\-add\fR	\fB\-\-add\fR
and	and
\fB\-\-del\fR	\fB\-\-del\fR
options.	options\&.
.TP	.RE
	.PP
\fB\-v\fR, \fB\-\-verbose\fR	\fB\-v\fR, \fB\-\-verbose\fR
Output debugging information.	.RS 4
	Output debugging information\&.
	.RE
.SH "SHELL COMMANDS"	.SH "SHELL COMMANDS"
.PP	.PP
Invoking	Invoking
Line 122 Invoking	Line 162 Invoking
with the	with the
\fB\-\-shell \fR\fB\fICATALOGFILE\fR\fR	\fB\-\-shell \fR\fB\fICATALOGFILE\fR\fR
option opens a command line shell allowing interactive access to the catalog file identified by	option opens a command line shell allowing interactive access to the catalog file identified by
\fICATALOGFILE\fR. Invoking the shell provides a command line prompt after which the following commands (described in alphabetical order) can be entered.	\fICATALOGFILE\fR\&. Invoking the shell provides a command line prompt after which the following commands (described in alphabetical order) can be entered\&.
.TP	.PP
\fBadd \fR\fB\fITYPE\fR\fR\fB \fR\fB\fIORIG\fR\fR\fB \fR\fB\fIREPLACE\fR\fR\fB \fR	\fBadd \fR\fB\fITYPE\fR\fR\fB \fR\fB\fIORIG\fR\fR\fB \fR\fB\fIREPLACE\fR\fR\fB \fR
Add an entry to the catalog file.	.RS 4
	Add an entry to the catalog file\&.
\fITYPE\fR	\fITYPE\fR
indicates the type of entry. Possible types are:	indicates the type of entry\&. Possible types are:
\fIpublic\fR, \fIsystem\fR, \fIrewriteSystem\fR, \fIrewriteURI\fR, \fIdelegatePublic\fR, \fIdelegateSystem\fR, \fInextCatalog\fR.	\fIpublic\fR, \fIsystem\fR, \fIuri\fR, \fIrewriteSystem\fR, \fIrewriteURI\fR, \fIdelegatePublic\fR, \fIdelegateSystem\fR, \fIdelegateURI\fR, \fInextCatalog\fR\&.
\fIORIG\fR	\fIORIG\fR
is the original reference to be replaced, and	is the original reference to be replaced, and
\fIREPLACE\fR	\fIREPLACE\fR
is the	is the
URI	URI
of the replacement entity to be used. The	of the replacement entity to be used\&. The
\fB\-\-add\fR	\fB\-\-add\fR
option will not overwrite	option will not overwrite
\fICATALOGFILE\fR, outputting to	CATALOGFILE, outputting to
\fIstdout\fR, unless	stdout, unless
\fB\-\-noout\fR	\fB\-\-noout\fR
is used. The	is used\&. The
\fB\-\-add\fR	\fB\-\-add\fR
will always take three parameters even if some of the	will always take three parameters even if some of the
XML	XML
catalog constructs will have only a single argument.	catalog constructs will have only a single argument\&.
.TP	.RE
	.PP
\fBdebug\fR	\fBdebug\fR
	.RS 4
Print debugging statements showing the steps	Print debugging statements showing the steps
\fBxmlcatalog\fR	\fBxmlcatalog\fR
is executing.	is executing\&.
.TP	.RE
	.PP
\fBdel \fR\fB\fIVALUE(S)\fR\fR	\fBdel \fR\fB\fIVALUE(S)\fR\fR
	.RS 4
Remove the catalog entry corresponding to	Remove the catalog entry corresponding to
\fIVALUE(S)\fR.	\fIVALUE(S)\fR\&.
.TP	.RE
	.PP
\fBdump\fR	\fBdump\fR
Print the current catalog.	.RS 4
.TP	Print the current catalog\&.
	.RE
	.PP
\fBexit\fR	\fBexit\fR
Quit the shell.	.RS 4
.TP	Quit the shell\&.
	.RE
	.PP
\fBpublic \fR\fB\fIPUBLIC\-ID\fR\fR	\fBpublic \fR\fB\fIPUBLIC\-ID\fR\fR
	.RS 4
Execute a Formal Public Identifier look\-up of the catalog entry for	Execute a Formal Public Identifier look\-up of the catalog entry for
\fIPUBLIC\-ID\fR. The corresponding entry will be output to the command line.	\fIPUBLIC\-ID\fR\&. The corresponding entry will be output to the command line\&.
.TP	.RE
	.PP
\fBquiet\fR	\fBquiet\fR
Stop printing debugging statements.	.RS 4
.TP	Stop printing debugging statements\&.
	.RE
	.PP
\fBsystem \fR\fB\fISYSTEM\-ID\fR\fR	\fBsystem \fR\fB\fISYSTEM\-ID\fR\fR
	.RS 4
Execute a Formal Public Identifier look\-up of the catalog entry for	Execute a Formal Public Identifier look\-up of the catalog entry for
\fISYSTEM\-ID\fR. The corresponding entry will be output to the command line.	\fISYSTEM\-ID\fR\&. The corresponding entry will be output to the command line\&.
	.RE
.SH "ENVIRONMENT"	.SH "ENVIRONMENT"
.TP	.PP
\fBXML_CATALOG_FILES\fR	\fBXML_CATALOG_FILES\fR
	.RS 4
XML	XML
catalog behavior can be changed by redirecting queries to the user's own set of catalogs. This can be done by setting the	catalog behavior can be changed by redirecting queries to the user\*(Aqs own set of catalogs\&. This can be done by setting the
\fBXML_CATALOG_FILES\fR	\fBXML_CATALOG_FILES\fR
environment variable to a list of catalogs. An empty one should deactivate loading the default	environment variable to a list of catalogs\&. An empty one should deactivate loading the default
\fI/etc/xml/catalog\fR	/etc/xml/catalog
catalog.	catalog\&.
	.RE
.SH "DIAGNOSTICS"	.SH "DIAGNOSTICS"
.PP	.PP

\fBxmlcatalog\fR	\fBxmlcatalog\fR
return codes provide information that can be used when calling it from scripts.	return codes provide information that can be used when calling it from scripts\&.
.TP	.PP
\fB0\fR	\fB0\fR
	.RS 4
No error	No error
.TP	.RE
	.PP
\fB1\fR	\fB1\fR
	.RS 4
Failed to remove an entry from the catalog	Failed to remove an entry from the catalog
.TP	.RE
	.PP
\fB2\fR	\fB2\fR
	.RS 4
Failed to save to the catalog, check file permissions	Failed to save to the catalog, check file permissions
.TP	.RE
	.PP
\fB3\fR	\fB3\fR
	.RS 4
Failed to add an entry to the catalog	Failed to add an entry to the catalog
.TP	.RE
	.PP
\fB4\fR	\fB4\fR
	.RS 4
Failed to look up an entry in the catalog	Failed to look up an entry in the catalog
	.RE
.SH "SEE ALSO"	.SH "SEE ALSO"
.PP	.PP
\fBlibxml\fR(3)	\fBlibxml\fR(3)
.PP	.PP
More information can be found at	More information can be found at
.TP 3	.sp
\(bu	.RS 4
	.ie n \{\
	\h'-04'\(bu\h'+03'\c
	.\}
	.el \{\
	.sp -1
	.IP \(bu 2.3
	.\}
\fBlibxml\fR(3)	\fBlibxml\fR(3)
web page	web page
\fI\%http://www.xmlsoft.org/\fR	\m[blue]\fB\%http://www.xmlsoft.org/\fR\m[]
.TP	.RE
\(bu	.sp
	.RS 4
	.ie n \{\
	\h'-04'\(bu\h'+03'\c
	.\}
	.el \{\
	.sp -1
	.IP \(bu 2.3
	.\}
\fBlibxml\fR(3)	\fBlibxml\fR(3)
catalog support web page at	catalog support web page at
\fI\%http://www.xmlsoft.org/catalog.html\fR	\m[blue]\fB\%http://www.xmlsoft.org/catalog.html\fR\m[]
.TP	.RE
\(bu	.sp
James Clark's	.RS 4
	.ie n \{\
	\h'-04'\(bu\h'+03'\c
	.\}
	.el \{\
	.sp -1
	.IP \(bu 2.3
	.\}
	James Clark\*(Aqs
SGML	SGML
catalog page	catalog page
\fI\%http://www.jclark.com/sp/catalog.htm\fR	\m[blue]\fB\%http://www.jclark.com/sp/catalog.htm\fR\m[]
.TP	.RE
\(bu	.sp
OASISXML	.RS 4
	.ie n \{\
	\h'-04'\(bu\h'+03'\c
	.\}
	.el \{\
	.sp -1
	.IP \(bu 2.3
	.\}
	OASIS
	XML
catalog specification	catalog specification
\fI\%http://www.oasis\-open.org/committees/entity/spec.html\fR	\m[blue]\fB\%http://www.oasis-open.org/committees/entity/spec.html\fR\m[]
	.RE
	.sp
.SH "AUTHOR"	.SH "AUTHOR"
John Fleck <jfleck@inkstain.net>.	.PP
	\fBJohn Fleck\fR <\&jfleck@inkstain\&.net\&>
	.RS 4
	Author.
	.RE
	.SH "COPYRIGHT"
	.br
	Copyright \(co 2001, 2004
	.br

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>

Removed from v.1.1.1.1
changed lines
	Added in v.1.1.1.2