blob: fd34a3b478fc7891dfdac3e125ccf101a58d7de9 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
|
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>xsltproc</title><meta name="generator" content="DocBook XSL Stylesheets V1.57.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="id2589410"></a><div class="titlepage"></div><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] | [--param <i><tt>name</tt></i> <i><tt>value</tt></i>] | [--stringparam <i><tt>name</tt></i> <i><tt>value</tt></i>] | [--nonet] | [--catalogs] | [--xinclude] | [--profile] | [--dumpextensions] | [--nowrite] | [--nomkdir] | [--writesubtree]] [<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" lang="en"><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" lang="en"><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>--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. (Note: The string must be utf-8.) </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>--catalogs</tt></span></dt><dd>Use the SGML catalog specified in
<tt>SGML_CATALOG_FILES</tt> to resolve the location of
external entities. By default, xsltproc
looks for the catalog specified in
<tt>XML_CATALOG_FILES</tt>. If that is not specified, it uses
<tt>/etc/xml/catalog</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><dt><span class="term">
<tt>--dumpextensions</tt></span></dt><dd>Dumps the list of all registered extensions on stdout.
</dd><dt><span class="term">
<tt>--nowrite</tt></span></dt><dd>Refuses to write to any file or resource.
</dd><dt><span class="term">
<tt>--nomkdir</tt></span></dt><dd>Refuses to create directories.
</dd><dt><span class="term">
<tt>--writesubtree</tt> <i><tt>path</tt></i></span></dt><dd>Allow file write only within the
<i><tt>path</tt></i> subtree.
</dd></dl></div></div><div class="refsect1" lang="en"><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><p>9: internal processing error</p><p>10: processing was stopped by a terminating message</p></div><div class="refsect1" lang="en"><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>
|
