doc/xsltproc.html

   1 <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.61.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="id2685813"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2>Name</h2><p>xsltproc &#8212; command line xslt processor</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><tt class="command">xsltproc</tt>  [[-V] |  [-v] |  [-o <i class="replaceable"><tt>file</tt></i>] |  [--timing] |  [--repeat] |  [--debug] |  [--novalid] |  [--noout] |  [--maxdepth <i class="replaceable"><tt>val</tt></i>] |  [--html] |  [--param <i class="replaceable"><tt>name</tt></i> <i class="replaceable"><tt>value</tt></i>] |  [--stringparam <i class="replaceable"><tt>name</tt></i> <i class="replaceable"><tt>value</tt></i>] |  [--nonet] |  [--path <i class="replaceable"><tt>paths</tt></i>] |  [--load-trace] |  [--catalogs] |  [--xinclude] |  [--profile] |  [--dumpextensions] |  [--nowrite] |  [--nomkdir] |  [--writesubtree] |  [--nodtdattr]] [<tt class="option"><i class="replaceable"><tt>stylesheet</tt></i></tt>] [<i class="replaceable"><tt>file1</tt></i>] [<i class="replaceable"><tt>file2</tt></i>] [<i class="replaceable"><tt>....</tt></i>]</p></div></div><div class="refsect1" lang="en"><a name="introduction"></a><h2>Introduction</h2><p>
   2       <span class="application">xsltproc</span> is a command line tool for applying
   3       <span class="acronym">XSLT</span> stylesheets to <span class="acronym">XML</span>
   4       documents. It is part of <span class="application">libxslt</span>, the XSLT C
   5       library for GNOME. While it was developed as part of the GNOME project, it
   6       can operate independently of the GNOME desktop.
   7    </p><p>
   8       <span class="application">xsltproc</span> is invoked from the command line with
   9       the name of the stylesheet to be used followed by the name of the file or
  10       files to which the stylesheet is to be applied. It will use the standard
  11       input if a filename provided is - .
  12     </p><p>
  13       If a stylesheet is included in an <span class="acronym">XML</span> document with a
  14       Stylesheet Processing Instruction, no stylesheet need be named at the
  15       command line. <span class="application">xsltproc</span> will automatically
  16       detect the included stylesheet and use it.
  17     </p><p>
  18       By default, output is to stdout. You can specify a file for output using
  19       the <tt class="option">-o</tt> option.
  20     </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 class="option">-V</tt> or <tt class="option">--version</tt></span></dt><dd>Show the version of
  21       <span class="application">libxml</span> and <span class="application">libxslt</span> used.
  22     </dd><dt><span class="term">
  23       <tt class="option">-v</tt> or <tt class="option">--verbose</tt></span></dt><dd>Output each step taken
  24       by <span class="application">xsltproc</span> in processing the stylesheet and the document.
  25     </dd><dt><span class="term">
  26       <tt class="option">-o</tt> or <tt class="option">--output</tt> <i class="replaceable"><tt>file</tt></i></span></dt><dd>Direct output to the file named
  27       <i class="replaceable"><tt>file</tt></i>. For multiple outputs, also known as
  28       "chunking", <tt class="option">-o</tt> <tt class="option">directory/</tt> directs the
  29       output files to a specified directory. The directory must already exist.
  30     </dd><dt><span class="term">
  31       <tt class="option">--timing</tt></span></dt><dd>Display the time used for parsing the
  32       stylesheet, parsing the document and applying the stylesheet and saving
  33       the result. Displayed in milliseconds.
  34     </dd><dt><span class="term">
  35       <tt class="option">--repeat</tt></span></dt><dd>Run the transformation 20 times. Used for
  36       timing tests.
  37     </dd><dt><span class="term">
  38       <tt class="option">--debug</tt></span></dt><dd>Output an <span class="acronym">XML</span> tree of the
  39       transformed document for debugging purposes.
  40     </dd><dt><span class="term">
  41       <tt class="option">--novalid</tt></span></dt><dd>Skip loading the document's <span class="acronym">DTD</span>.
  42     </dd><dt><span class="term">
  43       <tt class="option">--noout</tt></span></dt><dd>Do not output the result.
  44     </dd><dt><span class="term">
  45       <tt class="option">--maxdepth</tt> <i class="replaceable"><tt>value</tt></i></span></dt><dd>Adjust the
  46       maximum depth of the template stack before
  47       <span class="application">libxslt</span> concludes it is in an infinite
  48       loop. The default is 500.
  49     </dd><dt><span class="term">
  50       <tt class="option">--html</tt></span></dt><dd>The input document is an <span class="acronym">HTML</span>
  51       file.
  52     </dd><dt><span class="term">
  53       <tt class="option">--param</tt> <i class="replaceable"><tt>name</tt></i> <i class="replaceable"><tt>value</tt></i></span></dt><dd>Pass a parameter of name
  54       <i class="replaceable"><tt>name</tt></i> and value
  55       <i class="replaceable"><tt>value</tt></i> to the stylesheet. You may pass multiple
  56       name/value pairs up to a maximum of 32. If the value being passed is a
  57             string rather than a node identifier, use
  58             <tt class="option">--stringparam</tt> instead.
  59           </dd><dt><span class="term">
  60           <tt class="option">--stringparam</tt> <i class="replaceable"><tt>name</tt></i> <i class="replaceable"><tt>value</tt></i></span></dt><dd>Pass a paramenter of name <i class="replaceable"><tt>name</tt></i> and
  61             value <i class="replaceable"><tt>value</tt></i> where
  62             <i class="replaceable"><tt>value</tt></i> is a string rather than a node
  63             identifier. (Note: The string must be utf-8.) </dd><dt><span class="term">
  64       <tt class="option">--nonet</tt></span></dt><dd>Do not use the Internet to fetch DTD's,
  65       entities or documents.
  66     </dd><dt><span class="term"> <tt class="option">--path</tt> <i class="replaceable"><tt>paths</tt></i></span></dt><dd>
  67             Use the list (separated by space or column) of filesystem paths
  68         specified by <i class="replaceable"><tt>paths</tt></i> to load
  69         <span class="acronym">DTDs</span>, entities or documents.
  70           </dd><dt><span class="term"><tt class="option">--load-trace</tt></span></dt><dd>
  71             Display to stderr all the documents loaded during the processing.
  72           </dd><dt><span class="term">
  73       <tt class="option">--catalogs</tt></span></dt><dd>Use the <span class="acronym">SGML</span> catalog specified in
  74       <tt class="envar">SGML_CATALOG_FILES</tt> to resolve the location of
  75             external entities. By default, <span class="application">xsltproc</span>
  76             looks for the catalog specified in
  77       <tt class="envar">XML_CATALOG_FILES</tt>. If that is not specified, it uses
  78       <tt class="filename">/etc/xml/catalog</tt>.
  79     </dd><dt><span class="term">
  80       <tt class="option">--xinclude</tt></span></dt><dd>Process the input document using the
  81       Xinclude specification. More details on this can be found in the Xinclude
  82       specification: <a href="http://www.w3.org/TR/xinclude/" target="_top">http://www.w3.org/TR/xinclude/</a>
  83     </dd><dt><span class="term">
  84       <tt class="option">--profile</tt> or <tt class="option">--norman</tt></span></dt><dd>Output profiling
  85       information detailing the amount of time spent in each part of the
  86       stylesheet. This is useful in optimizing stylesheet performance.
  87     </dd><dt><span class="term">
  88       <tt class="option">--dumpextensions</tt></span></dt><dd>Dumps the list of all registered extensions on stdout.
  89     </dd><dt><span class="term">
  90       <tt class="option">--nowrite</tt></span></dt><dd>Refuses to write to any file or resource.
  91     </dd><dt><span class="term">
  92       <tt class="option">--nomkdir</tt></span></dt><dd>Refuses to create directories.
  93     </dd><dt><span class="term">
  94       <tt class="option">--writesubtree</tt> <i class="replaceable"><tt>path</tt></i></span></dt><dd>Allow file write only within the
  95           <i class="replaceable"><tt>path</tt></i> subtree.
  96     </dd><dt><span class="term">
  97           <tt class="option">--nodtdattr</tt>
  98         </span></dt><dd>Do not apply default attributes from the document's
  99           <span class="acronym">DTD</span>.
 100           </dd></dl></div></div><div class="refsect1" lang="en"><a name="return"></a><h2>Return values</h2><p><span class="application">xsltproc</span>'s return codes provide information
 101     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><span class="application">libxml web page: </span><a href="http://www.xmlsoft.org/" target="_top">http://www.xmlsoft.org/</a></p><p>W3C <span class="acronym">XSLT page: </span><a href="http://www.w3.org/TR/xslt" target="_top">http://www.w3.org/TR/xslt</a></p></div></div></body></html>