doc/xsltproc.xml, doc/xsltproc.html/, doc/xsltproc.1 updating docs to add
authorMDT 2002 John Fleck <jfleck@inkstain.net>
Sun, 30 Jun 2002 03:10:23 +0000 (03:10 +0000)
committerJohn Fleck <jfleck@src.gnome.org>
Sun, 30 Jun 2002 03:10:23 +0000 (03:10 +0000)
Sat Jun 29 21:12:14 MDT 2002 John Fleck <jfleck@inkstain.net>

* doc/xsltproc.xml, doc/xsltproc.html/, doc/xsltproc.1
updating docs to add reference to UTF-8 requirement for
stringparam command line option

ChangeLog
doc/xsltproc.1
doc/xsltproc.html
doc/xsltproc.xml

index 2e2fbdf..70ead5a 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+Sat Jun 29 21:12:14 MDT 2002 John Fleck <jfleck@inkstain.net>
+
+       * doc/xsltproc.xml, doc/xsltproc.html/, doc/xsltproc.1
+       updating docs to add reference to UTF-8 requirement for
+       stringparam command line option
+
 Wed Jun 19 13:43:00 CEST 2002 Daniel Veillard <daniel@veillard.com>
 
        * libxslt/documents.c libxslt/functions.c libxslt/xsltInternals.h:
index f8db1f6..904d63e 100644 (file)
@@ -1,4 +1,4 @@
-."Generated by db2man.xsl. Don't modify this, modify the source.
+.\"Generated by db2man.xsl. Don't modify this, modify the source.
 .de Sh \" Subsection
 .br
 .if t .Sp
 .el .ne 3
 .IP "\\$1" \\$2
 ..
-.TH "xsltproc" 1 "" "" "xsltproc Manual"
+.TH "XSLTPROC" 1 "" "" "xsltproc Manual"
 .SH NAME
 xsltproc \- command line xslt processor
 .SH "SYNOPSIS"
-\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--stringparam  \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 ]
+
+.nf
+\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--stringparam \fIname\fR \fIvalue\fR\fR | \fB--nonet\fR | \fB--warnnet\fR
+         | \fB--catalogs\fR | \fB--xinclude\fR | \fB--profile\fR | \fB--dumpextensions\fR]
+         [\fBstylesheet\fR] [\fIfile1\fR] [\fIfile2\fR] [\fI....\fR]
+.fi
+
 .SH "INTRODUCTION"
 
 .PP
-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.
+ 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.
 
 .PP
-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.
+ 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.
 
 .PP
 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.
@@ -40,111 +49,80 @@ By default, output is to stdout. You can specify a file for output using the \fB
 
 .TP
 \fB-V\fR or \fB--version\fR
-
 Show the version of libxml and libxslt used.
 
 .TP
-
-      \fB-v\fR or \fB--verbose\fR
-
+\fB-v\fR or \fB--verbose\fR
 Output each step taken by xsltproc in processing the stylesheet and the document.
 
 .TP
-
-      \fB-o\fR or \fB--output\fR \fIfile\fR
-
+\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.
 
 .TP
-
-      \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.
 
 .TP
-
-      \fB--repeat\fR
-
+\fB--repeat\fR
 Run the transformation 20 times. Used for timing tests.
 
 .TP
-
-      \fB--debug\fR
-
+\fB--debug\fR
 Output an XML tree of the transformed document for debugging purposes.
 
 .TP
-
-      \fB--novalid\fR
-
+\fB--novalid\fR
 Skip loading the document's DTD.
 
 .TP
-
-      \fB--noout\fR
-
+\fB--noout\fR
 Do not output the result.
 
 .TP
-
-      \fB--maxdepth\fR \fIvalue\fR
-
+\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.
 
 .TP
-
-      \fB--html\fR
-
+\fB--html\fR
 The input document is an HTML file.
 
 .TP
-
-      \fB--docbook\fR
-
+\fB--docbook\fR
 The input document is DocBook SGML.
 
 .TP
