mirror of
https://gitlab.gnome.org/GNOME/libxslt
synced 2025-11-05 12:10:38 +03:00
Tue Jan 8 21:04:17 MST 2002 John Fleck <jfleck@inkstain.net> * doc/xsltproc.xml, doc/xsltproc.1, doc/xsltproc.html update xsltproc man page to add --stringparam option
88 lines
6.4 KiB
HTML
88 lines
6.4 KiB
HTML
<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.45"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry"><h1 class="title">xsltproc</h1><div class="refnamediv"><h2>Name</h2><p>xsltproc — command line xslt processor</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><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> | --stringparam <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>]</p></div></div><div class="refsect1"><a name="introduction"></a><h2>Introduction</h2><p>
|
|
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.
|
|
</p><p>
|
|
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.
|
|
</p><p>
|
|
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.
|
|
</p><p>
|
|
By default, output is to stdout. You can specify a file for output using
|
|
the <tt>-o</tt> option.
|
|
</p></div><div class="refsect1"><a name="options"></a><h2>Command Line Options</h2><div class="variablelist"><dl><dt><span class="term"><tt>-V</tt> or <tt>--version</tt></span></dt><dd>Show the version of
|
|
libxml and libxslt used.
|
|
</dd><dt><span class="term">
|
|
<tt>-v</tt> or <tt>--verbose</tt></span></dt><dd>Output each step taken
|
|
by xsltproc in processing the stylesheet and the document.
|
|
</dd><dt><span class="term">
|
|
<tt>-o</tt> or <tt>--output</tt> <i><tt>file</tt></i></span></dt><dd>Direct output to the file named
|
|
<i><tt>file</tt></i>. For multiple outputs, also known as
|
|
"chunking", <tt>-o</tt> <tt>directory/</tt> directs the
|
|
output files to a specified directory. The directory must already exist.
|
|
</dd><dt><span class="term">
|
|
<tt>--timing</tt></span></dt><dd>Display the time used for parsing the
|
|
stylesheet, parsing the document and applying the stylesheet and saving
|
|
the result. Displayed in milliseconds.
|
|
</dd><dt><span class="term">
|
|
<tt>--repeat</tt></span></dt><dd>Run the transformation 20 times. Used for
|
|
timing tests.
|
|
</dd><dt><span class="term">
|
|
<tt>--debug</tt></span></dt><dd>Output an XML tree of the
|
|
transformed document for debugging purposes.
|
|
</dd><dt><span class="term">
|
|
<tt>--novalid</tt></span></dt><dd>Skip loading the document's DTD.
|
|
</dd><dt><span class="term">
|
|
<tt>--noout</tt></span></dt><dd>Do not output the result.
|
|
</dd><dt><span class="term">
|
|
<tt>--maxdepth</tt> <i><tt>value</tt></i></span></dt><dd>Adjust the
|
|
maximum depth of the template stack before
|
|
libxslt concludes it is in an infinite
|
|
loop. The default is 500.
|
|
</dd><dt><span class="term">
|
|
<tt>--html</tt></span></dt><dd>The input document is an HTML
|
|
file.
|
|
</dd><dt><span class="term">
|
|
<tt>--docbook</tt></span></dt><dd>The input document is DocBook
|
|
SGML.
|
|
</dd><dt><span class="term">
|
|
<tt>--param</tt> <i><tt>name</tt></i> <i><tt>value</tt></i></span></dt><dd>Pass a parameter of name
|
|
<i><tt>name</tt></i> and value
|
|
<i><tt>value</tt></i> 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
|
|
<tt>--stringparam</tt> instead.
|
|
</dd><dt><span class="term">
|
|
<tt>--stringparam</tt> <i><tt>name</tt></i> <i><tt>value</tt></i></span></dt><dd>Pass a paramenter of name <i><tt>name</tt></i> and
|
|
value <i><tt>value</tt></i> where
|
|
<i><tt>value</tt></i> is a string rather than a node identifier.</dd><dt><span class="term">
|
|
<tt>--nonet</tt></span></dt><dd>Do not use the Internet to fetch DTD's or
|
|
entities.
|
|
</dd><dt><span class="term">
|
|
<tt>--warnnet</tt></span></dt><dd>Output notification when DTD's or entities
|
|
are fetched over the Internet.
|
|
</dd><dt><span class="term">
|
|
<tt>--catalogs</tt></span></dt><dd>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
|
|
<tt>SGML_CATALOG_FILES</tt>.
|
|
</dd><dt><span class="term">
|
|
<tt>--xinclude</tt></span></dt><dd>Process the input document using the
|
|
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>
|
|
</dd><dt><span class="term">
|
|
<tt>--profile</tt> or <tt>--norman</tt></span></dt><dd>Output profiling
|
|
information detailing the amount of time spent in each part of the
|
|
stylesheet. This is useful in optimizing stylesheet performance.
|
|
</dd></dl></div></div><div class="refsect1"><a name="return"></a><h2>Return values</h2><p>xsltproc's return codes provide information
|
|
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: unsupported xsl:output method</p><p>8: string parameter contains both quote and double-quotes</p></div><div class="refsect1"><a name="moreinfo"></a><h2>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>
|