doc/xsltproc.xml, doc/xsltproc.1, doc/xsltproc.html update xsltproc man
authorMST 2002 John Fleck <jfleck@inkstain.net>
Wed, 9 Jan 2002 04:06:27 +0000 (04:06 +0000)
committerJohn Fleck <jfleck@src.gnome.org>
Wed, 9 Jan 2002 04:06:27 +0000 (04:06 +0000)
Tue Jan  8 21:04:17 MST 2002 John Fleck <jfleck@inkstain.net>

* doc/xsltproc.xml, doc/xsltproc.1, doc/xsltproc.html
update xsltproc man page to add --stringparam option

config.h.in
doc/xsltproc.1
doc/xsltproc.html
doc/xsltproc.xml

index ce889f7..5c3dfd7 100644 (file)
@@ -1,8 +1,4 @@
 /* config.h.in.  Generated automatically from configure.in by autoheader.  */
-
-/* Define if you have the ANSI C header files.  */
-#undef STDC_HEADERS
-
 #undef HAVE_ISINF
 #undef HAVE_ISNAN
 #undef HAVE_POW
 #undef HAVE_FABS
 #undef WITH_DEBUGGER
 
-/* Define if you have the _stat function.  */
-#undef HAVE__STAT
+/* Define if you have the <ansidecl.h> header file. */
+#undef HAVE_ANSIDECL_H
 
-/* Define if you have the asctime function.  */
+/* Define if you have the `asctime' function. */
 #undef HAVE_ASCTIME
 
-/* Define if you have the gettimeofday function.  */
-#undef HAVE_GETTIMEOFDAY
-
-/* Define if you have the gmtime function.  */
-#undef HAVE_GMTIME
-
-/* Define if you have the localtime function.  */
-#undef HAVE_LOCALTIME
-
-/* Define if you have the mktime function.  */
-#undef HAVE_MKTIME
-
-/* Define if you have the stat function.  */
-#undef HAVE_STAT
-
-/* Define if you have the time function.  */
-#undef HAVE_TIME
-
-/* Define if you have the <ansidecl.h> header file.  */
-#undef HAVE_ANSIDECL_H
-
-/* Define if you have the <dlfcn.h> header file.  */
+/* Define if you have the <dlfcn.h> header file. */
 #undef HAVE_DLFCN_H
 
-/* Define if you have the <float.h> header file.  */
+/* Define if you have the <float.h> header file. */
 #undef HAVE_FLOAT_H
 
-/* Define if you have the <fp_class.h> header file.  */
+/* Define if you have the <fp_class.h> header file. */
 #undef HAVE_FP_CLASS_H
 
-/* Define if you have the <ieeefp.h> header file.  */
+/* Define if you have the `gettimeofday' function. */
+#undef HAVE_GETTIMEOFDAY
+
+/* Define if you have the `gmtime' function. */
+#undef HAVE_GMTIME
+
+/* Define if you have the <ieeefp.h> header file. */
 #undef HAVE_IEEEFP_H
 
-/* Define if you have the <math.h> header file.  */
+/* Define if you have the `localtime' function. */
+#undef HAVE_LOCALTIME
+
+/* Define if you have the <math.h> header file. */
 #undef HAVE_MATH_H
 
-/* Define if you have the <nan.h> header file.  */
+/* Define if you have the `mktime' function. */
+#undef HAVE_MKTIME
+
+/* Define if you have the <nan.h> header file. */
 #undef HAVE_NAN_H
 
-/* Define if you have the <stdarg.h> header file.  */
+/* Define if you have the `stat' function. */
+#undef HAVE_STAT
+
+/* Define if you have the <stdarg.h> header file. */
 #undef HAVE_STDARG_H
 
-/* Define if you have the <stdlib.h> header file.  */
+/* Define if you have the <stdlib.h> header file. */
 #undef HAVE_STDLIB_H
 
-/* Define if you have the <string.h> header file.  */
+/* Define if you have the <string.h> header file. */
 #undef HAVE_STRING_H
 
-/* Define if you have the <sys/stat.h> header file.  */
+/* Define if you have the <sys/stat.h> header file. */
 #undef HAVE_SYS_STAT_H
 
-/* Define if you have the <sys/time.h> header file.  */
+/* Define if you have the <sys/time.h> header file. */
 #undef HAVE_SYS_TIME_H
 
-/* Define if you have the <sys/types.h> header file.  */
+/* Define if you have the <sys/types.h> header file. */
 #undef HAVE_SYS_TYPES_H
 
-/* Define if you have the <time.h> header file.  */
+/* Define if you have the `time' function. */
+#undef HAVE_TIME
+
+/* Define if you have the <time.h> header file. */
 #undef HAVE_TIME_H
 
