doc/xsltproc.1

   1 .\"
   2 .\" This page was created on 2001-08-28 20:39:41 by makeman.pl
   3 .\" ``makeman.pl'' is part of the ``MakeMan'' project.
   4 .\" For more information, please see http://mama.sourceforge.net
   5 .\"
   6 .TH xsltproc 1
   7
   8 .SH NAME
   9 xsltproc \- command line xslt processor
  10
  11 .SH SYNOPSIS
  12 \fBxsltproc\fR
  13 [ \fI\-V\fR ] [ \fI\-v\fR ] [ \fI\-o \fR ] [ \fI\-\-timing\fR ] [ \fI\-\-repeat\fR ] [ \fI\-\-debug\fR ] [ \fI\-\-novalid\fR ] [ \fI\-\-noout\fR ] [ \fI\-\-maxdepth \fR ] [ \fI\-\-html\fR ] [ \fI\-\-docbook\fR ] [ \fI\-\-param \fR ] [ \fI\-\-nonet\fR ] [ \fI\-\-warnnet\fR ] [ \fI\-\-catalogs\fR ] [ \fI\-\-xinclude\fR ] [ \fI\-\-profile\fR ] [ \fIstylesheet\fR ] [ \fIfile1\fR ] [ \fIfile2\fR ] [ \fI....\fR ]
  14
  15 .SH "Introduction"
  16
  17 .PP
  18
  19 xsltproc is a command line tool for applying
  20 XSLT stylesheets to XML
  21 documents. It is part of libxslt, the XSLT C
  22 library for GNOME. While it was developed as part of the GNOME project, it
  23 can operate independently of the GNOME desktop.
  24
  25
  26 .PP
  27
  28 xsltproc is invoked from the command line with
  29 the name of the stylesheet to be used followed by the name of the file or
  30 files to which the stylesheet is to be applied.
  31
  32
  33 .PP
  34
  35 If a stylesheet is included in an XML document with a
  36 Stylesheet Processing Instruction, no stylesheet need be named at the
  37 command line. xsltproc will automatically
  38 detect the included stylesheet and use it.
  39
  40
  41 .PP
  42
  43 By default, output is to stdout. You can specify a file for output using
  44 the \-o option.
  45
  46
  47 .SH "Options"
  48
  49 .PP
  50
  51 \-V or \-\-version \- Show the version of
  52 libxml and libxslt used.
  53
  54
  55 .PP
  56
  57 \-v or \-\-verbose \- Output each step taken
  58 by xsltproc in processing the stylesheet and the document.
  59
  60
  61 .PP
  62
  63 \-o or \-\-output
  64 \fIfile\fR \- Direct output to the file named
  65 \fIfile\fR. For multiple outputs, also known as
  66 "chunking", \-o directory/ directs the
  67 output files to a specified directory. The directory must already exist.
  68
  69
  70 .PP
  71
  72 \-\-timing \- Display the time used for parsing the
  73 stylesheet, parsing the document and applying the stylesheet and saving
  74 the result. Displayed in milliseconds.
  75
  76
  77 .PP
  78
  79 \-\-repeat \- Run the transformation 20 times. Used for
  80 timing tests.
  81
  82
  83 .PP
  84
  85 \-\-debug \- Output an XML tree of the
  86 transformed document for debugging purposes.
  87
  88
  89 .PP
  90
  91 \-\-novalid \- Skip loading the document's DTD.
  92
  93
  94 .PP
  95
  96 \-\-noout \- Do not output the result.
  97
  98
  99 .PP
 100
 101 \-\-maxdepth \fIvalue\fR \- Adjust the
 102 maximum depth of the template stack before
 103 libxslt concludes it is in an infinite
 104 loop. The default is 500.
 105
 106
 107 .PP
 108
 109 \-\-html \- The input document is an HTML
 110 file.
 111
 112
 113 .PP
 114
 115 \-\-docbook \- The input document is DocBook
 116 SGML.
 117
 118
 119 .PP
 120
 121 \-\-param \fIname\fR
 122 \fIvalue\fR \- Pass a parameter of name
 123 \fIname\fR and value
 124 \fIvalue\fR to the stylesheet. You may pass multiple
 125 name/value pairs up to a maximum of 8.
 126
 127 .PP
 128
 129 If the value being passed is a string rather than a node identifier,
 130 it must be escaped in quotes, as follows:
 131
 132 .PP
 133
 134 xsltproc \-\-param rootid '"introduction"'
 135 \fIstylesheet\fR \fIfile\fR
 136
 137
 138
 139 .PP
 140
 141 \-\-nonet \- Do not use the Internet to fetch DTD's or
 142 entities.
 143
 144
 145 .PP
 146
 147 \-\-warnnet \- Output notification when DTD's or entities
 148 are fetched over the Internet.
 149
 150
 151 .PP
 152
 153 \-\-catalogs \- Use catalogs to resolve the location of
 154 external entities. This speeds DTD resolution. By having a
 155 catalog file point to a local version of the DTD,
 156 xsltproc does not have to use the
 157 Internet to fetch the DTD. xsltproc
 158 uses the catalog identified by the environmental variable
 159 SGML_CATALOG_FILES.
 160
 161
 162 .PP
 163
 164 \-\-xinclude \- Process the input document using the
 165 Xinclude specification. More details on this can be found in the Xinclude
 166 specification: http://www.w3.org/TR/xinclude/ (Link to \fIhttp://www.w3.org/TR/xinclude/\fR)
 167
 168
 169 .PP
 170
 171 \-\-profile or \-\-norman \- Output profiling
 172 information detailing the amount of time spent in each part of the
 173 stylesheet. This is useful in optimizing stylesheet performance.
 174
 175
 176 .SH "More Information"
 177
 178 .PP
 179
 180 .IP
 181 libxml web page: http://www.xmlsoft.org/ (Link to \fIhttp://www.xmlsoft.org/\fR)
 182 .IP
 183 W3C XSLT page: http://www.w3.org/TR/xslt (Link to \fIhttp://www.w3.org/TR/xslt\fR)
 184
 185