1
0
mirror of https://gitlab.gnome.org/GNOME/libxslt synced 2025-07-31 02:43:06 +03:00

//bugzilla.redhat.com/bugzilla/show_bug.cgi?id=56649

Tue Nov 27 21:15:43 MST 2001 John Fleck <jfleck@inkstain.net>

	* doc/xsltproc.xml, xsltproc.1, xsltproc.html - documenting new
	xsltproc return codes, per
	https://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=56649
This commit is contained in:
MST 2001 John Fleck
2001-11-28 04:17:13 +00:00
committed by John Fleck
parent ab9d61ede5
commit 76cbe5f70a
4 changed files with 136 additions and 229 deletions

View File

@ -1,3 +1,9 @@
Tue Nov 27 21:15:43 MST 2001 John Fleck <jfleck@inkstain.net>
* doc/xsltproc.xml, xsltproc.1, xsltproc.html - documenting new
xsltproc return codes, per
https://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=56649
Tue Nov 27 22:16:50 CET 2001 Daniel Veillard <daniel@veillard.com> Tue Nov 27 22:16:50 CET 2001 Daniel Veillard <daniel@veillard.com>
* libxslt/pattern.c: Marc Tardif provided a patch to use as * libxslt/pattern.c: Marc Tardif provided a patch to use as

View File

