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

improvement of the man page by Daniel Leidert, c.f. #331779 Daniel

Browse Source 
* doc/xsltproc.1 doc/xsltproc.xml: improvement of the man page
  by Daniel Leidert, c.f. #331779
Daniel
This commit is contained in:
Daniel Veillard
2006-02-19 21:42:25 +00:00
parent e9517d8c4a
commit 9f976346a2
3 changed files with 282 additions and 184 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
ChangeLog
View File

@ -1,3 +1,8 @@
Sun Feb 19 22:40:58 CET 2006 Daniel Veillard <daniel@veillard.com>
* doc/xsltproc.1 doc/xsltproc.xml: improvement of the man page
by Daniel Leidert, c.f. #331779
Sat Feb 11 13:10:01 CET 2006 Daniel Veillard <daniel@veillard.com> Sat Feb 11 13:10:01 CET 2006 Daniel Veillard <daniel@veillard.com>
* libxslt/xsltutils.c: fix xsltSaveResultToString comment * libxslt/xsltutils.c: fix xsltSaveResultToString comment

143
doc/xsltproc.1
View File

@ -24,25 +24,28 @@ xsltproc \- command line xslt processor
.ad l .ad l
.hy 0 .hy 0
.HP 9 .HP 9
\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\-\-param\ \fIname\fR\ \fIvalue\fR\fR | \fB\-\-stringparam\ \fIname\fR\ \fIvalue\fR\fR | \fB\-\-nonet\fR | \fB\-\-path\ \fIpaths\fR\fR | \fB\-\-load\-trace\fR | \fB\-\-catalogs\fR | \fB\-\-xinclude\fR | \fB\-\-profile\fR | \fB\-\-dumpextensions\fR | \fB\-\-nowrite\fR | \fB\-\-nomkdir\fR | \fB\-\-writesubtree\fR | \fB\-\-nodtdattr\fR] [\fB\fIstylesheet\fR\fR] [\fIfile1\fR] [\fIfile2\fR] [\fI\&.\&.\&.\&.\fR] \fBxsltproc\fR [[\fB\fB\-V\fR\fR | \fB\fB\-\-version\fR\fR] [\fB\fB\-v\fR\fR | \fB\fB\-\-verbose\fR\fR] | \fB{\fB\fB\-o\fR\fR\ |\ \fB\fB\-\-output\fR\fR}\ \fIFILE\fR\fR | \fB\fB\-\-timing\fR\fR | \fB\fB\-\-repeat\fR\fR | \fB\fB\-\-debug\fR\fR | \fB\fB\-\-novalid\fR\fR | \fB\fB\-\-noout\fR\fR | \fB\fB\-\-maxdepth\ \fIVALUE\fR\fR\fR | \fB\fB\-\-html\fR\fR | \fB\fB\-\-param\ \fIPARAMNAME\fR\ \fIPARAMVALUE\fR\ \fR\fR | \fB\fB\-\-stringparam\ \fIPARAMNAME\fR\ \fIPARAMVALUE\fR\ \fR\fR | \fB\fB\-\-nonet\fR\fR | \fB\fB\-\-path\ "\fIPATHS\fR"\fR\fR | \fB\fB\-\-load\-trace\fR\fR | \fB\fB\-\-catalogs\fR\fR | \fB\fB\-\-xinclude\fR\fR [\fB\fB\-\-profile\fR\fR | \fB\fB\-\-norman\fR\fR] | \fB\fB\-\-dumpextensions\fR\fR | \fB\fB\-\-nowrite\fR\fR | \fB\fB\-\-nomkdir\fR\fR | \fB\fB\-\-writesubtree\ \fIPATH\fR\fR\fR | \fB\fB\-\-nodtdattr\fR\fR] [\fISTYLESHEET\fR] {\fIFILE\fR...}
.ad .ad
.hy .hy
.SH "INTRODUCTION" .SH "DESCRIPTION"
.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\&. \fBxsltproc\fR 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\&. It will use the standard input if a filename provided is \- \&. \fBxsltproc\fR 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\&. It will use the standard input if a filename provided is \- \&.
.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\&. \fBxsltproc\fR 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 the \fB\-o\fR option\&.
.SH "COMMAND LINE OPTIONS" .SH "OPTIONS"
.PP
\fBxsltproc\fR currently accepts the following options:
.TP .TP
\fB\-V\fR or \fB\-\-version\fR \fB\-V\fR or \fB\-\-version\fR
@ -50,11 +53,11 @@ Show the version of libxml and libxslt used\&.
.TP .TP
\fB\-v\fR or \fB\-\-verbose\fR \fB\-v\fR or \fB\-\-verbose\fR
Output each step taken by xsltproc in processing the stylesheet and the document\&. Output each step taken by \fBxsltproc\fR in processing the stylesheet and the document\&.
.TP .TP
\fB\-o\fR or \fB\-\-output\fR \fIfile\fR \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\&. Direct output to the file named \fIFILE\fR\&. For multiple outputs, also known as "chunking", \fB\-o \fIDIRECTORY/\fR\fR directs the output files to a specified directory\&. The directory must already exist\&.
.TP .TP
\fB\-\-timing\fR \fB\-\-timing\fR
@ -77,7 +80,7 @@ Skip loading the document's DTD\&.
Do not output the result\&. Do not output the result\&.
.TP .TP
\fB\-\-maxdepth\fR \fIvalue\fR \fB\-\-maxdepth \fIVALUE\fR\fR
Adjust the maximum depth of the template stack before libxslt concludes it is in an infinite loop\&. The default is 500\&. Adjust the maximum depth of the template stack before libxslt concludes it is in an infinite loop\&. The default is 500\&.
.TP .TP
@ -85,19 +88,19 @@ Adjust the maximum depth of the template stack before libxslt concludes it is in
The input document is an HTML file\&. The input document is an HTML file\&.
.TP .TP
\fB\-\-param\fR \fIname\fR \fIvalue\fR \fB\-\-param \fIPARAMNAME\fR \fIPARAMVALUE\fR\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 32\&. If the value being passed is a string rather than a node identifier, use \fB\-\-stringparam\fR instead\&. Pass a parameter of name \fIPARAMNAME\fR and value \fIPARAMVALUE\fR to the stylesheet\&. You may pass multiple name/value pairs up to a maximum of 32\&. If the value being passed is a string rather than a node identifier, use \fB\-\-stringparam\fR instead\&.
.TP .TP
\fB\-\-stringparam\fR \fIname\fR \fIvalue\fR \fB\-\-stringparam \fIPARAMNAME\fR \fIPARAMVALUE\fR\fR
Pass a paramenter of name \fIname\fR and value \fIvalue\fR where \fIvalue\fR is a string rather than a node identifier\&. (Note: The string must be utf\-8\&.) Pass a paramenter of name \fIPARAMNAME\fR and value \fIPARAMVALUE\fR where \fIPARAMVALUE\fR is a string rather than a node identifier\&. (Note: The string must be utf\-8\&.)
.TP .TP
\fB\-\-nonet\fR \fB\-\-nonet\fR
Do not use the Internet to fetch DTD's, entities or documents\&. Do not use the Internet to fetch DTDs, entities or documents\&.
.TP .TP
\fB\-\-path\fR \fIpaths\fR \fB\-\-path "\fIPATHS\fR"\fR
Use the list (separated by space or colon) of filesystem paths specified by \fIpaths\fR to load DTDs, entities or documents\&. Use the list (separated by space or colon) of filesystem paths specified by \fIpaths\fR to load DTDs, entities or documents\&.
.TP .TP
@ -106,11 +109,11 @@ Display to stderr all the documents loaded during the processing\&.
.TP .TP
\fB\-\-catalogs\fR \fB\-\-catalogs\fR
Use the SGML catalog specified in \fBSGML_CATALOG_FILES\fR to resolve the location of external entities\&. By default, xsltproc looks for the catalog specified in \fBXML_CATALOG_FILES\fR\&. If that is not specified, it uses \fI/etc/xml/catalog\fR\&. Use the SGML catalog specified in \fBSGML_CATALOG_FILES\fR to resolve the location of external entities\&. By default, \fBxsltproc\fR looks for the catalog specified in \fBXML_CATALOG_FILES\fR\&. If that is not specified, it uses \fI/etc/xml/catalog\fR\&.
.TP .TP
\fB\-\-xinclude\fR \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 Process the input document using the Xinclude specification\&. More details on this can be found in the Xinclude specification: \fIhttp://www.w3.org/TR/xinclude/\fR
.TP .TP
\fB\-\-profile\fR or \fB\-\-norman\fR \fB\-\-profile\fR or \fB\-\-norman\fR
@ -129,58 +132,76 @@ Refuses to write to any file or resource\&.
Refuses to create directories\&. Refuses to create directories\&.
.TP .TP
\fB\-\-writesubtree\fR \fIpath\fR \fB\-\-writesubtree \fIPATH\fR\fR
Allow file write only within the \fIpath\fR subtree\&. Allow file write only within the \fIPATH\fR subtree\&.
.TP .TP
\fB\-\-nodtdattr\fR \fB\-\-nodtdattr\fR
Do not apply default attributes from the document's DTD\&. Do not apply default attributes from the document's DTD\&.
.SH "RETURN VALUES" .SH "ENVIRONMENT"
.TP
\fBSGML_CATALOG_FILES\fR
\&.\&.\&.
.TP
\fBXML_CATALOG_FILES\fR
\&.\&.\&.
.SH "DIAGNOSTICS"
.PP .PP
xsltproc's return codes provide information that can be used when calling it from scripts\&. \fBxsltproc\fR's return codes provide information that can be used when calling it from scripts\&.
.TP
\fB0\fR
normal
.TP
\fB1\fR
no argument
.TP
\fB2\fR
too many parameters
.TP
\fB3\fR
unknown option
.TP
\fB4\fR
failed to parse the stylesheet
.TP
\fB5\fR
error in the stylesheet
.TP
\fB6\fR
error in one of the documents
.TP
\fB7\fR
unsupported xsl:output method
.TP
\fB8\fR
string parameter contains both quote and double\-quotes
.TP
\fB9\fR
internal processing error
.TP
\fB10\fR
processing was stopped by a terminating message
.SH "SEE ALSO"
.PP .PP
0: normal More information can be found at the libxml web pages at \fIhttp://www.xmlsoft.org/\fR and the W3C XSLT pages at \fIhttp://www.w3.org/TR/xslt\fR\&.
.PP
1: no argument
.PP
2: too many parameters
.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: unsupported xsl:output method
.PP
8: string parameter contains both quote and double\-quotes
.PP
9: internal processing error
.PP
10: processing was stopped by a terminating message
.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 .SH AUTHOR
John Fleck. John Fleck.

