← Back to branch summary

~ubuntu-branches/ubuntu/precise/dblatex/precise

« back to all changes in this revision

Viewing changes to docs/xhtml/manual/ref-dblatex.html

  • Committer: Package Import Robot
  • Author(s): Andreas Hoenen
  • Date: 2011-07-09 15:20:37 UTC
  • mfrom: (0.8.1) (0.6.2) (8.1.7 sid)
  • mto: This revision was merged to the branch mainline in revision 9.
  • Revision ID: package-import@ubuntu.com-20110709152037-8ao9l07dmgyjn6vn
http://bugs.debian.org/629110
http://bugs.debian.org/629514
* New upstram release
* New upstream release fixes the following open Debian BTS issues:
  + Don't crash on XeTeX backend compilation of spanish documents with an
    <appendix> element.  Thanks to W. Martin Borgert for reporting.
    Closes: #629110
* Remove patches that have been integrated upstream:
  + 20_filename_replaceable.patch (#623590)
* Take over actualized copyright period of upstream COPYRIGHT to
  debian/copyright.
* Replace python build helper dh_pysupport with dh_python2.
* In draft mode set draft watermark for XeTeX backend, too.  Thanks to W.
  Martin Borgert for reporting and for the patch.  Closes: #629514

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/xhtml/manual/ref-dblatex.html
 
1
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
 
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
3
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>dblatex</title><link rel="stylesheet" href="manual.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /><link rel="start" href="index.html" title="DocBook to LaTeX Publishing" /><link rel="up" href="ch03.html#id3406628" title="Reference" /><link rel="prev" href="ch03.html#id3406628" title="Reference" /><link rel="next" href="sec-style.html" title="Output Formatting Style" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">dblatex</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch03.html#id3406628">Prev</a> </td><th width="60%" align="center">Reference</th><td width="20%" align="right"> <a accesskey="n" href="sec-style.html">Next</a></td></tr></table><hr /></div><div class="refentry" lang="en" xml:lang="en"><a id="ref-dblatex"></a><div class="titlepage"></div><div class="refnamediv"><h2><span class="refentrytitle">dblatex</span></h2><p>dblatex — 
 
4
      convert <span class="application">DocBook</span> to
 
5
      <span class="application">LaTeX</span>, <span class="application">DVI</span>,
 
6
      <span class="application">PostScript</span>, and <span class="application">PDF</span>
 
7
    </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">dblatex</code>  [<code class="option">options</code>]  {<em class="replaceable"><code>file</code></em> | -} </p></div></div><div class="refsection" lang="en" xml:lang="en"><a id="id2634176"></a><h2>Description</h2><p>
 
8
      <span class="command"><strong>dblatex</strong></span> is a program that transforms your
 
9
      <span class="application">SGML</span>/<span class="application">XML</span>
 
10
      <span class="application">DocBook</span> documents to
 
11
      <span class="application">DVI</span>, <span class="application">PostScript</span> or
 
12
      <span class="application">PDF</span> by translating them into pure
 
13
      <span class="application">LaTeX</span> as a first process.
 
14
      <span class="application">MathML 2.0</span> markups are supported, too.
 
15
      
 
16
    </p></div><div class="refsection" lang="en" xml:lang="en"><a id="id3406806"></a><h2>Options</h2><p>
 
17
      A summary of options is included below. 
 
18
    </p><div class="variablelist"><dl><dt><span class="term"><code class="option">-h</code>, </span><span class="term"><code class="option">--help</code></span></dt><dd>Show a help message and exit.</dd><dt><span class="term"><code class="option">-b <em class="replaceable"><code>backend</code></em></code>, </span><span class="term">
 
19
          <code class="option">--backend=<em class="replaceable"><code>backend</code></em></code>
 
20
        </span></dt><dd>
 
21
            Backend driver to use: <em class="parameter"><code>pdftex</code></em> (default),
 
22
            <em class="parameter"><code>dvips</code></em>, or <em class="parameter"><code>xetex</code></em>.
 
23
            <span>
 
24
            See also <a class="xref" href="ch01s05.html#sec-process" title="Backend Drivers">the section called “Backend Drivers”</a>.</span>
 
25
          </dd><dt><span class="term"><code class="option">-B</code>, </span><span class="term"><code class="option">--no-batch</code></span></dt><dd>All the tex output is printed.</dd><dt><span class="term"><code class="option">-c <em class="replaceable"><code>config</code></em></code>, </span><span class="term"><code class="option">-S <em class="replaceable"><code>config</code></em></code>, </span><span class="term"><code class="option">--config=<em class="replaceable"><code>config</code></em></code></span></dt><dd>Configuration file. A configuration file can be used to group
 
26
          all the options and customizations to apply. <span>See
 
27
          <a class="xref" href="sec-specs.html" title="Dblatex Configuration File">the section called “Dblatex Configuration File”</a>.</span>
 
28
          </dd><dt><span class="term"><code class="option">-d</code>, </span><span class="term"><code class="option">--debug</code></span></dt><dd>
 
29
            Debug mode: Keep the temporary directory in which dblatex actually
 
30
            works. <span><a class="xref" href="sec-custom-latex.html#sec-debug" title="Debugging your Style">the section called “Debugging your Style”</a> explains how
 
31
            you can use it.</span>
 
32
          </dd><dt><span class="term"><code class="option">-D</code>, </span><span class="term"><code class="option">--dump</code></span></dt><dd>
 
33
            Dump the error stack when an error occurs (debug purpose).
 
34
          </dd><dt><span class="term"><code class="option">-e <em class="replaceable"><code>indexstyle</code></em></code>, </span><span class="term"><code class="option">--indexstyle <em class="replaceable"><code>indexstyle</code></em></code></span></dt><dd>
 
35
            Index style file to pass to <span class="command"><strong>makeindex</strong></span> instead of
 
36
            the dblatex default index style.
 
37
          </dd><dt><span class="term"><code class="option">-f <em class="replaceable"><code>figure_format</code></em></code>, </span><span class="term">
 
38
          <code class="option">--fig-format=<em class="replaceable"><code>figure_format</code></em></code>
 
39
        </span></dt><dd>
 
40
            Input figure format: <em class="parameter"><code>fig</code></em>,
 
41
            <em class="parameter"><code>eps</code></em>.  Used when not deduced from figure file
 
42
            extension. <span>See also
 
43
            <a class="xref" href="sec-figinclude.html#sec-figconv" title="Converting on the fly">the section called “
 
44
    Converting on the fly
 
45
   ”</a>.</span>
 
46
          </dd><dt><span class="term"><code class="option">-F <em class="replaceable"><code>input_format</code></em></code>, </span><span class="term">
 
47
          <code class="option">--input-format=<em class="replaceable"><code>input_format</code></em></code>
 
48
        </span></dt><dd>
 
49
            Input file format: <em class="parameter"><code>sgml</code></em>,
 
50
            <em class="parameter"><code>xml</code></em> (default).
 
51
          </dd><dt><span class="term"><code class="option">-i <em class="replaceable"><code>texinputs</code></em></code>, </span><span class="term">
 
52
          <code class="option">--texinputs <em class="replaceable"><code>texinputs</code></em></code>
 
53
        </span></dt><dd>Path added to <code class="envar">TEXINPUTS</code></dd><dt><span class="term"><code class="option">-I <em class="replaceable"><code>figure_path</code></em></code>, </span><span class="term">
 
54
          <code class="option">--fig-path=<em class="replaceable"><code>figure_path</code></em></code>
 
55
        </span></dt><dd>Additional lookup path of the figures. <span>See <a class="xref" href="sec-figinclude.html#sec-lookup" title="Paths Lookup">the section called “
 
56
    Paths Lookup
 
57
   ”</a>.</span></dd><dt><span class="term"><code class="option">-l <em class="replaceable"><code>bst_path</code></em></code>, </span><span class="term">
 
58
          <code class="option">--bst-path=<em class="replaceable"><code>bst_path</code></em></code>
 
59
        </span></dt><dd>Additional lookup path of the BibTeX styles. <span>See <a class="xref" href="ch03s09.html#sec-bibtex" title="Using BibTeX Databases">the section called “Using BibTeX Databases”</a>.</span></dd><dt><span class="term"><code class="option">-L <em class="replaceable"><code>bib_path</code></em></code>, </span><span class="term">
 
60
          <code class="option">--bib-path=<em class="replaceable"><code>bib_path</code></em></code>
 
61
        </span></dt><dd>Additional lookup path of the BibTeX databases. <span>See <a class="xref" href="ch03s09.html#sec-bibtex" title="Using BibTeX Databases">the section called “Using BibTeX Databases”</a>.</span></dd><dt><span class="term"><code class="option">-m <em class="replaceable"><code>xslt</code></em></code>, </span><span class="term">
 
62
          <code class="option">--xslt=<em class="replaceable"><code>xslt</code></em></code>
 
63
        </span></dt><dd>XSLT engine to use. The available engines are:
 
64
          xsltproc (default), 4xslt.</dd><dt><span class="term"><code class="option">-o <em class="replaceable"><code>output</code></em></code>, </span><span class="term"><code class="option">--output=<em class="replaceable"><code>output</code></em></code></span></dt><dd>
 
65
            Output filename. When not specified, the input filename is used, with
 
66
            the suffix of the output format. The option is ignored if several
 
67
            books are chunked from a set. In this case the <code class="option">-O</code>
 
68
            option is applied instead.
 
69
          </dd><dt><span class="term"><code class="option">-O <em class="replaceable"><code>output_dir</code></em></code>, </span><span class="term"><code class="option">--output-dir=<em class="replaceable"><code>output_dir</code></em></code></span></dt><dd>
 
70
            Output directory of the books built from a set. When not specified,
 
71
            the current working directory is used instead. The option is ignored
 
72
            if a single document is outputed, and the <code class="option">-o</code> is
 
73
            taken into account.
 
74
          </dd><dt><span class="term"><code class="option">-p <em class="replaceable"><code>xsl_user</code></em></code>, </span><span class="term">
 
75
          <code class="option">--xsl-user=<em class="replaceable"><code>xsl_user</code></em></code>
 
76
        </span></dt><dd>
 
77
            An <span class="application">XSL</span> user stylesheet to use. Several
 
78
            user stylesheets can be specified, but the option order is meaningful.
 
79
            <span>See <a class="xref" href="sec-custom.html#sec-param" title="Using XSL Parameters">the section called “Using XSL Parameters”</a>.</span>
 
80
          </dd><dt><span class="term"><code class="option">-P <em class="replaceable"><code>param</code></em>=<em class="replaceable"><code>value</code></em></code>
 
81
        , </span><span class="term">
 
82
          <code class="option">--param=<em class="replaceable"><code>param</code></em>=<em class="replaceable"><code>value</code></em></code>
 
83
        </span></dt><dd>
 
84
            Set an <span class="application">XSL</span> parameter from command line.
 
85
            <span>See <a class="xref" href="sec-param-value.html" title="Setting Command line Parameters">the section called “Setting Command line Parameters”</a>.</span>
 
86
          </dd><dt><span class="term"><code class="option">-q</code>, </span><span class="term"><code class="option">--quiet</code></span></dt><dd>
 
87
            Less verbose, showing only TeX output messages and error messages.
 
88
          </dd><dt><span class="term"><code class="option">-r <em class="replaceable"><code>script</code></em></code>, </span><span class="term">
 
89
          <code class="option">--texpost=<em class="replaceable"><code>script</code></em></code>
 
90
        </span></dt><dd>
 
91
            Script called at the very end of the tex compilation. Its role is to
 
92
            modify the tex file or one of the compilation files before the last
 
93
            round.
 
94
            <span>See <a class="xref" href="sec-texpost.html" title="Latex post process script">the section called “Latex post process script”</a>.</span>
 
95
          </dd><dt><span class="term"><code class="option">-s <em class="replaceable"><code>latex_style</code></em></code>, </span><span class="term">
 
96
          <code class="option">--texstyle=<em class="replaceable"><code>latex_style</code></em></code>
 
97
        </span></dt><dd>
 
98
            Latex style to apply. It can be a package name, or directly a latex
 
99
            package path. A package name must be without a directory
 
100
            path and without the '.sty' extension. On the contrary,
 
101
            a full latex package path can contain a directory path, but must ends with
 
102
            the '.sty' extension.
 
103
            <span>See <a class="xref" href="sec-custom-latex.html" title="Customized LaTeX style">the section called “Customized LaTeX style”</a>.</span>
 
104
          </dd><dt><span class="term"><code class="option">-t <em class="replaceable"><code>format</code></em></code>, </span><span class="term"><code class="option">--type=<em class="replaceable"><code>format</code></em></code></span></dt><dd>
 
105
            Output format.  Available formats: <em class="parameter"><code>tex</code></em>,
 
106
            <em class="parameter"><code>dvi</code></em>, <em class="parameter"><code>ps</code></em>,
 
107
            <em class="parameter"><code>pdf</code></em> (default).
 
108
          </dd><dt><span class="term"><code class="option">--dvi</code></span></dt><dd>DVI output. Equivalent to <code class="option">-tdvi</code>.</dd><dt><span class="term"><code class="option">--pdf</code></span></dt><dd>PDF output. Equivalent to <code class="option">-tpdf</code>.</dd><dt><span class="term"><code class="option">--ps</code></span></dt><dd>
 
109
            PostScript output. Equivalent to <code class="option">-tps</code>.
 
110
          </dd><dt><span class="term"><code class="option">-T <em class="replaceable"><code>style</code></em></code>, </span><span class="term"><code class="option">--style=<em class="replaceable"><code>style</code></em></code></span></dt><dd>
 
111
            Output style, predefined are: <em class="parameter"><code>db2latex</code></em>,
 
112
            <em class="parameter"><code>simple</code></em>, <em class="parameter"><code>native</code></em>
 
113
            (default). <span>See <a class="xref" href="sec-style.html" title="Output Formatting Style">the section called “Output Formatting Style”</a>.
 
114
            </span>
 
115
          </dd><dt><span class="term"><code class="option">-v</code>, </span><span class="term"><code class="option">--version</code></span></dt><dd>Display the dblatex version.</dd><dt><span class="term"><code class="option">-V</code>, </span><span class="term"><code class="option">--verbose</code></span></dt><dd>Verbose mode, showing the running commands</dd><dt><span class="term"><code class="option">-x <em class="replaceable"><code>xslt_options</code></em></code>, </span><span class="term">
 
116
          <code class="option">--xslt-opts=<em class="replaceable"><code>xslt_options</code></em></code>
 
117
        </span></dt><dd>
 
118
            Arguments directly passed to the <span class="application">XSLT
 
119
            engine</span>
 
120
          </dd><dt><span class="term"><code class="option">-X</code>, </span><span class="term"><code class="option">--no-external</code></span></dt><dd>
 
121
            Disable the external text file support. This support is needed for
 
122
            callouts on external files referenced by <code class="sgmltag-element">textdata</code>
 
123
            or <code class="sgmltag-element">imagedata</code>, but it can be disabled if the document
 
124
            does not contain such callouts. Disabling this support can improve the
 
125
            processing performance for big documents.
 
126
          </dd></dl></div></div><div class="refsection" lang="en" xml:lang="en"><a id="id3407739"></a><h2>Files and Directories</h2><div class="variablelist"><dl><dt><span class="term"><code class="filename">$HOME/.dblatex/</code></span></dt><dd>
 
127
            User configuration directory.
 
128
          </dd><dt><span class="term"><code class="filename">/etc/dblatex/</code></span></dt><dd>
 
129
            System-wide configuration directory.
 
130
          </dd></dl></div><p>The predefined output styles are located in the installed package
 
131
    directory.</p></div><div class="refsection" lang="en" xml:lang="en"><a id="id3408063"></a><h2>Environment Variables</h2><div class="variablelist"><dl><dt><span class="term"><code class="envar">DBLATEX_CONFIG_FILES</code></span></dt><dd>
 
132
            Extra configuration directories that may contain some dblatex
 
133
            configuration files.
 
134
          </dd></dl></div></div><div class="refsection" lang="en" xml:lang="en"><a id="id3408087"></a><h2>Examples</h2><p>
 
135
      To produce <code class="filename">myfile.pdf</code> from
 
136
      <code class="filename">myfile.xml</code>:
 
137
      </p><pre class="screen">dblatex myfile.xml</pre><p>
 
138
    </p><p>
 
139
      To set some XSL parameters from the command line:
 
140
      </p><pre class="screen">dblatex -P latex.babel.language=de myfile.xml</pre><p>
 
141
    </p><p>
 
142
      To use the db2latex output style:
 
143
      </p><pre class="screen">dblatex -T db2latex myfile.xml</pre><p>
 
144
    </p><p>
 
145
      To apply your own latex style:
 
146
      </p><pre class="screen">dblatex -s mystyle myfile.xml
 
147
dblatex -s /path/to/mystyle.sty myfile.xml</pre><p>
 
148
    </p><p>
 
149
      To use <span class="command"><strong>dblatex</strong></span> and profiling:
 
150
      </p><pre class="screen">
 
151
xsltproc --param profile.attribute "'output'" \
 
152
         --param profile.value "'pdf'" /path/to/profiling/profile.xsl \
 
153
         myfile.xml | dblatex -o myfile.pdf -
 
154
</pre><p>
 
155
    </p><p>
 
156
      To build a set of books:
 
157
      </p><pre class="screen">dblatex -O /path/to/chunk/dir -Pset.book.num=all myfile.xml</pre><p>
 
158
    </p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch03.html#id3406628">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch03.html#id3406628">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="sec-style.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Reference </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Output Formatting Style</td></tr></table></div></body></html>