VirtualBox

source: vbox/trunk/src/libs/libxslt-1.1.22/doc/xsltproc.xml@ 35499

Last change on this file since 35499 was 7296, checked in by vboxsync, 17 years ago

Added libxslt-1.1.22 sources.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Date Revision Author Id
File size: 15.8 KB
Line 
1<?xml version="1.0"?>
2<?xml-stylesheet type="text/xsl"
3 href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
4<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
5 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
6
7 <!ENTITY xsltproc "<command>xsltproc</command>">
8]>
9
10<refentry>
11
12<refentryinfo>
13 <title>xsltproc Manual</title>
14 <productname>libxslt</productname>
15 <copyright>
16 <year>2001</year>
17 <year>2002</year>
18 </copyright>
19 <author>
20 <firstname>John</firstname>
21 <surname>Fleck</surname>
22 <affiliation>
23 <address>
24 <email>[email protected]</email>
25 </address>
26 </affiliation>
27 </author>
28 <!-- date should be the date of the latest change or the release version -->
29 <date>$Date: 2008-03-05 10:43:38 +0000 (Wed, 05 Mar 2008) $</date>
30 <!-- still a bit buggy output, will talk to docbook-xsl upstream to fix this -->
31 <!-- <releaseinfo>This is release 0.4 of the xsltproc Manual.</releaseinfo> -->
32 <!-- <edition>0.4</edition> -->
33</refentryinfo>
34
35<refmeta>
36 <refentrytitle>xsltproc</refentrytitle>
37 <manvolnum>1</manvolnum>
38</refmeta>
39
40<refnamediv>
41 <refname>xsltproc</refname>
42 <refpurpose>command line XSLT processor</refpurpose>
43</refnamediv>
44
45<refsynopsisdiv>
46 <cmdsynopsis>
47 <command>xsltproc</command>
48 <group choice="opt">
49 <group choice="opt">
50 <arg choice="plain"><option>-V</option></arg>
51 <arg choice="plain"><option>--version</option></arg>
52 </group>
53 <group choice="opt">
54 <arg choice="plain"><option>-v</option></arg>
55 <arg choice="plain"><option>--verbose</option></arg>
56 </group>
57 <group choice="opt">
58 <group choice="req">
59 <arg choice="plain"><option>-o</option></arg>
60 <arg choice="plain"><option>--output</option></arg>
61 </group>
62 <group choice="req">
63 <arg choice="plain"><replaceable class="option">FILE</replaceable></arg>
64 <arg choice="plain"><replaceable class="option">DIRECTORY</replaceable></arg>
65 </group>
66 </group>
67 <arg choice="plain"><option>--timing</option></arg>
68 <arg choice="plain"><option>--repeat</option></arg>
69 <arg choice="plain"><option>--debug</option></arg>
70 <arg choice="plain"><option>--novalid</option></arg>
71 <arg choice="plain"><option>--noout</option></arg>
72 <arg choice="plain"><option>--maxdepth <replaceable class="option">VALUE</replaceable></option></arg>
73 <arg choice="plain"><option>--html</option></arg>
74 <arg choice="plain"><option>--param
75 <replaceable class="option">ENCODING</replaceable>
76 </option></arg>
77 <arg choice="plain"><option>--param
78 <replaceable class="option">PARAMNAME</replaceable>
79 <replaceable class="option">PARAMVALUE</replaceable>
80 </option></arg>
81 <arg choice="plain"><option>--stringparam
82 <replaceable class="option">PARAMNAME</replaceable>
83 <replaceable class="option">PARAMVALUE</replaceable>
84 </option></arg>
85 <arg choice="plain"><option>--nonet</option></arg>
86 <arg choice="plain"><option>--path "<replaceable class="option">PATH(S)</replaceable>"</option></arg>
87 <arg choice="plain"><option>--load-trace</option></arg>
88 <arg choice="plain"><option>--catalogs</option></arg>
89 <arg choice="plain"><option>--xinclude</option></arg>
90 <arg choice="plain">
91 <group choice="opt">
92 <arg choice="plain"><option>--profile</option></arg>
93 <arg choice="plain"><option>--norman</option></arg>
94 </group>
95 </arg>
96 <arg choice="plain"><option>--dumpextensions</option></arg>
97 <arg choice="plain"><option>--nowrite</option></arg>
98 <arg choice="plain"><option>--nomkdir</option></arg>
99 <arg choice="plain"><option>--writesubtree <replaceable>PATH</replaceable></option></arg>
100 <arg choice="plain"><option>--nodtdattr</option></arg>
101 </group>
102 <arg choice="opt"><replaceable>STYLESHEET</replaceable></arg>
103 <group choice="req">
104 <arg choice="plain" rep="norepeat"><replaceable>XML-FILE</replaceable></arg>
105 <arg choice="plain" rep="norepeat">-</arg>
106 </group>
107 </cmdsynopsis>
108</refsynopsisdiv>
109
110<refsect1 id="description">
111 <title>DESCRIPTION</title>
112 <para>
113 &xsltproc; is a command line tool for applying <acronym>XSLT</acronym>
114 stylesheets to <acronym>XML</acronym> documents. It is part
115 of <citerefentry>
116 <refentrytitle>libxslt</refentrytitle>
117 <manvolnum>3</manvolnum>
118 </citerefentry>, the XSLT C library for GNOME.
119 While it was developed as part of the GNOME project, it can operate
120 independently of the GNOME desktop.
121 </para>
122 <para>
123 &xsltproc; is invoked from the command line with the name of the
124 stylesheet to be used followed by the name of the file or files to which
125 the stylesheet is to be applied. It will use the standard input if a
126 filename provided is <emphasis role="bold">-</emphasis> .
127 </para>
128 <para>
129 If a stylesheet is included in an <acronym>XML</acronym> document with a
130 Stylesheet Processing Instruction, no stylesheet need to be named at the
131 command line. &xsltproc; will automatically detect the included stylesheet
132 and use it.
133 </para>
134 <para>
135 By default, output is to <filename class="devicefile">stdout</filename>.
136 You can specify a file for output using
137 the <option>-o</option> or <option>--output</option> option.
138 </para>
139</refsect1>
140
141<refsect1 id="options">
142 <title>OPTIONS</title>
143 <para>
144 &xsltproc; accepts the following options (in alphabetical order):
145 </para>
146 <variablelist>
147
148 <varlistentry>
149 <term><option>--catalogs</option></term>
150 <listitem>
151 <para>
152 Use the <acronym>SGML</acronym> catalog specified
153 in <envar>SGML_CATALOG_FILES</envar> to resolve the location of
154 external entities. By default, &xsltproc; looks for the catalog
155 specified in <envar>XML_CATALOG_FILES</envar>. If that is not
156 specified, it uses <filename>/etc/xml/catalog</filename>.
157 </para>
158 </listitem>
159 </varlistentry>
160
161 <varlistentry>
162 <term><option>--debug</option></term>
163 <listitem>
164 <para>
165 Output an <acronym>XML</acronym> tree of the transformed document
166 for debugging purposes.
167 </para>
168 </listitem>
169 </varlistentry>
170
171 <varlistentry>
172 <term><option>--dumpextensions</option></term>
173 <listitem>
174 <para>
175 Dumps the list of all registered extensions
176 on <filename class="devicefile">stdout</filename>.
177 </para>
178 </listitem>
179 </varlistentry>
180
181 <varlistentry>
182 <term><option>--html</option></term>
183 <listitem>
184 <para>The input document is an <acronym>HTML</acronym> file.</para>
185 </listitem>
186 </varlistentry>
187
188 <varlistentry>
189 <term><option>--load-trace</option></term>
190 <listitem>
191 <para>
192 Display all the documents loaded during the processing
193 to <filename class="devicefile">stderr</filename>.
194 </para>
195 </listitem>
196 </varlistentry>
197
198 <varlistentry>
199 <term><option>--maxdepth <replaceable>VALUE</replaceable></option></term>
200 <listitem>
201 <para>
202 Adjust the maximum depth of the template stack
203 before <citerefentry>
204 <refentrytitle>libxslt</refentrytitle>
205 <manvolnum>3</manvolnum>
206 </citerefentry> concludes it is in an infinite loop. The default is 500.
207 </para>
208 </listitem>
209 </varlistentry>
210
211 <varlistentry>
212 <term><option>--nodtdattr</option></term>
213 <listitem>
214 <para>
215 Do not apply default attributes from the
216 document's <acronym>DTD</acronym>.
217 </para>
218 </listitem>
219 </varlistentry>
220
221 <varlistentry>
222 <term><option>--nomkdir</option></term>
223 <listitem>
224 <para>Refuses to create directories.</para>
225 </listitem>
226 </varlistentry>
227
228 <varlistentry>
229 <term><option>--nonet</option></term>
230 <listitem>
231 <para>
232 Do not use the Internet to fetch <acronym>DTD</acronym>s, entities
233 or documents.
234 </para>
235 </listitem>
236 </varlistentry>
237
238 <varlistentry>
239 <term><option>--noout</option></term>
240 <listitem>
241 <para>Do not output the result.</para>
242 </listitem>
243 </varlistentry>
244
245 <varlistentry>
246 <term><option>--novalid</option></term>
247 <listitem>
248 <para>Skip loading the document's <acronym>DTD</acronym>.</para>
249 </listitem>
250 </varlistentry>
251
252 <varlistentry>
253 <term><option>--nowrite</option></term>
254 <listitem>
255 <para>Refuses to write to any file or resource.</para>
256 </listitem>
257 </varlistentry>
258
259 <varlistentry>
260 <term>
261 <option>-o</option> or <option>--output</option>
262 <replaceable>FILE</replaceable> | <replaceable>DIRECTORY</replaceable>
263 </term>
264 <listitem>
265 <para>
266 Direct output to the given <replaceable>FILE</replaceable>. Using
267 the option with a <replaceable>DIRECTORY</replaceable> directs the
268 output files to the specified directory. This can be
269 useful for multiple outputs (also known as "chunking") or manpage
270 processing.
271 </para>
272 <important>
273 <para>
274 The given directory <emphasis role="bold">must</emphasis> already exist.
275 </para>
276 </important>
277 <note>
278 <para>
279 Make sure that <replaceable>FILE</replaceable>
280 and <replaceable>DIRECTORY</replaceable> follow the <quote>URI reference
281 computation</quote> as described in RFC 2396 and laters. This means, that
282 e.g. <option>-o directory</option> will maybe not work,
283 but <option>-o directory/</option> will.
284 </para>
285 </note>
286 </listitem>
287 </varlistentry>
288
289 <varlistentry>
290 <term>
291 <option>--encoding <replaceable>ENCODING</replaceable></option>
292 </term>
293 <listitem>
294 <para>
295 Allow to specify the encoding for the input.
296 </para>
297 </listitem>
298 </varlistentry>
299 <varlistentry>
300 <term>
301 <option>--param <replaceable>PARAMNAME</replaceable> <replaceable>PARAMVALUE</replaceable></option>
302 </term>
303 <listitem>
304 <para>
305 Pass a parameter of name <replaceable>PARAMNAME</replaceable> and
306 value <replaceable>PARAMVALUE</replaceable> to the stylesheet. You
307 may pass multiple name/value pairs up to a maximum of 32. If the
308 value being passed is a string rather than a node identifier,
309 use <option>--stringparam</option> instead.
310 </para>
311 </listitem>
312 </varlistentry>
313
314 <varlistentry>
315 <term><option>--path "<replaceable>PATH(S)</replaceable>"</option></term>
316 <listitem>
317 <para>
318 Use the (space- or colon-separated) list of filesystem paths specified
319 by <replaceable>PATHS</replaceable> to load <acronym>DTD</acronym>s,
320 entities or documents. Enclose space-separated lists by quotation marks.
321 </para>
322 </listitem>
323 </varlistentry>
324
325 <varlistentry>
326 <term><option>--profile</option> or <option>--norman</option></term>
327 <listitem>
328 <para>
329 Output profiling information detailing the amount of time spent in
330 each part of the stylesheet. This is useful in optimizing stylesheet
331 performance.
332 </para>
333 </listitem>
334 </varlistentry>
335
336 <varlistentry>
337 <term><option>--repeat</option></term>
338 <listitem>
339 <para>Run the transformation 20 times. Used for timing tests.</para>
340 </listitem>
341 </varlistentry>
342
343 <varlistentry>
344 <term>
345 <option>--stringparam <replaceable>PARAMNAME</replaceable> <replaceable>PARAMVALUE</replaceable></option>
346 </term>
347 <listitem>
348 <para>
349 Pass a parameter of name <replaceable>PARAMNAME</replaceable> and
350 value <replaceable>PARAMVALUE</replaceable>
351 where <replaceable>PARAMVALUE</replaceable> is a string rather than a
352 node identifier. <emphasis role="bold">Note:</emphasis> The string
353 must be UTF-8 encoded.
354 </para>
355 </listitem>
356 </varlistentry>
357
358 <varlistentry>
359 <term><option>--timing</option></term>
360 <listitem>
361 <para>
362 Display the time used for parsing the stylesheet, parsing the document
363 and applying the stylesheet and saving the result. Displayed in
364 milliseconds.
365 </para>
366 </listitem>
367 </varlistentry>
368
369 <varlistentry>
370 <term><option>-v</option> or <option>--verbose</option></term>
371 <listitem>
372 <para>
373 Output each step taken by &xsltproc; in processing the stylesheet
374 and the document.
375 </para>
376 </listitem>
377 </varlistentry>
378
379 <varlistentry>
380 <term><option>-V</option> or <option>--version</option></term>
381 <listitem>
382 <para>
383 Show the version of <citerefentry>
384 <refentrytitle>libxml</refentrytitle>
385 <manvolnum>3</manvolnum>
386 </citerefentry> and <citerefentry>
387 <refentrytitle>libxslt</refentrytitle>
388 <manvolnum>3</manvolnum>
389 </citerefentry> used.
390 </para>
391 </listitem>
392 </varlistentry>
393
394 <varlistentry>
395 <term><option>--writesubtree <replaceable>PATH</replaceable></option></term>
396 <listitem>
397 <para>
398 Allow file write only within the <replaceable>PATH</replaceable>
399 subtree.
400 </para>
401 </listitem>
402 </varlistentry>
403
404 <varlistentry>
405 <term><option>--xinclude</option></term>
406 <listitem>
407 <para>
408 Process the input document using the XInclude specification. More
409 details on this can be found in the XInclude
410 specification: <ulink url="http://www.w3.org/TR/xinclude/"/>
411 </para>
412 </listitem>
413 </varlistentry>
414
415 </variablelist>
416</refsect1>
417
418<refsect1 id="environment">
419 <title>ENVIRONMENT</title>
420 <variablelist>
421
422 <varlistentry>
423 <term><envar>SGML_CATALOG_FILES</envar></term>
424 <listitem>
425 <para><acronym>SGML</acronym> catalog behavior can be changed by redirecting
426 queries to the user's own set of catalogs. This can be done by setting
427 the <envar>SGML_CATALOG_FILES</envar> environment variable to a list
428 of catalogs. An empty one should deactivate loading the
429 default <filename>/etc/sgml/catalog</filename> catalog.
430 </para>
431 </listitem>
432 </varlistentry>
433
434 <varlistentry>
435 <term><envar>XML_CATALOG_FILES</envar></term>
436 <listitem>
437 <para><acronym>XML</acronym> catalog behavior can be changed by redirecting
438 queries to the user's own set of catalogs. This can be done by setting
439 the <envar>XML_CATALOG_FILES</envar> environment variable to a list
440 of catalogs. An empty one should deactivate loading the
441 default <filename>/etc/xml/catalog</filename> catalog.
442 </para>
443 </listitem>
444 </varlistentry>
445
446 </variablelist>
447</refsect1>
448
449<refsect1 id="diagnostics">
450 <title>DIAGNOSTICS</title>
451 <para>
452 &xsltproc; return codes provide information that can be used when
453 calling it from scripts.
454 </para>
455 <variablelist>
456
457 <varlistentry>
458 <term><errorcode>0</errorcode></term>
459 <listitem>
460 <para>No error (normal operation)</para>
461 </listitem>
462 </varlistentry>
463
464 <varlistentry>
465 <term><errorcode>1</errorcode></term>
466 <listitem>
467 <para>No argument</para>
468 </listitem>
469 </varlistentry>
470
471 <varlistentry>
472 <term><errorcode>2</errorcode></term>
473 <listitem>
474 <para>Too many parameters</para>
475 </listitem>
476 </varlistentry>
477
478 <varlistentry>
479 <term><errorcode>3</errorcode></term>
480 <listitem>
481 <para>Unknown option</para>
482 </listitem>
483 </varlistentry>
484
485 <varlistentry>
486 <term><errorcode>4</errorcode></term>
487 <listitem>
488 <para>Failed to parse the stylesheet</para>
489 </listitem>
490 </varlistentry>
491
492 <varlistentry>
493 <term><errorcode>5</errorcode></term>
494 <listitem>
495 <para>Error in the stylesheet</para>
496 </listitem>
497 </varlistentry>
498
499 <varlistentry>
500 <term><errorcode>6</errorcode></term>
501 <listitem>
502 <para>Error in one of the documents</para>
503 </listitem>
504 </varlistentry>
505
506 <varlistentry>
507 <term><errorcode>7</errorcode></term>
508 <listitem>
509 <para>Unsupported xsl:output method</para>
510 </listitem>
511 </varlistentry>
512
513 <varlistentry>
514 <term><errorcode>8</errorcode></term>
515 <listitem>
516 <para>String parameter contains both quote and double-quotes</para>
517 </listitem>
518 </varlistentry>
519
520 <varlistentry>
521 <term><errorcode>9</errorcode></term>
522 <listitem>
523 <para>Internal processing error</para>
524 </listitem>
525 </varlistentry>
526
527 <varlistentry>
528 <term><errorcode>10</errorcode></term>
529 <listitem>
530 <para>Processing was stopped by a terminating message</para>
531 </listitem>
532 </varlistentry>
533
534 <varlistentry>
535 <term><errorcode>11</errorcode></term>
536 <listitem>
537 <para>Could not write the result to the output file</para>
538 </listitem>
539 </varlistentry>
540
541 </variablelist>
542</refsect1>
543
544<refsect1 id="seealso">
545 <title>SEE ALSO</title>
546 <para><citerefentry>
547 <refentrytitle>libxml</refentrytitle>
548 <manvolnum>3</manvolnum>
549 </citerefentry>, <citerefentry>
550 <refentrytitle>libxslt</refentrytitle>
551 <manvolnum>3</manvolnum>
552 </citerefentry>
553 </para>
554 <para>
555 More information can be found at
556 <itemizedlist>
557 <listitem>
558 <para><citerefentry>
559 <refentrytitle>libxml</refentrytitle>
560 <manvolnum>3</manvolnum>
561 </citerefentry> web page <ulink url="http://www.xmlsoft.org/"/>
562 </para>
563 </listitem>
564 <listitem>
565 <para>W3C <acronym>XSLT</acronym> page <ulink url="http://www.w3.org/TR/xslt"/>
566 </para>
567 </listitem>
568 </itemizedlist>
569 </para>
570</refsect1>
571
572</refentry>
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette