summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDaniel Veillard <veillard@src.gnome.org>2008-03-03 08:42:08 +0000
committerDaniel Veillard <veillard@src.gnome.org>2008-03-03 08:42:08 +0000
commit15964811dce33c00baea4fca289a9bba1ddb6e29 (patch)
tree50be4bec846be4f8304ae04fc591e4dbc89e9e9d /doc
parent4f91dfa7e63a4013599890980d2b8013197c522d (diff)
downloadlibxslt-15964811dce33c00baea4fca289a9bba1ddb6e29.tar.gz
libxslt-15964811dce33c00baea4fca289a9bba1ddb6e29.tar.bz2
libxslt-15964811dce33c00baea4fca289a9bba1ddb6e29.zip
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
Diffstat (limited to 'doc')
-rw-r--r--doc/xsltproc.1300
-rw-r--r--doc/xsltproc.xml2
2 files changed, 198 insertions, 104 deletions
diff --git a/doc/xsltproc.1 b/doc/xsltproc.1
index e66be310..cbb63ef8 100644
--- a/doc/xsltproc.1
+++ b/doc/xsltproc.1
@@ -1,267 +1,361 @@
-.\" ** You probably do not want to edit this file directly **
-.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
-.\" Instead of manually editing it, you probably should edit the DocBook XML
-.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "XSLTPROC" "1" "$Date: 2007\-08\-23 14:20:49 +0200 (Thu, 23 Aug 2007) $" "libxslt" ""
+.\" Title: xsltproc
+.\" Author: John Fleck <jfleck@inkstain.net>
+.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
+.\" Date: $Date: 2007-08-23 14:20:49 +0200 (Thu, 23 Aug 2007) $
+.\" 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
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-xsltproc \- command line XSLT processor
+xsltproc - command line XSLT processor
.SH "SYNOPSIS"
.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"
.PP
+
\fBxsltproc\fR
is a command line tool for applying
XSLT
stylesheets to
XML
-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.
+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\.
.PP
+
\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
-.
+\.
.PP
If a stylesheet is included in an
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
-will automatically detect the included stylesheet and use it.
+will automatically detect the included stylesheet and use it\.
.PP
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
or
\fB\-\-output\fR
-option.
+option\.
.SH "OPTIONS"
.PP
+
\fBxsltproc\fR
accepts the following options (in alphabetical order):
-.TP
+.PP
\fB\-\-catalogs\fR
+.RS 4
Use the
SGML
catalog specified in
\fBSGML_CATALOG_FILES\fR
-to resolve the location of external entities. By default,
+to resolve the location of external entities\. By default,
\fBxsltproc\fR
looks for the catalog specified in
-\fBXML_CATALOG_FILES\fR. If that is not specified, it uses
-\fI/etc/xml/catalog\fR.
-.TP
+\fBXML_CATALOG_FILES\fR\. If that is not specified, it uses
+\fI/etc/xml/catalog\fR\.
+.RE
+.PP
\fB\-\-debug\fR
+.RS 4
Output an
XML
-tree of the transformed document for debugging purposes.
-.TP
+tree of the transformed document for debugging purposes\.
+.RE
+.PP
\fB\-\-dumpextensions\fR
+.RS 4
Dumps the list of all registered extensions on
-\fIstdout\fR.
-.TP
+\fIstdout\fR\.
+.RE
+.PP
\fB\-\-html\fR
+.RS 4
The input document is an
HTML
-file.
-.TP
+file\.
+.RE
+.PP
\fB\-\-load\-trace\fR
+.RS 4
Display all the documents loaded during the processing to
-\fIstderr\fR.
-.TP
+\fIstderr\fR\.
+.RE
+.PP
\fB\-\-maxdepth \fR\fB\fIVALUE\fR\fR
+.RS 4
Adjust the maximum depth of the template stack before
\fBlibxslt\fR(3)
-concludes it is in an infinite loop. The default is 500.
-.TP
+concludes it is in an infinite loop\. The default is 3000\.
+.RE
+.PP
\fB\-\-nodtdattr\fR
-Do not apply default attributes from the document's
-DTD.
-.TP
+.RS 4
+Do not apply default attributes from the document\'s
+DTD\.
+.RE
+.PP
\fB\-\-nomkdir\fR
-Refuses to create directories.
-.TP
+.RS 4
+Refuses to create directories\.
+.RE
+.PP
\fB\-\-nonet\fR
+.RS 4
Do not use the Internet to fetch
-DTDs, entities or documents.
-.TP
+DTDs, entities or documents\.
+.RE
+.PP
\fB\-\-noout\fR
-Do not output the result.
-.TP
+.RS 4
+Do not output the result\.
+.RE
+.PP
\fB\-\-novalid\fR
-Skip loading the document's
-DTD.
-.TP
+.RS 4
+Skip loading the document\'s
+DTD\.
+.RE
+.PP
\fB\-\-nowrite\fR
-Refuses to write to any file or resource.
-.TP
+.RS 4
+Refuses to write to any file or resource\.
+.RE
+.PP
\fB\-o\fR or \fB\-\-output\fR \fIFILE\fR | \fIDIRECTORY\fR
+.RS 4
Direct output to the given
-\fIFILE\fR. Using the option with a
+\fIFILE\fR\. Using the option with a
\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
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBImportant\fR
+Important
The given directory
\fBmust\fR
-already exist.
+already exist\.
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBNote\fR
+Note
Make sure that
\fIFILE\fR
and
\fIDIRECTORY\fR
follow the
\(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
will maybe not work, but
\fB\-o directory/\fR
-will.
-.TP
+will\.
+.RE
+.PP
\fB\-\-encoding \fR\fB\fIENCODING\fR\fR
-Allow to specify the encoding for the input.
-.TP
+.RS 4
+Allow to specify the encoding for the input\.
+.RE
+.PP
\fB\-\-param \fR\fB\fIPARAMNAME\fR\fR\fB \fR\fB\fIPARAMVALUE\fR\fR
+.RS 4
Pass a parameter of name
\fIPARAMNAME\fR
and value
\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
-instead.
-.TP
+instead\.
+.RE
+.PP
\fB\-\-path "\fR\fB\fIPATH(S)\fR\fR\fB"\fR
+.RS 4
Use the (space\- or colon\-separated) list of filesystem paths specified by
\fIPATHS\fR
to load
-DTDs, entities or documents. Enclose space\-separated lists by quotation marks.
-.TP
+DTDs, entities or documents\. Enclose space\-separated lists by quotation marks\.
+.RE
+.PP
\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.
-.TP
+.RS 4
+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
-Run the transformation 20 times. Used for timing tests.
-.TP
+.RS 4
+Run the transformation 20 times\. Used for timing tests\.
+.RE
+.PP
\fB\-\-stringparam \fR\fB\fIPARAMNAME\fR\fR\fB \fR\fB\fIPARAMVALUE\fR\fR
+.RS 4
Pass a parameter of name
\fIPARAMNAME\fR
and value
\fIPARAMVALUE\fR
where
\fIPARAMVALUE\fR
-is a string rather than a node identifier.
+is a string rather than a node identifier\.
\fBNote:\fR
-The string must be UTF\-8 encoded.
-.TP
+The string must be UTF\-8 encoded\.
+.RE
+.PP
\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.
-.TP
+.RS 4
+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
+.RS 4
Output each step taken by
\fBxsltproc\fR
-in processing the stylesheet and the document.
-.TP
+in processing the stylesheet and the document\.
+.RE
+.PP
\fB\-V\fR or \fB\-\-version\fR
+.RS 4
Show the version of
\fBlibxml\fR(3)
and
\fBlibxslt\fR(3)
-used.
-.TP
+used\.
+.RE
+.PP
\fB\-\-writesubtree \fR\fB\fIPATH\fR\fR
+.RS 4
Allow file write only within the
\fIPATH\fR
-subtree.
-.TP
+subtree\.
+.RE
+.PP
\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
+.RE
.SH "ENVIRONMENT"
-.TP
+.PP
\fBSGML_CATALOG_FILES\fR
+.RS 4
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
-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
-catalog.
-.TP
+catalog\.
+.RE
+.PP
\fBXML_CATALOG_FILES\fR
+.RS 4
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
-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
-catalog.
+catalog\.
+.RE
.SH "DIAGNOSTICS"
.PP
+
\fBxsltproc\fR
-return codes provide information that can be used when calling it from scripts.
-.TP
+return codes provide information that can be used when calling it from scripts\.
+.PP
\fB0\fR
+.RS 4
No error (normal operation)
-.TP
+.RE
+.PP
\fB1\fR
+.RS 4
No argument
-.TP
+.RE
+.PP
\fB2\fR
+.RS 4
Too many parameters
-.TP
+.RE
+.PP
\fB3\fR
+.RS 4
Unknown option
-.TP
+.RE
+.PP
\fB4\fR
+.RS 4
Failed to parse the stylesheet
-.TP
+.RE
+.PP
\fB5\fR
+.RS 4
Error in the stylesheet
-.TP
+.RE
+.PP
\fB6\fR
+.RS 4
Error in one of the documents
-.TP
+.RE
+.PP
\fB7\fR
+.RS 4
Unsupported xsl:output method
-.TP
+.RE
+.PP
\fB8\fR
+.RS 4
String parameter contains both quote and double\-quotes
-.TP
+.RE
+.PP
\fB9\fR
+.RS 4
Internal processing error
-.TP
+.RE
+.PP
\fB10\fR
+.RS 4
Processing was stopped by a terminating message
-.TP
+.RE
+.PP
\fB11\fR
+.RS 4
Could not write the result to the output file
+.RE
.SH "SEE ALSO"
.PP
\fBlibxml\fR(3),
\fBlibxslt\fR(3)
.PP
More information can be found at
-.TP 3
-\(bu
-\fBlibxml\fR(3)
+.sp
+.RS 4
+\h'-04'\(bu\h'+03'\fBlibxml\fR(3)
web page
\fI\%http://www.xmlsoft.org/\fR
-.TP
-\(bu
-W3C
+.RE
+.sp
+.RS 4
+\h'-04'\(bu\h'+03'W3C
XSLT
page
\fI\%http://www.w3.org/TR/xslt\fR
+.RE
+.sp
+.RE
.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
diff --git a/doc/xsltproc.xml b/doc/xsltproc.xml
index b641c608..5069483a 100644
--- a/doc/xsltproc.xml
+++ b/doc/xsltproc.xml
@@ -203,7 +203,7 @@
before <citerefentry>
<refentrytitle>libxslt</refentrytitle>
<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>
</listitem>
</varlistentry>