source: trunk/third/libxslt/doc/xsltproc.1 @ 21535

Revision 21535, 5.4 KB checked in by ghudson, 20 years ago (diff)
This commit was generated by cvs2svn to compensate for changes in r21534, which included commits to RCS files with non-trunk default branches.
Line 
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
22xsltproc \- command line xslt processor
23.SH "SYNOPSIS"
24.ad l
25.hy 0
26.HP 9
27\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\-\-param\ \fIname\fR\ \fIvalue\fR\fR | \fB\-\-stringparam\ \fIname\fR\ \fIvalue\fR\fR | \fB\-\-nonet\fR | \fB\-\-path\ \fIpaths\fR\fR | \fB\-\-load\-trace\fR | \fB\-\-catalogs\fR | \fB\-\-xinclude\fR | \fB\-\-profile\fR | \fB\-\-dumpextensions\fR | \fB\-\-nowrite\fR | \fB\-\-nomkdir\fR | \fB\-\-writesubtree\fR] [\fB\fIstylesheet\fR\fR] [\fIfile1\fR] [\fIfile2\fR] [\fI\&.\&.\&.\&.\fR]
28.ad
29.hy
30
31.SH "INTRODUCTION"
32
33.PP
34 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\&.
35
36.PP
37 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\&. It will use the standard input if a filename provided is \- \&.
38
39.PP
40If 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\&.
41
42.PP
43By default, output is to stdout\&. You can specify a file for output using the \fB\-o\fR option\&.
44
45.SH "COMMAND LINE OPTIONS"
46
47.TP
48\fB\-V\fR or \fB\-\-version\fR
49Show the version of libxml and libxslt used\&.
50
51.TP
52\fB\-v\fR or \fB\-\-verbose\fR
53Output each step taken by xsltproc in processing the stylesheet and the document\&.
54
55.TP
56\fB\-o\fR or \fB\-\-output\fR \fIfile\fR
57Direct 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\&.
58
59.TP
60\fB\-\-timing\fR
61Display the time used for parsing the stylesheet, parsing the document and applying the stylesheet and saving the result\&. Displayed in milliseconds\&.
62
63.TP
64\fB\-\-repeat\fR
65Run the transformation 20 times\&. Used for timing tests\&.
66
67.TP
68\fB\-\-debug\fR
69Output an XML tree of the transformed document for debugging purposes\&.
70
71.TP
72\fB\-\-novalid\fR
73Skip loading the document's DTD\&.
74
75.TP
76\fB\-\-noout\fR
77Do not output the result\&.
78
79.TP
80\fB\-\-maxdepth\fR \fIvalue\fR
81Adjust the maximum depth of the template stack before libxslt concludes it is in an infinite loop\&. The default is 500\&.
82
83.TP
84\fB\-\-html\fR
85The input document is an HTML file\&.
86
87.TP
88\fB\-\-param\fR \fIname\fR \fIvalue\fR
89Pass 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\&.
90
91.TP
92\fB\-\-stringparam\fR \fIname\fR \fIvalue\fR
93Pass 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\&.)
94
95.TP
96\fB\-\-nonet\fR
97Do not use the Internet to fetch DTD's, entities or documents\&.
98
99.TP
100\fB\-\-path\fR \fIpaths\fR
101Use the list (separated by space or column) of filesystem paths specified by \fIpaths\fR to load DTDs, entities or documents\&.
102
103.TP
104\fB\-\-load\-trace\fR
105Display to stderr all the documents loaded during the processing\&.
106
107.TP
108\fB\-\-catalogs\fR
109Use the SGML catalog specified in \fBSGML_CATALOG_FILES\fR to resolve the location of external entities\&. By default, xsltproc looks for the catalog specified in \fBXML_CATALOG_FILES\fR\&. If that is not specified, it uses \fI/etc/xml/catalog\fR\&.
110
111.TP
112\fB\-\-xinclude\fR
113Process 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
114
115.TP
116\fB\-\-profile\fR or \fB\-\-norman\fR
117Output 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
121Dumps the list of all registered extensions on stdout\&.
122
123.TP
124\fB\-\-nowrite\fR
125Refuses to write to any file or resource\&.
126
127.TP
128\fB\-\-nomkdir\fR
129Refuses to create directories\&.
130
131.TP
132\fB\-\-writesubtree\fR \fIpath\fR
133Allow file write only within the \fIpath\fR subtree\&.
134
135.SH "RETURN VALUES"
136
137.PP
138xsltproc's return codes provide information that can be used when calling it from scripts\&.
139
140.PP
1410: normal
142
143.PP
1441: no argument
145
146.PP
1472: too many parameters
148
149.PP
1503: unknown option
151
152.PP
1534: failed to parse the stylesheet
154
155.PP
1565: error in the stylesheet
157
158.PP
1596: error in one of the documents
160
161.PP
1627: unsupported xsl:output method
163
164.PP
1658: string parameter contains both quote and double\-quotes
166
167.PP
1689: internal processing error
169
170.PP
17110: processing was stopped by a terminating message
172
173.SH "MORE INFORMATION"
174
175.PP
176libxml web page:http://www\&.xmlsoft\&.org/: \fIhttp://www.xmlsoft.org/\fR
177
178.PP
179W3C XSLT page:http://www\&.w3\&.org/TR/xslt: \fIhttp://www.w3.org/TR/xslt\fR
180
181.SH AUTHOR
182John Fleck.
Note: See TracBrowser for help on using the repository browser.