/usr/share/doc/refdb/refdb-manual/re25.html is in refdb-doc 1.0.2-3ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 | <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>refdbxml</title><link rel="stylesheet" type="text/css" href="manual.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="RefDB handbook" /><link rel="up" href="ch15.html" title="Chapter 15. Tools for bibliographies" /><link rel="prev" href="re24.html" title="refdbjade" /><link rel="next" href="re26.html" title="refdbrtf" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">refdbxml</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="re24.html">Prev</a> </td><th width="60%" align="center">Chapter 15. Tools for bibliographies</th><td width="20%" align="right"> <a accesskey="n" href="re26.html">Next</a></td></tr></table><hr /></div><div class="refentry"><a id="refentry-refdbxml"></a><div class="titlepage"></div><div class="refnamediv"><a id="refdbxml-name"></a><h2>Name</h2><p>refdbxml — transform XML documents containing RefDB bibliographies</p></div><div class="refsynopsisdiv"><a id="refdbxml-synopsis"></a><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">refdbxml</code> [<code class="option">-c</code> <em class="replaceable"><code>fop_config_file</code></em>] [<code class="option">-f</code> <em class="replaceable"><code>fo_processor</code></em>] [<code class="option">-h</code> ] [<code class="option">-p</code> <em class="replaceable"><code>xslt-processor</code></em>] [<code class="option">-s</code> <em class="replaceable"><code>stylesheet</code></em>] [<code class="option">-t</code> <em class="replaceable"><code>format</code></em>] <em class="replaceable"><code>file</code></em> </p></div></div><div class="refsect1"><a id="refdbxml-description"></a><h2>Description</h2><p>refdbxml uses the stylesheet driver file that you created with runbib(1) and feeds it to an XSLT processor to transform your DocBook or TEI XML document to one of the supported output formats. If printable output is requested, the intermediate FO output will be further processed by a FO processor.</p></div><div class="refsect1"><a id="refdbxml-options"></a><h2>Options</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-c</code> <em class="replaceable"><code>fop_config_file</code></em></span></dt><dd><p>The path to a custom configuration file for the FO processor <a class="ulink" href="http://xmlgraphics.apache.org/fop/" target="_top">FOP</a>.</p></dd><dt><span class="term"><code class="option">-f</code> <em class="replaceable"><code>fo_processor</code></em></span></dt><dd><p>The name of the FO processor used to transform FO files into printable output. Supported values are <span class="emphasis"><em>fop</em></span> (default), <span class="emphasis"><em>passivetex</em></span>, <span class="emphasis"><em>xep</em></span>, and <span class="emphasis"><em>xfor</em></span>.</p></dd><dt><span class="term"><code class="option">-h</code></span></dt><dd><p>Prints a command synopsis on the screen and exits</p></dd><dt><span class="term"><code class="option">-i</code> <em class="replaceable"><code>variable</code></em></span></dt><dd><p>Define a variable that is passed to Jade/OpenJade. Multiple entries are possible. This can be used to conditionally include or exclude parts of the document according to which variable is set.</p></dd><dt><span class="term"><code class="option">-p</code> <em class="replaceable"><code>xslt-processor</code></em></span></dt><dd><p>This determines the XSL processor that is to be used. refdbxml currently knows to handle <span class="emphasis"><em>Xalan</em></span>, <span class="emphasis"><em>XT</em></span>, <span class="emphasis"><em>Saxon</em></span>, and <span class="emphasis"><em>xsltproc</em></span>.</p></dd><dt><span class="term"><code class="option">-s</code> <em class="replaceable"><code>stylesheet</code></em></span></dt><dd><p>This selects the stylesheet driver file. This file is generated by refdbib(1) (which in turn is called by runbib(1)) and contains additional formatting information.</p></dd><dt><span class="term"><code class="option">-t</code> <em class="replaceable"><code>format</code></em></span></dt><dd><p>Select an output format with this option. Possible values are <span class="emphasis"><em>html\fr, rtf</em></span>, and <span class="emphasis"><em>pdf</em></span>.</p></dd><dt><span class="term"><span class="emphasis"><em>file</em></span></span></dt><dd><p>The names of one or more XML files. Each document will be processed separately.</p></dd></dl></div></div><div class="refsect1"><a id="refdbxml-configuration"></a><h2>Configuration</h2><p>Instead of using the command-line switches, refdbxml can also be configured by means of the refdbxmlrc configuration file. As with all refdb configuration files, you may maintain a global copy in <code class="filename">/usr/local/etc/refdb/</code> and one copy per user in <code class="envar">$HOME</code>.</p><div class="table"><a id="idp69615696"></a><p class="title"><strong>Table 15.4. refdbxmlrc</strong></p><div class="table-contents"><table class="table" summary="refdbxmlrc" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Variable</th><th>Default</th><th>Comment</th></tr></thead><tbody><tr><td>xslt_processor</td><td>xsltproc</td><td>The name of the XSLT processor used to transform XML documents to html or fo files. Supported values are xsltproc (default), xalan, xt, saxon, saxon-xerces (using the xerces parser instead of the built-in parser)</td></tr><tr><td>xslt_classpath</td><td>/usr/share/java</td><td>Specify the directory which contains the Java classes for Java-based XSLT processors. This variable is not required if you use a non-Java processor (xsltproc).</td></tr><tr><td>fo_processor</td><td>fop</td><td>The name of the FO processor used to transform FO files into printable output. Supported values are fop (default), passivetex, xep, and xfor.</td></tr><tr><td>fo_classpath</td><td>/usr/share/java</td><td>Specify the directory which contains the Java classes for Java-based FO processors. This variable is not required if you use a non-Java processor (passivetex).</td></tr><tr><td>fop_config_file</td><td>(none)</td><td>The path to a custom configuration file for FOP.</td></tr><tr><td>outformat</td><td>html</td><td>Set the default output format. Supported values are html, xhtml, pdf, and rtf. Be aware that pdf and rtf are not supported by all FO processors.</td></tr></tbody></table></div></div><br class="table-break" /></div><div class="refsect1"><a id="refdbxml-pubid"></a><h2>Resolving Public Identifiers</h2><p>Public identifiers can be resolved to local files if you have a working XML catalog on your system and if your XSLT processor supports XML catalogs. xalan and saxon require additional Java classes to support XML catalogs. For further information, please consult Bob Stayton's <a class="ulink" href="http://www.sagehill.net/docbookxsl/UseCatalog.html" target="_top">book</a> about XSLT.</p></div><div class="refsect1"><a id="refdbxml-files"></a><h2>Files</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="filename">/usr/local/etc/refdb/refdbxmlrc</code></span></dt><dd><p>The global configuration file of refdbxml</p></dd><dt><span class="term"><span class="emphasis"><em>$HOME/.refdbxmlrc</em></span></span></dt><dd><p>The user configuration file of refdbxml.</p></dd><dt><span class="term"><code class="filename">/etc/xml/catalog</code></span></dt><dd><p>The global XML catalog file, used to resolve public identifiers. Please note that the location of this file is system-dependent. Also, some XSLT processors do not support catalogs, and others require additional classes or plugins to do so.</p></dd></dl></div></div><div class="refsect1"><a id="refdbxml-example"></a><h2>Example</h2><p>We'll transform our document (which is either a DocBook or TEI XML document) to a nice-looking PDF file with the following command:</p><pre class="screen">
<code class="prompt">~$ </code>
<strong class="userinput"><code>refdbxml -d J.Biol.Chem.fo.xsl -t pdf mypaper.xml</code></strong>
</pre><p>Note that we used the FO stylesheet for this purpose. If we want HTML output, we need to change the output type switch and use the corresponding HTML stylesheet:</p><pre class="screen">
<code class="prompt">~$ </code>
<strong class="userinput"><code>refdbxml -d J.Biol.Chem.html.xsl -t html mypaper.xml</code></strong>
</pre></div><div class="refsect1"><a id="refdbxml-see_also"></a><h2>See also</h2><p><span class="emphasis"><em>RefDB</em></span> (7),
<span class="emphasis"><em><a class="link" href="re20.html" title="refdbib">refdbib</a></em></span> (1),
<span class="emphasis"><em><a class="link" href="re22.html" title="runbib">runbib</a></em></span> (1),
<span class="emphasis"><em><a class="link" href="re24.html" title="refdbjade">refdbjade</a></em></span> (1).</p><p><span class="emphasis"><em>RefDB manual (local copy) </em></span> PREFIX/share/doc/refdb-<version>/refdb-manual/index.html</p><p><span class="emphasis"><em>RefDB manual (web) </em></span> <<a class="ulink" href="http://refdb.sourceforge.net/manual/index.html" target="_top">http://refdb.sourceforge.net/manual/index.html</a>></p><p><span class="emphasis"><em>RefDB on the web </em></span> <<a class="ulink" href="http://refdb.sourceforge.net/" target="_top">http://refdb.sourceforge.net/</a>></p></div><div class="refsect1"><a id="refdbxml-author"></a><h2>Author</h2><p>refdbxml was written by Markus Hoenicka <markus@mhoenicka.de>.</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="re24.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch15.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="re26.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">refdbjade </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> refdbrtf</td></tr></table></div></body></html>
|