@ -1,185 +1,138 @@
.\" ."Generated by db2man.xsl. Don't modify this, modify the source.
.\" This page was created on 2001-08-28 20:39:41 by makeman.pl .de Sh \" Subsection
.\" ``makeman.pl'' is part of the ``MakeMan'' project. .br
.\" For more information, please see http://mama.sourceforge.net .if t .Sp
.\" .ne 5
.TH xsltproc 1 .PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Ip \" List item
.br
.ie \\n(.$>=3 .ne \\$3
.el .ne 3
.IP "\\$1" \\$2
..
.TH "xsltproc" 1 "" "" "xsltproc Manual"
.SH NAME .SH NAME
xsltproc \- command line xslt processor xsltproc \- command line xslt processor
.SH "SYNOPSIS"
.SH SYNOPSIS \fBxsltproc\fR [\fB-V\fR | \fB-v\fR | \fB-o \fIfile\fR \fR | \fB--timing\fR | \fB--repeat\fR | \fB--debug\fR | \fB--novalid\fR | \fB--noout\fR | \fB--maxdepth \fIval\fR \fR | \fB--html\fR | \fB--docbook\fR | \fB--param \fIname\fR \fIvalue\fR \fR | \fB--nonet\fR | \fB--warnnet\fR | \fB--catalogs\fR | \fB--xinclude\fR | \fB--profile\fR] [\fB\fIstylesheet\fR\fR] [ \fIfile1\fR ] [ \fIfile2\fR ] [ \fI....\fR ]
\fBxsltproc\fR .SH "INTRODUCTION"
[ \fI\-V\fR ] [ \fI\-v\fR ] [ \fI\-o \fR ] [ \fI\-\-timing\fR ] [ \fI\-\-repeat\fR ] [ \fI\-\-debug\fR ] [ \fI\-\-novalid\fR ] [ \fI\-\-noout\fR ] [ \fI\-\-maxdepth \fR ] [ \fI\-\-html\fR ] [ \fI\-\-docbook\fR ] [ \fI\-\-param \fR ] [ \fI\-\-nonet\fR ] [ \fI\-\-warnnet\fR ] [ \fI\-\-catalogs\fR ] [ \fI\-\-xinclude\fR ] [ \fI\-\-profile\fR ] [ \fIstylesheet\fR ] [ \fIfile1\fR ] [ \fIfile2\fR ] [ \fI....\fR ]
.SH "Introduction"
.PP .PP
xsltproc is a command line tool for applying XSLT stylesheets to XML documents. It is part of libxslt, the XSLT C library for GNOME. While it was developed as part of the GNOME project, it can operate independently of the GNOME desktop.
xsltproc is a command line tool for applying
XSLT stylesheets to XML
documents. It is part of libxslt, the XSLT C
library for GNOME. While it was developed as part of the GNOME project, it
can operate independently of the GNOME desktop.
.PP .PP
xsltproc is invoked from the command line with the name of the stylesheet to be used followed by the name of the file or files to which the stylesheet is to be applied.
xsltproc is invoked from the command line with
the name of the stylesheet to be used followed by the name of the file or
files to which the stylesheet is to be applied.
.PP .PP
If a stylesheet is included in an XML document with a Stylesheet Processing Instruction, no stylesheet need be named at the command line. xsltproc will automatically detect the included stylesheet and use it.
If a stylesheet is included in an XML document with a
Stylesheet Processing Instruction, no stylesheet need be named at the
command line. xsltproc will automatically
detect the included stylesheet and use it.
.PP .PP
By default, output is to stdout. You can specify a file for output using the \fB-o\fR option.
By default, output is to stdout. You can specify a file for output using .SH "OPTIONS"
the \-o option.
.SH "Options"
.PP .PP
\fB-V\fR or \fB--version\fR - Show the version of libxml and libxslt used.
\-V or \-\-version \- Show the version of
libxml and libxslt used.
.PP .PP
\fB-v\fR or \fB--verbose\fR - Output each step taken by xsltproc in processing the stylesheet and the document.
\-v or \-\-verbose \- Output each step taken
by xsltproc in processing the stylesheet and the document.
.PP .PP
\fB-o\fR or \fB--output\fR \fIfile\fR - Direct output to the file named \fIfile\fR. For multiple outputs, also known as "chunking", \fB-o\fR \fBdirectory/\fR directs the output files to a specified directory. The directory must already exist.
\-o or \-\-output
\fIfile\fR \- Direct output to the file named
\fIfile\fR. For multiple outputs, also known as
"chunking", \-o directory/ directs the
output files to a specified directory. The directory must already exist.
.PP .PP
\fB--timing\fR - Display the time used for parsing the stylesheet, parsing the document and applying the stylesheet and saving the result. Displayed in milliseconds.
\-\-timing \- Display the time used for parsing the
stylesheet, parsing the document and applying the stylesheet and saving
the result. Displayed in milliseconds.
.PP .PP
\fB--repeat\fR - Run the transformation 20 times. Used for timing tests.
\-\-repeat \- Run the transformation 20 times. Used for
timing tests.
.PP .PP
\fB--debug\fR - Output an XML tree of the transformed document for debugging purposes.
\-\-debug \- Output an XML tree of the
transformed document for debugging purposes.
.PP .PP
\fB--novalid\fR - Skip loading the document's DTD.
\-\-novalid \- Skip loading the document's DTD.
.PP .PP
\fB--noout\fR - Do not output the result.
\-\-noout \- Do not output the result.
.PP .PP
\fB--maxdepth\fR \fIvalue\fR - Adjust the maximum depth of the template stack before libxslt concludes it is in an infinite loop. The default is 500.
\-\-maxdepth \fIvalue\fR \- Adjust the
maximum depth of the template stack before
libxslt concludes it is in an infinite
loop. The default is 500.
.PP .PP
\fB--html\fR - The input document is an HTML file.
\-\-html \- The input document is an HTML
file.
.PP .PP
\fB--docbook\fR - The input document is DocBook SGML.
\-\-docbook \- The input document is DocBook
SGML.
.PP .PP
\fB--param\fR \fIname\fR \fIvalue\fR - Pass a parameter of name \fIname\fR and value \fIvalue\fR to the stylesheet. You may pass multiple name/value pairs up to a maximum of 8. .PP If the value being passed is a string rather than a node identifier, it must be escaped in quotes, as follows: .PP xsltproc --param rootid '"introduction"' \fIstylesheet\fR \fIfile\fR
\-\-param \fIname\fR
\fIvalue\fR \- Pass a parameter of name
\fIname\fR and value
\fIvalue\fR to the stylesheet. You may pass multiple
name/value pairs up to a maximum of 8.
.PP .PP
\fB--nonet\fR - Do not use the Internet to fetch DTD's or entities.
If the value being passed is a string rather than a node identifier,
it must be escaped in quotes, as follows:
.PP .PP
\fB--warnnet\fR - Output notification when DTD's or entities are fetched over the Internet.
xsltproc \-\-param rootid '"introduction"'
\fIstylesheet\fR \fIfile\fR
.PP .PP
\fB--catalogs\fR - Use catalogs to resolve the location of external entities. This speeds DTD resolution. By having a catalog file point to a local version of the DTD, xsltproc does not have to use the Internet to fetch the DTD. xsltproc uses the catalog identified by the environmental variable \fBSGML_CATALOG_FILES\fR.
\-\-nonet \- Do not use the Internet to fetch DTD's or
entities.
.PP .PP
\fB--xinclude\fR - Process the input document using the Xinclude specification. More details on this can be found in the Xinclude specification: http://www.w3.org/TR/xinclude/: \fIhttp://www.w3.org/TR/xinclude/\fR
\-\-warnnet \- Output notification when DTD's or entities
are fetched over the Internet.
.PP .PP
\fB--profile\fR or \fB--norman\fR - Output profiling information detailing the amount of time spent in each part of the stylesheet. This is useful in optimizing stylesheet performance.
\-\-catalogs \- Use catalogs to resolve the location of .SH "RETURN VALUES"
external entities. This speeds DTD resolution. By having a
catalog file point to a local version of the DTD,
xsltproc does not have to use the
Internet to fetch the DTD. xsltproc
uses the catalog identified by the environmental variable
SGML_CATALOG_FILES.
.PP .PP
xsltproc's return codes provide information that can be used when calling it from scripts.
\-\-xinclude \- Process the input document using the
Xinclude specification. More details on this can be found in the Xinclude
specification: http://www.w3.org/TR/xinclude/ (Link to \fIhttp://www.w3.org/TR/xinclude/\fR)
.PP .PP
0: normal
\-\-profile or \-\-norman \- Output profiling
information detailing the amount of time spent in each part of the
stylesheet. This is useful in optimizing stylesheet performance.
.SH "More Information"
.PP .PP
1: no argument
.IP .PP
libxml web page: http://www.xmlsoft.org/ (Link to \fIhttp://www.xmlsoft.org/\fR) 2: too many parameters
.IP
W3C XSLT page: http://www.w3.org/TR/xslt (Link to \fIhttp://www.w3.org/TR/xslt\fR)
.PP
3: unknown option
.PP
4: failed to parse the stylesheet
.PP
5: error in the stylesheet
.PP
6: error in one of the documents
.PP
7: unsuppoted xsl:output method
.SH "MORE INFORMATION"
.PP
libxml web page: http://www.xmlsoft.org/: \fIhttp://www.xmlsoft.org/\fR
.PP
W3C XSLT page: http://www.w3.org/TR/xslt: \fIhttp://www.w3.org/TR/xslt\fR
.SH AUTHOR
Copyright 2001
.Sp
John Fleck <jfleck@inkstain.net>
.PP
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License: \fIgnome-help:fdl\fR, 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 here: \fIgnome-help:fdl\fR.
.PP
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.
This is release 0.1 of the xsltproc Manual.

View File

@ -1,127 +1,80 @@
<!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>xsltproc</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="id2589399"></a>xsltproc</h1><div class="refnamediv"><a name="id2709332"></a><h2>Name</h2>xsltproc &#8212; command line xslt processor</div><div class="refsynopsisdiv"><a name="id2709344"></a><h2>Synopsis</h2><div class="cmdsynopsis" id="id2589405"><a name="id2589405"></a><tt>xsltproc</tt> [-V | -v | -o <i><tt>file</tt></i> | --timing | --repeat | --debug | --novalid | --noout | --maxdepth <i><tt>val</tt></i> | --html | --docbook | --param <i><tt>name</tt></i> <i><tt>value</tt></i> | --nonet | --warnnet | --catalogs | --xinclude | --profile] [<tt><i><tt>stylesheet</tt></i></tt>] [<i><tt>file1</tt></i>] [<i><tt>file2</tt></i>] [<i><tt>....</tt></i>]</div></div><div class="refsect1"><a name="introduction"></a><h2><a name="introduction"></a>Introduction</h2><p>
<html>
<head>
<meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type">
<title>xsltproc</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="id2589653"></a>xsltproc</h1>
<div class="refnamediv">
<a name="id2708033"></a><h2>Name</h2>xsltproc &#x2014; command line xslt processor</div>
<div class="refsynopsisdiv">
<a name="id2708046"></a><h2>Synopsis</h2>
<div class="cmdsynopsis" id="id2708049">
<a name="id2708049"></a><tt>xsltproc</tt> [-V | -v | -o <i><tt>file</tt></i> | --timing | --repeat | --debug | --novalid | --noout | --maxdepth <i><tt>val</tt></i> | --html | --docbook | --param <i><tt>name</tt></i> <i><tt>value</tt></i> | --nonet | --warnnet | --catalogs | --xinclude | --profile] [<tt><i><tt>stylesheet</tt></i></tt>] [<i><tt>file1</tt></i>] [<i><tt>file2</tt></i>] [<i><tt>....</tt></i>]</div>
</div>
<div class="refsect1">
<a name="introduction"></a><h2>
<a name="introduction"></a>Introduction</h2>
<p>
xsltproc is a command line tool for applying xsltproc is a command line tool for applying
XSLT stylesheets to XML XSLT stylesheets to XML
documents. It is part of libxslt, the XSLT C documents. It is part of libxslt, the XSLT C
library for GNOME. While it was developed as part of the GNOME project, it library for GNOME. While it was developed as part of the GNOME project, it
can operate independently of the GNOME desktop. can operate independently of the GNOME desktop.
</p> </p><p>
<p>
xsltproc is invoked from the command line with xsltproc is invoked from the command line with
the name of the stylesheet to be used followed by the name of the file or the name of the stylesheet to be used followed by the name of the file or
files to which the stylesheet is to be applied. files to which the stylesheet is to be applied.
</p> </p><p>
<p>
If a stylesheet is included in an XML document with a If a stylesheet is included in an XML document with a
Stylesheet Processing Instruction, no stylesheet need be named at the Stylesheet Processing Instruction, no stylesheet need be named at the
command line. xsltproc will automatically command line. xsltproc will automatically
detect the included stylesheet and use it. detect the included stylesheet and use it.
</p> </p><p>
<p>
By default, output is to stdout. You can specify a file for output using By default, output is to stdout. You can specify a file for output using
the <tt>-o</tt> option. the <tt>-o</tt> option.
</p> </p></div><div class="refsect1"><a name="options"></a><h2><a name="options"></a>Options</h2><p>
</div>
<div class="refsect1">
<a name="options"></a><h2>
<a name="options"></a>Options</h2>
<p>
<tt>-V</tt> or <tt>--version</tt> - Show the version of <tt>-V</tt> or <tt>--version</tt> - Show the version of
libxml and libxslt used. libxml and libxslt used.
</p> </p><p>
<p>
<tt>-v</tt> or <tt>--verbose</tt> - Output each step taken <tt>-v</tt> or <tt>--verbose</tt> - Output each step taken
by xsltproc in processing the stylesheet and the document. by xsltproc in processing the stylesheet and the document.
</p> </p><p>
<p>
<tt>-o</tt> or <tt>--output</tt> <tt>-o</tt> or <tt>--output</tt>
<i><tt>file</tt></i> - Direct output to the file named <i><tt>file</tt></i> - Direct output to the file named
<i><tt>file</tt></i>. For multiple outputs, also known as <i><tt>file</tt></i>. For multiple outputs, also known as
&quot;chunking&quot;, <tt>-o</tt> <tt>directory/</tt> directs the &quot;chunking&quot;, <tt>-o</tt> <tt>directory/</tt> directs the
output files to a specified directory. The directory must already exist. output files to a specified directory. The directory must already exist.
</p> </p><p>
<p>
<tt>--timing</tt> - Display the time used for parsing the <tt>--timing</tt> - Display the time used for parsing the
stylesheet, parsing the document and applying the stylesheet and saving stylesheet, parsing the document and applying the stylesheet and saving
the result. Displayed in milliseconds. the result. Displayed in milliseconds.
</p> </p><p>
<p>
<tt>--repeat</tt> - Run the transformation 20 times. Used for <tt>--repeat</tt> - Run the transformation 20 times. Used for
timing tests. timing tests.
</p> </p><p>
<p>
<tt>--debug</tt> - Output an XML tree of the <tt>--debug</tt> - Output an XML tree of the
transformed document for debugging purposes. transformed document for debugging purposes.
</p> </p><p>
<p>
<tt>--novalid</tt> - Skip loading the document's DTD. <tt>--novalid</tt> - Skip loading the document's DTD.
</p> </p><p>
<p>
<tt>--noout</tt> - Do not output the result. <tt>--noout</tt> - Do not output the result.
</p> </p><p>
<p>
<tt>--maxdepth</tt> <i><tt>value</tt></i> - Adjust the <tt>--maxdepth</tt> <i><tt>value</tt></i> - Adjust the
maximum depth of the template stack before maximum depth of the template stack before
libxslt concludes it is in an infinite libxslt concludes it is in an infinite
loop. The default is 500. loop. The default is 500.
</p> </p><p>
<p>
<tt>--html</tt> - The input document is an HTML <tt>--html</tt> - The input document is an HTML
file. file.
</p> </p><p>
<p>
<tt>--docbook</tt> - The input document is DocBook <tt>--docbook</tt> - The input document is DocBook
SGML. SGML.
</p> </p><p>
<p>
<tt>--param</tt> <i><tt>name</tt></i> <tt>--param</tt> <i><tt>name</tt></i>
<i><tt>value</tt></i> - Pass a parameter of name <i><tt>value</tt></i> - Pass a parameter of name
<i><tt>name</tt></i> and value <i><tt>name</tt></i> and value
<i><tt>value</tt></i> to the stylesheet. You may pass multiple <i><tt>value</tt></i> to the stylesheet. You may pass multiple
name/value pairs up to a maximum of 8. name/value pairs up to a maximum of 8.
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"> <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2707986"></a>Note</h3><p>
<h3 class="title">
<a name="id2708378"></a>Note</h3>
<p>
If the value being passed is a string rather than a node identifier, If the value being passed is a string rather than a node identifier,
it must be escaped in quotes, as follows: it must be escaped in quotes, as follows:
</p> </p><p>
<p>
xsltproc --param rootid '&quot;introduction&quot;' xsltproc --param rootid '&quot;introduction&quot;'
<i><tt>stylesheet</tt></i> <i><tt>file</tt></i> <i><tt>stylesheet</tt></i> <i><tt>file</tt></i>
</p> </p></div>
</div> </p><p>
</p>
<p>
<tt>--nonet</tt> - Do not use the Internet to fetch DTD's or <tt>--nonet</tt> - Do not use the Internet to fetch DTD's or
entities. entities.
</p> </p><p>
<p>
<tt>--warnnet</tt> - Output notification when DTD's or entities <tt>--warnnet</tt> - Output notification when DTD's or entities
are fetched over the Internet. are fetched over the Internet.
</p> </p><p>
<p>
<tt>--catalogs</tt> - Use catalogs to resolve the location of <tt>--catalogs</tt> - Use catalogs to resolve the location of
external entities. This speeds DTD resolution. By having a external entities. This speeds DTD resolution. By having a
catalog file point to a local version of the DTD, catalog file point to a local version of the DTD,
@ -129,31 +82,13 @@
Internet to fetch the DTD. xsltproc Internet to fetch the DTD. xsltproc
uses the catalog identified by the environmental variable uses the catalog identified by the environmental variable
<tt>SGML_CATALOG_FILES</tt>. <tt>SGML_CATALOG_FILES</tt>.
</p> </p><p>
<p>
<tt>--xinclude</tt> - Process the input document using the <tt>--xinclude</tt> - Process the input document using the
Xinclude specification. More details on this can be found in the Xinclude Xinclude specification. More details on this can be found in the Xinclude
specification: <a href="http://www.w3.org/TR/xinclude/" target="_top">http://www.w3.org/TR/xinclude/</a> specification: <a href="http://www.w3.org/TR/xinclude/" target="_top">http://www.w3.org/TR/xinclude/</a>
</p> </p><p>
<p>
<tt>--profile</tt> or <tt>--norman</tt> - Output profiling <tt>--profile</tt> or <tt>--norman</tt> - Output profiling
information detailing the amount of time spent in each part of the information detailing the amount of time spent in each part of the
stylesheet. This is useful in optimizing stylesheet performance. stylesheet. This is useful in optimizing stylesheet performance.
</p> </p></div><div class="refsect1"><a name="return"></a><h2><a name="return"></a>Return values</h2><p>xsltproc's return codes provide information
</div> that can be used when calling it from scripts.</p><p>0: normal</p><p>1: no argument</p><p>2: too many parameters</p><p>3: unknown option</p><p>4: failed to parse the stylesheet</p><p>5: error in the stylesheet</p><p>6: error in one of the documents</p><p>7: unsuppoted xsl:output method</p></div><div class="refsect1"><a name="moreinfo"></a><h2><a name="moreinfo"></a>More Information</h2><p>libxml web page: <a href="http://www.xmlsoft.org/" target="_top">http://www.xmlsoft.org/</a></p><p>W3C XSLT page: <a href="http://www.w3.org/TR/xslt" target="_top">http://www.w3.org/TR/xslt</a></p></div></div></body></html>
<div class="refsect1">
<a name="moreinfo"></a><h2>
<a name="moreinfo"></a>More Information</h2>
<p>
<div class="itemizedlist"><ul>
<li><p>
<a name="id2708506"></a>libxml web page: <a href="http://www.xmlsoft.org/" target="_top">http://www.xmlsoft.org/</a>
</p></li>
<li><p>
<a name="id2708525"></a>W3C XSLT page: <a href="http://www.w3.org/TR/xslt" target="_top">http://www.w3.org/TR/xslt</a>
</p></li>
</ul></div>
</p>
</div>
</div></body>
</html>

View File

@ -217,17 +217,30 @@
</para> </para>
</refsect1> </refsect1>
<refsect1 id="return">
<title>Return values</title>
<para><application>xsltproc</application>'s return codes provide information
that can be used when calling it from scripts.</para>
<para>0: normal</para>
<para>1: no argument</para>
<para>2: too many parameters</para>
<para>3: unknown option</para>
<para>4: failed to parse the stylesheet</para>
<para>5: error in the stylesheet</para>
<para>6: error in one of the documents</para>
<para>7: unsuppoted xsl:output method</para>
</refsect1>
<refsect1 id="moreinfo"> <refsect1 id="moreinfo">
<title>More Information</title> <title>More Information</title>
<para>
<itemizedlist>
<listitem>
<para><application>libxml web page: </application><ulink url="http://www.xmlsoft.org/">http://www.xmlsoft.org/</ulink></para> <para><application>libxml web page: </application><ulink url="http://www.xmlsoft.org/">http://www.xmlsoft.org/</ulink></para>
</listitem>
<listitem>
<para>W3C <acronym>XSLT page: </acronym><ulink url="http://www.w3.org/TR/xslt">http://www.w3.org/TR/xslt</ulink></para> <para>W3C <acronym>XSLT page: </acronym><ulink url="http://www.w3.org/TR/xslt">http://www.w3.org/TR/xslt</ulink></para>
</listitem>
</itemizedlist>
</para>
</refsect1> </refsect1>
</refentry> </refentry>