.el .ne 3
.IP "\\$1" \\$2
..
-.TH "XSLTPROC" 1 "" "" "xsltproc Manual"
+.TH "XSLTPROC" 1 "2006-02-20" "libxslt" "xsltproc Manual"
.SH NAME
-xsltproc \- command line xslt processor
+xsltproc \- command line XSLT processor
.SH "SYNOPSIS"
.ad l
.hy 0
.HP 9
-\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...}
+\fBxsltproc\fR [[\fB\fB\-V\fR\fR | \fB\fB\-\-version\fR\fR] [\fB\fB\-v\fR\fR | \fB\fB\-\-verbose\fR\fR] [{\fB\fB\-o\fR\fR | \fB\fB\-\-output\fR\fR} {\fB\fIFILE\fR\fR | \fB\fIDIRECTORY\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\ \fI"PATHS"\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] {\fB\fIXML\-FILE\fR\fR | \fB\-\fR}
.ad
.hy
\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
-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\&.
+If a stylesheet is included in an XML document with a Stylesheet Processing Instruction, no stylesheet need to be named at the command line\&. \fBxsltproc\fR will automatically detect the included stylesheet and use it\&.
.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 \fIstdout\fR\&. You can specify a file for output using the \fB\-o\fR or \fB\-\-output\fR option\&.
+
+.PP
+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\&.
.SH "OPTIONS"
.PP
-\fBxsltproc\fR currently accepts the following options:
+\fBxsltproc\fR accepts the following options (in alphabetical order):
.TP
-\fB\-V\fR or \fB\-\-version\fR
-Show the version of libxml and libxslt used\&.
+\fB\-\-catalogs\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
-\fB\-v\fR or \fB\-\-verbose\fR
-Output each step taken by \fBxsltproc\fR in processing the stylesheet and the document\&.
+\fB\-\-debug\fR
+Output an XML tree of the transformed document for debugging purposes\&.
.TP
-\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 \fIDIRECTORY/\fR\fR directs the output files to a specified directory\&. The directory must already exist\&.
+\fB\-\-dumpextensions\fR
+Dumps the list of all registered extensions on \fIstdout\fR\&.
.TP
-\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\&.
+\fB\-\-html\fR
+The input document is an HTML file\&.
.TP
-\fB\-\-repeat\fR
-Run the transformation 20 times\&. Used for timing tests\&.
+\fB\-\-load\-trace\fR
+Display all the documents loaded during the processing to \fIstderr\fR\&.
.TP
-\fB\-\-debug\fR
-Output an XML tree of the transformed document for debugging purposes\&.
+\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\&.
.TP
-\fB\-\-novalid\fR
-Skip loading the document's DTD\&.
+\fB\-\-nodtdattr\fR
+Do not apply default attributes from the document's DTD\&.
.TP
-\fB\-\-noout\fR
-Do not output the result\&.
+\fB\-\-nomkdir\fR
+Refuses to create directories\&.
.TP
-\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\&.
+\fB\-\-nonet\fR
+Do not use the Internet to fetch DTDs, entities or documents\&.
.TP
-\fB\-\-html\fR
-The input document is an HTML file\&.
+\fB\-\-noout\fR
+Do not output the result\&.
.TP
-\fB\-\-param \fIPARAMNAME\fR \fIPARAMVALUE\fR\fR
-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\&.
+\fB\-\-novalid\fR
+Skip loading the document's DTD\&.
.TP
-\fB\-\-stringparam \fIPARAMNAME\fR \fIPARAMVALUE\fR\fR
-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\&.)
+\fB\-\-nowrite\fR
+Refuses to write to any file or resource\&.
.TP
-\fB\-\-nonet\fR
-Do not use the Internet to fetch DTDs, entities or documents\&.
+\fB\-o\fR or \fB\-\-output\fR \fIFILE\fR | \fIDIRECTORY\fR
+Direct output to the given \fIFILE\fR\&. Using the option with a \fIDIRECTORY\fR directs the output files to the specified directory\&. This can be useful for multiple outputs (also known as "chunking") or manpage processing\&. Note: The given directory must already exist\&.
.TP
-\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\&.
+\fB\-\-param \fIPARAMNAME\fR \fIPARAMVALUE\fR\fR
+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
-\fB\-\-load\-trace\fR
-Display to stderr all the documents loaded during the processing\&.
+\fB\-\-path \fI"PATHS"\fR\fR
+Use the (space\- or colon\-separated) list of filesystem paths specified by \fIPATHS\fR to load DTDs, entities or documents\&. Enclose space\-separated lists by quotation marks\&.
.TP
-\fB\-\-catalogs\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\&.
+\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\&.
.TP
-\fB\-\-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
+\fB\-\-repeat\fR
+Run the transformation 20 times\&. Used for timing tests\&.
.TP
-\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\&.
+\fB\-\-stringparam \fIPARAMNAME\fR \fIPARAMVALUE\fR\fR
+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 encoded\&.
.TP
-\fB\-\-dumpextensions\fR
-Dumps the list of all registered extensions on stdout\&.
+\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\&.
.TP
-\fB\-\-nowrite\fR
-Refuses to write to any file or resource\&.
+\fB\-v\fR or \fB\-\-verbose\fR
+Output each step taken by \fBxsltproc\fR in processing the stylesheet and the document\&.
.TP
-\fB\-\-nomkdir\fR
-Refuses to create directories\&.
+\fB\-V\fR or \fB\-\-version\fR
+Show the version of libxml and libxslt used\&.
.TP
\fB\-\-writesubtree \fIPATH\fR\fR
Allow file write only within the \fIPATH\fR subtree\&.
.TP
-\fB\-\-nodtdattr\fR
-Do not apply default attributes from the document's DTD\&.
+\fB\-\-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
.SH "ENVIRONMENT"
.TP
\fB0\fR
-normal
+No error (normal operation)
.TP
\fB1\fR
-no argument
+No argument
.TP
\fB2\fR
-too many parameters
+Too many parameters
.TP
\fB3\fR
-unknown option
+Unknown option
.TP
\fB4\fR
-failed to parse the stylesheet
+Failed to parse the stylesheet
.TP
\fB5\fR
-error in the stylesheet
+Error in the stylesheet
.TP
\fB6\fR
-error in one of the documents
+Error in one of the documents
.TP
\fB7\fR
-unsupported xsl:output method
+Unsupported xsl:output method
.TP
\fB8\fR
-string parameter contains both quote and double\-quotes
+String parameter contains both quote and double\-quotes
.TP
\fB9\fR
-internal processing error
+Internal processing error
.TP
\fB10\fR
-processing was stopped by a terminating message
-
-.SH "SEE ALSO"
-
-.PP
-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\&.
+Processing was stopped by a terminating message
.SH AUTHOR
-John Fleck.
+John Fleck <jfleck@inkstain\&.net>.
]>
<refentry>
- <refentryinfo>
- <title>xsltproc Manual</title>
- <copyright>
- <year>2001, 2002</year>
- </copyright>
- <author>
- <firstname>John</firstname>
- <surname>Fleck</surname>
- </author>
- <address><email>jfleck@inkstain.net</email></address>
-
- <releaseinfo>This is release 0.4 of the xsltproc Manual.</releaseinfo>
- </refentryinfo>
-
- <refmeta>
- <refentrytitle>xsltproc</refentrytitle>
- <manvolnum>1</manvolnum>
- </refmeta>
-
- <refnamediv>
- <refname>xsltproc</refname>
- <refpurpose>command line xslt processor</refpurpose>
- </refnamediv>
-
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>xsltproc</command>
- <group choice='opt'>
- <group choice='opt'>
- <arg choice='plain'><option>-V</option></arg>
- <arg choice='plain'><option>--version</option></arg>
- </group>
- <group choice='opt'>
- <arg choice='plain'><option>-v</option></arg>
- <arg choice='plain'><option>--verbose</option></arg>
- </group>
- <arg choice="opt">
- <group choice='req'>
- <arg choice='plain'><option>-o</option></arg>
- <arg choice='plain'><option>--output</option></arg>
- </group>
- <replaceable class="option">FILE</replaceable>
- </arg>
- <arg choice='plain'><option>--timing</option></arg>
- <arg choice='plain'><option>--repeat</option></arg>
- <arg choice='plain'><option>--debug</option></arg>
- <arg choice='plain'><option>--novalid</option></arg>
- <arg choice='plain'><option>--noout</option></arg>
- <arg choice='plain'><option>--maxdepth <replaceable class="option">VALUE</replaceable></option></arg>
- <arg choice='plain'><option>--html</option></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>
- <arg choice="opt"><replaceable>STYLESHEET</replaceable></arg>
- <arg choice="req" rep="repeat"><replaceable>FILE</replaceable></arg>
- </cmdsynopsis>
- </refsynopsisdiv>
-
-
- <refsect1 id="introduction">
- <title>DESCRIPTION</title>
- <para>&xsltproc; is a command line tool for applying <acronym>XSLT</acronym>
- stylesheets to <acronym>XML</acronym>
- 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
- can operate independently of the GNOME desktop.
- </para>
-
- <para>&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 - .
- </para>
-
- <para>
- If a stylesheet is included in an <acronym>XML</acronym> 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.
- </para>
-
- <para>
- By default, output is to stdout. You can specify a file for output using
- the <option>-o</option> option.
- </para>
- </refsect1>
-
- <refsect1 id="options">
- <title>OPTIONS</title>
- <para>&xsltproc; currently accepts the following options:</para>
- <variablelist>
- <varlistentry>
- <term><option>-V</option> or <option>--version</option></term>
+
+<refentryinfo>
+ <title>xsltproc Manual</title>
+ <productname>libxslt</productname>
+ <copyright>
+ <year>2001</year>
+ <year>2002</year>
+ </copyright>
+ <author>
+ <firstname>John</firstname>
+ <surname>Fleck</surname>
+ <affiliation>
+ <address>
+ <email>jfleck@inkstain.net</email>
+ </address>
+ </affiliation>
+ </author>
+ <releaseinfo>This is release 0.4 of the xsltproc Manual.</releaseinfo>
+ <!-- date should be the date of the latest change or the release version -->
+ <date>2006-02-20</date>
+</refentryinfo>
+
+<refmeta>
+ <refentrytitle>xsltproc</refentrytitle>
+ <manvolnum>1</manvolnum>
+</refmeta>
+
+<refnamediv>
+ <refname>xsltproc</refname>
+ <refpurpose>command line XSLT processor</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+ <cmdsynopsis>
+ <command>xsltproc</command>
+ <group choice='opt'>
+ <group choice='opt'>
+ <arg choice='plain'><option>-V</option></arg>
+ <arg choice='plain'><option>--version</option></arg>
+ </group>
+ <group choice='opt'>
+ <arg choice='plain'><option>-v</option></arg>
+ <arg choice='plain'><option>--verbose</option></arg>
+ </group>
+ <group choice="opt">
+ <group choice='req'>
+ <arg choice='plain'><option>-o</option></arg>
+ <arg choice='plain'><option>--output</option></arg>
+ </group>
+ <group choice='req'>
+ <arg choice='plain'><replaceable class="option">FILE</replaceable></arg>
+ <arg choice='plain'><replaceable class="option">DIRECTORY</replaceable></arg>
+ </group>
+ </group>
+ <arg choice='plain'><option>--timing</option></arg>
+ <arg choice='plain'><option>--repeat</option></arg>
+ <arg choice='plain'><option>--debug</option></arg>
+ <arg choice='plain'><option>--novalid</option></arg>
+ <arg choice='plain'><option>--noout</option></arg>
+ <arg choice='plain'><option>--maxdepth <replaceable class="option">VALUE</replaceable></option></arg>
+ <arg choice='plain'><option>--html</option></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>
+ <arg choice="opt"><replaceable>STYLESHEET</replaceable></arg>
+ <group choice="req">
+ <arg choice="plain" rep="norepeat"><replaceable>XML-FILE</replaceable></arg>
+ <arg choice="plain" rep="norepeat">-</arg>
+ </group>
+ </cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1 id="introduction">
+ <title>DESCRIPTION</title>
+ <para>
+ &xsltproc; is a command line tool for applying <acronym>XSLT</acronym>
+ stylesheets to <acronym>XML</acronym> 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 can operate
+ independently of the GNOME desktop.
+ </para>
+ <para>
+ &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 <emphasis role="bold">-</emphasis> .
+ </para>
+ <para>
+ If a stylesheet is included in an <acronym>XML</acronym> document with a
+ Stylesheet Processing Instruction, no stylesheet need to be named at the
+ command line. &xsltproc; will automatically detect the included stylesheet
+ and use it.
+ </para>
+ <para>
+ By default, output is to <filename class="devicefile">stdout</filename>.
+ You can specify a file for output using
+ the <option>-o</option> or <option>--output</option> option.
+ </para>
+ <para>
+ More information can be found at the <application>libxml</application> web pages
+ at <ulink url="http://www.xmlsoft.org/"/> and the W3C <acronym>XSLT</acronym>
+ pages at <ulink url="http://www.w3.org/TR/xslt"/>.
+ </para>
+</refsect1>
+
+<refsect1 id="options">
+ <title>OPTIONS</title>
+ <para>
+ &xsltproc; accepts the following options (in alphabetical order):
+ </para>
+ <variablelist>
+
+ <varlistentry>
+ <term><option>--catalogs</option></term>
<listitem>
- <simpara>Show the version of <application>libxml</application>
- and <application>libxslt</application> used.</simpara>
+ <para>
+ Use the <acronym>SGML</acronym> catalog specified
+ in <envar>SGML_CATALOG_FILES</envar> to resolve the location of
+ external entities. By default, &xsltproc; looks for the catalog
+ specified in <envar>XML_CATALOG_FILES</envar>. If that is not
+ specified, it uses <filename>/etc/xml/catalog</filename>.
+ </para>
</listitem>
- </varlistentry>
+ </varlistentry>
-
- <varlistentry>
- <term>
- <option>-v</option> or <option>--verbose</option></term>
+ <varlistentry>
+ <term><option>--debug</option></term>
<listitem>
- <simpara>Output each step taken by &xsltproc; in processing the
- stylesheet and the document.</simpara>
+ <para>
+ Output an <acronym>XML</acronym> tree of the transformed document
+ for debugging purposes.
+ </para>
</listitem>
- </varlistentry>
+ </varlistentry>
-
- <varlistentry>
- <term>
- <option>-o</option> or <option>--output</option> <replaceable>FILE</replaceable></term>
+ <varlistentry>
+ <term><option>--dumpextensions</option></term>
<listitem>
- <simpara>Direct output to the file named
- <replaceable>FILE</replaceable>. For multiple outputs, also known as
- "chunking", <option>-o <replaceable>DIRECTORY/</replaceable></option>
- directs the output files to a specified directory. The directory must
- already exist.</simpara>
+ <para>
+ Dumps the list of all registered extensions
+ on <filename class="devicefile">stdout</filename>.
+ </para>
</listitem>
- </varlistentry>
+ </varlistentry>
-
- <varlistentry>
- <term>
- <option>--timing</option></term>
+ <varlistentry>
+ <term><option>--html</option></term>
<listitem>
- <simpara>Display the time used for parsing the
- stylesheet, parsing the document and applying the stylesheet and saving
- the result. Displayed in milliseconds.
- </simpara>
+ <para>The input document is an <acronym>HTML</acronym> file.</para>
</listitem>
- </varlistentry>
+ </varlistentry>
-
- <varlistentry>
- <term>
- <option>--repeat</option></term>
+ <varlistentry>
+ <term><option>--load-trace</option></term>
<listitem>
- <simpara>Run the transformation 20 times. Used for
- timing tests.
- </simpara>
+ <para>
+ Display all the documents loaded during the processing
+ to <filename class="devicefile">stderr</filename>.
+ </para>
</listitem>
- </varlistentry>
+ </varlistentry>
-
- <varlistentry>
- <term>
- <option>--debug</option></term>
+ <varlistentry>
+ <term><option>--maxdepth <replaceable>VALUE</replaceable></option></term>
<listitem>
- <simpara>Output an <acronym>XML</acronym> tree of the
- transformed document for debugging purposes.
- </simpara>
+ <para>
+ Adjust the maximum depth of the template stack
+ before <application>libxslt</application> concludes it is in an
+ infinite loop. The default is 500.
+ </para>
</listitem>
- </varlistentry>
+ </varlistentry>
-
- <varlistentry>
- <term>
- <option>--novalid</option></term>
+ <varlistentry>
+ <term><option>--nodtdattr</option></term>
<listitem>
- <simpara>Skip loading the document's <acronym>DTD</acronym>.</simpara>
+ <para>
+ Do not apply default attributes from the
+ document's <acronym>DTD</acronym>.
+ </para>
</listitem>
- </varlistentry>
+ </varlistentry>
-
- <varlistentry>
- <term>
- <option>--noout</option></term>
+ <varlistentry>
+ <term><option>--nomkdir</option></term>
<listitem>
- <simpara>Do not output the result.</simpara>
+ <para>Refuses to create directories.</para>
</listitem>
- </varlistentry>
+ </varlistentry>
-
- <varlistentry>
- <term>
- <option>--maxdepth <replaceable>VALUE</replaceable></option></term>
+ <varlistentry>
+ <term><option>--nonet</option></term>
<listitem>
- <simpara>Adjust the
- maximum depth of the template stack before <application>libxslt</application>
- concludes it is in an infinite loop. The default is 500.
- </simpara>
+ <para>
+ Do not use the Internet to fetch <acronym>DTD</acronym>s, entities
+ or documents.
+ </para>
</listitem>
- </varlistentry>
+ </varlistentry>
-
- <varlistentry>
- <term>
- <option>--html</option></term>
+ <varlistentry>
+ <term><option>--noout</option></term>
<listitem>
- <simpara>The input document is an <acronym>HTML</acronym>
- file.</simpara>
+ <para>Do not output the result.</para>
</listitem>
- </varlistentry>
+ </varlistentry>
- <varlistentry>
- <term>
- <option>--param <replaceable>PARAMNAME</replaceable> <replaceable>PARAMVALUE</replaceable></option></term>
+ <varlistentry>
+ <term><option>--novalid</option></term>
<listitem>
- <simpara>Pass a parameter of name <replaceable>PARAMNAME</replaceable> and
- value <replaceable>PARAMVALUE</replaceable> 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 <option>--stringparam</option>
- instead.</simpara>
- </listitem>
- </varlistentry>
+ <para>Skip loading the document's <acronym>DTD</acronym>.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--nowrite</option></term>
+ <listitem>
+ <para>Refuses to write to any file or resource.</para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
+ <varlistentry>
<term>
- <option>--stringparam <replaceable>PARAMNAME</replaceable> <replaceable>PARAMVALUE</replaceable></option></term>
+ <option>-o</option> or <option>--output</option>
+ <replaceable>FILE</replaceable> | <replaceable>DIRECTORY</replaceable>
+ </term>
<listitem>
- <simpara>Pass a paramenter of name <replaceable>PARAMNAME</replaceable> and
- value <replaceable>PARAMVALUE</replaceable>
- where <replaceable>PARAMVALUE</replaceable> is a string rather than a node
- identifier. (Note: The string must be utf-8.) </simpara>
+ <para>
+ Direct output to the given <replaceable>FILE</replaceable>. Using
+ the option with a <replaceable>DIRECTORY</replaceable> directs the
+ output files to the specified directory. This can be
+ useful for multiple outputs (also known as "chunking") or manpage
+ processing. <emphasis role="bold">Note:</emphasis> The given
+ directory <emphasis role="bold">must</emphasis>
+ already exist.
+ </para>
</listitem>
- </varlistentry>
-
- <varlistentry>
+ </varlistentry>
+
+ <varlistentry>
<term>
- <option>--nonet</option></term>
+ <option>--param <replaceable>PARAMNAME</replaceable> <replaceable>PARAMVALUE</replaceable></option>
+ </term>
<listitem>
- <simpara>Do not use the Internet to fetch <acronym>DTD</acronym>s,
- entities or documents.</simpara>
+ <para>
+ Pass a parameter of name <replaceable>PARAMNAME</replaceable> and
+ value <replaceable>PARAMVALUE</replaceable> 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 <option>--stringparam</option> instead.
+ </para>
</listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>--path "<replaceable>PATHS</replaceable>"</option></term>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--path <replaceable>"PATHS"</replaceable></option></term>
<listitem>
- <simpara>
- Use the list (separated by space or colon) of filesystem paths
- specified by <replaceable>paths</replaceable> to
- load <acronym>DTDs</acronym>, entities or documents.
- </simpara>
+ <para>
+ Use the (space- or colon-separated) list of filesystem paths specified
+ by <replaceable>PATHS</replaceable> to load <acronym>DTD</acronym>s,
+ entities or documents. Enclose space-separated lists by quotation marks.
+ </para>
</listitem>
- </varlistentry>
+ </varlistentry>
- <varlistentry>
- <term><option>--load-trace</option></term>
+ <varlistentry>
+ <term><option>--profile</option> or <option>--norman</option></term>
<listitem>
- <simpara>
- Display to stderr all the documents loaded during the processing.
- </simpara>
+ <para>
+ Output profiling information detailing the amount of time spent in
+ each part of the stylesheet. This is useful in optimizing stylesheet
+ performance.
+ </para>
</listitem>
- </varlistentry>
+ </varlistentry>
- <varlistentry>
- <term>
- <option>--catalogs</option></term>
+ <varlistentry>
+ <term><option>--repeat</option></term>
<listitem>
- <simpara>Use the <acronym>SGML</acronym> catalog specified
- in <envar>SGML_CATALOG_FILES</envar> to resolve the location of
- external entities. By default, &xsltproc;
- looks for the catalog specified in <envar>XML_CATALOG_FILES</envar>.
- If that is not specified, it uses <filename>/etc/xml/catalog</filename>.
- </simpara>
+ <para>Run the transformation 20 times. Used for timing tests.</para>
</listitem>
- </varlistentry>
+ </varlistentry>
-
- <varlistentry>
+ <varlistentry>
<term>
- <option>--xinclude</option></term>
+ <option>--stringparam <replaceable>PARAMNAME</replaceable> <replaceable>PARAMVALUE</replaceable></option>
+ </term>
<listitem>
- <simpara>Process the input document using the
- Xinclude specification. More details on this can be found in the Xinclude
- specification: <ulink url="http://www.w3.org/TR/xinclude/"/>
- </simpara>
+ <para>
+ Pass a paramenter of name <replaceable>PARAMNAME</replaceable> and
+ value <replaceable>PARAMVALUE</replaceable>
+ where <replaceable>PARAMVALUE</replaceable> is a string rather than a
+ node identifier. <emphasis role="bold">Note:</emphasis> The string
+ must be UTF-8 encoded.
+ </para>
</listitem>
- </varlistentry>
-
-
- <varlistentry>
- <term>
- <option>--profile</option> or <option>--norman</option></term>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--timing</option></term>
<listitem>
- <simpara>Output profiling
- information detailing the amount of time spent in each part of the
- stylesheet. This is useful in optimizing stylesheet
- performance.</simpara>
+ <para>
+ Display the time used for parsing the stylesheet, parsing the document
+ and applying the stylesheet and saving the result. Displayed in
+ milliseconds.
+ </para>
</listitem>
- </varlistentry>
+ </varlistentry>
- <varlistentry>
- <term>
- <option>--dumpextensions</option></term>
+ <varlistentry>
+ <term><option>-v</option> or <option>--verbose</option></term>
<listitem>
- <simpara>Dumps the list of all registered extensions on stdout.</simpara>
+ <para>
+ Output each step taken by &xsltproc; in processing the stylesheet
+ and the document.
+ </para>
</listitem>
- </varlistentry>
+ </varlistentry>
- <varlistentry>
- <term>
- <option>--nowrite</option></term>
+ <varlistentry>
+ <term><option>-V</option> or <option>--version</option></term>
<listitem>
- <simpara>Refuses to write to any file or resource.</simpara>
+ <para>
+ Show the version of <application>libxml</application>
+ and <application>libxslt</application> used.
+ </para>
</listitem>
- </varlistentry>
-
- <varlistentry>
- <term>
- <option>--nomkdir</option></term>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--writesubtree <replaceable>PATH</replaceable></option></term>
<listitem>
- <simpara>Refuses to create directories.</simpara>
+ <para>
+ Allow file write only within the <replaceable>PATH</replaceable>
+ subtree.
+ </para>
</listitem>
- </varlistentry>
-
- <varlistentry>
- <term>
- <option>--writesubtree <replaceable>PATH</replaceable></option></term>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--xinclude</option></term>
<listitem>
- <simpara>Allow file write only within
- the <replaceable>PATH</replaceable> subtree.</simpara>
+ <para>
+ Process the input document using the Xinclude specification. More
+ details on this can be found in the Xinclude
+ specification: <ulink url="http://www.w3.org/TR/xinclude/"/>
+ </para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <option>--nodtdattr</option>
- </term>
+ </varlistentry>
+
+ </variablelist>
+</refsect1>
+
+<refsect1 id="envar">
+ <title>ENVIRONMENT</title>
+ <variablelist>
+
+ <varlistentry>
+ <term><envar>SGML_CATALOG_FILES</envar></term>
<listitem>
- <simpara>Do not apply default attributes from the
- document's <acronym>DTD</acronym>.</simpara>
+ <para>...</para>
</listitem>
- </varlistentry>
-
- </variablelist>
- </refsect1>
-
- <refsect1 id="envar">
- <title>ENVIRONMENT</title>
- <variablelist>
- <varlistentry>
- <term><envar>SGML_CATALOG_FILES</envar></term>
- <listitem>
- <para>...</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><envar>XML_CATALOG_FILES</envar></term>
- <listitem>
- <para>...</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </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">
- <title>SEE ALSO</title>
- <para>More information can be found at the <application>libxml</application> web pages
- at <ulink url="http://www.xmlsoft.org/"/> and the W3C <acronym>XSLT</acronym>
- pages at <ulink url="http://www.w3.org/TR/xslt"/>.</para>
- </refsect1>
+ </varlistentry>
+
+ <varlistentry>
+ <term><envar>XML_CATALOG_FILES</envar></term>
+ <listitem>
+ <para>...</para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+</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>No error (normal operation)</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>
+
</refentry>
projects / platform / upstream / libxslt.git / commitdiff