-
-      \fB--param\fR \fIname\fR \fIvalue\fR
-
+\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 32. If the value being passed is a string rather than a node identifier, use \fB--stringparam\fR instead.
 
 .TP
-
-         \fB--stringparam\fR \fIname\fR \fIvalue\fR
-
-Pass a paramenter of name \fIname\fR and value \fIvalue\fR where \fIvalue\fR is a string rather than a node identifier.
+\fB--stringparam\fR \fIname\fR \fIvalue\fR
+Pass 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.)
 
 .TP
-
-      \fB--nonet\fR
-
+\fB--nonet\fR
 Do not use the Internet to fetch DTD's or entities.
 
 .TP
-
-      \fB--warnnet\fR
-
+\fB--warnnet\fR
 Output notification when DTD's or entities are fetched over the Internet.
 
 .TP
-
-      \fB--catalogs\fR
-
+\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.
 
 .TP
-
-      \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
+\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/http://www.w3.org/TR/xinclude/
 
 .TP
-
-      \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.
 
+.TP
+\fB--dumpextensions\fR
+Dumps the list of all registered extensions on stdout.
+
 .SH "RETURN VALUES"
 
 .PP
@@ -177,15 +155,19 @@ xsltproc's return codes provide information that can be used when calling it fro
 .PP
 8: string parameter contains both quote and double-quotes
 
+.PP
+9: internal processing error
+
+.PP
+10: processing was stopped by a terminating message
+
 .SH "MORE INFORMATION"
 
 .PP
-libxml web page: http://www.xmlsoft.org/: \fIhttp://www.xmlsoft.org/\fR
+libxml web page:: http://www.xmlsoft.org/http://www.xmlsoft.org/
 
 .PP
-W3C XSLT page: http://www.w3.org/TR/xslt: \fIhttp://www.w3.org/TR/xslt\fR
+W3C XSLT page:: http://www.w3.org/TR/xslthttp://www.w3.org/TR/xslt
 
 .SH AUTHOR
-Copyright 2001
-.Sp
-John Fleck  <jfleck@inkstain.net>This is release 0.2 of the xsltproc Manual.
\ No newline at end of file
+.
index 3840d5c..c17d9f8 100644 (file)
@@ -1,4 +1,4 @@
-<html><head><meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type"><title>xsltproc</title><meta name="generator" content="DocBook XSL Stylesheets V1.45"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry"><h1 class="title">xsltproc</h1><div class="refnamediv"><h2>Name</h2><p>xsltproc &#8212; command line xslt processor</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><tt>xsltproc</tt>  [-V | -v | -o <i><tt>file</tt></i> | --timing | --repeat | --debug | --novalid | --noout | --maxdepth <i><tt>val</tt></i> | --html | --docbook | --param <i><tt>name</tt></i> <i><tt>value</tt></i> | --stringparam <i><tt>name</tt></i> <i><tt>value</tt></i> | --nonet | --warnnet | --catalogs | --xinclude | --profile] [<tt><i><tt>stylesheet</tt></i></tt>] [<i><tt>file1</tt></i>] [<i><tt>file2</tt></i>] [<i><tt>....</tt></i>]</p></div></div><div class="refsect1"><a name="introduction"></a><h2>Introduction</h2><p>
+<html><head><meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type"><title>xsltproc</title><meta name="generator" content="DocBook XSL Stylesheets V1.48"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry"><a name="id2745836"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>xsltproc &#8212; command line xslt processor</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><tt>xsltproc</tt>  [-V | -v | -o <i><tt>file</tt></i> | --timing | --repeat | --debug | --novalid | --noout | --maxdepth <i><tt>val</tt></i> | --html | --docbook | --param <i><tt>name</tt></i> <i><tt>value</tt></i> | --stringparam <i><tt>name</tt></i> <i><tt>value</tt></i> | --nonet | --warnnet | --catalogs | --xinclude | --profile | --dumpextensions] [<tt><i><tt>stylesheet</tt></i></tt>] [<i><tt>file1</tt></i>] [<i><tt>file2</tt></i>] [<i><tt>....</tt></i>]</p></div></div><div class="refsect1"><a name="introduction"></a><h2>Introduction</h2><p>
       xsltproc is a command line tool for applying
       XSLT stylesheets to XML
       documents. It is part of libxslt, the XSLT C
