doc/xsltproc.xml, xsltproc.1 - updating man page to reflect increased
authorMST 2002 John Fleck <jfleck@inkstain.net>
Sat, 5 Jan 2002 05:14:33 +0000 (05:14 +0000)
committerJohn Fleck <jfleck@src.gnome.org>
Sat, 5 Jan 2002 05:14:33 +0000 (05:14 +0000)
Fri Jan  4 22:13:40 MST 2002 John Fleck <jfleck@inkstain.net>

* doc/xsltproc.xml, xsltproc.1 - updating man page to reflect
increased number of parameteres, changed license, cleaned up some
places where it looked junky because of stylesheet issues

ChangeLog
doc/xsltproc.1
doc/xsltproc.xml

index 803196d..e0f8ef4 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+Fri Jan  4 22:13:40 MST 2002 John Fleck <jfleck@inkstain.net>
+
+       * doc/xsltproc.xml, xsltproc.1 - updating man page to reflect
+       increased number of parameteres, changed license, cleaned up some
+       places where it looked junky because of stylesheet issues
+
 Fri Jan  4 15:50:25 CET 2002 Daniel Veillard <daniel@veillard.com>
 
        * xsltproc/xsltproc.c: increased the max number of parameters
index dc9e3d6..10339ee 100644 (file)
@@ -36,58 +36,108 @@ If a stylesheet is included in an XML document with a Stylesheet Processing Inst
 .PP
 By default, output is to stdout. You can specify a file for output using the \fB-o\fR option.
 
-.SH "OPTIONS"
+.SH "COMMAND LINE OPTIONS"
 
-.PP
-\fB-V\fR or \fB--version\fR - Show the version of libxml and libxslt used.
+.TP
+\fB-V\fR or \fB--version\fR
 
-.PP
-\fB-v\fR or \fB--verbose\fR - Output each step taken by xsltproc in processing the stylesheet and the document.
+Show the version of libxml and libxslt used.
 
-.PP
-\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
 
-.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.
+      \fB-v\fR or \fB--verbose\fR
 
-.PP
-\fB--repeat\fR - Run the transformation 20 times. Used for timing tests.
+Output each step taken by xsltproc in processing the stylesheet and the document.
 
-.PP
-\fB--debug\fR - Output an XML tree of the transformed document for debugging purposes.
+.TP
 
-.PP
-\fB--novalid\fR - Skip loading the document's DTD.
+      \fB-o\fR or \fB--output\fR\fIfile\fR
 
-.PP
-\fB--noout\fR - Do not output the result.
+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.
 
-.PP
-\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
 
-.PP
-\fB--html\fR - The input document is an HTML file.
+      \fB--timing\fR
 
-.PP
-\fB--docbook\fR - The input document is DocBook SGML.
+Display the time used for parsing the stylesheet, parsing the document and applying the stylesheet and saving the result. Displayed in milliseconds.
 
-.PP
-\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 8. .PP If the value being passed is a string rather than a node identifier, it must be escaped in quotes, as follows: .PP xsltproc --param rootid '"introduction"' \fIstylesheet\fR \fIfile\fR
+.TP
 
-.PP
-\fB--nonet\fR - Do not use the Internet to fetch DTD's or entities.
+      \fB--repeat\fR
 
-.PP
-\fB--warnnet\fR - Output notification when DTD's or entities are fetched over the Internet.
+Run the transformation 20 times. Used for timing tests.
 
-.PP
-\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
 
-.PP
-\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--debug\fR
 
-.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.
+Output an XML tree of the transformed document for debugging purposes.
+
+.TP
+
+      \fB--novalid\fR
+
+Skip loading the document's DTD.
+
+.TP
+
+      \fB--noout\fR
+
+Do not output the result.
+
+.TP
+
+      \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
+
+The input document is an HTML file.
+
+.TP
+
+      \fB--docbook\fR
+
+The input document is DocBook SGML.
+
+.TP
+
+      \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
+
+.TP
+
+      \fB--nonet\fR
+
+Do not use the Internet to fetch DTD's or entities.
+
+.TP
+
+      \fB--warnnet\fR
+
+Output notification when DTD's or entities are fetched over the Internet.
+
+.TP
+
+      \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
+
+.TP
+
+      \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.
 
 .SH "RETURN VALUES"
 
@@ -129,10 +179,4 @@ W3C XSLT page: http://www.w3.org/TR/xslt: \fIhttp://www.w3.org/TR/xslt\fR
 .SH AUTHOR
 Copyright 2001
 .Sp
