source-git / libxml2

Clone
Source Code
GIT

Blame doc/xmlcatalog_man.html

c8 c8s master
  1.   571f18a95c6e28341d6b354490af897b00685cf6
  2.   doc
  3.   xmlcatalog_man.html
Blob History Raw
Packit Service a31ea6 
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>xmlcatalog</title><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Name
xmlcatalog —
Packit Service a31ea6 
		Command line tool to parse and manipulate XML
Packit Service a31ea6 
		or SGML catalog files.
Packit Service a31ea6 
	
Synopsis
xmlcatalog  [ --sgml  |   --shell  |   --create  |   --del VALUE(S)  |
Packit Service a31ea6 
			[
Packit Service a31ea6 
					--add
Packit Service a31ea6 
					 TYPE
Packit Service a31ea6 
					 ORIG
Packit Service a31ea6 
					 REPLACE
Packit Service a31ea6
Packit Service a31ea6 
				  |   --add FILENAME ]
Packit Service a31ea6 
		  |   --noout  |   --no-super-update  |
Packit Service a31ea6 
			[ -v  |   --verbose ]
Packit Service a31ea6 
		 ] {CATALOGFILE} {ENTITIES...}
DESCRIPTION
Packit Service a31ea6 
		xmlcatalog is a command line application allowing users to monitor and
Packit Service a31ea6 
		manipulate XML and SGML catalogs. It
Packit Service a31ea6 
		is included in libxml(3).
Packit Service a31ea6
Packit Service a31ea6 
		Its functions can be invoked from a single command from the command line,
Packit Service a31ea6 
		or it can perform multiple functions in interactive mode. It can operate
Packit Service a31ea6 
		on both XML and SGML files.
Packit Service a31ea6 
	
OPTIONS
Packit Service a31ea6 
		xmlcatalog accepts the following options (in alphabetical order):
Packit Service a31ea6
Packit Service a31ea6 
		--add
Packit Service a31ea6 
		 TYPE
Packit Service a31ea6 
		 ORIG
Packit Service a31ea6 
		 REPLACE
Packit Service a31ea6
Packit Service a31ea6
Packit Service a31ea6 
			Add an entry to CATALOGFILE. TYPE
Packit Service a31ea6 
			indicates the type of entry. Possible types are: public, system, uri, rewriteSystem, rewriteURI, delegatePublic, delegateSystem, delegateURI, nextCatalog. ORIG is the original
Packit Service a31ea6 
			reference to be replaced, and REPLACE
Packit Service a31ea6 
			is the URI of the replacement entity to be
Packit Service a31ea6 
			used. The --add option will not overwrite
Packit Service a31ea6 
			CATALOGFILE, outputting
Packit Service a31ea6 
			to stdout, unless
Packit Service a31ea6 
			--noout is used. The --add will
Packit Service a31ea6 
			always take three parameters even if some of the XML
Packit Service a31ea6 
			catalog constructs will have only a single argument.
Packit Service a31ea6 
		
--add FILENAME
Packit Service a31ea6 
			If the --add option is used following
Packit Service a31ea6 
			the --sgml option, only a single argument,
Packit Service a31ea6 
			a FILENAME, is used. This is used to add
Packit Service a31ea6 
			the name of a catalog file to an SGML supercatalog,
Packit Service a31ea6 
			a file that contains references to other included SGML
Packit Service a31ea6 
			catalog files.
Packit Service a31ea6 
		
--create
Packit Service a31ea6 
			Create a new XML catalog. Outputs
Packit Service a31ea6 
			to stdout,
Packit Service a31ea6 
			ignoring filename unless --noout is
Packit Service a31ea6 
			used, in which case it creates a new catalog
Packit Service a31ea6 
			file filename.
Packit Service a31ea6 
		
--del VALUE(S)
Packit Service a31ea6 
			Remove entries from CATALOGFILE
Packit Service a31ea6 
			matching VALUE(S). The --del
Packit Service a31ea6 
			option will not overwrite CATALOGFILE,
Packit Service a31ea6 
			outputting to stdout,
Packit Service a31ea6 
			unless --noout is used.
Packit Service a31ea6 
		
--noout
Packit Service a31ea6 
			Save output to the named file rather than outputting
Packit Service a31ea6 
			to stdout.
Packit Service a31ea6 
		
--no-super-update
Packit Service a31ea6 
			Do not update the SGML super catalog.
Packit Service a31ea6 
		
--shell
Packit Service a31ea6 
			Run a shell allowing interactive queries on catalog
Packit Service a31ea6 
			file CATALOGFILE. For the set of available
Packit Service a31ea6 
			commands see the section called “SHELL COMMANDS”.
Packit Service a31ea6 
		
--sgml
Packit Service a31ea6 
			Uses SGML super catalogs for --add
Packit Service a31ea6 
			and --del options.
Packit Service a31ea6 
		
-v, --verbose
Output debugging information.
Packit Service a31ea6 
		Invoking xmlcatalog non-interactively without a designated action
Packit Service a31ea6 
		(imposed with options like --add) will result in a lookup