-/* Define if you have the <unistd.h> header file.  */
+/* Define if you have the <unistd.h> header file. */
 #undef HAVE_UNISTD_H
 
+/* Define if you have the `_stat' function. */
+#undef HAVE__STAT
+
 /* Name of package */
 #undef PACKAGE
 
+/* Define if you have the ANSI C header files. */
+#undef STDC_HEADERS
+
 /* Version number of package */
 #undef VERSION
-
index 10339ee..f8db1f6 100644 (file)
@@ -21,7 +21,7 @@
 .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--nonet\fR | \fB--warnnet\fR | \fB--catalogs\fR | \fB--xinclude\fR | \fB--profile\fR] [\fB\fIstylesheet\fR\fR] [ \fIfile1\fR ] [ \fIfile2\fR ] [ \fI....\fR ]
+\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 ]
 .SH "INTRODUCTION"
 
 .PP
@@ -51,7 +51,7 @@ 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.
 
@@ -105,9 +105,15 @@ 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 it must be escaped in quotes, as follows: xsltproc --param rootid '"introduction"' \fIstylesheet\fR \fIfile\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.
 
 .TP
 
@@ -166,7 +172,10 @@ xsltproc's return codes provide information that can be used when calling it fro
 6: error in one of the documents
 
 .PP
-7: unsuppoted xsl:output method
+7: unsupported xsl:output method
+
+.PP
+8: string parameter contains both quote and double-quotes
 
 .SH "MORE INFORMATION"
 
index 33d4e04..3840d5c 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.41"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry"><h1 class="title"><a name="id2589399"></a>xsltproc</h1><div class="refnamediv"><a name="id2709332"></a><h2>Name</h2>xsltproc &#8212; command line xslt processor</div><div class="refsynopsisdiv"><a name="id2709344"></a><h2>Synopsis</h2><div class="cmdsynopsis" id="id2589405"><a name="id2589405"></a><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> | --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>]</div></div><div class="refsect1"><a name="introduction"></a><h2><a name="introduction"></a>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.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>
       xsltproc is a command line tool for applying
       XSLT stylesheets to XML
       documents. It is part of libxslt, the XSLT C
     </p><p>
       By default, output is to stdout. You can specify a file for output using
       the <tt>-o</tt> option.
-    </p></div><div class="refsect1"><a name="options"></a><h2><a name="options"></a>Options</h2><p>
-      <tt>-V</tt> or <tt>--version</tt> - Show the version of
+    </p></div><div class="refsect1"><a name="options"></a><h2>Command Line Options</h2><div class="variablelist"><dl><dt><span class="term"><tt>-V</tt> or <tt>--version</tt></span></dt><dd>Show the version of
       libxml and libxslt used.
-    </p><p>
-      <tt>-v</tt> or <tt>--verbose</tt> - Output each step taken
+    </dd><dt><span class="term">
+      <tt>-v</tt> or <tt>--verbose</tt></span></dt><dd>Output each step taken
       by xsltproc in processing the stylesheet and the document.
-    </p><p>
-      <tt>-o</tt> or <tt>--output</tt>
-      <i><tt>file</tt></i> - Direct output to the file named
+    </dd><dt><span class="term">
+      <tt>-o</tt> or <tt>--output</tt> <i><tt>file</tt></i></span></dt><dd>Direct output to the file named
       <i><tt>file</tt></i>. For multiple outputs, also known as
       &quot;chunking&quot;, <tt>-o</tt> <tt>directory/</tt> directs the
       output files to a specified directory. The directory must already exist.
-    </p><p>
-      <tt>--timing</tt> - Display the time used for parsing the
+    </dd><dt><span class="term">
+      <tt>--timing</tt></span></dt><dd>Display the time used for parsing the
       stylesheet, parsing the document and applying the stylesheet and saving
       the result. Displayed in milliseconds.
-    </p><p>
-      <tt>--repeat</tt> - Run the transformation 20 times. Used for
+    </dd><dt><span class="term">
+      <tt>--repeat</tt></span></dt><dd>Run the transformation 20 times. Used for
       timing tests.
-    </p><p>
-      <tt>--debug</tt> - Output an XML tree of the
+    </dd><dt><span class="term">
+      <tt>--debug</tt></span></dt><dd>Output an XML tree of the
       transformed document for debugging purposes.
-    </p><p>
-      <tt>--novalid</tt> - Skip loading the document's DTD.
-    </p><p>
-      <tt>--noout</tt> - Do not output the result.
-    </p><p>
-      <tt>--maxdepth</tt> <i><tt>value</tt></i> - Adjust the
+    </dd><dt><span class="term">
+      <tt>--novalid</tt></span></dt><dd>Skip loading the document's DTD.
+    </dd><dt><span class="term">
+      <tt>--noout</tt></span></dt><dd>Do not output the result.
+    </dd><dt><span class="term">
+      <tt>--maxdepth</tt> <i><tt>value</tt></i></span></dt><dd>Adjust the
       maximum depth of the template stack before
       libxslt concludes it is in an infinite
       loop. The default is 500.
