source-git / libxml2

Clone
Source Code
GIT

Blame doc/xmlcatalog_man.html

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

    Powered by Pagure 5.13.3

    SSH Hostkey/Fingerprint | Documentation