doc/xsltproc.1

   1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
   2 .de Sh \" Subsection
   3 .br
   4 .if t .Sp
   5 .ne 5
   6 .PP
   7 \fB\\$1\fR
   8 .PP
   9 ..
  10 .de Sp \" Vertical space (when we can't use .PP)
  11 .if t .sp .5v
  12 .if n .sp
  13 ..
  14 .de Ip \" List item
  15 .br
  16 .ie \\n(.$>=3 .ne \\$3
  17 .el .ne 3
  18 .IP "\\$1" \\$2
  19 ..
  20 .TH "XSLTPROC" 1 "" "" "xsltproc Manual"
  21 .SH NAME
  22 xsltproc \- command line xslt processor
  23 .SH "SYNOPSIS"
  24 .ad l
  25 .hy 0
  26 .HP 9
  27 \fBxsltproc\fR [[\fB\fB\-V\fR\fR | \fB\fB\-\-version\fR\fR] [\fB\fB\-v\fR\fR | \fB\fB\-\-verbose\fR\fR] | \fB{\fB\fB\-o\fR\fR\ |\ \fB\fB\-\-output\fR\fR}\ \fIFILE\fR\fR | \fB\fB\-\-timing\fR\fR | \fB\fB\-\-repeat\fR\fR | \fB\fB\-\-debug\fR\fR | \fB\fB\-\-novalid\fR\fR | \fB\fB\-\-noout\fR\fR | \fB\fB\-\-maxdepth\ \fIVALUE\fR\fR\fR | \fB\fB\-\-html\fR\fR | \fB\fB\-\-param\ \fIPARAMNAME\fR\ \fIPARAMVALUE\fR\ \fR\fR | \fB\fB\-\-stringparam\ \fIPARAMNAME\fR\ \fIPARAMVALUE\fR\ \fR\fR | \fB\fB\-\-nonet\fR\fR | \fB\fB\-\-path\ "\fIPATHS\fR"\fR\fR | \fB\fB\-\-load\-trace\fR\fR | \fB\fB\-\-catalogs\fR\fR | \fB\fB\-\-xinclude\fR\fR [\fB\fB\-\-profile\fR\fR | \fB\fB\-\-norman\fR\fR] | \fB\fB\-\-dumpextensions\fR\fR | \fB\fB\-\-nowrite\fR\fR | \fB\fB\-\-nomkdir\fR\fR | \fB\fB\-\-writesubtree\ \fIPATH\fR\fR\fR | \fB\fB\-\-nodtdattr\fR\fR] [\fISTYLESHEET\fR] {\fIFILE\fR...}
  28 .ad
  29 .hy
  30
  31 .SH "DESCRIPTION"
  32
  33 .PP
  34 \fBxsltproc\fR 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\&.
  35
  36 .PP
  37 \fBxsltproc\fR 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 \- \&.
  38
  39 .PP
  40 If a stylesheet is included in an XML document with a Stylesheet Processing Instruction, no stylesheet need be named at the command line\&. \fBxsltproc\fR will automatically detect the included stylesheet and use it\&.
  41
  42 .PP
  43 By default, output is to stdout\&. You can specify a file for output using the \fB\-o\fR option\&.
  44
  45 .SH "OPTIONS"
  46
  47 .PP
  48 \fBxsltproc\fR currently accepts the following options:
  49
  50 .TP
  51 \fB\-V\fR or \fB\-\-version\fR
  52 Show the version of libxml and libxslt used\&.
  53
  54 .TP
  55 \fB\-v\fR or \fB\-\-verbose\fR
  56 Output each step taken by \fBxsltproc\fR in processing the stylesheet and the document\&.
  57
  58 .TP
  59 \fB\-o\fR or \fB\-\-output\fR \fIFILE\fR
  60 Direct output to the file named \fIFILE\fR\&. For multiple outputs, also known as "chunking", \fB\-o \fIDIRECTORY/\fR\fR directs the output files to a specified directory\&. The directory must already exist\&.
  61
  62 .TP
  63 \fB\-\-timing\fR
  64 Display the time used for parsing the stylesheet, parsing the document and applying the stylesheet and saving the result\&. Displayed in milliseconds\&.
  65
  66 .TP
  67 \fB\-\-repeat\fR
  68 Run the transformation 20 times\&. Used for timing tests\&.
  69
  70 .TP
  71 \fB\-\-debug\fR
  72 Output an XML tree of the transformed document for debugging purposes\&.
  73
  74 .TP
  75 \fB\-\-novalid\fR
  76 Skip loading the document's DTD\&.
  77
  78 .TP
  79 \fB\-\-noout\fR
  80 Do not output the result\&.
  81
  82 .TP
  83 \fB\-\-maxdepth \fIVALUE\fR\fR
  84 Adjust the maximum depth of the template stack before libxslt concludes it is in an infinite loop\&. The default is 500\&.
  85
  86 .TP
  87 \fB\-\-html\fR
  88 The input document is an HTML file\&.
  89
  90 .TP
  91 \fB\-\-param \fIPARAMNAME\fR \fIPARAMVALUE\fR\fR
  92 Pass a parameter of name \fIPARAMNAME\fR and value \fIPARAMVALUE\fR 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 \fB\-\-stringparam\fR instead\&.
  93
  94 .TP
  95 \fB\-\-stringparam \fIPARAMNAME\fR \fIPARAMVALUE\fR\fR
  96 Pass a paramenter of name \fIPARAMNAME\fR and value \fIPARAMVALUE\fR where \fIPARAMVALUE\fR is a string rather than a node identifier\&. (Note: The string must be utf\-8\&.)
  97
  98 .TP
  99 \fB\-\-nonet\fR
 100 Do not use the Internet to fetch DTDs, entities or documents\&.
 101
 102 .TP
 103 \fB\-\-path "\fIPATHS\fR"\fR
 104 Use the list (separated by space or colon) of filesystem paths specified by \fIpaths\fR to load DTDs, entities or documents\&.
 105
 106 .TP
 107 \fB\-\-load\-trace\fR
 108 Display to stderr all the documents loaded during the processing\&.
 109
 110 .TP
 111 \fB\-\-catalogs\fR
 112 Use the SGML catalog specified in \fBSGML_CATALOG_FILES\fR to resolve the location of external entities\&. By default, \fBxsltproc\fR looks for the catalog specified in \fBXML_CATALOG_FILES\fR\&. If that is not specified, it uses \fI/etc/xml/catalog\fR\&.
 113
 114 .TP
 115 \fB\-\-xinclude\fR
 116 Process the input document using the Xinclude specification\&. More details on this can be found in the Xinclude specification: \fIhttp://www.w3.org/TR/xinclude/\fR
 117
 118 .TP
 119 \fB\-\-profile\fR or \fB\-\-norman\fR
 120 Output profiling information detailing the amount of time spent in each part of the stylesheet\&. This is useful in optimizing stylesheet performance\&.
 121
 122 .TP
 123 \fB\-\-dumpextensions\fR
 124 Dumps the list of all registered extensions on stdout\&.
 125
 126 .TP
 127 \fB\-\-nowrite\fR
 128 Refuses to write to any file or resource\&.
 129
 130 .TP
 131 \fB\-\-nomkdir\fR
 132 Refuses to create directories\&.
 133
 134 .TP
 135 \fB\-\-writesubtree \fIPATH\fR\fR
 136 Allow file write only within the \fIPATH\fR subtree\&.
 137
 138 .TP
 139 \fB\-\-nodtdattr\fR
 140 Do not apply default attributes from the document's DTD\&.
 141
 142 .SH "ENVIRONMENT"
 143
 144 .TP
 145 \fBSGML_CATALOG_FILES\fR
 146 \&.\&.\&.
 147
 148 .TP
 149 \fBXML_CATALOG_FILES\fR
 150 \&.\&.\&.
 151
 152 .SH "DIAGNOSTICS"
 153
 154 .PP
 155 \fBxsltproc\fR's return codes provide information that can be used when calling it from scripts\&.
 156
 157 .TP
 158 \fB0\fR
 159 normal
 160
 161 .TP
 162 \fB1\fR
 163 no argument
 164
 165 .TP
 166 \fB2\fR
 167 too many parameters
 168
 169 .TP
 170 \fB3\fR
 171 unknown option
 172
 173 .TP
 174 \fB4\fR
 175 failed to parse the stylesheet
 176
 177 .TP
 178 \fB5\fR
 179 error in the stylesheet
 180
 181 .TP
 182 \fB6\fR
 183 error in one of the documents
 184
 185 .TP
 186 \fB7\fR
 187 unsupported xsl:output method
 188
 189 .TP
 190 \fB8\fR
 191 string parameter contains both quote and double\-quotes
 192
 193 .TP
 194 \fB9\fR
 195 internal processing error
 196
 197 .TP
 198 \fB10\fR
 199 processing was stopped by a terminating message
 200
 201 .SH "SEE ALSO"
 202
 203 .PP
 204 More information can be found at the libxml web pages at \fIhttp://www.xmlsoft.org/\fR and the W3C XSLT pages at \fIhttp://www.w3.org/TR/xslt\fR\&.
 205
 206 .SH AUTHOR
 207 John Fleck.