@@ -61,7 +61,8 @@
          </dd><dt><span class="term">
          <tt>--stringparam</tt> <i><tt>name</tt></i> <i><tt>value</tt></i></span></dt><dd>Pass a paramenter of name <i><tt>name</tt></i> and
            value <i><tt>value</tt></i> where
-           <i><tt>value</tt></i> is a string rather than a node identifier.</dd><dt><span class="term">
+           <i><tt>value</tt></i> is a string rather than a node
+           identifier. (Note: The string must be utf-8.) </dd><dt><span class="term">
       <tt>--nonet</tt></span></dt><dd>Do not use the Internet to fetch DTD's or
       entities.
     </dd><dt><span class="term">
@@ -83,5 +84,7 @@
       <tt>--profile</tt> or <tt>--norman</tt></span></dt><dd>Output profiling
       information detailing the amount of time spent in each part of the
       stylesheet. This is useful in optimizing stylesheet performance.
+    </dd><dt><span class="term">
+      <tt>--dumpextensions</tt></span></dt><dd>Dumps the list of all registered extensions on stdout.
     </dd></dl></div></div><div class="refsect1"><a name="return"></a><h2>Return values</h2><p>xsltproc's return codes provide information
-    that can be used when calling it from scripts.</p><p>0: normal</p><p>1: no argument</p><p>2: too many parameters</p><p>3: unknown option</p><p>4: failed to parse the stylesheet</p><p>5: error in the stylesheet</p><p>6: error in one of the documents</p><p>7: unsupported xsl:output method</p><p>8: string parameter contains both quote and double-quotes</p></div><div class="refsect1"><a name="moreinfo"></a><h2>More Information</h2><p>libxml web page: <a href="http://www.xmlsoft.org/" target="_top">http://www.xmlsoft.org/</a></p><p>W3C XSLT page: <a href="http://www.w3.org/TR/xslt" target="_top">http://www.w3.org/TR/xslt</a></p></div></div></body></html>
+    that can be used when calling it from scripts.</p><p>0: normal</p><p>1: no argument</p><p>2: too many parameters</p><p>3: unknown option</p><p>4: failed to parse the stylesheet</p><p>5: error in the stylesheet</p><p>6: error in one of the documents</p><p>7: unsupported xsl:output method</p><p>8: string parameter contains both quote and double-quotes</p><p>9: internal processing error</p><p>10: processing was stopped by a terminating message</p></div><div class="refsect1"><a name="moreinfo"></a><h2>More Information</h2><p>libxml web page: <a href="http://www.xmlsoft.org/" target="_top">http://www.xmlsoft.org/</a></p><p>W3C XSLT page: <a href="http://www.w3.org/TR/xslt" target="_top">http://www.w3.org/TR/xslt</a></p></div></div></body></html>
index 6807aa6..80508aa 100644 (file)
@@ -7,7 +7,7 @@
   <refentryinfo>
     <title>xsltproc Manual</title>
     <copyright>
-      <year>2001</year>
+      <year>2001, 2002</year>
     </copyright>
     <author>
       <firstname>John</firstname>
@@ -15,7 +15,7 @@
     </author>
     <address><email>jfleck@inkstain.net</email></address>
     
-    <releaseinfo>This is release 0.2 of the xsltproc Manual.</releaseinfo>
+    <releaseinfo>This is release 0.3 of the xsltproc Manual.</releaseinfo>
   </refentryinfo>
 
   <refmeta>
        <listitem>
          <simpara>Pass a paramenter of name <replaceable>name</replaceable> and
            value <replaceable>value</replaceable> where
-           <replaceable>value</replaceable> is a string rather than a node identifier.</simpara>
+           <replaceable>value</replaceable> is a string rather than a node
+           identifier. (Note: The string must be utf-8.) </simpara>
        </listitem>
       </varlistentry>