doc/xsltproc.1

   1 .\" ** You probably do not want to edit this file directly **
   2 .\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
   3 .\" Instead of manually editing it, you probably should edit the DocBook XML
   4 .\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
   5 .TH "XSLTPROC" "1" "$Date: 2007\-08\-23 14:20:49 +0200 (Thu, 23 Aug 2007) $" "libxslt" ""
   6 .\" disable hyphenation
   7 .nh
   8 .\" disable justification (adjust text to left margin only)
   9 .ad l
  10 .SH "NAME"
  11 xsltproc \- command line XSLT processor
  12 .SH "SYNOPSIS"
  13 .HP 9
  14 \fBxsltproc\fR [[\fB\-V\fR \fB\-\-version\fR] [\fB\-v\fR \fB\-\-verbose\fR] [{\fB\-o\fR \fB\-\-output\fR} {\fIFILE\fR \fIDIRECTORY\fR}] \fB\-\-timing\fR \fB\-\-repeat\fR \fB\-\-debug\fR \fB\-\-novalid\fR \fB\-\-noout\fR \fB\-\-maxdepth\ \fR\fB\fIVALUE\fR\fR \fB\-\-html\fR \fB\-\-param\ \fR\fB\fIENCODING\fR\fR\fB\ \fR \fB\-\-param\ \fR\fB\fIPARAMNAME\fR\fR\fB\ \fR\fB\fIPARAMVALUE\fR\fR\fB\ \fR \fB\-\-stringparam\ \fR\fB\fIPARAMNAME\fR\fR\fB\ \fR\fB\fIPARAMVALUE\fR\fR\fB\ \fR \fB\-\-nonet\fR \fB\-\-path\ "\fR\fB\fIPATH(S)\fR\fR\fB"\fR \fB\-\-load\-trace\fR \fB\-\-catalogs\fR \fB\-\-xinclude\fR [\fB\-\-profile\fR\ \fB\-\-norman\fR] \fB\-\-dumpextensions\fR \fB\-\-nowrite\fR \fB\-\-nomkdir\fR \fB\-\-writesubtree\ \fR\fB\fIPATH\fR\fR \fB\-\-nodtdattr\fR] [\fISTYLESHEET\fR] {\fIXML\-FILE\fR \-}
  15 .SH "DESCRIPTION"
  16 .PP
  17 \fBxsltproc\fR
  18 is a command line tool for applying
  19 XSLT
  20 stylesheets to
  21 XML
  22 documents. It is part of
  23 \fBlibxslt\fR(3), the XSLT C library for GNOME. While it was developed as part of the GNOME project, it can operate independently of the GNOME desktop.
  24 .PP
  25 \fBxsltproc\fR
  26 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. It will use the standard input if a filename provided is
  27 \fB\-\fR
  28 .
  29 .PP
  30 If a stylesheet is included in an
  31 XML
  32 document with a Stylesheet Processing Instruction, no stylesheet need to be named at the command line.
  33 \fBxsltproc\fR
  34 will automatically detect the included stylesheet and use it.
  35 .PP
  36 By default, output is to
  37 \fIstdout\fR. You can specify a file for output using the
  38 \fB\-o\fR
  39 or
  40 \fB\-\-output\fR
  41 option.
  42 .SH "OPTIONS"
  43 .PP
  44 \fBxsltproc\fR
  45 accepts the following options (in alphabetical order):
  46 .TP
  47 \fB\-\-catalogs\fR
  48 Use the
  49 SGML
  50 catalog specified in
  51 \fBSGML_CATALOG_FILES\fR
  52 to resolve the location of external entities. By default,
  53 \fBxsltproc\fR
  54 looks for the catalog specified in
  55 \fBXML_CATALOG_FILES\fR. If that is not specified, it uses
  56 \fI/etc/xml/catalog\fR.
  57 .TP
  58 \fB\-\-debug\fR
  59 Output an
  60 XML
  61 tree of the transformed document for debugging purposes.
  62 .TP
  63 \fB\-\-dumpextensions\fR
  64 Dumps the list of all registered extensions on
  65 \fIstdout\fR.
  66 .TP
  67 \fB\-\-html\fR
  68 The input document is an
  69 HTML
  70 file.
  71 .TP
  72 \fB\-\-load\-trace\fR
  73 Display all the documents loaded during the processing to
  74 \fIstderr\fR.
  75 .TP
  76 \fB\-\-maxdepth \fR\fB\fIVALUE\fR\fR
  77 Adjust the maximum depth of the template stack before
  78 \fBlibxslt\fR(3)
  79 concludes it is in an infinite loop. The default is 500.
  80 .TP
  81 \fB\-\-nodtdattr\fR
  82 Do not apply default attributes from the document's
  83 DTD.
  84 .TP
  85 \fB\-\-nomkdir\fR
  86 Refuses to create directories.
  87 .TP
  88 \fB\-\-nonet\fR
  89 Do not use the Internet to fetch
  90 DTDs, entities or documents.
  91 .TP
  92 \fB\-\-noout\fR
  93 Do not output the result.
  94 .TP
  95 \fB\-\-novalid\fR
  96 Skip loading the document's
  97 DTD.
  98 .TP
  99 \fB\-\-nowrite\fR
 100 Refuses to write to any file or resource.
 101 .TP
 102 \fB\-o\fR or \fB\-\-output\fR \fIFILE\fR | \fIDIRECTORY\fR
 103 Direct output to the given
 104 \fIFILE\fR. Using the option with a
 105 \fIDIRECTORY\fR
 106 directs the output files to the specified directory. This can be useful for multiple outputs (also known as "chunking") or manpage processing.
 107 .sp
 108 .it 1 an-trap
 109 .nr an-no-space-flag 1
 110 .nr an-break-flag 1
 111 .br
 112 \fBImportant\fR
 113 The given directory
 114 \fBmust\fR
 115 already exist.
 116 .sp
 117 .it 1 an-trap
 118 .nr an-no-space-flag 1
 119 .nr an-break-flag 1
 120 .br
 121 \fBNote\fR
 122 Make sure that
 123 \fIFILE\fR
 124 and
 125 \fIDIRECTORY\fR
 126 follow the
 127 \(lqURI reference computation\(rq
 128 as described in RFC 2396 and laters. This means, that e.g.
 129 \fB\-o directory\fR
 130 will maybe not work, but
 131 \fB\-o directory/\fR
 132 will.
 133 .TP
 134 \fB\-\-encoding \fR\fB\fIENCODING\fR\fR
 135 Allow to specify the encoding for the input.
 136 .TP
 137 \fB\-\-param \fR\fB\fIPARAMNAME\fR\fR\fB \fR\fB\fIPARAMVALUE\fR\fR
 138 Pass a parameter of name
 139 \fIPARAMNAME\fR
 140 and value
 141 \fIPARAMVALUE\fR
 142 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
 143 \fB\-\-stringparam\fR
 144 instead.
 145 .TP
 146 \fB\-\-path "\fR\fB\fIPATH(S)\fR\fR\fB"\fR
 147 Use the (space\- or colon\-separated) list of filesystem paths specified by
 148 \fIPATHS\fR
 149 to load
 150 DTDs, entities or documents. Enclose space\-separated lists by quotation marks.
 151 .TP
 152 \fB\-\-profile\fR or \fB\-\-norman\fR
 153 Output profiling information detailing the amount of time spent in each part of the stylesheet. This is useful in optimizing stylesheet performance.
 154 .TP
 155 \fB\-\-repeat\fR
 156 Run the transformation 20 times. Used for timing tests.
 157 .TP
 158 \fB\-\-stringparam \fR\fB\fIPARAMNAME\fR\fR\fB \fR\fB\fIPARAMVALUE\fR\fR
 159 Pass a parameter of name
 160 \fIPARAMNAME\fR
 161 and value
 162 \fIPARAMVALUE\fR
 163 where
 164 \fIPARAMVALUE\fR
 165 is a string rather than a node identifier.
 166 \fBNote:\fR
 167 The string must be UTF\-8 encoded.
 168 .TP
 169 \fB\-\-timing\fR
 170 Display the time used for parsing the stylesheet, parsing the document and applying the stylesheet and saving the result. Displayed in milliseconds.
 171 .TP
 172 \fB\-v\fR or \fB\-\-verbose\fR
 173 Output each step taken by
 174 \fBxsltproc\fR
 175 in processing the stylesheet and the document.
 176 .TP
 177 \fB\-V\fR or \fB\-\-version\fR
 178 Show the version of
 179 \fBlibxml\fR(3)
 180 and
 181 \fBlibxslt\fR(3)
 182 used.
 183 .TP
 184 \fB\-\-writesubtree \fR\fB\fIPATH\fR\fR
 185 Allow file write only within the
 186 \fIPATH\fR
 187 subtree.
 188 .TP
 189 \fB\-\-xinclude\fR
 190 Process the input document using the XInclude specification. More details on this can be found in the XInclude specification:
 191 \fI\%http://www.w3.org/TR/xinclude/\fR
 192 .SH "ENVIRONMENT"
 193 .TP
 194 \fBSGML_CATALOG_FILES\fR
 195 SGML
 196 catalog behavior can be changed by redirecting queries to the user's own set of catalogs. This can be done by setting the
 197 \fBSGML_CATALOG_FILES\fR
 198 environment variable to a list of catalogs. An empty one should deactivate loading the default
 199 \fI/etc/sgml/catalog\fR
 200 catalog.
 201 .TP
 202 \fBXML_CATALOG_FILES\fR
 203 XML
 204 catalog behavior can be changed by redirecting queries to the user's own set of catalogs. This can be done by setting the
 205 \fBXML_CATALOG_FILES\fR
 206 environment variable to a list of catalogs. An empty one should deactivate loading the default
 207 \fI/etc/xml/catalog\fR
 208 catalog.
 209 .SH "DIAGNOSTICS"
 210 .PP
 211 \fBxsltproc\fR
 212 return codes provide information that can be used when calling it from scripts.
 213 .TP
 214 \fB0\fR
 215 No error (normal operation)
 216 .TP
 217 \fB1\fR
 218 No argument
 219 .TP
 220 \fB2\fR
 221 Too many parameters
 222 .TP
 223 \fB3\fR
 224 Unknown option
 225 .TP
 226 \fB4\fR
 227 Failed to parse the stylesheet
 228 .TP
 229 \fB5\fR
 230 Error in the stylesheet
 231 .TP
 232 \fB6\fR
 233 Error in one of the documents
 234 .TP
 235 \fB7\fR
 236 Unsupported xsl:output method
 237 .TP
 238 \fB8\fR
 239 String parameter contains both quote and double\-quotes
 240 .TP
 241 \fB9\fR
 242 Internal processing error
 243 .TP
 244 \fB10\fR
 245 Processing was stopped by a terminating message
 246 .TP
 247 \fB11\fR
 248 Could not write the result to the output file
 249 .SH "SEE ALSO"
 250 .PP
 251 \fBlibxml\fR(3),
 252 \fBlibxslt\fR(3)
 253 .PP
 254 More information can be found at
 255 .TP 3
 256 \(bu
 257 \fBlibxml\fR(3)
 258 web page
 259 \fI\%http://www.xmlsoft.org/\fR
 260 .TP
 261 \(bu
 262 W3C
 263 XSLT
 264 page
 265 \fI\%http://www.w3.org/TR/xslt\fR
 266 .SH "AUTHOR"
 267 John Fleck <jfleck@inkstain.net>.