1XSLTPROC(1) xsltproc Manual XSLTPROC(1)
2
6 xsltproc - command line XSLT processor
7
9 xsltproc [[-V | --version] [-v | --verbose] [{-o | --output} {FILE |
10 DIRECTORY}] | --timing | --repeat | --debug | --novalid |
11 --noout | --maxdepth VALUE | --html | --encoding ENCODING |
12 --param PARAMNAME PARAMVALUE |
13 --stringparam PARAMNAME PARAMVALUE | --nonet |
14 --path "PATH(S)" | --load-trace | --catalogs | --xinclude |
15 [--profile | --norman] | --dumpextensions | --nowrite |
16 --nomkdir | --writesubtree PATH | --nodtdattr] [STYLESHEET]
17 {XML-FILE | -}
18
20 xsltproc is a command line tool for applying XSLT stylesheets to XML
21 documents. It is part of libxslt(3), the XSLT C library for GNOME.
22 While it was developed as part of the GNOME project, it can operate
23 independently of the GNOME desktop.
24 xsltproc is invoked from the command line with the name of the
26 stylesheet to be used followed by the name of the file or files to
27 which the stylesheet is to be applied. It will use the standard input
28 if a filename provided is -
29 If a stylesheet is included in an XML document with a Stylesheet
31 Processing Instruction, no stylesheet need to be named at the command
32 line. xsltproc will automatically detect the included stylesheet and
33 use it.
34 By default, output is to stdout. You can specify a file for output
36 using the -o or --output option.
37
39 xsltproc accepts the following options (in alphabetical order):
40 --catalogs
42 Use the SGML catalog specified in SGML_CATALOG_FILES to resolve the
43 location of external entities. By default, xsltproc looks for the
44 catalog specified in XML_CATALOG_FILES. If that is not specified,
45 it uses /etc/xml/catalog.
46 --debug
48 Output an XML tree of the transformed document for debugging
49 purposes.
50 --dumpextensions
52 Dumps the list of all registered extensions on stdout.
53 --html
55 The input document is an HTML file.
56 --load-trace
58 Display all the documents loaded during the processing to stderr.
59 --maxdepth VALUE
61 Adjust the maximum depth of the template stack before libxslt(3)
62 concludes it is in an infinite loop. The default is 3000.
63 --nodtdattr
65 Do not apply default attributes from the document´s DTD.
66 --nomkdir
68 Refuses to create directories.
69 --nonet
71 Do not use the Internet to fetch DTDs, entities or documents.
72 --noout
74 Do not output the result.
75 --novalid
77 Skip loading the document´s DTD.
78 --nowrite
80 Refuses to write to any file or resource.
81 -o or --output FILE | DIRECTORY
83 Direct output to the given FILE. Using the option with a DIRECTORY
84 directs the output files to the specified directory. This can be
85 useful for multiple outputs (also known as "chunking") or manpage
86 processing.
87 Important
89 The given directory must already exist.
90 Note
92 Make sure that FILE and DIRECTORY follow the “URI reference
93 computation” as described in RFC 2396 and laters. This means, that
94 e.g. -o directory will maybe not work, but -o directory/ will.
95 --encoding ENCODING
97 Allow to specify the encoding for the input.
98 --param PARAMNAME PARAMVALUE
100 Pass a parameter of name PARAMNAME and value PARAMVALUE to the
101 stylesheet. You may pass multiple name/value pairs up to a maximum
102 of 32. If the value being passed is a string, you can use
103 --stringparam instead, to avoid additional quote characters that
104 appear in string expressions. Note: the XPath expression must be
105 UTF-8 encoded.
106 --path "PATH(S)"
108 Use the (space- or colon-separated) list of filesystem paths
109 specified by PATHS to load DTDs, entities or documents. Enclose
110 space-separated lists by quotation marks.
111 --profile or --norman
113 Output profiling information detailing the amount of time spent in
114 each part of the stylesheet. This is useful in optimizing
115 stylesheet performance.
116 --repeat
118 Run the transformation 20 times. Used for timing tests.
119 --stringparam PARAMNAME PARAMVALUE
121 Pass a parameter of name PARAMNAME and value PARAMVALUE where
122 PARAMVALUE is a string rather than a node identifier. Note: The
123 string must be UTF-8 encoded.
124 --timing
126 Display the time used for parsing the stylesheet, parsing the
127 document and applying the stylesheet and saving the result.
128 Displayed in milliseconds.
129 -v or --verbose
131 Output each step taken by xsltproc in processing the stylesheet and
132 the document.
133 -V or --version
135 Show the version of libxml(3) and libxslt(3) used.
136 --writesubtree PATH
138 Allow file write only within the PATH subtree.
139 --xinclude
141 Process the input document using the XInclude specification. More
142 details on this can be found in the XInclude specification:
143 http://www.w3.org/TR/xinclude/
144
146 SGML_CATALOG_FILES
147 SGML catalog behavior can be changed by redirecting queries to the
148 user´s own set of catalogs. This can be done by setting the
149 SGML_CATALOG_FILES environment variable to a list of catalogs. An
150 empty one should deactivate loading the default /etc/sgml/catalog
151 catalog.
152 XML_CATALOG_FILES
154 XML catalog behavior can be changed by redirecting queries to the
155 user´s own set of catalogs. This can be done by setting the
156 XML_CATALOG_FILES environment variable to a list of catalogs. An
157 empty one should deactivate loading the default /etc/xml/catalog
158 catalog.
159
161 xsltproc return codes provide information that can be used when calling
162 it from scripts.
163 0
165 No error (normal operation)
166 1
168 No argument
169 2
171 Too many parameters
172 3
174 Unknown option
175 4
177 Failed to parse the stylesheet
178 5
180 Error in the stylesheet
181 6
183 Error in one of the documents
184 7
186 Unsupported xsl:output method
187 8
189 String parameter contains both quote and double-quotes
190 9
192 Internal processing error
193 10
195 Processing was stopped by a terminating message
196 11
198 Could not write the result to the output file
199
201 libxml(3), libxslt(3)
202 More information can be found at
204 · libxml(3) web page http://www.xmlsoft.org/
206 · W3C XSLT page http://www.w3.org/TR/xslt
208
211 John Fleck <jfleck@inkstain.net>
212 Author.
213
215 Copyright © 2001, 2002
216libxslt $Date: 2008-04-21 16:28:56 +0200 (Mon, 21 Apr 2008) $ XSLTPROC(1)