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 "2006-02-20" "libxslt" "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\-o\fR\fR | \fB\fB\-\-output\fR\fR} {\fB\fIFILE\fR\fR | \fB\fIDIRECTORY\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\ \fI"PATHS"\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] {\fB\fIXML\-FILE\fR\fR | \fB\-\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 to 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 \fIstdout\fR\&. You can specify a file for output using the \fB\-o\fR or \fB\-\-output\fR option\&.
  44
  45 .PP
  46 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\&.
  47
  48 .SH "OPTIONS"
  49
  50 .PP
  51 \fBxsltproc\fR accepts the following options (in alphabetical order):
  52
  53 .TP
  54 \fB\-\-catalogs\fR
  55 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\&.
  56
  57 .TP
  58 \fB\-\-debug\fR
  59 Output an XML tree of the transformed document for debugging purposes\&.
  60
  61 .TP
  62 \fB\-\-dumpextensions\fR
  63 Dumps the list of all registered extensions on \fIstdout\fR\&.
  64
  65 .TP
  66 \fB\-\-html\fR
  67 The input document is an HTML file\&.
  68
  69 .TP
  70 \fB\-\-load\-trace\fR
  71 Display all the documents loaded during the processing to \fIstderr\fR\&.
  72
  73 .TP
  74 \fB\-\-maxdepth \fIVALUE\fR\fR
  75 Adjust the maximum depth of the template stack before libxslt concludes it is in an infinite loop\&. The default is 500\&.
  76
  77 .TP
  78 \fB\-\-nodtdattr\fR
  79 Do not apply default attributes from the document's DTD\&.
  80
  81 .TP
  82 \fB\-\-nomkdir\fR
  83 Refuses to create directories\&.
  84
  85 .TP
  86 \fB\-\-nonet\fR
  87 Do not use the Internet to fetch DTDs, entities or documents\&.
  88
  89 .TP
  90 \fB\-\-noout\fR
  91 Do not output the result\&.
  92
  93 .TP
  94 \fB\-\-novalid\fR
  95 Skip loading the document's DTD\&.
  96
  97 .TP
  98 \fB\-\-nowrite\fR
  99 Refuses to write to any file or resource\&.
 100
 101 .TP
 102 \fB\-o\fR or \fB\-\-output\fR \fIFILE\fR | \fIDIRECTORY\fR
 103 Direct output to the given \fIFILE\fR\&. Using the option with a \fIDIRECTORY\fR directs the output files to the specified directory\&. This can be useful for multiple outputs (also known as "chunking") or manpage processing\&. Note: The given directory must already exist\&.
 104
 105 .TP
 106 \fB\-\-param \fIPARAMNAME\fR \fIPARAMVALUE\fR\fR
 107 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\&.
 108
 109 .TP
 110 \fB\-\-path \fI"PATHS"\fR\fR
 111 Use the (space\- or colon\-separated) list of filesystem paths specified by \fIPATHS\fR to load DTDs, entities or documents\&. Enclose space\-separated lists by quotation marks\&.
 112
 113 .TP
 114 \fB\-\-profile\fR or \fB\-\-norman\fR
 115 Output profiling information detailing the amount of time spent in each part of the stylesheet\&. This is useful in optimizing stylesheet performance\&.
 116
 117 .TP
 118 \fB\-\-repeat\fR
 119 Run the transformation 20 times\&. Used for timing tests\&.
 120
 121 .TP
 122 \fB\-\-stringparam \fIPARAMNAME\fR \fIPARAMVALUE\fR\fR
 123 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 encoded\&.
 124
 125 .TP
 126 \fB\-\-timing\fR
 127 Display the time used for parsing the stylesheet, parsing the document and applying the stylesheet and saving the result\&. Displayed in milliseconds\&.
 128
 129 .TP
 130 \fB\-v\fR or \fB\-\-verbose\fR
 131 Output each step taken by \fBxsltproc\fR in processing the stylesheet and the document\&.
 132
 133 .TP
 134 \fB\-V\fR or \fB\-\-version\fR
 135 Show the version of libxml and libxslt used\&.
 136
 137 .TP
 138 \fB\-\-writesubtree \fIPATH\fR\fR
 139 Allow file write only within the \fIPATH\fR subtree\&.
 140
 141 .TP
 142 \fB\-\-xinclude\fR
 143 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
 144
 145 .SH "ENVIRONMENT"
 146
 147 .TP
 148 \fBSGML_CATALOG_FILES\fR
 149 \&.\&.\&.
 150
 151 .TP
 152 \fBXML_CATALOG_FILES\fR
 153 \&.\&.\&.
 154
 155 .SH "DIAGNOSTICS"
 156
 157 .PP
 158 \fBxsltproc\fR's return codes provide information that can be used when calling it from scripts\&.
 159
 160 .TP
 161 \fB0\fR
 162 No error (normal operation)
 163
 164 .TP
 165 \fB1\fR
 166 No argument
 167
 168 .TP
 169 \fB2\fR
 170 Too many parameters
 171
 172 .TP
 173 \fB3\fR
 174 Unknown option
 175
 176 .TP
 177 \fB4\fR
 178 Failed to parse the stylesheet
 179
 180 .TP
 181 \fB5\fR
 182 Error in the stylesheet
 183
 184 .TP
 185 \fB6\fR
 186 Error in one of the documents
 187
 188 .TP
 189 \fB7\fR
 190 Unsupported xsl:output method
 191
 192 .TP
 193 \fB8\fR
 194 String parameter contains both quote and double\-quotes
 195
 196 .TP
 197 \fB9\fR
 198 Internal processing error
 199
 200 .TP
 201 \fB10\fR
 202 Processing was stopped by a terminating message
 203
 204 .SH AUTHOR
 205 John Fleck <jfleck@inkstain\&.net>.