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 \fBxsltproc\fR [\fB-V\fR | \fB-v\fR | \fB-o  \fIfile\fR \fR | \fB--timing\fR | \fB--repeat\fR | \fB--debug\fR | \fB--novalid\fR | \fB--noout\fR | \fB--maxdepth  \fIval\fR \fR | \fB--html\fR | \fB--docbook\fR | \fB--param  \fIname\fR   \fIvalue\fR \fR | \fB--nonet\fR | \fB--warnnet\fR | \fB--catalogs\fR | \fB--xinclude\fR | \fB--profile\fR] [\fB\fIstylesheet\fR\fR] [ \fIfile1\fR ] [ \fIfile2\fR ] [ \fI....\fR ]
  25 .SH "INTRODUCTION"
  26
  27 .PP
  28 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.
  29
  30 .PP
  31 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.
  32
  33 .PP
  34 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.
  35
  36 .PP
  37 By default, output is to stdout. You can specify a file for output using the \fB-o\fR option.
  38
  39 .SH "COMMAND LINE OPTIONS"
  40
  41 .TP
  42 \fB-V\fR or \fB--version\fR
  43
  44 Show the version of libxml and libxslt used.
  45
  46 .TP
  47
  48       \fB-v\fR or \fB--verbose\fR
  49
  50 Output each step taken by xsltproc in processing the stylesheet and the document.
  51
  52 .TP
  53
  54       \fB-o\fR or \fB--output\fR\fIfile\fR
  55
  56 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.
  57
  58 .TP
  59
  60       \fB--timing\fR
  61
  62 Display the time used for parsing the stylesheet, parsing the document and applying the stylesheet and saving the result. Displayed in milliseconds.
  63
  64 .TP
  65
  66       \fB--repeat\fR
  67
  68 Run the transformation 20 times. Used for timing tests.
  69
  70 .TP
  71
  72       \fB--debug\fR
  73
  74 Output an XML tree of the transformed document for debugging purposes.
  75
  76 .TP
  77
  78       \fB--novalid\fR
  79
  80 Skip loading the document's DTD.
  81
  82 .TP
  83
  84       \fB--noout\fR
  85
  86 Do not output the result.
  87
  88 .TP
  89
  90       \fB--maxdepth\fR \fIvalue\fR
  91
  92 Adjust the maximum depth of the template stack before libxslt concludes it is in an infinite loop. The default is 500.
  93
  94 .TP
  95
  96       \fB--html\fR
  97
  98 The input document is an HTML file.
  99
 100 .TP
 101
 102       \fB--docbook\fR
 103
 104 The input document is DocBook SGML.
 105
 106 .TP
 107
 108       \fB--param\fR \fIname\fR\fIvalue\fR
 109
 110 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 it must be escaped in quotes, as follows: xsltproc --param rootid '"introduction"' \fIstylesheet\fR \fIfile\fR
 111
 112 .TP
 113
 114       \fB--nonet\fR
 115
 116 Do not use the Internet to fetch DTD's or entities.
 117
 118 .TP
 119
 120       \fB--warnnet\fR
 121
 122 Output notification when DTD's or entities are fetched over the Internet.
 123
 124 .TP
 125
 126       \fB--catalogs\fR
 127
 128 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.
 129
 130 .TP
 131
 132       \fB--xinclude\fR
 133
 134 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/: \fIhttp://www.w3.org/TR/xinclude/\fR
 135
 136 .TP
 137
 138       \fB--profile\fR or \fB--norman\fR
 139
 140 Output profiling information detailing the amount of time spent in each part of the stylesheet. This is useful in optimizing stylesheet performance.
 141
 142 .SH "RETURN VALUES"
 143
 144 .PP
 145 xsltproc's return codes provide information that can be used when calling it from scripts.
 146
 147 .PP
 148 0: normal
 149
 150 .PP
 151 1: no argument
 152
 153 .PP
 154 2: too many parameters
 155
 156 .PP
 157 3: unknown option
 158
 159 .PP
 160 4: failed to parse the stylesheet
 161
 162 .PP
 163 5: error in the stylesheet
 164
 165 .PP
 166 6: error in one of the documents
 167
 168 .PP
 169 7: unsuppoted xsl:output method
 170
 171 .SH "MORE INFORMATION"
 172
 173 .PP
 174 libxml web page: http://www.xmlsoft.org/: \fIhttp://www.xmlsoft.org/\fR
 175
 176 .PP
 177 W3C XSLT page: http://www.w3.org/TR/xslt: \fIhttp://www.w3.org/TR/xslt\fR
 178
 179 .SH AUTHOR
 180 Copyright 2001
 181 .Sp
 182 John Fleck  <jfleck@inkstain.net>This is release 0.2 of the xsltproc Manual.