-John Fleck  <jfleck@inkstain.net>
-.PP
-Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License: \fIgnome-help:fdl\fR, Version 1.1 or any later version published by the Free Software Foundation with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license can be found here: \fIgnome-help:fdl\fR.
-
-.PP
-Many of the names used by companies to distinguish their products and services are claimed as trademarks. Where those names appear in any GNOME documentation, and those trademarks are made aware to the members of the GNOME Documentation Project, the names have been printed in caps or initial caps.
-This is release 0.1 of the xsltproc Manual.
\ No newline at end of file
+John Fleck  <jfleck@inkstain.net>This is release 0.2 of the xsltproc Manual.
\ No newline at end of file
index f0a6d18..06ebbe6 100644 (file)
       <surname>Fleck</surname>
     </author>
     <address><email>jfleck@inkstain.net</email></address>
-    <legalnotice id="legalnotice">
-      <para>Permission is granted to copy, distribute and/or modify this document
-       under the terms of the <ulink type="help" url="gnome-help:fdl"><citetitle>GNU Free Documentation
-           License</citetitle></ulink>, Version 1.1 or any later version 
-       published by the Free Software Foundation with no Invariant Sections, 
-       no Front-Cover Texts, and no Back-Cover Texts.  A copy of the license
-       can be found <ulink type="help" url="gnome-help:fdl">here</ulink>.
-      </para>
-      <para>Many of the names used by companies to distinguish their products and
-       services are claimed as trademarks. Where those names appear in any
-       GNOME documentation, and those trademarks are made aware to the members
-       of the GNOME Documentation Project, the names have been printed in caps
-       or initial caps.
-      </para>
-    </legalnotice>
-    <releaseinfo>This is release 0.1 of the xsltproc Manual.</releaseinfo>
+    
+    <releaseinfo>This is release 0.2 of the xsltproc Manual.</releaseinfo>
   </refentryinfo>
 
   <refmeta>
   </refsect1>
 
   <refsect1 id="options">
-    <title>Options</title>
+    <title>Command Line Options</title>
     
-    <para>
-      <option>-V</option> or <option>--version</option> - Show the version of
+    <variablelist>
+      <varlistentry>
+       <term><option>-V</option> or <option>--version</option></term>
+       <listitem>
+         <simpara>Show the version of
       <application>libxml</application> and <application>libxslt</application> used.
-    </para>
+    </simpara>
+       </listitem>
+      </varlistentry>
 
-    <para>
-      <option>-v</option> or <option>--verbose</option> - Output each step taken
+    
+      <varlistentry>
+       <term>
+      <option>-v</option> or <option>--verbose</option></term>
+       <listitem>
+         <simpara>Output each step taken
       by <application>xsltproc</application> in processing the stylesheet and the document.
-    </para>
+    </simpara>
+       </listitem>
+      </varlistentry>
 
-    <para>
-      <option>-o</option> or <option>--output</option>
-      <replaceable>file</replaceable> - Direct output to the file named
+    
+      <varlistentry>
+       <term>
+      <option>-o</option> or <option>--output</option> <replaceable>file</replaceable></term>
+       <listitem>
+         <simpara>Direct output to the file named
       <replaceable>file</replaceable>. For multiple outputs, also known as
       "chunking", <option>-o</option> <option>directory/</option> directs the
       output files to a specified directory. The directory must already exist.
-    </para>
+    </simpara>
+       </listitem>
+      </varlistentry>
 
-    <para>
-      <option>--timing</option> - Display the time used for parsing the
+    
+      <varlistentry>
+       <term>
+      <option>--timing</option></term>
+       <listitem>
+         <simpara>Display the time used for parsing the
       stylesheet, parsing the document and applying the stylesheet and saving
       the result. Displayed in milliseconds.
-    </para>
+    </simpara>
+       </listitem>
+      </varlistentry>
 
-    <para>
-      <option>--repeat</option> - Run the transformation 20 times. Used for
+    
+      <varlistentry>
+       <term>
+      <option>--repeat</option></term>
+       <listitem>
+         <simpara>Run the transformation 20 times. Used for
       timing tests.
-    </para>
+    </simpara>
+       </listitem>
+      </varlistentry>
 
-    <para>
-      <option>--debug</option> - Output an <acronym>XML</acronym> tree of the
+    
+      <varlistentry>
+       <term>
+      <option>--debug</option></term>
+       <listitem>
+         <simpara>Output an <acronym>XML</acronym> tree of the
       transformed document for debugging purposes.
-    </para>
+    </simpara>
+       </listitem>
+      </varlistentry>
 
