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
  25 .nf
  26 \fBxsltproc\fR [\fB-V\fR | \fB-v\fR | \fB-o \fIfile\fR\fR | \fB--timing\fR | \fB--repeat\fR
  27          | \fB--debug\fR | \fB--novalid\fR | \fB--noout\fR | \fB--maxdepth \fIval\fR\fR
  28          | \fB--html\fR | \fB--docbook\fR | \fB--param \fIname\fR \fIvalue\fR\fR
  29          | \fB--stringparam \fIname\fR \fIvalue\fR\fR | \fB--nonet\fR | \fB--catalogs\fR
  30          | \fB--xinclude\fR | \fB--profile\fR | \fB--dumpextensions\fR] [\fBstylesheet\fR]
  31          [\fIfile1\fR] [\fIfile2\fR] [\fI....\fR]
  32 .fi
  33
  34 .SH "INTRODUCTION"
  35
  36 .PP
  37  xsltproc 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.
  38
  39 .PP
  40  xsltproc 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.
  41
  42 .PP
  43 If a stylesheet is included in an XML document with a Stylesheet Processing Instruction, no stylesheet need be named at the command line. xsltproc will automatically detect the included stylesheet and use it.
  44
  45 .PP
  46 By default, output is to stdout. You can specify a file for output using the \fB-o\fR option.
  47
  48 .SH "COMMAND LINE 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 xsltproc 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\fR \fBdirectory/\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\fR \fIvalue\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--docbook\fR
  92 The input document is DocBook SGML.
  93
  94 .TP
  95 \fB--param\fR \fIname\fR \fIvalue\fR
  96 Pass a parameter of name \fIname\fR and value \fIvalue\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.
  97
  98 .TP
  99 \fB--stringparam\fR \fIname\fR \fIvalue\fR
 100 Pass a paramenter of name \fIname\fR and value \fIvalue\fR where \fIvalue\fR is a string rather than a node identifier. (Note: The string must be utf-8.)
 101
 102 .TP
 103 \fB--nonet\fR
 104 Do not use the Internet to fetch DTD's or entities.
 105
 106 .TP
 107 \fB--catalogs\fR
 108 Use catalogs to resolve the location of external entities. This speeds DTD resolution. By having a catalog file point to a local version of the DTD, xsltproc does not have to use the Internet to fetch the DTD. xsltproc uses the catalog identified by the environmental variable \fBSGML_CATALOG_FILES\fR.
 109
 110 .TP
 111 \fB--xinclude\fR
 112 Process the input document using the Xinclude specification. More details on this can be found in the Xinclude specification: : http://www.w3.org/TR/xinclude/http://www.w3.org/TR/xinclude/
 113
 114 .TP
 115 \fB--profile\fR or \fB--norman\fR
 116 Output profiling information detailing the amount of time spent in each part of the stylesheet. This is useful in optimizing stylesheet performance.
 117
 118 .TP
 119 \fB--dumpextensions\fR
 120 Dumps the list of all registered extensions on stdout.
 121
 122 .SH "RETURN VALUES"
 123
 124 .PP
 125 xsltproc's return codes provide information that can be used when calling it from scripts.
 126
 127 .PP
 128 0: normal
 129
 130 .PP
 131 1: no argument
 132
 133 .PP
 134 2: too many parameters
 135
 136 .PP
 137 3: unknown option
 138
 139 .PP
 140 4: failed to parse the stylesheet
 141
 142 .PP
 143 5: error in the stylesheet
 144
 145 .PP
 146 6: error in one of the documents
 147
 148 .PP
 149 7: unsupported xsl:output method
 150
 151 .PP
 152 8: string parameter contains both quote and double-quotes
 153
 154 .PP
 155 9: internal processing error
 156
 157 .PP
 158 10: processing was stopped by a terminating message
 159
 160 .SH "MORE INFORMATION"
 161
 162 .PP
 163 libxml web page:: http://www.xmlsoft.org/http://www.xmlsoft.org/
 164
 165 .PP
 166 W3C XSLT page:: http://www.w3.org/TR/xslthttp://www.w3.org/TR/xslt
 167
 168 .SH AUTHOR
 169 .