diff options
author | Dirk Baechle <dl9obn@darc.de> | 2013-05-04 01:17:54 +0200 |
---|---|---|
committer | Dirk Baechle <dl9obn@darc.de> | 2013-05-04 01:17:54 +0200 |
commit | 2fbab041df44f30a342fc7c0b43bb0808638c7e0 (patch) | |
tree | d0af9a1d5bab726ac6f3a402b2bd715f36fb969c /doc | |
parent | 0947775a51fa7bdb446b40c08f417fe6ce1ebbdc (diff) | |
download | scons-git-2fbab041df44f30a342fc7c0b43bb0808638c7e0.tar.gz |
- added documentation and tests for the new Docbook tool
Diffstat (limited to 'doc')
-rw-r--r-- | doc/generated/builders.gen | 254 | ||||
-rw-r--r-- | doc/generated/builders.mod | 36 | ||||
-rw-r--r-- | doc/generated/tools.gen | 127 | ||||
-rw-r--r-- | doc/generated/tools.mod | 2 | ||||
-rw-r--r-- | doc/generated/variables.gen | 188 | ||||
-rw-r--r-- | doc/generated/variables.mod | 40 | ||||
-rw-r--r-- | doc/man/scons.xml | 7 |
7 files changed, 652 insertions, 2 deletions
diff --git a/doc/generated/builders.gen b/doc/generated/builders.gen index 0e3073e19..eec4711cd 100644 --- a/doc/generated/builders.gen +++ b/doc/generated/builders.gen @@ -84,6 +84,260 @@ env.CXXFile(target = 'bar', source = 'bar.yy') </example_commands> </listitem> </varlistentry> + <varlistentry id="b-DocbookHtml"> + <term> + <function>DocbookHtml()</function> + </term> + <term> + <function>env.DocbookHtml()</function> + </term> + <listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +A pseudo-Builder, providing a Docbook toolchain for HTML output. +</para> +<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +env.DocbookHtml('manual.html', 'manual.xml') +</example_commands> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +or simply +</para> +<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +env.DocbookHtml('manual') +</example_commands> +</listitem> + </varlistentry> + <varlistentry id="b-DocbookHtmlChunked"> + <term> + <function>DocbookHtmlChunked()</function> + </term> + <term> + <function>env.DocbookHtmlChunked()</function> + </term> + <listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +A pseudo-Builder, providing a Docbook toolchain for chunked HTML output. +It supports the <literal>base.dir</literal> parameter. The +<filename>chunkfast.xsl</filename> file (requires "EXSLT") is used as the +default stylesheet. Basic syntax: +</para> + +<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +env.DocbookHtmlChunked('manual') +</example_commands> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +where <filename>manual.xml</filename> is the input file. +</para> +<para xmlns="http://www.scons.org/dbxsd/v1.0">If you use the <literal>root.filename</literal> +parameter in your own stylesheets you have to specify the new target name. +This ensures that the dependencies get correct, especially for the cleanup via <quote><literal>scons -c</literal></quote>: +</para> +<screen xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +env.DocbookHtmlChunked('mymanual.html', 'manual', xsl='htmlchunk.xsl') +</screen> +<para xmlns="http://www.scons.org/dbxsd/v1.0">Some basic support for the <literal>base.dir</literal> is provided. You +can add the <literal>base_dir</literal> keyword to your Builder +call, and the given prefix gets prepended to all the created filenames: +</para> +<screen xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +env.DocbookHtmlChunked('manual', xsl='htmlchunk.xsl', base_dir='output/') +</screen> +<para xmlns="http://www.scons.org/dbxsd/v1.0">Make sure that you don't forget the trailing slash for the base folder, else +your files get renamed only! +</para> +</listitem> + </varlistentry> + <varlistentry id="b-DocbookHtmlhelp"> + <term> + <function>DocbookHtmlhelp()</function> + </term> + <term> + <function>env.DocbookHtmlhelp()</function> + </term> + <listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +A pseudo-Builder, providing a Docbook toolchain for HTMLHELP output. +Its basic syntax is: +</para> + +<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +env.DocbookHtmlhelp('manual') +</example_commands> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +where <filename>manual.xml</filename> is the input file. +</para> + +<para xmlns="http://www.scons.org/dbxsd/v1.0">If you use the <literal>root.filename</literal> +parameter in your own stylesheets you have to specify the new target name. +This ensures that the dependencies get correct, especially for the cleanup via <quote><literal>scons -c</literal></quote>: +</para> +<screen xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +env.DocbookHtmlhelp('mymanual.html', 'manual', xsl='htmlhelp.xsl') +</screen> +<para xmlns="http://www.scons.org/dbxsd/v1.0">Some basic support for the <literal>base.dir</literal> parameter +is provided. You can add the <literal>base_dir</literal> keyword to +your Builder call, and the given prefix gets prepended to all the +created filenames: +</para> +<screen xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +env.DocbookHtmlhelp('manual', xsl='htmlhelp.xsl', base_dir='output/') +</screen> +<para xmlns="http://www.scons.org/dbxsd/v1.0">Make sure that you don't forget the trailing slash for the base folder, else +your files get renamed only! +</para> + +</listitem> + </varlistentry> + <varlistentry id="b-DocbookMan"> + <term> + <function>DocbookMan()</function> + </term> + <term> + <function>env.DocbookMan()</function> + </term> + <listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +A pseudo-Builder, providing a Docbook toolchain for Man page output. +Its basic syntax is: +</para> + +<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +env.DocbookMan('manual') +</example_commands> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +where <filename>manual.xml</filename> is the input file. Note, that +you can specify a target name, but the actual output names are automatically +set from the <literal>refname</literal> entries in your XML source. +</para> +</listitem> + </varlistentry> + <varlistentry id="b-DocbookPdf"> + <term> + <function>DocbookPdf()</function> + </term> + <term> + <function>env.DocbookPdf()</function> + </term> + <listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +A pseudo-Builder, providing a Docbook toolchain for PDF output. +</para> + +<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +env.DocbookPdf('manual.pdf', 'manual.xml') +</example_commands> + +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +or simply +</para> + +<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +env.DocbookPdf('manual') +</example_commands> + +</listitem> + </varlistentry> + <varlistentry id="b-DocbookSlidesHtml"> + <term> + <function>DocbookSlidesHtml()</function> + </term> + <term> + <function>env.DocbookSlidesHtml()</function> + </term> + <listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +A pseudo-Builder, providing a Docbook toolchain for HTML slides output. +</para> + +<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +env.DocbookSlidesHtml('manual') +</example_commands> + +<para xmlns="http://www.scons.org/dbxsd/v1.0">If you use the <literal>titlefoil.html</literal> parameter in +your own stylesheets you have to give the new target name. This ensures +that the dependencies get correct, especially for the cleanup via +<quote><literal>scons -c</literal></quote>: +</para> +<screen xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +env.DocbookSlidesHtml('mymanual.html','manual', xsl='slideshtml.xsl') +</screen> + +<para xmlns="http://www.scons.org/dbxsd/v1.0">Some basic support for the <literal>base.dir</literal> parameter +is provided. You +can add the <literal>base_dir</literal> keyword to your Builder +call, and the given prefix gets prepended to all the created filenames: +</para> +<screen xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +env.DocbookSlidesHtml('manual', xsl='slideshtml.xsl', base_dir='output/') +</screen> +<para xmlns="http://www.scons.org/dbxsd/v1.0">Make sure that you don't forget the trailing slash for the base folder, else +your files get renamed only! +</para> + +</listitem> + </varlistentry> + <varlistentry id="b-DocbookSlidesPdf"> + <term> + <function>DocbookSlidesPdf()</function> + </term> + <term> + <function>env.DocbookSlidesPdf()</function> + </term> + <listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +A pseudo-Builder, providing a Docbook toolchain for PDF slides output. +</para> + +<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +env.DocbookSlidesPdf('manual.pdf', 'manual.xml') +</example_commands> + +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +or simply +</para> + +<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +env.DocbookSlidesPdf('manual') +</example_commands> +</listitem> + </varlistentry> + <varlistentry id="b-DocbookXInclude"> + <term> + <function>DocbookXInclude()</function> + </term> + <term> + <function>env.DocbookXInclude()</function> + </term> + <listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +A pseudo-Builder, for resolving XIncludes in a separate processing step. +</para> + +<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +env.DocbookXInclude('manual_xincluded.xml', 'manual.xml') +</example_commands> +</listitem> + </varlistentry> + <varlistentry id="b-DocbookXslt"> + <term> + <function>DocbookXslt()</function> + </term> + <term> + <function>env.DocbookXslt()</function> + </term> + <listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +A pseudo-Builder, applying a given XSL transformation to the input file. +</para> + +<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +env.DocbookXslt('manual_transformed.xml', 'manual.xml', xsl='transform.xslt') +</example_commands> + +<para xmlns="http://www.scons.org/dbxsd/v1.0">Note, that this builder requires the <literal>xsl</literal> parameter +to be set. +</para> +</listitem> + </varlistentry> <varlistentry id="b-DVI"> <term> <function>DVI()</function> diff --git a/doc/generated/builders.mod b/doc/generated/builders.mod index 13472db3b..59900cc1d 100644 --- a/doc/generated/builders.mod +++ b/doc/generated/builders.mod @@ -11,6 +11,15 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. <!ENTITY b-CFile "<function xmlns='http://www.scons.org/dbxsd/v1.0'>CFile</function>"> <!ENTITY b-Command "<function xmlns='http://www.scons.org/dbxsd/v1.0'>Command</function>"> <!ENTITY b-CXXFile "<function xmlns='http://www.scons.org/dbxsd/v1.0'>CXXFile</function>"> +<!ENTITY b-DocbookHtml "<function xmlns='http://www.scons.org/dbxsd/v1.0'>DocbookHtml</function>"> +<!ENTITY b-DocbookHtmlChunked "<function xmlns='http://www.scons.org/dbxsd/v1.0'>DocbookHtmlChunked</function>"> +<!ENTITY b-DocbookHtmlhelp "<function xmlns='http://www.scons.org/dbxsd/v1.0'>DocbookHtmlhelp</function>"> +<!ENTITY b-DocbookMan "<function xmlns='http://www.scons.org/dbxsd/v1.0'>DocbookMan</function>"> +<!ENTITY b-DocbookPdf "<function xmlns='http://www.scons.org/dbxsd/v1.0'>DocbookPdf</function>"> +<!ENTITY b-DocbookSlidesHtml "<function xmlns='http://www.scons.org/dbxsd/v1.0'>DocbookSlidesHtml</function>"> +<!ENTITY b-DocbookSlidesPdf "<function xmlns='http://www.scons.org/dbxsd/v1.0'>DocbookSlidesPdf</function>"> +<!ENTITY b-DocbookXInclude "<function xmlns='http://www.scons.org/dbxsd/v1.0'>DocbookXInclude</function>"> +<!ENTITY b-DocbookXslt "<function xmlns='http://www.scons.org/dbxsd/v1.0'>DocbookXslt</function>"> <!ENTITY b-DVI "<function xmlns='http://www.scons.org/dbxsd/v1.0'>DVI</function>"> <!ENTITY b-Install "<function xmlns='http://www.scons.org/dbxsd/v1.0'>Install</function>"> <!ENTITY b-InstallAs "<function xmlns='http://www.scons.org/dbxsd/v1.0'>InstallAs</function>"> @@ -55,6 +64,15 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. <!ENTITY b-env-CFile "<function xmlns='http://www.scons.org/dbxsd/v1.0'>env.CFile</function>"> <!ENTITY b-env-Command "<function xmlns='http://www.scons.org/dbxsd/v1.0'>env.Command</function>"> <!ENTITY b-env-CXXFile "<function xmlns='http://www.scons.org/dbxsd/v1.0'>env.CXXFile</function>"> +<!ENTITY b-env-DocbookHtml "<function xmlns='http://www.scons.org/dbxsd/v1.0'>env.DocbookHtml</function>"> +<!ENTITY b-env-DocbookHtmlChunked "<function xmlns='http://www.scons.org/dbxsd/v1.0'>env.DocbookHtmlChunked</function>"> +<!ENTITY b-env-DocbookHtmlhelp "<function xmlns='http://www.scons.org/dbxsd/v1.0'>env.DocbookHtmlhelp</function>"> +<!ENTITY b-env-DocbookMan "<function xmlns='http://www.scons.org/dbxsd/v1.0'>env.DocbookMan</function>"> +<!ENTITY b-env-DocbookPdf "<function xmlns='http://www.scons.org/dbxsd/v1.0'>env.DocbookPdf</function>"> +<!ENTITY b-env-DocbookSlidesHtml "<function xmlns='http://www.scons.org/dbxsd/v1.0'>env.DocbookSlidesHtml</function>"> +<!ENTITY b-env-DocbookSlidesPdf "<function xmlns='http://www.scons.org/dbxsd/v1.0'>env.DocbookSlidesPdf</function>"> +<!ENTITY b-env-DocbookXInclude "<function xmlns='http://www.scons.org/dbxsd/v1.0'>env.DocbookXInclude</function>"> +<!ENTITY b-env-DocbookXslt "<function xmlns='http://www.scons.org/dbxsd/v1.0'>env.DocbookXslt</function>"> <!ENTITY b-env-DVI "<function xmlns='http://www.scons.org/dbxsd/v1.0'>env.DVI</function>"> <!ENTITY b-env-Install "<function xmlns='http://www.scons.org/dbxsd/v1.0'>env.Install</function>"> <!ENTITY b-env-InstallAs "<function xmlns='http://www.scons.org/dbxsd/v1.0'>env.InstallAs</function>"> @@ -109,6 +127,15 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. <!ENTITY b-link-CFile "<link linkend='b-CFile' xmlns='http://www.scons.org/dbxsd/v1.0'><function>CFile</function></link>"> <!ENTITY b-link-Command "<link linkend='b-Command' xmlns='http://www.scons.org/dbxsd/v1.0'><function>Command</function></link>"> <!ENTITY b-link-CXXFile "<link linkend='b-CXXFile' xmlns='http://www.scons.org/dbxsd/v1.0'><function>CXXFile</function></link>"> +<!ENTITY b-link-DocbookHtml "<link linkend='b-DocbookHtml' xmlns='http://www.scons.org/dbxsd/v1.0'><function>DocbookHtml</function></link>"> +<!ENTITY b-link-DocbookHtmlChunked "<link linkend='b-DocbookHtmlChunked' xmlns='http://www.scons.org/dbxsd/v1.0'><function>DocbookHtmlChunked</function></link>"> +<!ENTITY b-link-DocbookHtmlhelp "<link linkend='b-DocbookHtmlhelp' xmlns='http://www.scons.org/dbxsd/v1.0'><function>DocbookHtmlhelp</function></link>"> +<!ENTITY b-link-DocbookMan "<link linkend='b-DocbookMan' xmlns='http://www.scons.org/dbxsd/v1.0'><function>DocbookMan</function></link>"> +<!ENTITY b-link-DocbookPdf "<link linkend='b-DocbookPdf' xmlns='http://www.scons.org/dbxsd/v1.0'><function>DocbookPdf</function></link>"> +<!ENTITY b-link-DocbookSlidesHtml "<link linkend='b-DocbookSlidesHtml' xmlns='http://www.scons.org/dbxsd/v1.0'><function>DocbookSlidesHtml</function></link>"> +<!ENTITY b-link-DocbookSlidesPdf "<link linkend='b-DocbookSlidesPdf' xmlns='http://www.scons.org/dbxsd/v1.0'><function>DocbookSlidesPdf</function></link>"> +<!ENTITY b-link-DocbookXInclude "<link linkend='b-DocbookXInclude' xmlns='http://www.scons.org/dbxsd/v1.0'><function>DocbookXInclude</function></link>"> +<!ENTITY b-link-DocbookXslt "<link linkend='b-DocbookXslt' xmlns='http://www.scons.org/dbxsd/v1.0'><function>DocbookXslt</function></link>"> <!ENTITY b-link-DVI "<link linkend='b-DVI' xmlns='http://www.scons.org/dbxsd/v1.0'><function>DVI</function></link>"> <!ENTITY b-link-Install "<link linkend='b-Install' xmlns='http://www.scons.org/dbxsd/v1.0'><function>Install</function></link>"> <!ENTITY b-link-InstallAs "<link linkend='b-InstallAs' xmlns='http://www.scons.org/dbxsd/v1.0'><function>InstallAs</function></link>"> @@ -153,6 +180,15 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. <!ENTITY b-link-env-CFile "<link linkend='b-CFile' xmlns='http://www.scons.org/dbxsd/v1.0'><function>env.CFile</function></link>"> <!ENTITY b-link-env-Command "<link linkend='b-Command' xmlns='http://www.scons.org/dbxsd/v1.0'><function>env.Command</function></link>"> <!ENTITY b-link-env-CXXFile "<link linkend='b-CXXFile' xmlns='http://www.scons.org/dbxsd/v1.0'><function>env.CXXFile</function></link>"> +<!ENTITY b-link-env-DocbookHtml "<link linkend='b-DocbookHtml' xmlns='http://www.scons.org/dbxsd/v1.0'><function>env.DocbookHtml</function></link>"> +<!ENTITY b-link-env-DocbookHtmlChunked "<link linkend='b-DocbookHtmlChunked' xmlns='http://www.scons.org/dbxsd/v1.0'><function>env.DocbookHtmlChunked</function></link>"> +<!ENTITY b-link-env-DocbookHtmlhelp "<link linkend='b-DocbookHtmlhelp' xmlns='http://www.scons.org/dbxsd/v1.0'><function>env.DocbookHtmlhelp</function></link>"> +<!ENTITY b-link-env-DocbookMan "<link linkend='b-DocbookMan' xmlns='http://www.scons.org/dbxsd/v1.0'><function>env.DocbookMan</function></link>"> +<!ENTITY b-link-env-DocbookPdf "<link linkend='b-DocbookPdf' xmlns='http://www.scons.org/dbxsd/v1.0'><function>env.DocbookPdf</function></link>"> +<!ENTITY b-link-env-DocbookSlidesHtml "<link linkend='b-DocbookSlidesHtml' xmlns='http://www.scons.org/dbxsd/v1.0'><function>env.DocbookSlidesHtml</function></link>"> +<!ENTITY b-link-env-DocbookSlidesPdf "<link linkend='b-DocbookSlidesPdf' xmlns='http://www.scons.org/dbxsd/v1.0'><function>env.DocbookSlidesPdf</function></link>"> +<!ENTITY b-link-env-DocbookXInclude "<link linkend='b-DocbookXInclude' xmlns='http://www.scons.org/dbxsd/v1.0'><function>env.DocbookXInclude</function></link>"> +<!ENTITY b-link-env-DocbookXslt "<link linkend='b-DocbookXslt' xmlns='http://www.scons.org/dbxsd/v1.0'><function>env.DocbookXslt</function></link>"> <!ENTITY b-link-env-DVI "<link linkend='b-DVI' xmlns='http://www.scons.org/dbxsd/v1.0'><function>env.DVI</function></link>"> <!ENTITY b-link-env-Install "<link linkend='b-Install' xmlns='http://www.scons.org/dbxsd/v1.0'><function>env.Install</function></link>"> <!ENTITY b-link-env-InstallAs "<link linkend='b-InstallAs' xmlns='http://www.scons.org/dbxsd/v1.0'><function>env.InstallAs</function></link>"> diff --git a/doc/generated/tools.gen b/doc/generated/tools.gen index ceea03067..57bb0a244 100644 --- a/doc/generated/tools.gen +++ b/doc/generated/tools.gen @@ -147,6 +147,133 @@ Sets construction variables for D language compilers </para> </listitem> </varlistentry> + <varlistentry id="t-docbook"> + <term>docbook</term> + <listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0">This tool tries to make working with Docbook in SCons a little easier. +It provides several toolchains for creating different output formats, +like HTML or PDF. Contained in the package is +a distribution of the Docbook XSL stylesheets as of version 1.76.1. +As long as you don't specify your own stylesheets for customization, +these official versions are picked as default...which should reduce +the inevitable setup hassles for you. +</para> +<para xmlns="http://www.scons.org/dbxsd/v1.0">Implicit dependencies to images and XIncludes are detected automatically +if you meet the HTML requirements. The additional +stylesheet <filename>utils/xmldepend.xsl</filename> by Paul DuBois is used for this purpose. +</para> +<para xmlns="http://www.scons.org/dbxsd/v1.0">Note, that there is no support for XML catalog resolving offered! This tool calls +the XSLT processors and PDF renderers with the stylesheets you specified, that's it. +The rest lies in your hands and you still have to know what you're doing when +resolving names via a catalog. +</para> +<para xmlns="http://www.scons.org/dbxsd/v1.0">For activating the tool "docbook", you have to add its name to the Environment constructor, +like this +</para> +<screen xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +</screen> +<para xmlns="http://www.scons.org/dbxsd/v1.0">On its startup, the Docbook tool tries to find a required <literal>xsltproc</literal> processor, and +a PDF renderer, e.g. <literal>fop</literal>. So make sure that these are added to your system's environment +<literal>PATH</literal> and can be called directly, without specifying their full path. +</para> +<para xmlns="http://www.scons.org/dbxsd/v1.0">For the most basic processing of Docbook to HTML, you need to have installed +</para> +<itemizedlist xmlns="http://www.scons.org/dbxsd/v1.0"><listitem><para>the Python <literal>lxml</literal> binding to <literal>libxml2</literal>, or +</para> +</listitem> +<listitem><para>the direct Python bindings for <literal>libxml2/libxslt</literal>, or +</para> +</listitem> +<listitem><para>a standalone XSLT processor, currently detected are <literal>xsltproc</literal>, <literal>saxon</literal>, <literal>saxon-xslt</literal> +and <literal>xalan</literal>. +</para> +</listitem> +</itemizedlist> +<para xmlns="http://www.scons.org/dbxsd/v1.0">Rendering to PDF requires you to have one of the applications +<literal>fop</literal> or <literal>xep</literal> installed. +</para> + +<para xmlns="http://www.scons.org/dbxsd/v1.0">Creating a HTML or PDF document is very simple and straightforward. Say +</para> +<screen xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +env.DocbookHtml('manual.html', 'manual.xml') +env.DocbookPdf('manual.pdf', 'manual.xml') +</screen> +<para xmlns="http://www.scons.org/dbxsd/v1.0">to get both outputs from your XML source <filename>manual.xml</filename>. As a shortcut, you can +give the stem of the filenames alone, like this: +</para> +<screen xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +env.DocbookHtml('manual') +env.DocbookPdf('manual') +</screen> +<para xmlns="http://www.scons.org/dbxsd/v1.0">and get the same result. Target and source lists are also supported: +</para> +<screen xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +env.DocbookHtml(['manual.html','reference.html'], ['manual.xml','reference.xml']) +</screen> +<para xmlns="http://www.scons.org/dbxsd/v1.0">or even +</para> +<screen xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +env.DocbookHtml(['manual','reference']) +</screen> +<important xmlns="http://www.scons.org/dbxsd/v1.0"><para>Whenever you leave out the list of sources, you may not specify a file extension! The +Tool uses the given names as file stems, and adds the suffixes for target and source files +accordingly. +</para> +</important> +<para xmlns="http://www.scons.org/dbxsd/v1.0">The rules given above are valid for the Builders <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-DocbookHtml"><function>DocbookHtml</function></link>, +<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-DocbookPdf"><function>DocbookPdf</function></link>, <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-DocbookSlidesPdf"><function>DocbookSlidesPdf</function></link> and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-DocbookXInclude"><function>DocbookXInclude</function></link>. For the +<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-DocbookMan"><function>DocbookMan</function></link> transformation you +can specify a target name, but the actual output names are automatically +set from the <literal>refname</literal> entries in your XML source. +</para> + +<para xmlns="http://www.scons.org/dbxsd/v1.0">The Builders <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-DocbookHtmlChunked"><function>DocbookHtmlChunked</function></link>, <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-DocbookHtmlhelp"><function>DocbookHtmlhelp</function></link> and +<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-DocbookSlidesHtml"><function>DocbookSlidesHtml</function></link> are special, in that: +</para> +<orderedlist xmlns="http://www.scons.org/dbxsd/v1.0"><listitem><para>they create a large set of files, where the exact names and their number depend +on the content of the source file, and +</para> +</listitem> +<listitem><para>the main target is always named <filename>index.html</filename>, i.e. the output name for the +XSL transformation is not picked up by the stylesheets. +</para> +</listitem> +</orderedlist> +<para xmlns="http://www.scons.org/dbxsd/v1.0">As a result, there is simply no use in specifying a target HTML name. +So the basic syntax for these builders is always: +</para> +<screen xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +env.DocbookHtmlhelp('manual') +</screen> + +<para xmlns="http://www.scons.org/dbxsd/v1.0">If you want to use a specific XSL file, you can set the +additional <literal>xsl</literal> parameter to your +Builder call as follows: +</para> +<screen xmlns="http://www.scons.org/dbxsd/v1.0">env.DocbookHtml('other.html', 'manual.xml', xsl='html.xsl') +</screen> +<para xmlns="http://www.scons.org/dbxsd/v1.0">Since this may get tedious if you always use the same local naming for your customized XSL files, +e.g. <filename>html.xsl</filename> for HTML and <filename>pdf.xsl</filename> for PDF output, a set of +variables for setting the default XSL name is provided. These are: +</para> +<screen xmlns="http://www.scons.org/dbxsd/v1.0">DOCBOOK_DEFAULT_XSL_HTML +DOCBOOK_DEFAULT_XSL_HTMLCHUNKED +DOCBOOK_DEFAULT_XSL_HTMLHELP +DOCBOOK_DEFAULT_XSL_PDF +DOCBOOK_DEFAULT_XSL_MAN +DOCBOOK_DEFAULT_XSL_SLIDESPDF +DOCBOOK_DEFAULT_XSL_SLIDESHTML +</screen> +<para xmlns="http://www.scons.org/dbxsd/v1.0">and you can set them when constructing your environment: +</para> +<screen xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook'], + DOCBOOK_DEFAULT_XSL_HTML='html.xsl', + DOCBOOK_DEFAULT_XSL_PDF='pdf.xsl') +env.DocbookHtml('manual') # now uses html.xsl +</screen> +<para>Sets: &cv-link-DOCBOOK_DEFAULT_XSL_HTML;, &cv-link-DOCBOOK_DEFAULT_XSL_HTMLCHUNKED;, &cv-link-DOCBOOK_DEFAULT_XSL_HTMLHELP;, &cv-link-DOCBOOK_DEFAULT_XSL_MAN;, &cv-link-DOCBOOK_DEFAULT_XSL_PDF;, &cv-link-DOCBOOK_DEFAULT_XSL_SLIDESHTML;, &cv-link-DOCBOOK_DEFAULT_XSL_SLIDESPDF;, &cv-link-DOCBOOK_FOP;, &cv-link-DOCBOOK_FOPCOM;, &cv-link-DOCBOOK_FOPFLAGS;, &cv-link-DOCBOOK_XMLLINT;, &cv-link-DOCBOOK_XMLLINTCOM;, &cv-link-DOCBOOK_XMLLINTFLAGS;, &cv-link-DOCBOOK_XSLTPROC;, &cv-link-DOCBOOK_XSLTPROCCOM;, &cv-link-DOCBOOK_XSLTPROCFLAGS;, &cv-link-DOCBOOK_XSLTPROCPARAMS;.</para><para>Uses: &cv-link-DOCBOOK_FOPCOMSTR;, &cv-link-DOCBOOK_XMLLINTCOMSTR;, &cv-link-DOCBOOK_XSLTPROCCOMSTR;.</para></listitem> + </varlistentry> <varlistentry id="t-dvi"> <term>dvi</term> <listitem> diff --git a/doc/generated/tools.mod b/doc/generated/tools.mod index bde24705e..0a746b039 100644 --- a/doc/generated/tools.mod +++ b/doc/generated/tools.mod @@ -24,6 +24,7 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. <!ENTITY t-cXX "<literal xmlns='http://www.scons.org/dbxsd/v1.0'>cXX</literal>"> <!ENTITY t-default "<literal xmlns='http://www.scons.org/dbxsd/v1.0'>default</literal>"> <!ENTITY t-dmd "<literal xmlns='http://www.scons.org/dbxsd/v1.0'>dmd</literal>"> +<!ENTITY t-docbook "<literal xmlns='http://www.scons.org/dbxsd/v1.0'>docbook</literal>"> <!ENTITY t-dvi "<literal xmlns='http://www.scons.org/dbxsd/v1.0'>dvi</literal>"> <!ENTITY t-dvipdf "<literal xmlns='http://www.scons.org/dbxsd/v1.0'>dvipdf</literal>"> <!ENTITY t-dvips "<literal xmlns='http://www.scons.org/dbxsd/v1.0'>dvips</literal>"> @@ -130,6 +131,7 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. <!ENTITY t-link-cXX "<link linkend='t-cXX' xmlns='http://www.scons.org/dbxsd/v1.0'><literal>cXX</literal></link>"> <!ENTITY t-link-default "<link linkend='t-default' xmlns='http://www.scons.org/dbxsd/v1.0'><literal>default</literal></link>"> <!ENTITY t-link-dmd "<link linkend='t-dmd' xmlns='http://www.scons.org/dbxsd/v1.0'><literal>dmd</literal></link>"> +<!ENTITY t-link-docbook "<link linkend='t-docbook' xmlns='http://www.scons.org/dbxsd/v1.0'><literal>docbook</literal></link>"> <!ENTITY t-link-dvi "<link linkend='t-dvi' xmlns='http://www.scons.org/dbxsd/v1.0'><literal>dvi</literal></link>"> <!ENTITY t-link-dvipdf "<link linkend='t-dvipdf' xmlns='http://www.scons.org/dbxsd/v1.0'><literal>dvipdf</literal></link>"> <!ENTITY t-link-dvips "<link linkend='t-dvips' xmlns='http://www.scons.org/dbxsd/v1.0'><literal>dvips</literal></link>"> diff --git a/doc/generated/variables.gen b/doc/generated/variables.gen index c2e83aebb..18281122c 100644 --- a/doc/generated/variables.gen +++ b/doc/generated/variables.gen @@ -909,6 +909,194 @@ into a list of Dir instances relative to the target being built. </para> </listitem> </varlistentry> + <varlistentry id="cv-DOCBOOK_DEFAULT_XSL_HTML"> + <term>DOCBOOK_DEFAULT_XSL_HTML</term> + <listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +The default XSLT file for the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-DocbookHtml"><function>DocbookHtml</function></link> builder within the +current environment, if no other XSLT gets specified via keyword. +</para> +</listitem> + </varlistentry> + <varlistentry id="cv-DOCBOOK_DEFAULT_XSL_HTMLCHUNKED"> + <term>DOCBOOK_DEFAULT_XSL_HTMLCHUNKED</term> + <listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +The default XSLT file for the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-DocbookHtmlChunked"><function>DocbookHtmlChunked</function></link> builder within the +current environment, if no other XSLT gets specified via keyword. +</para> +</listitem> + </varlistentry> + <varlistentry id="cv-DOCBOOK_DEFAULT_XSL_HTMLHELP"> + <term>DOCBOOK_DEFAULT_XSL_HTMLHELP</term> + <listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +The default XSLT file for the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-DocbookHtmlhelp"><function>DocbookHtmlhelp</function></link> builder within the +current environment, if no other XSLT gets specified via keyword. +</para> +</listitem> + </varlistentry> + <varlistentry id="cv-DOCBOOK_DEFAULT_XSL_MAN"> + <term>DOCBOOK_DEFAULT_XSL_MAN</term> + <listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +The default XSLT file for the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-DocbookMan"><function>DocbookMan</function></link> builder within the +current environment, if no other XSLT gets specified via keyword. +</para> +</listitem> + </varlistentry> + <varlistentry id="cv-DOCBOOK_DEFAULT_XSL_PDF"> + <term>DOCBOOK_DEFAULT_XSL_PDF</term> + <listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +The default XSLT file for the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-DocbookPdf"><function>DocbookPdf</function></link> builder within the +current environment, if no other XSLT gets specified via keyword. +</para> +</listitem> + </varlistentry> + <varlistentry id="cv-DOCBOOK_DEFAULT_XSL_SLIDESHTML"> + <term>DOCBOOK_DEFAULT_XSL_SLIDESHTML</term> + <listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +The default XSLT file for the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-DocbookSlidesHtml"><function>DocbookSlidesHtml</function></link> builder within the +current environment, if no other XSLT gets specified via keyword. +</para> +</listitem> + </varlistentry> + <varlistentry id="cv-DOCBOOK_DEFAULT_XSL_SLIDESPDF"> + <term>DOCBOOK_DEFAULT_XSL_SLIDESPDF</term> + <listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +The default XSLT file for the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-DocbookSlidesPdf"><function>DocbookSlidesPdf</function></link> builder within the +current environment, if no other XSLT gets specified via keyword. +</para> +</listitem> + </varlistentry> + <varlistentry id="cv-DOCBOOK_FOP"> + <term>DOCBOOK_FOP</term> + <listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +The path to the PDF renderer <literal>fop</literal> or <literal>xep</literal>, +if one of them is installed (<literal>fop</literal> gets checked first). +</para> +</listitem> + </varlistentry> + <varlistentry id="cv-DOCBOOK_FOPCOM"> + <term>DOCBOOK_FOPCOM</term> + <listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +The full command-line for the +PDF renderer <literal>fop</literal> or <literal>xep</literal>. +</para> +</listitem> + </varlistentry> + <varlistentry id="cv-DOCBOOK_FOPCOMSTR"> + <term>DOCBOOK_FOPCOMSTR</term> + <listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +The string displayed when a renderer like <literal>fop</literal> or +<literal>xep</literal> is used to create PDF output from an XML file. +</para> +</listitem> + </varlistentry> + <varlistentry id="cv-DOCBOOK_FOPFLAGS"> + <term>DOCBOOK_FOPFLAGS</term> + <listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +Additonal command-line flags for the +PDF renderer <literal>fop</literal> or <literal>xep</literal>. +</para> +</listitem> + </varlistentry> + <varlistentry id="cv-DOCBOOK_XMLLINT"> + <term>DOCBOOK_XMLLINT</term> + <listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +The path to the external executable <literal>xmllint</literal>, if it's installed. +Note, that this is only used as last fallback for resolving +XIncludes, if no libxml2 or lxml Python binding can be imported +in the current system. +</para> +</listitem> + </varlistentry> + <varlistentry id="cv-DOCBOOK_XMLLINTCOM"> + <term>DOCBOOK_XMLLINTCOM</term> + <listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +The full command-line for the external executable +<literal>xmllint</literal>. +</para> +</listitem> + </varlistentry> + <varlistentry id="cv-DOCBOOK_XMLLINTCOMSTR"> + <term>DOCBOOK_XMLLINTCOMSTR</term> + <listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +The string displayed when <literal>xmllint</literal> is used to resolve +XIncludes for a given XML file. +</para> +</listitem> + </varlistentry> + <varlistentry id="cv-DOCBOOK_XMLLINTFLAGS"> + <term>DOCBOOK_XMLLINTFLAGS</term> + <listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +Additonal command-line flags for the external executable +<literal>xmllint</literal>. +</para> +</listitem> + </varlistentry> + <varlistentry id="cv-DOCBOOK_XSLTPROC"> + <term>DOCBOOK_XSLTPROC</term> + <listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +The path to the external executable <literal>xsltproc</literal> +(or <literal>saxon</literal>, <literal>xalan</literal>), if one of them +is installed. +Note, that this is only used as last fallback for XSL transformations, if +no libxml2 or lxml Python binding can be imported in the current system. +</para> +</listitem> + </varlistentry> + <varlistentry id="cv-DOCBOOK_XSLTPROCCOM"> + <term>DOCBOOK_XSLTPROCCOM</term> + <listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +The full command-line for the external executable +<literal>xsltproc</literal> (or <literal>saxon</literal>, +<literal>xalan</literal>). +</para> +</listitem> + </varlistentry> + <varlistentry id="cv-DOCBOOK_XSLTPROCCOMSTR"> + <term>DOCBOOK_XSLTPROCCOMSTR</term> + <listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +The string displayed when <literal>xsltproc</literal> is used to transform +an XML file via a given XSLT stylesheet. +</para> +</listitem> + </varlistentry> + <varlistentry id="cv-DOCBOOK_XSLTPROCFLAGS"> + <term>DOCBOOK_XSLTPROCFLAGS</term> + <listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +Additonal command-line flags for the external executable +<literal>xsltproc</literal> (or <literal>saxon</literal>, +<literal>xalan</literal>). +</para> +</listitem> + </varlistentry> + <varlistentry id="cv-DOCBOOK_XSLTPROCPARAMS"> + <term>DOCBOOK_XSLTPROCPARAMS</term> + <listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +Additonal parameters that are not intended for the XSLT processor executable, but +the XSL processing itself. By default, they get appended at the end of the command line +for <literal>saxon</literal> and <literal>saxon-xslt</literal>, respectively. +</para> +</listitem> + </varlistentry> <varlistentry id="cv-DSUFFIXES"> <term>DSUFFIXES</term> <listitem> diff --git a/doc/generated/variables.mod b/doc/generated/variables.mod index 28b0d41c2..7247f554e 100644 --- a/doc/generated/variables.mod +++ b/doc/generated/variables.mod @@ -70,6 +70,26 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. <!ENTITY cv-DESCRIPTION_lang "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$DESCRIPTION_lang</envar>"> <!ENTITY cv-Dir "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$Dir</envar>"> <!ENTITY cv-Dirs "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$Dirs</envar>"> +<!ENTITY cv-DOCBOOK_DEFAULT_XSL_HTML "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$DOCBOOK_DEFAULT_XSL_HTML</envar>"> +<!ENTITY cv-DOCBOOK_DEFAULT_XSL_HTMLCHUNKED "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$DOCBOOK_DEFAULT_XSL_HTMLCHUNKED</envar>"> +<!ENTITY cv-DOCBOOK_DEFAULT_XSL_HTMLHELP "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$DOCBOOK_DEFAULT_XSL_HTMLHELP</envar>"> +<!ENTITY cv-DOCBOOK_DEFAULT_XSL_MAN "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$DOCBOOK_DEFAULT_XSL_MAN</envar>"> +<!ENTITY cv-DOCBOOK_DEFAULT_XSL_PDF "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$DOCBOOK_DEFAULT_XSL_PDF</envar>"> +<!ENTITY cv-DOCBOOK_DEFAULT_XSL_SLIDESHTML "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$DOCBOOK_DEFAULT_XSL_SLIDESHTML</envar>"> +<!ENTITY cv-DOCBOOK_DEFAULT_XSL_SLIDESPDF "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$DOCBOOK_DEFAULT_XSL_SLIDESPDF</envar>"> +<!ENTITY cv-DOCBOOK_FOP "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$DOCBOOK_FOP</envar>"> +<!ENTITY cv-DOCBOOK_FOPCOM "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$DOCBOOK_FOPCOM</envar>"> +<!ENTITY cv-DOCBOOK_FOPCOMSTR "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$DOCBOOK_FOPCOMSTR</envar>"> +<!ENTITY cv-DOCBOOK_FOPFLAGS "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$DOCBOOK_FOPFLAGS</envar>"> +<!ENTITY cv-DOCBOOK_XMLLINT "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$DOCBOOK_XMLLINT</envar>"> +<!ENTITY cv-DOCBOOK_XMLLINTCOM "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$DOCBOOK_XMLLINTCOM</envar>"> +<!ENTITY cv-DOCBOOK_XMLLINTCOMSTR "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$DOCBOOK_XMLLINTCOMSTR</envar>"> +<!ENTITY cv-DOCBOOK_XMLLINTFLAGS "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$DOCBOOK_XMLLINTFLAGS</envar>"> +<!ENTITY cv-DOCBOOK_XSLTPROC "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$DOCBOOK_XSLTPROC</envar>"> +<!ENTITY cv-DOCBOOK_XSLTPROCCOM "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$DOCBOOK_XSLTPROCCOM</envar>"> +<!ENTITY cv-DOCBOOK_XSLTPROCCOMSTR "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$DOCBOOK_XSLTPROCCOMSTR</envar>"> +<!ENTITY cv-DOCBOOK_XSLTPROCFLAGS "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$DOCBOOK_XSLTPROCFLAGS</envar>"> +<!ENTITY cv-DOCBOOK_XSLTPROCPARAMS "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$DOCBOOK_XSLTPROCPARAMS</envar>"> <!ENTITY cv-DSUFFIXES "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$DSUFFIXES</envar>"> <!ENTITY cv-DVIPDF "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$DVIPDF</envar>"> <!ENTITY cv-DVIPDFCOM "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$DVIPDFCOM</envar>"> @@ -630,6 +650,26 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. <!ENTITY cv-link-DESCRIPTION_lang "<link linkend='cv-DESCRIPTION_lang' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$DESCRIPTION_lang</envar></link>"> <!ENTITY cv-link-Dir "<link linkend='cv-Dir' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$Dir</envar></link>"> <!ENTITY cv-link-Dirs "<link linkend='cv-Dirs' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$Dirs</envar></link>"> +<!ENTITY cv-link-DOCBOOK_DEFAULT_XSL_HTML "<link linkend='cv-DOCBOOK_DEFAULT_XSL_HTML' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$DOCBOOK_DEFAULT_XSL_HTML</envar></link>"> +<!ENTITY cv-link-DOCBOOK_DEFAULT_XSL_HTMLCHUNKED "<link linkend='cv-DOCBOOK_DEFAULT_XSL_HTMLCHUNKED' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$DOCBOOK_DEFAULT_XSL_HTMLCHUNKED</envar></link>"> +<!ENTITY cv-link-DOCBOOK_DEFAULT_XSL_HTMLHELP "<link linkend='cv-DOCBOOK_DEFAULT_XSL_HTMLHELP' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$DOCBOOK_DEFAULT_XSL_HTMLHELP</envar></link>"> +<!ENTITY cv-link-DOCBOOK_DEFAULT_XSL_MAN "<link linkend='cv-DOCBOOK_DEFAULT_XSL_MAN' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$DOCBOOK_DEFAULT_XSL_MAN</envar></link>"> +<!ENTITY cv-link-DOCBOOK_DEFAULT_XSL_PDF "<link linkend='cv-DOCBOOK_DEFAULT_XSL_PDF' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$DOCBOOK_DEFAULT_XSL_PDF</envar></link>"> +<!ENTITY cv-link-DOCBOOK_DEFAULT_XSL_SLIDESHTML "<link linkend='cv-DOCBOOK_DEFAULT_XSL_SLIDESHTML' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$DOCBOOK_DEFAULT_XSL_SLIDESHTML</envar></link>"> +<!ENTITY cv-link-DOCBOOK_DEFAULT_XSL_SLIDESPDF "<link linkend='cv-DOCBOOK_DEFAULT_XSL_SLIDESPDF' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$DOCBOOK_DEFAULT_XSL_SLIDESPDF</envar></link>"> +<!ENTITY cv-link-DOCBOOK_FOP "<link linkend='cv-DOCBOOK_FOP' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$DOCBOOK_FOP</envar></link>"> +<!ENTITY cv-link-DOCBOOK_FOPCOM "<link linkend='cv-DOCBOOK_FOPCOM' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$DOCBOOK_FOPCOM</envar></link>"> +<!ENTITY cv-link-DOCBOOK_FOPCOMSTR "<link linkend='cv-DOCBOOK_FOPCOMSTR' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$DOCBOOK_FOPCOMSTR</envar></link>"> +<!ENTITY cv-link-DOCBOOK_FOPFLAGS "<link linkend='cv-DOCBOOK_FOPFLAGS' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$DOCBOOK_FOPFLAGS</envar></link>"> +<!ENTITY cv-link-DOCBOOK_XMLLINT "<link linkend='cv-DOCBOOK_XMLLINT' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$DOCBOOK_XMLLINT</envar></link>"> +<!ENTITY cv-link-DOCBOOK_XMLLINTCOM "<link linkend='cv-DOCBOOK_XMLLINTCOM' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$DOCBOOK_XMLLINTCOM</envar></link>"> +<!ENTITY cv-link-DOCBOOK_XMLLINTCOMSTR "<link linkend='cv-DOCBOOK_XMLLINTCOMSTR' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$DOCBOOK_XMLLINTCOMSTR</envar></link>"> +<!ENTITY cv-link-DOCBOOK_XMLLINTFLAGS "<link linkend='cv-DOCBOOK_XMLLINTFLAGS' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$DOCBOOK_XMLLINTFLAGS</envar></link>"> +<!ENTITY cv-link-DOCBOOK_XSLTPROC "<link linkend='cv-DOCBOOK_XSLTPROC' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$DOCBOOK_XSLTPROC</envar></link>"> +<!ENTITY cv-link-DOCBOOK_XSLTPROCCOM "<link linkend='cv-DOCBOOK_XSLTPROCCOM' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$DOCBOOK_XSLTPROCCOM</envar></link>"> +<!ENTITY cv-link-DOCBOOK_XSLTPROCCOMSTR "<link linkend='cv-DOCBOOK_XSLTPROCCOMSTR' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$DOCBOOK_XSLTPROCCOMSTR</envar></link>"> +<!ENTITY cv-link-DOCBOOK_XSLTPROCFLAGS "<link linkend='cv-DOCBOOK_XSLTPROCFLAGS' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$DOCBOOK_XSLTPROCFLAGS</envar></link>"> +<!ENTITY cv-link-DOCBOOK_XSLTPROCPARAMS "<link linkend='cv-DOCBOOK_XSLTPROCPARAMS' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$DOCBOOK_XSLTPROCPARAMS</envar></link>"> <!ENTITY cv-link-DSUFFIXES "<link linkend='cv-DSUFFIXES' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$DSUFFIXES</envar></link>"> <!ENTITY cv-link-DVIPDF "<link linkend='cv-DVIPDF' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$DVIPDF</envar></link>"> <!ENTITY cv-link-DVIPDFCOM "<link linkend='cv-DVIPDFCOM' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$DVIPDFCOM</envar></link>"> diff --git a/doc/man/scons.xml b/doc/man/scons.xml index a7ed37efb..7d8a53f29 100644 --- a/doc/man/scons.xml +++ b/doc/man/scons.xml @@ -60,9 +60,12 @@ </copyright> <releaseinfo>version &buildversion;</releaseinfo> - </referenceinfo> - + + <title>SCons &buildversion;</title> + <subtitle>MAN page</subtitle> + + <refentry id='scons1'> <refmeta> <refentrytitle>SCONS</refentrytitle> |