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 "OPTIONS"
  40
  41 .PP
  42 \fB-V\fR or \fB--version\fR - Show the version of libxml and libxslt used.
  43
  44 .PP
  45 \fB-v\fR or \fB--verbose\fR - Output each step taken by xsltproc in processing the stylesheet and the document.
  46
  47 .PP
  48 \fB-o\fR or \fB--output\fR \fIfile\fR - 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.
  49
  50 .PP
  51 \fB--timing\fR - Display the time used for parsing the stylesheet, parsing the document and applying the stylesheet and saving the result. Displayed in milliseconds.
  52
  53 .PP
  54 \fB--repeat\fR - Run the transformation 20 times. Used for timing tests.
  55
  56 .PP
  57 \fB--debug\fR - Output an XML tree of the transformed document for debugging purposes.
  58
  59 .PP
  60 \fB--novalid\fR - Skip loading the document's DTD.
  61
  62 .PP
  63 \fB--noout\fR - Do not output the result.
  64
  65 .PP
  66 \fB--maxdepth\fR \fIvalue\fR - Adjust the maximum depth of the template stack before libxslt concludes it is in an infinite loop. The default is 500.
  67
  68 .PP
  69 \fB--html\fR - The input document is an HTML file.
  70
  71 .PP
  72 \fB--docbook\fR - The input document is DocBook SGML.
  73
  74 .PP
  75 \fB--param\fR \fIname\fR \fIvalue\fR - 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 8. .PP If the value being passed is a string rather than a node identifier, it must be escaped in quotes, as follows: .PP xsltproc --param rootid '"introduction"' \fIstylesheet\fR \fIfile\fR
  76
  77 .PP
  78 \fB--nonet\fR - Do not use the Internet to fetch DTD's or entities.
  79
  80 .PP
  81 \fB--warnnet\fR - Output notification when DTD's or entities are fetched over the Internet.
  82
  83 .PP
  84 \fB--catalogs\fR - 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.
  85
  86 .PP
  87 \fB--xinclude\fR - 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
  88
  89 .PP
  90 \fB--profile\fR or \fB--norman\fR - Output profiling information detailing the amount of time spent in each part of the stylesheet. This is useful in optimizing stylesheet performance.
  91
  92 .SH "RETURN VALUES"
  93
  94 .PP
  95 xsltproc's return codes provide information that can be used when calling it from scripts.
  96
  97 .PP
  98 0: normal
  99
 100 .PP
 101 1: no argument
 102
 103 .PP
 104 2: too many parameters
 105
 106 .PP
 107 3: unknown option
 108
 109 .PP
 110 4: failed to parse the stylesheet
 111
 112 .PP
 113 5: error in the stylesheet
 114
 115 .PP
 116 6: error in one of the documents
 117
 118 .PP
 119 7: unsuppoted xsl:output method
 120
 121 .SH "MORE INFORMATION"
 122
 123 .PP
 124 libxml web page: http://www.xmlsoft.org/: \fIhttp://www.xmlsoft.org/\fR
 125
 126 .PP
 127 W3C XSLT page: http://www.w3.org/TR/xslt: \fIhttp://www.w3.org/TR/xslt\fR
 128
 129 .SH AUTHOR
 130 Copyright 2001
 131 .Sp
 132 John Fleck  <jfleck@inkstain.net>
 133 .PP
 134 Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License: \fIgnome-help:fdl\fR, Version 1.1 or any later version published by the Free Software Foundation with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license can be found here: \fIgnome-help:fdl\fR.
 135
 136 .PP
 137 Many of the names used by companies to distinguish their products and services are claimed as trademarks. Where those names appear in any GNOME documentation, and those trademarks are made aware to the members of the GNOME Documentation Project, the names have been printed in caps or initial caps.
 138 This is release 0.1 of the xsltproc Manual.