-    <para>
-      <option>--novalid</option> - Skip loading the document's <acronym>DTD</acronym>.
-    </para>
+    
+      <varlistentry>
+       <term>
+      <option>--novalid</option></term>
+       <listitem>
+         <simpara>Skip loading the document's <acronym>DTD</acronym>.
+    </simpara>
+       </listitem>
+      </varlistentry>
 
-    <para>
-      <option>--noout</option> - Do not output the result.
-    </para>
+    
+      <varlistentry>
+       <term>
+      <option>--noout</option></term>
+       <listitem>
+         <simpara>Do not output the result.
+    </simpara>
+       </listitem>
+      </varlistentry>
 
-    <para>
-      <option>--maxdepth</option> <replaceable>value</replaceable> - Adjust the
+    
+      <varlistentry>
+       <term>
+      <option>--maxdepth</option> <replaceable>value</replaceable></term>
+       <listitem>
+         <simpara>Adjust the
       maximum depth of the template stack before
       <application>libxslt</application> concludes it is in an infinite
       loop. The default is 500.
-    </para>
+    </simpara>
+       </listitem>
+      </varlistentry>
 
-    <para>
-      <option>--html</option> - The input document is an <acronym>HTML</acronym>
+    
+      <varlistentry>
+       <term>
+      <option>--html</option></term>
+       <listitem>
+         <simpara>The input document is an <acronym>HTML</acronym>
       file.
-    </para>
+    </simpara>
+       </listitem>
+      </varlistentry>
 
-    <para>
-      <option>--docbook</option> - The input document is DocBook
+    
+      <varlistentry>
+       <term>
+      <option>--docbook</option></term>
+       <listitem>
+         <simpara>The input document is DocBook
       <acronym>SGML</acronym>.
-    </para>
+    </simpara>
+       </listitem>
+      </varlistentry>
 
-    <para>
-      <option>--param</option> <replaceable>name</replaceable>
-      <replaceable>value</replaceable> - Pass a parameter of name
+    
+      <varlistentry>
+       <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 8.
-
-      <note>
-       <para>
-         If the value being passed is a string rather than a node identifier,
-         it must be escaped in quotes, as follows:
-       </para>
-       <para>
+      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>
 
-       </para>
-      </note>
-    </para>
+       </simpara>
+      
+    
+       </listitem>
+      </varlistentry>
 
-    <para>
-      <option>--nonet</option> - Do not use the Internet to fetch DTD's or
+    
+      <varlistentry>
+       <term>
+      <option>--nonet</option></term>
+       <listitem>
+         <simpara>Do not use the Internet to fetch DTD's or
       entities.
-    </para>
+    </simpara>
+       </listitem>
+      </varlistentry>
 
-    <para>
-      <option>--warnnet</option> - Output notification when DTD's or entities
+    
+      <varlistentry>
+       <term>
+      <option>--warnnet</option></term>
+       <listitem>
+         <simpara>Output notification when DTD's or entities
       are fetched over the Internet.
-    </para>
+    </simpara>
+       </listitem>
+      </varlistentry>
 
-    <para>
-      <option>--catalogs</option> - Use catalogs to resolve the location of
+    
+      <varlistentry>
+       <term>
+      <option>--catalogs</option></term>
+       <listitem>
+         <simpara>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,
       <application>xsltproc</application> does not have to use the
       Internet to fetch the DTD. <application>xsltproc</application>
       uses the catalog identified by the environmental variable
       <envar>SGML_CATALOG_FILES</envar>.
-    </para>
+    </simpara>
+       </listitem>
+      </varlistentry>
 
-    <para>
-      <option>--xinclude</option> - Process the input document using the
+    
+      <varlistentry>
+       <term>
+      <option>--xinclude</option></term>
+       <listitem>
+         <simpara>Process the input document using the
       Xinclude specification. More details on this can be found in the Xinclude
       specification: <ulink
       url="http://www.w3.org/TR/xinclude/">http://www.w3.org/TR/xinclude/</ulink>
-    </para>
+    </simpara>
+       </listitem>
+      </varlistentry>
     
-    <para>
-      <option>--profile</option> or <option>--norman</option> - Output profiling
+    
+      <varlistentry>
+       <term>
+      <option>--profile</option> or <option>--norman</option></term>
+       <listitem>
+         <simpara>Output profiling
       information detailing the amount of time spent in each part of the
       stylesheet. This is useful in optimizing stylesheet performance.
-    </para>
+    </simpara>
+       </listitem>
+      </varlistentry>
+    </variablelist>
   </refsect1>
 
   <refsect1 id="return">