-    </p><p>
-      <tt>--html</tt> - The input document is an HTML
+    </dd><dt><span class="term">
+      <tt>--html</tt></span></dt><dd>The input document is an HTML
       file.
-    </p><p>
-      <tt>--docbook</tt> - The input document is DocBook
+    </dd><dt><span class="term">
+      <tt>--docbook</tt></span></dt><dd>The input document is DocBook
       SGML.
-    </p><p>
-      <tt>--param</tt> <i><tt>name</tt></i>
-      <i><tt>value</tt></i> - Pass a parameter of name
+    </dd><dt><span class="term">
+      <tt>--param</tt> <i><tt>name</tt></i> <i><tt>value</tt></i></span></dt><dd>Pass a parameter of name
       <i><tt>name</tt></i> and value
       <i><tt>value</tt></i> to the stylesheet. You may pass multiple
-      name/value pairs up to a maximum of 8.
-
-      <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2707986"></a>Note</h3><p>
-         If the value being passed is a string rather than a node identifier,
-         it must be escaped in quotes, as follows:
-       </p><p>
-         xsltproc --param rootid '&quot;introduction&quot;'
-         <i><tt>stylesheet</tt></i> <i><tt>file</tt></i>
-
-       </p></div>
-    </p><p>
-      <tt>--nonet</tt> - Do not use the Internet to fetch DTD's or
+      name/value pairs up to a maximum of 32. If the value being passed is a
+           string rather than a node identifier, use
+           <tt>--stringparam</tt> instead.
+         </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">
+      <tt>--nonet</tt></span></dt><dd>Do not use the Internet to fetch DTD's or
       entities.
-    </p><p>
-      <tt>--warnnet</tt> - Output notification when DTD's or entities
+    </dd><dt><span class="term">
+      <tt>--warnnet</tt></span></dt><dd>Output notification when DTD's or entities
       are fetched over the Internet.
-    </p><p>
-      <tt>--catalogs</tt> - Use catalogs to resolve the location of
+    </dd><dt><span class="term">
+      <tt>--catalogs</tt></span></dt><dd>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
       <tt>SGML_CATALOG_FILES</tt>.
-    </p><p>
-      <tt>--xinclude</tt> - Process the input document using the
+    </dd><dt><span class="term">
+      <tt>--xinclude</tt></span></dt><dd>Process the input document using the
       Xinclude specification. More details on this can be found in the Xinclude
       specification: <a href="http://www.w3.org/TR/xinclude/" target="_top">http://www.w3.org/TR/xinclude/</a>
-    </p><p>
-      <tt>--profile</tt> or <tt>--norman</tt> - Output profiling
+    </dd><dt><span class="term">
+      <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.
-    </p></div><div class="refsect1"><a name="return"></a><h2><a name="return"></a>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: unsuppoted xsl:output method</p></div><div class="refsect1"><a name="moreinfo"></a><h2><a name="moreinfo"></a>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>
+    </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>
index cca5b09..208ac72 100644 (file)
@@ -44,6 +44,7 @@
        <arg>--html</arg>
        <arg>--docbook</arg>
        <arg>--param <replaceable>name</replaceable> <replaceable>value</replaceable></arg>
+       <arg>--stringparam <replaceable>name</replaceable> <replaceable>value</replaceable></arg>
        <arg>--nonet</arg>
        <arg>--warnnet</arg>
        <arg>--catalogs</arg>
     
       <varlistentry>
        <term>
-      <option>--param</option> <replaceable>name</replaceable><replaceable>value</replaceable></term>
+      <option>--param</option> <replaceable>name</replaceable> <replaceable>value</replaceable></term>
        <listitem>
          <simpara>Pass a parameter of name
       <replaceable>name</replaceable> and value
       <replaceable>value</replaceable> 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 it must be escaped in quotes, as follows:
-         xsltproc --param rootid '"introduction"'
-         <replaceable>stylesheet</replaceable> <replaceable>file</replaceable>
+           string rather than a node identifier, use
+           <option>--stringparam</option> instead.
+         </simpara>
+       </listitem>
+      </varlistentry>
 
-       </simpara>
-      
-    
+      <varlistentry>
+       <term>
+         <option>--stringparam</option> <replaceable>name</replaceable> <replaceable>value</replaceable></term>
+       <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>
        </listitem>
       </varlistentry>
-
     
       <varlistentry>
        <term>