318
doc/xsltproc.xml
View File

@ -3,6 +3,8 @@
href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?> href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY xsltproc "<command>xsltproc</command>">
]> ]>
<refentry> <refentry>
@ -33,51 +35,68 @@
<refsynopsisdiv> <refsynopsisdiv>
<cmdsynopsis> <cmdsynopsis>
<command>xsltproc</command> <command>xsltproc</command>
<group> <group choice='opt'>
<arg>-V</arg> <group choice='opt'>
<arg>-v</arg> <arg choice='plain'><option>-V</option></arg>
<arg>-o <replaceable>file</replaceable></arg> <arg choice='plain'><option>--version</option></arg>
<arg>--timing</arg> </group>
<arg>--repeat</arg> <group choice='opt'>
<arg>--debug</arg> <arg choice='plain'><option>-v</option></arg>
<arg>--novalid</arg> <arg choice='plain'><option>--verbose</option></arg>
<arg>--noout</arg> </group>
<arg>--maxdepth <replaceable>val</replaceable></arg> <arg choice="opt">
<arg>--html</arg> <group choice='req'>
<arg>--param <replaceable>name</replaceable> <replaceable>value</replaceable></arg> <arg choice='plain'><option>-o</option></arg>
<arg>--stringparam <replaceable>name</replaceable> <replaceable>value</replaceable></arg> <arg choice='plain'><option>--output</option></arg>
<arg>--nonet</arg> </group>
<arg>--path <replaceable>paths</replaceable></arg> <replaceable class="option">FILE</replaceable>
<arg>--load-trace</arg> </arg>
<arg>--catalogs</arg> <arg choice='plain'><option>--timing</option></arg>
<arg>--xinclude</arg> <arg choice='plain'><option>--repeat</option></arg>
<arg>--profile</arg> <arg choice='plain'><option>--debug</option></arg>
<arg>--dumpextensions</arg> <arg choice='plain'><option>--novalid</option></arg>
<arg>--nowrite</arg> <arg choice='plain'><option>--noout</option></arg>
<arg>--nomkdir</arg> <arg choice='plain'><option>--maxdepth <replaceable class="option">VALUE</replaceable></option></arg>
<arg>--writesubtree</arg> <arg choice='plain'><option>--html</option></arg>
<arg>--nodtdattr</arg> <arg choice='plain'><option>--param
<replaceable class="option">PARAMNAME</replaceable>
<replaceable class="option">PARAMVALUE</replaceable>
</option></arg>
<arg choice='plain'><option>--stringparam
<replaceable class="option">PARAMNAME</replaceable>
<replaceable class="option">PARAMVALUE</replaceable>
</option></arg>
<arg choice='plain'><option>--nonet</option></arg>
<arg choice='plain'><option>--path "<replaceable class="option">PATHS</replaceable>"</option></arg>
<arg choice='plain'><option>--load-trace</option></arg>
<arg choice='plain'><option>--catalogs</option></arg>
<arg choice='plain'><option>--xinclude</option></arg>
<group choice='opt'>
<arg choice='plain'><option>--profile</option></arg>
<arg choice='plain'><option>--norman</option></arg>
</group>
<arg choice='plain'><option>--dumpextensions</option></arg>
<arg choice='plain'><option>--nowrite</option></arg>
<arg choice='plain'><option>--nomkdir</option></arg>
<arg choice='plain'><option>--writesubtree <replaceable>PATH</replaceable></option></arg>
<arg choice='plain'><option>--nodtdattr</option></arg>
</group> </group>
<arg><option><replaceable>stylesheet</replaceable></option></arg> <arg choice="opt"><replaceable>STYLESHEET</replaceable></arg>
<arg><replaceable>file1</replaceable></arg> <arg choice="req" rep="repeat"><replaceable>FILE</replaceable></arg>
<arg><replaceable>file2</replaceable></arg>
<arg><replaceable>....</replaceable></arg>
</cmdsynopsis> </cmdsynopsis>
</refsynopsisdiv> </refsynopsisdiv>
<refsect1 id="introduction"> <refsect1 id="introduction">
<title>Introduction</title> <title>DESCRIPTION</title>
<para> <para>&xsltproc; is a command line tool for applying <acronym>XSLT</acronym>
<application>xsltproc</application> is a command line tool for applying stylesheets to <acronym>XML</acronym>
<acronym>XSLT</acronym> stylesheets to <acronym>XML</acronym>
documents. It is part of <application>libxslt</application>, the XSLT C documents. It is part of <application>libxslt</application>, 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.
</para> </para>
<para> <para>&xsltproc; is invoked from the command line with
<application>xsltproc</application> 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. It will use the standard files to which the stylesheet is to be applied. It will use the standard
input if a filename provided is - . input if a filename provided is - .
@ -86,7 +105,7 @@
<para> <para>
If a stylesheet is included in an <acronym>XML</acronym> document with a If a stylesheet is included in an <acronym>XML</acronym> 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. <application>xsltproc</application> will automatically command line. &xsltproc; will automatically
detect the included stylesheet and use it. detect the included stylesheet and use it.
</para> </para>
@ -97,15 +116,14 @@
</refsect1> </refsect1>
<refsect1 id="options"> <refsect1 id="options">
<title>Command Line Options</title> <title>OPTIONS</title>
<para>&xsltproc; currently accepts the following options:</para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><option>-V</option> or <option>--version</option></term> <term><option>-V</option> or <option>--version</option></term>
<listitem> <listitem>
<simpara>Show the version of <simpara>Show the version of <application>libxml</application>
<application>libxml</application> and <application>libxslt</application> used. and <application>libxslt</application> used.</simpara>
</simpara>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -114,22 +132,21 @@
<term> <term>
<option>-v</option> or <option>--verbose</option></term> <option>-v</option> or <option>--verbose</option></term>
<listitem> <listitem>
<simpara>Output each step taken <simpara>Output each step taken by &xsltproc; in processing the
by <application>xsltproc</application> in processing the stylesheet and the document. stylesheet and the document.</simpara>
</simpara>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<option>-o</option> or <option>--output</option> <replaceable>file</replaceable></term> <option>-o</option> or <option>--output</option> <replaceable>FILE</replaceable></term>
<listitem> <listitem>
<simpara>Direct output to the file named <simpara>Direct output to the file named
<replaceable>file</replaceable>. For multiple outputs, also known as <replaceable>FILE</replaceable>. For multiple outputs, also known as
"chunking", <option>-o</option> <option>directory/</option> directs the "chunking", <option>-o <replaceable>DIRECTORY/</replaceable></option>
output files to a specified directory. The directory must already exist. directs the output files to a specified directory. The directory must
</simpara> already exist.</simpara>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -172,8 +189,7 @@
<term> <term>
<option>--novalid</option></term> <option>--novalid</option></term>
<listitem> <listitem>
<simpara>Skip loading the document's <acronym>DTD</acronym>. <simpara>Skip loading the document's <acronym>DTD</acronym>.</simpara>
</simpara>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -182,20 +198,18 @@
<term> <term>
<option>--noout</option></term> <option>--noout</option></term>
<listitem> <listitem>
<simpara>Do not output the result. <simpara>Do not output the result.</simpara>
</simpara>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<option>--maxdepth</option> <replaceable>value</replaceable></term> <option>--maxdepth <replaceable>VALUE</replaceable></option></term>
<listitem> <listitem>
<simpara>Adjust the <simpara>Adjust the
maximum depth of the template stack before maximum depth of the template stack before <application>libxslt</application>
<application>libxslt</application> concludes it is in an infinite concludes it is in an infinite loop. The default is 500.
loop. The default is 500.
</simpara> </simpara>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -206,32 +220,29 @@
<option>--html</option></term> <option>--html</option></term>
<listitem> <listitem>
<simpara>The input document is an <acronym>HTML</acronym> <simpara>The input document is an <acronym>HTML</acronym>
file. file.</simpara>
</simpara>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<option>--param</option> <replaceable>name</replaceable> <replaceable>value</replaceable></term> <option>--param <replaceable>PARAMNAME</replaceable> <replaceable>PARAMVALUE</replaceable></option></term>
<listitem> <listitem>
<simpara>Pass a parameter of name <simpara>Pass a parameter of name <replaceable>PARAMNAME</replaceable> and
<replaceable>name</replaceable> and value value <replaceable>PARAMVALUE</replaceable> to the stylesheet. You may pass
<replaceable>value</replaceable> to the stylesheet. You may pass multiple multiple name/value pairs up to a maximum of 32. If the value being passed
name/value pairs up to a maximum of 32. If the value being passed is a is a string rather than a node identifier, use <option>--stringparam</option>
string rather than a node identifier, use instead.</simpara>
<option>--stringparam</option> instead.
</simpara>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<option>--stringparam</option> <replaceable>name</replaceable> <replaceable>value</replaceable></term> <option>--stringparam <replaceable>PARAMNAME</replaceable> <replaceable>PARAMVALUE</replaceable></option></term>
<listitem> <listitem>
<simpara>Pass a paramenter of name <replaceable>name</replaceable> and <simpara>Pass a paramenter of name <replaceable>PARAMNAME</replaceable> and
value <replaceable>value</replaceable> where value <replaceable>PARAMVALUE</replaceable>
<replaceable>value</replaceable> is a string rather than a node where <replaceable>PARAMVALUE</replaceable> is a string rather than a node
identifier. (Note: The string must be utf-8.) </simpara> identifier. (Note: The string must be utf-8.) </simpara>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -240,19 +251,18 @@
<term> <term>
<option>--nonet</option></term> <option>--nonet</option></term>
<listitem> <listitem>
<simpara>Do not use the Internet to fetch DTD's, <simpara>Do not use the Internet to fetch <acronym>DTD</acronym>s,
entities or documents. entities or documents.</simpara>
</simpara>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <option>--path</option> <replaceable>paths</replaceable></term> <term><option>--path "<replaceable>PATHS</replaceable>"</option></term>
<listitem> <listitem>
<simpara> <simpara>
Use the list (separated by space or colon) of filesystem paths Use the list (separated by space or colon) of filesystem paths
specified by <replaceable>paths</replaceable> to load specified by <replaceable>paths</replaceable> to
<acronym>DTDs</acronym>, entities or documents. load <acronym>DTDs</acronym>, entities or documents.
</simpara> </simpara>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -270,12 +280,11 @@
<term> <term>
<option>--catalogs</option></term> <option>--catalogs</option></term>
<listitem> <listitem>
<simpara>Use the <acronym>SGML</acronym> catalog specified in <simpara>Use the <acronym>SGML</acronym> catalog specified
<envar>SGML_CATALOG_FILES</envar> to resolve the location of in <envar>SGML_CATALOG_FILES</envar> to resolve the location of
external entities. By default, <application>xsltproc</application> external entities. By default, &xsltproc;
looks for the catalog specified in looks for the catalog specified in <envar>XML_CATALOG_FILES</envar>.
<envar>XML_CATALOG_FILES</envar>. If that is not specified, it uses If that is not specified, it uses <filename>/etc/xml/catalog</filename>.
<filename>/etc/xml/catalog</filename>.
</simpara> </simpara>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -287,8 +296,7 @@
<listitem> <listitem>
<simpara>Process the input document using the <simpara>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: <ulink specification: <ulink url="http://www.w3.org/TR/xinclude/"/>
url="http://www.w3.org/TR/xinclude/">http://www.w3.org/TR/xinclude/</ulink>
</simpara> </simpara>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -300,8 +308,8 @@
<listitem> <listitem>
<simpara>Output profiling <simpara>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
</simpara> performance.</simpara>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -309,8 +317,7 @@
<term> <term>
<option>--dumpextensions</option></term> <option>--dumpextensions</option></term>
<listitem> <listitem>
<simpara>Dumps the list of all registered extensions on stdout. <simpara>Dumps the list of all registered extensions on stdout.</simpara>
</simpara>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -318,8 +325,7 @@
<term> <term>
<option>--nowrite</option></term> <option>--nowrite</option></term>
<listitem> <listitem>
<simpara>Refuses to write to any file or resource. <simpara>Refuses to write to any file or resource.</simpara>
</simpara>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -327,18 +333,16 @@
<term> <term>
<option>--nomkdir</option></term> <option>--nomkdir</option></term>
<listitem> <listitem>
<simpara>Refuses to create directories. <simpara>Refuses to create directories.</simpara>
</simpara>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<option>--writesubtree</option> <replaceable>path</replaceable></term> <option>--writesubtree <replaceable>PATH</replaceable></option></term>
<listitem> <listitem>
<simpara>Allow file write only within the <simpara>Allow file write only within
<replaceable>path</replaceable> subtree. the <replaceable>PATH</replaceable> subtree.</simpara>
</simpara>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -346,42 +350,110 @@
<option>--nodtdattr</option> <option>--nodtdattr</option>
</term> </term>
<listitem> <listitem>
<simpara>Do not apply default attributes from the document's <simpara>Do not apply default attributes from the
<acronym>DTD</acronym>. document's <acronym>DTD</acronym>.</simpara>
</simpara>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
</refsect1> </refsect1>
<refsect1 id="return"> <refsect1 id="envar">
<title>Return values</title> <title>ENVIRONMENT</title>
<para><application>xsltproc</application>'s return codes provide information <variablelist>
that can be used when calling it from scripts.</para> <varlistentry>
<term><envar>SGML_CATALOG_FILES</envar></term>
<para>0: normal</para> <listitem>
<para>1: no argument</para> <para>...</para>
<para>2: too many parameters</para> </listitem>
<para>3: unknown option</para> </varlistentry>
<para>4: failed to parse the stylesheet</para> <varlistentry>
<para>5: error in the stylesheet</para> <term><envar>XML_CATALOG_FILES</envar></term>
<para>6: error in one of the documents</para> <listitem>
<para>7: unsupported xsl:output method</para> <para>...</para>
<para>8: string parameter contains both quote and double-quotes</para> </listitem>
<para>9: internal processing error</para> </varlistentry>
<para>10: processing was stopped by a terminating message</para> </variablelist>
</refsect1> </refsect1>
<refsect1 id="return">
<title>DIAGNOSTICS</title>
<para>&xsltproc;'s return codes provide information
that can be used when calling it from scripts.</para>
<variablelist>
<varlistentry>
<term><errorcode>0</errorcode></term>
<listitem>
<para>normal</para>
</listitem>
</varlistentry>
<varlistentry>
<term><errorcode>1</errorcode></term>
<listitem>
<para>no argument</para>
</listitem>
</varlistentry>
<varlistentry>
<term><errorcode>2</errorcode></term>
<listitem>
<para>too many parameters</para>
</listitem>
</varlistentry>
<varlistentry>
<term><errorcode>3</errorcode></term>
<listitem>
<para>unknown option</para>
</listitem>
</varlistentry>
<varlistentry>
<term><errorcode>4</errorcode></term>
<listitem>
<para>failed to parse the stylesheet</para>
</listitem>
</varlistentry>
<varlistentry>
<term><errorcode>5</errorcode></term>
<listitem>
<para>error in the stylesheet</para>
</listitem>
</varlistentry>
<varlistentry>
<term><errorcode>6</errorcode></term>
<listitem>
<para>error in one of the documents</para>
</listitem>
</varlistentry>
<varlistentry>
<term><errorcode>7</errorcode></term>
<listitem>
<para>unsupported xsl:output method</para>
</listitem>
</varlistentry>
<varlistentry>
<term><errorcode>8</errorcode></term>
<listitem>
<para>string parameter contains both quote and double-quotes</para>
</listitem>
</varlistentry>
<varlistentry>
<term><errorcode>9</errorcode></term>
<listitem>
<para>internal processing error</para>
</listitem>
</varlistentry>
<varlistentry>
<term><errorcode>10</errorcode></term>
<listitem>
<para>processing was stopped by a terminating message</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="moreinfo"> <refsect1 id="moreinfo">
<title>More Information</title> <title>SEE ALSO</title>
<para>More information can be found at the <application>libxml</application> web pages
<para><application>libxml web page: </application><ulink url="http://www.xmlsoft.org/">http://www.xmlsoft.org/</ulink></para> at <ulink url="http://www.xmlsoft.org/"/> and the W3C <acronym>XSLT</acronym>
pages at <ulink url="http://www.w3.org/TR/xslt"/>.</para>
<para>W3C <acronym>XSLT page: </acronym><ulink url="http://www.w3.org/TR/xslt">http://www.w3.org/TR/xslt</ulink></para>
</refsect1> </refsect1>
</refentry> </refentry>