Packit Service a31ea6 
		of the catalog entry for ENTITIES in the
Packit Service a31ea6 
		catalog denoted with CATALOGFILE. The
Packit Service a31ea6 
		corresponding entries will be output to the command line. This mode of
Packit Service a31ea6 
		operation, together with --shell mode and non-modifying
Packit Service a31ea6 
		(i.e. without --noout) direct actions, allows for
Packit Service a31ea6 
		a special shortcut of the void CATALOGFILE
Packit Service a31ea6 
		specification (possibly expressed as "" in the shell
Packit Service a31ea6 
		environment) appointing the default system catalog. That simplifies the
Packit Service a31ea6 
		handling when its exact location is irrelevant but the respective built-in
Packit Service a31ea6 
		still needs to be consulted.
Packit Service a31ea6 
	
SHELL COMMANDS
Packit Service a31ea6 
		Invoking xmlcatalog with
Packit Service a31ea6 
		the --shell CATALOGFILE option opens
Packit Service a31ea6 
		a command line shell allowing interactive access to the catalog file
Packit Service a31ea6 
		identified by CATALOGFILE. Invoking the shell
Packit Service a31ea6 
		provides a command line prompt after which the following commands (described in
Packit Service a31ea6 
		alphabetical order) can be entered.
Packit Service a31ea6
Packit Service a31ea6 
		add
Packit Service a31ea6 
		 TYPE
Packit Service a31ea6 
		 ORIG
Packit Service a31ea6 
		 REPLACE
Packit Service a31ea6
Packit Service a31ea6
Packit Service a31ea6 
			Add an entry to the catalog file. TYPE
Packit Service a31ea6 
			indicates the type of entry. Possible types are: public, system, uri, rewriteSystem, rewriteURI, delegatePublic, delegateSystem, delegateURI, nextCatalog. ORIG is the original
Packit Service a31ea6 
			reference to be replaced, and REPLACE
Packit Service a31ea6 
			is the URI of the replacement entity to be
Packit Service a31ea6 
			used. The --add option will not overwrite
Packit Service a31ea6 
			CATALOGFILE, outputting
Packit Service a31ea6 
			to stdout, unless
Packit Service a31ea6 
			--noout is used. The --add will
Packit Service a31ea6 
			always take three parameters even if some of the XML
Packit Service a31ea6 
			catalog constructs will have only a single argument.
Packit Service a31ea6 
		
debug
Packit Service a31ea6 
			Print debugging statements showing the steps xmlcatalog is executing.
Packit Service a31ea6 
		
del VALUE(S)
Packit Service a31ea6 
			Remove the catalog entry corresponding to VALUE(S).
Packit Service a31ea6 
		
dump
Print the current catalog.
exit
Quit the shell.
public PUBLIC-ID
Packit Service a31ea6 
			Execute a Formal Public Identifier lookup of the catalog entry
Packit Service a31ea6 
			for PUBLIC-ID. The corresponding entry will be
Packit Service a31ea6 
			output to the command line.
Packit Service a31ea6 
		
quiet
Stop printing debugging statements.
system SYSTEM-ID
Packit Service a31ea6 
			Execute a Formal Public Identifier lookup of the catalog entry
Packit Service a31ea6 
			for SYSTEM-ID. The corresponding entry will be
Packit Service a31ea6 
			output to the command line.
Packit Service a31ea6 
		
ENVIRONMENT
XML_CATALOG_FILES
XML catalog behavior can be changed by redirecting
Packit Service a31ea6 
			queries to the user's own set of catalogs. This can be done by setting
Packit Service a31ea6 
			the XML_CATALOG_FILES environment variable to a list
Packit Service a31ea6 
			of catalogs. An empty one should deactivate loading the
Packit Service a31ea6 
			default /etc/xml/catalog catalog.
Packit Service a31ea6 
		
DIAGNOSTICS
Packit Service a31ea6 
		xmlcatalog return codes provide information that can be used when
Packit Service a31ea6 
		calling it from scripts.
Packit Service a31ea6 
	
0
No error
1
Failed to remove an entry from the catalog
2
Failed to save to the catalog, check file permissions
3
Failed to add an entry to the catalog
4
Failed to look up an entry in the catalog
SEE ALSO
libxml(3)
Packit Service a31ea6
Packit Service a31ea6 
		More information can be found at
Packit Service a31ea6
Packit Service a31ea6 
				
  • libxml(3) catalog support web page
    		•
    Packit Service a31ea6 
    					at http://www.xmlsoft.org/catalog.html
    Packit Service a31ea6 
    				
  • James Clark's SGML catalog
    		•
    Packit Service a31ea6 
    					page http://www.jclark.com/sp/catalog.htm
    Packit Service a31ea6 
    				
  • OASIS XML catalog specification
    		•
    Packit Service a31ea6 
    					http://www.oasis-open.org/committees/entity/spec.html
    Packit Service a31ea6
    Packit Service a31ea6 
    	
    </body></html>

    Powered by Pagure 5.13.3

    SSH Hostkey/Fingerprint | Documentation