/usr/share/doc/refdb/refdb-manual/re24.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>refdbjade</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="re23.html" title="runbib-missing" /><link rel="next" href="re25.html" title="refdbxml" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">refdbjade</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="re23.html">Prev</a> </td><th width="60%" align="center">Chapter 15. Tools for bibliographies</th><td width="20%" align="right"> <a accesskey="n" href="re25.html">Next</a></td></tr></table><hr /></div><div class="refentry"><a id="refentry-refdbjade"></a><div class="titlepage"></div><div class="refnamediv"><a id="refdbjade-name"></a><h2>Name</h2><p>refdbjade — transform SGML and XML documents containing RefDB bibliographies</p></div><div class="refsynopsisdiv"><a id="refdbjade-synopsis"></a><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">refdbjade</code> [<code class="option">-h</code> ] [<code class="option">-I</code> <em class="replaceable"><code>name</code></em>] [<code class="option">-j</code> <em class="replaceable"><code>jade-args</code></em>] [<code class="option">-p</code> <em class="replaceable"><code>prefix</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>] [<code class="option">-v</code> <em class="replaceable"><code>variable[=name]</code></em>] <em class="replaceable"><code>file</code></em> </p></div></div><div class="refsect1"><a id="refdbjade-description"></a><h2>Description</h2><p>refdbjade uses the stylesheet driver file that you created with <a class="link" href="re22.html" title="runbib">runbib</a>(1) and feeds it to Jade/OpenJade to transform your DocBook SGML or XML document to one of the supported output formats.</p><p>Note: If you prefer to transform your DocBook XML document with the XSL stylesheets as most people do these days, please use <a class="link" href="re25.html" title="refdbxml">refdbxml</a>(1) instead.</p></div><div class="refsect1"><a id="refdbjade-options"></a><h2>Options</h2><div class="variablelist"><dl class="variablelist"><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>name</code></em></span></dt><dd><p>Change the value of an entity declaration to include marked sections. Multiple entries are possible. These are passed as <code class="option">-i</code> options to Jade/OpenJade.</p></dd><dt><span class="term"><code class="option">-j</code> <em class="replaceable"><code>jade-args</code></em></span></dt><dd><p>Set additional command line options for Jade/OpenJade</p></dd><dt><span class="term"><code class="option">-p</code> <em class="replaceable"><code>prefix</code></em></span></dt><dd><p>This determines a prefix that is added to all filenames that Jade/OpenJade create. This can be useful to avoid filename conflicts if you transform or use several DocBook documents in the same folder.</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</em></span>, <span class="emphasis"><em>rtf</em></span>, <span class="emphasis"><em>dvi</em></span>, <span class="emphasis"><em>pdf</em></span>, <span class="emphasis"><em>ps</em></span>, <span class="emphasis"><em>tex</em></span>, to generate HTML, RTF, DVI, PDF, PostScript, or JadeTeX output, respectively. Use <span class="emphasis"><em>tps</em></span> and <span class="emphasis"><em>tpdf</em></span> to create PostScript or PDF output, respectively, from the intermediate JadeTeX output generated by any of the switches <span class="emphasis"><em>dvi</em></span>, <span class="emphasis"><em>pdf</em></span>, <span class="emphasis"><em>ps</em></span>, or <span class="emphasis"><em>tex</em></span>. This is useful if you have to edit the intermediate JadeTeX file, e.g. to manually shift pagebreaks. If your DSSSL engine of choice is OpenJade, you can use <span class="emphasis"><em>htmlr</em></span> to generate raw HTML output (the same as HTML but without these funny linefeeds in the end tags).</p></dd><dt><span class="term"><code class="option">-v</code> <em class="replaceable"><code>variable[=value]</code></em></span></dt><dd><p>Change the value of a variable in the stylesheet. Multiple entries are possible. These are passed as such to Jade/OpenJade. The syntax "variable" causes "variable" to be set to "#t". The extended syntax "variable[=value]" sets the variable to the given value.</p></dd><dt><span class="term"><span class="emphasis"><em>file</em></span></span></dt><dd><p>The names of one or more SGML or XML files. Each document will be processed separately.</p></dd></dl></div></div><div class="refsect1"><a id="refdbjade-configuration"></a><h2>Configuration</h2><p>Instead of using the command-line switches, refdbjade can also be configured by means of the refdbjaderc 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="idp69529120"></a><p class="title"><strong>Table 15.3. refdbjaderc</strong></p><div class="table-contents"><table class="table" summary="refdbjaderc" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Variable</th><th>Default</th><th>Comment</th></tr></thead><tbody><tr><td>jade_includearg</td><td>none</td><td>Change the value of an entity declaration to include marked sections. Multiple entries are possible. These are passed as <code class="option">-i</code> options to Jade/OpenJade.</td></tr><tr><td>jade_variable</td><td>none</td><td>Change the value of a variable in the stylesheet. Multiple entries are possible. These are passed as <code class="option">-v</code> options to Jade/OpenJade. The syntax "variable" causes "variable" to be set to "#t". The extended syntax "variable[=value]" sets the variable to the given value.</td></tr><tr><td>jadeargs</td><td>none</td><td>Set additional command line options for Jade/OpenJade. Use e.g. "-E 0" to disable the maximum error limit</td></tr><tr><td>outformat</td><td>tex</td><td>Set the default output format. Supported values are tex, html, rtf, dvi, pdf, ps, tps, and tpdf</td></tr></tbody></table></div></div><br class="table-break" /></div><div class="refsect1"><a id="refdbjade-environment"></a><h2>Environment</h2><p><span class="emphasis"><em>SGML_CATALOG_FILES</em></span></p><p>This environment variable is consulted to resolve public identifiers in the SGML source documents. It is advisable to keep local copies of the DTD files and add <span class="command"><strong>OVERRIDE YES</strong></span> to the top of your catalog files. This ensures that the local copies are used and avoids unnecessary network traffic.</p></div><div class="refsect1"><a id="refdbjade-example"></a><h2>Example</h2><p>Here we'll use the files generated in the last example above (see <a class="link" href="re22.html" title="runbib">runbib</a>) and generate a nicely formatted PDF file:</p><pre class="screen">
<code class="prompt">~$ </code>
<strong class="userinput"><code>refdbjade -d J.Biol.Chem.dsl -t pdf mypaper.sgml</code></strong>
</pre><p>To obtain HTML output, you just change the output type switch:</p><pre class="screen">
<code class="prompt">~$ </code>
<strong class="userinput"><code>refdbjade -d J.Biol.Chem.dsl -t html mypaper.sgml</code></strong>
</pre></div><div class="refsect1"><a id="refdbjade-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="re25.html" title="refdbxml">refdbxml</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="refdbjade-author"></a><h2>Author</h2><p>refdbjade 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="re23.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="re25.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">runbib-missing </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> refdbxml</td></tr></table></div></body></html>
|