1
0
mirror of https://gitlab.gnome.org/GNOME/libxslt synced 2025-07-29 15:41:13 +03:00

fix maxdepth default value documentation fixes #519921. Daniel

* doc/xsltproc.xml doc/xsltproc.1: fix maxdepth default value
  documentation fixes #519921.
Daniel

svn path=/trunk/; revision=1457
This commit is contained in:
Daniel Veillard
2008-03-03 08:42:08 +00:00
parent 4f91dfa7e6
commit 15964811dc
3 changed files with 203 additions and 104 deletions

View File

@ -1,3 +1,8 @@
Mon Mar 3 09:39:31 CET 2008 Daniel Veillard <daniel@veillard.com>
* doc/xsltproc.xml doc/xsltproc.1: fix maxdepth default value
documentation fixes #519921.
Sat Feb 16 01:24:58 HKT 2008 William Brack <wbrack@mmm.com.hk> Sat Feb 16 01:24:58 HKT 2008 William Brack <wbrack@mmm.com.hk>
*libxslt/extensions.c: fixed minor error bug #516483 *libxslt/extensions.c: fixed minor error bug #516483

View File

@ -1,267 +1,361 @@
.\" ** You probably do not want to edit this file directly ** .\" Title: xsltproc
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). .\" Author: John Fleck <jfleck@inkstain.net>
.\" Instead of manually editing it, you probably should edit the DocBook XML .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it. .\" Date: $Date: 2007-08-23 14:20:49 +0200 (Thu, 23 Aug 2007) $
.TH "XSLTPROC" "1" "$Date: 2007\-08\-23 14:20:49 +0200 (Thu, 23 Aug 2007) $" "libxslt" "" .\" Manual: xsltproc Manual
.\" Source: libxslt
.\"
.TH "XSLTPROC" "1" "$Date: 2007\-08\-23 14:20:49 +0200 (Thu, 23 Aug 2007) $" "libxslt" "xsltproc Manual"
.\" disable hyphenation .\" disable hyphenation
.nh .nh
.\" disable justification (adjust text to left margin only) .\" disable justification (adjust text to left margin only)
.ad l .ad l
.SH "NAME" .SH "NAME"
xsltproc \- command line XSLT processor xsltproc - command line XSLT processor
.SH "SYNOPSIS" .SH "SYNOPSIS"
.HP 9 .HP 9
\fBxsltproc\fR [[\fB\-V\fR \fB\-\-version\fR] [\fB\-v\fR \fB\-\-verbose\fR] [{\fB\-o\fR \fB\-\-output\fR} {\fIFILE\fR \fIDIRECTORY\fR}] \fB\-\-timing\fR \fB\-\-repeat\fR \fB\-\-debug\fR \fB\-\-novalid\fR \fB\-\-noout\fR \fB\-\-maxdepth\ \fR\fB\fIVALUE\fR\fR \fB\-\-html\fR \fB\-\-param\ \fR\fB\fIENCODING\fR\fR\fB\ \fR \fB\-\-param\ \fR\fB\fIPARAMNAME\fR\fR\fB\ \fR\fB\fIPARAMVALUE\fR\fR\fB\ \fR \fB\-\-stringparam\ \fR\fB\fIPARAMNAME\fR\fR\fB\ \fR\fB\fIPARAMVALUE\fR\fR\fB\ \fR \fB\-\-nonet\fR \fB\-\-path\ "\fR\fB\fIPATH(S)\fR\fR\fB"\fR \fB\-\-load\-trace\fR \fB\-\-catalogs\fR \fB\-\-xinclude\fR [\fB\-\-profile\fR\ \fB\-\-norman\fR] \fB\-\-dumpextensions\fR \fB\-\-nowrite\fR \fB\-\-nomkdir\fR \fB\-\-writesubtree\ \fR\fB\fIPATH\fR\fR \fB\-\-nodtdattr\fR] [\fISTYLESHEET\fR] {\fIXML\-FILE\fR \-} \fBxsltproc\fR [[\fB\-V\fR | \fB\-\-version\fR] [\fB\-v\fR | \fB\-\-verbose\fR] [{\fB\-o\fR | \fB\-\-output\fR} {\fIFILE\fR | \fIDIRECTORY\fR}] | \fB\-\-timing\fR | \fB\-\-repeat\fR | \fB\-\-debug\fR | \fB\-\-novalid\fR | \fB\-\-noout\fR | \fB\-\-maxdepth\ \fR\fB\fIVALUE\fR\fR | \fB\-\-html\fR | \fB\-\-param\ \fR\fB\fIENCODING\fR\fR\fB\ \fR | \fB\-\-param\ \fR\fB\fIPARAMNAME\fR\fR\fB\ \fR\fB\fIPARAMVALUE\fR\fR\fB\ \fR | \fB\-\-stringparam\ \fR\fB\fIPARAMNAME\fR\fR\fB\ \fR\fB\fIPARAMVALUE\fR\fR\fB\ \fR | \fB\-\-nonet\fR | \fB\-\-path\ "\fR\fB\fIPATH(S)\fR\fR\fB"\fR | \fB\-\-load\-trace\fR | \fB\-\-catalogs\fR | \fB\-\-xinclude\fR | [\fB\-\-profile\fR\ |\ \fB\-\-norman\fR] | \fB\-\-dumpextensions\fR | \fB\-\-nowrite\fR | \fB\-\-nomkdir\fR | \fB\-\-writesubtree\ \fR\fB\fIPATH\fR\fR | \fB\-\-nodtdattr\fR] [\fISTYLESHEET\fR] {\fIXML\-FILE\fR | \-}
.SH "DESCRIPTION" .SH "DESCRIPTION"
.PP .PP
\fBxsltproc\fR \fBxsltproc\fR
is a command line tool for applying is a command line tool for applying
XSLT XSLT
stylesheets to stylesheets to
XML XML
documents. It is part of documents\. It is part of
\fBlibxslt\fR(3), the XSLT C library for GNOME. While it was developed as part of the GNOME project, it can operate independently of the GNOME desktop. \fBlibxslt\fR(3), the XSLT C library for GNOME\. While it was developed as part of the GNOME project, it can operate independently of the GNOME desktop\.
.PP .PP
\fBxsltproc\fR \fBxsltproc\fR
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 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
\fB\-\fR \fB\-\fR
. \.
.PP .PP
If a stylesheet is included in an If a stylesheet is included in an
XML XML
document with a Stylesheet Processing Instruction, no stylesheet need to be named at the command line. document with a Stylesheet Processing Instruction, no stylesheet need to be named at the command line\.
\fBxsltproc\fR \fBxsltproc\fR
will automatically detect the included stylesheet and use it. will automatically detect the included stylesheet and use it\.
.PP .PP
By default, output is to By default, output is to
\fIstdout\fR. You can specify a file for output using the \fIstdout\fR\. You can specify a file for output using the
\fB\-o\fR \fB\-o\fR
or or
\fB\-\-output\fR \fB\-\-output\fR
option. option\.
.SH "OPTIONS" .SH "OPTIONS"
.PP .PP
\fBxsltproc\fR \fBxsltproc\fR
accepts the following options (in alphabetical order): accepts the following options (in alphabetical order):
.TP .PP
\fB\-\-catalogs\fR \fB\-\-catalogs\fR
.RS 4
Use the Use the
SGML SGML
catalog specified in catalog specified in
\fBSGML_CATALOG_FILES\fR \fBSGML_CATALOG_FILES\fR
to resolve the location of external entities. By default, to resolve the location of external entities\. By default,
\fBxsltproc\fR \fBxsltproc\fR
looks for the catalog specified in looks for the catalog specified in
\fBXML_CATALOG_FILES\fR. If that is not specified, it uses \fBXML_CATALOG_FILES\fR\. If that is not specified, it uses
\fI/etc/xml/catalog\fR. \fI/etc/xml/catalog\fR\.
.TP .RE
.PP
\fB\-\-debug\fR \fB\-\-debug\fR
.RS 4
Output an Output an
XML XML
tree of the transformed document for debugging purposes. tree of the transformed document for debugging purposes\.
.TP .RE
.PP
\fB\-\-dumpextensions\fR \fB\-\-dumpextensions\fR
.RS 4
Dumps the list of all registered extensions on Dumps the list of all registered extensions on
\fIstdout\fR. \fIstdout\fR\.
.TP .RE
.PP
\fB\-\-html\fR \fB\-\-html\fR
.RS 4
The input document is an The input document is an
HTML HTML
file. file\.
.TP .RE
.PP
\fB\-\-load\-trace\fR \fB\-\-load\-trace\fR
.RS 4
Display all the documents loaded during the processing to Display all the documents loaded during the processing to
\fIstderr\fR. \fIstderr\fR\.
.TP .RE
.PP
\fB\-\-maxdepth \fR\fB\fIVALUE\fR\fR \fB\-\-maxdepth \fR\fB\fIVALUE\fR\fR
.RS 4
Adjust the maximum depth of the template stack before Adjust the maximum depth of the template stack before
\fBlibxslt\fR(3) \fBlibxslt\fR(3)
concludes it is in an infinite loop. The default is 500. concludes it is in an infinite loop\. The default is 3000\.
.TP .RE
.PP
\fB\-\-nodtdattr\fR \fB\-\-nodtdattr\fR
Do not apply default attributes from the document's .RS 4
DTD. Do not apply default attributes from the document\'s
.TP DTD\.
.RE
.PP
\fB\-\-nomkdir\fR \fB\-\-nomkdir\fR
Refuses to create directories. .RS 4
.TP Refuses to create directories\.
.RE
.PP
\fB\-\-nonet\fR \fB\-\-nonet\fR
.RS 4
Do not use the Internet to fetch Do not use the Internet to fetch
DTDs, entities or documents. DTDs, entities or documents\.
.TP .RE
.PP
\fB\-\-noout\fR \fB\-\-noout\fR
Do not output the result. .RS 4
.TP Do not output the result\.
.RE
.PP
\fB\-\-novalid\fR \fB\-\-novalid\fR
Skip loading the document's .RS 4
DTD. Skip loading the document\'s
.TP DTD\.
.RE
.PP
\fB\-\-nowrite\fR \fB\-\-nowrite\fR
Refuses to write to any file or resource. .RS 4
.TP Refuses to write to any file or resource\.
.RE
.PP
\fB\-o\fR or \fB\-\-output\fR \fIFILE\fR | \fIDIRECTORY\fR \fB\-o\fR or \fB\-\-output\fR \fIFILE\fR | \fIDIRECTORY\fR
.RS 4
Direct output to the given Direct output to the given
\fIFILE\fR. Using the option with a \fIFILE\fR\. Using the option with a
\fIDIRECTORY\fR \fIDIRECTORY\fR
directs the output files to the specified directory. This can be useful for multiple outputs (also known as "chunking") or manpage processing. directs the output files to the specified directory\. This can be useful for multiple outputs (also known as "chunking") or manpage processing\.
.sp .sp
.it 1 an-trap .it 1 an-trap
.nr an-no-space-flag 1 .nr an-no-space-flag 1
.nr an-break-flag 1 .nr an-break-flag 1
.br .br
\fBImportant\fR Important
The given directory The given directory
\fBmust\fR \fBmust\fR
already exist. already exist\.
.sp .sp
.it 1 an-trap .it 1 an-trap
.nr an-no-space-flag 1 .nr an-no-space-flag 1
.nr an-break-flag 1 .nr an-break-flag 1
.br .br
\fBNote\fR Note
Make sure that Make sure that
\fIFILE\fR \fIFILE\fR
and and
\fIDIRECTORY\fR \fIDIRECTORY\fR
follow the follow the
\(lqURI reference computation\(rq \(lqURI reference computation\(rq
as described in RFC 2396 and laters. This means, that e.g. as described in RFC 2396 and laters\. This means, that e\.g\.
\fB\-o directory\fR \fB\-o directory\fR
will maybe not work, but will maybe not work, but
\fB\-o directory/\fR \fB\-o directory/\fR
will. will\.
.TP .RE
.PP
\fB\-\-encoding \fR\fB\fIENCODING\fR\fR \fB\-\-encoding \fR\fB\fIENCODING\fR\fR
Allow to specify the encoding for the input. .RS 4
.TP Allow to specify the encoding for the input\.
.RE
.PP
\fB\-\-param \fR\fB\fIPARAMNAME\fR\fR\fB \fR\fB\fIPARAMVALUE\fR\fR \fB\-\-param \fR\fB\fIPARAMNAME\fR\fR\fB \fR\fB\fIPARAMVALUE\fR\fR
.RS 4
Pass a parameter of name Pass a parameter of name
\fIPARAMNAME\fR \fIPARAMNAME\fR
and value and value
\fIPARAMVALUE\fR \fIPARAMVALUE\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 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 \fB\-\-stringparam\fR
instead. instead\.
.TP .RE
.PP
\fB\-\-path "\fR\fB\fIPATH(S)\fR\fR\fB"\fR \fB\-\-path "\fR\fB\fIPATH(S)\fR\fR\fB"\fR
.RS 4
Use the (space\- or colon\-separated) list of filesystem paths specified by Use the (space\- or colon\-separated) list of filesystem paths specified by
\fIPATHS\fR \fIPATHS\fR
to load to load
DTDs, entities or documents. Enclose space\-separated lists by quotation marks. DTDs, entities or documents\. Enclose space\-separated lists by quotation marks\.
.TP .RE
.PP
\fB\-\-profile\fR or \fB\-\-norman\fR \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. .RS 4
.TP Output profiling information detailing the amount of time spent in each part of the stylesheet\. This is useful in optimizing stylesheet performance\.
.RE
.PP
\fB\-\-repeat\fR \fB\-\-repeat\fR
Run the transformation 20 times. Used for timing tests. .RS 4
.TP Run the transformation 20 times\. Used for timing tests\.
.RE
.PP
\fB\-\-stringparam \fR\fB\fIPARAMNAME\fR\fR\fB \fR\fB\fIPARAMVALUE\fR\fR \fB\-\-stringparam \fR\fB\fIPARAMNAME\fR\fR\fB \fR\fB\fIPARAMVALUE\fR\fR
.RS 4
Pass a parameter of name Pass a parameter of name
\fIPARAMNAME\fR \fIPARAMNAME\fR
and value and value
\fIPARAMVALUE\fR \fIPARAMVALUE\fR
where where
\fIPARAMVALUE\fR \fIPARAMVALUE\fR
is a string rather than a node identifier. is a string rather than a node identifier\.
\fBNote:\fR \fBNote:\fR
The string must be UTF\-8 encoded. The string must be UTF\-8 encoded\.
.TP .RE
.PP
\fB\-\-timing\fR \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. .RS 4
.TP Display the time used for parsing the stylesheet, parsing the document and applying the stylesheet and saving the result\. Displayed in milliseconds\.
.RE
.PP
\fB\-v\fR or \fB\-\-verbose\fR \fB\-v\fR or \fB\-\-verbose\fR
.RS 4
Output each step taken by Output each step taken by
\fBxsltproc\fR \fBxsltproc\fR
in processing the stylesheet and the document. in processing the stylesheet and the document\.
.TP .RE
.PP
\fB\-V\fR or \fB\-\-version\fR \fB\-V\fR or \fB\-\-version\fR
.RS 4
Show the version of Show the version of
\fBlibxml\fR(3) \fBlibxml\fR(3)
and and
\fBlibxslt\fR(3) \fBlibxslt\fR(3)
used. used\.
.TP .RE
.PP
\fB\-\-writesubtree \fR\fB\fIPATH\fR\fR \fB\-\-writesubtree \fR\fB\fIPATH\fR\fR
.RS 4
Allow file write only within the Allow file write only within the
\fIPATH\fR \fIPATH\fR
subtree. subtree\.
.TP .RE
.PP
\fB\-\-xinclude\fR \fB\-\-xinclude\fR
Process the input document using the XInclude specification. More details on this can be found in the XInclude specification: .RS 4
Process the input document using the XInclude specification\. More details on this can be found in the XInclude specification:
\fI\%http://www.w3.org/TR/xinclude/\fR \fI\%http://www.w3.org/TR/xinclude/\fR
.RE
.SH "ENVIRONMENT" .SH "ENVIRONMENT"
.TP .PP
\fBSGML_CATALOG_FILES\fR \fBSGML_CATALOG_FILES\fR
.RS 4
SGML SGML
catalog behavior can be changed by redirecting queries to the user's own set of catalogs. This can be done by setting the catalog behavior can be changed by redirecting queries to the user\'s own set of catalogs\. This can be done by setting the
\fBSGML_CATALOG_FILES\fR \fBSGML_CATALOG_FILES\fR
environment variable to a list of catalogs. An empty one should deactivate loading the default environment variable to a list of catalogs\. An empty one should deactivate loading the default
\fI/etc/sgml/catalog\fR \fI/etc/sgml/catalog\fR
catalog. catalog\.
.TP .RE
.PP
\fBXML_CATALOG_FILES\fR \fBXML_CATALOG_FILES\fR
.RS 4
XML XML
catalog behavior can be changed by redirecting queries to the user's own set of catalogs. This can be done by setting the catalog behavior can be changed by redirecting queries to the user\'s own set of catalogs\. This can be done by setting the
\fBXML_CATALOG_FILES\fR \fBXML_CATALOG_FILES\fR
environment variable to a list of catalogs. An empty one should deactivate loading the default environment variable to a list of catalogs\. An empty one should deactivate loading the default
\fI/etc/xml/catalog\fR \fI/etc/xml/catalog\fR
catalog. catalog\.
.RE
.SH "DIAGNOSTICS" .SH "DIAGNOSTICS"
.PP .PP
\fBxsltproc\fR \fBxsltproc\fR
return codes provide information that can be used when calling it from scripts. return codes provide information that can be used when calling it from scripts\.
.TP .PP
\fB0\fR \fB0\fR
.RS 4
No error (normal operation) No error (normal operation)
.TP .RE
.PP
\fB1\fR \fB1\fR
.RS 4
No argument No argument
.TP .RE
.PP
\fB2\fR \fB2\fR
.RS 4
Too many parameters Too many parameters
.TP .RE
.PP
\fB3\fR \fB3\fR
.RS 4
Unknown option Unknown option
.TP .RE
.PP
\fB4\fR \fB4\fR
.RS 4
Failed to parse the stylesheet Failed to parse the stylesheet
.TP .RE
.PP
\fB5\fR \fB5\fR
.RS 4
Error in the stylesheet Error in the stylesheet
.TP .RE
.PP
\fB6\fR \fB6\fR
.RS 4
Error in one of the documents Error in one of the documents
.TP .RE
.PP
\fB7\fR \fB7\fR
.RS 4
Unsupported xsl:output method Unsupported xsl:output method
.TP .RE
.PP
\fB8\fR \fB8\fR
.RS 4
String parameter contains both quote and double\-quotes String parameter contains both quote and double\-quotes
.TP .RE
.PP
\fB9\fR \fB9\fR
.RS 4
Internal processing error Internal processing error
.TP .RE
.PP
\fB10\fR \fB10\fR
.RS 4
Processing was stopped by a terminating message Processing was stopped by a terminating message
.TP .RE
.PP
\fB11\fR \fB11\fR
.RS 4
Could not write the result to the output file Could not write the result to the output file
.RE
.SH "SEE ALSO" .SH "SEE ALSO"
.PP .PP
\fBlibxml\fR(3), \fBlibxml\fR(3),
\fBlibxslt\fR(3) \fBlibxslt\fR(3)
.PP .PP
More information can be found at More information can be found at
.TP 3 .sp
\(bu .RS 4
\fBlibxml\fR(3) \h'-04'\(bu\h'+03'\fBlibxml\fR(3)
web page web page
\fI\%http://www.xmlsoft.org/\fR \fI\%http://www.xmlsoft.org/\fR
.TP .RE
\(bu .sp
W3C .RS 4
\h'-04'\(bu\h'+03'W3C
XSLT XSLT
page page
\fI\%http://www.w3.org/TR/xslt\fR \fI\%http://www.w3.org/TR/xslt\fR
.RE
.sp
.RE
.SH "AUTHOR" .SH "AUTHOR"
John Fleck <jfleck@inkstain.net>. .PP
\fBJohn Fleck\fR <\&jfleck@inkstain\.net\&>
.sp -1n
.IP "" 4
Author.
.SH "COPYRIGHT"
Copyright \(co 2001, 2002
.br

View File

@ -203,7 +203,7 @@
before <citerefentry> before <citerefentry>
<refentrytitle>libxslt</refentrytitle> <refentrytitle>libxslt</refentrytitle>
<manvolnum>3</manvolnum> <manvolnum>3</manvolnum>
</citerefentry> concludes it is in an infinite loop. The default is 500. </citerefentry> concludes it is in an infinite loop. The default is 3000.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>