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