1DBLATEX(1) Dblatex Manual Page DBLATEX(1)
2
6 dblatex - convert DocBook to LaTeX, DVI, PostScript, and PDF
7
9 dblatex [options] {file | -}
10
12 This manual page briefly documents the dblatex command. For more
13 details read the PDF manual; see below.
14 dblatex is a program that transforms your SGML/XML DocBook documents to
16 DVI, PostScript or PDF by translating them into pure LaTeX as a first
17 process. MathML 2.0 markups are supported, too. It started as a clone
18 of DB2LaTeX.
19
21 A summary of options is included below. For a complete description,
22 see the PDF manual.
23 -h, --help
25 Show a help message and exit.
26 -b backend, --backend=backend
28 Backend driver to use: pdftex (default), dvips, or xetex.
29 -B, --no-batch
31 All the tex output is printed.
32 -c config, -S config, --config=config
34 Configuration file. A configuration file can be used to group all
35 the options and customizations to apply.
36 -d, --debug
38 Debug mode: Keep the temporary directory in which dblatex actually
39 works.
40 -D, --dump
42 Dump the error stack when an error occurs (debug purpose).
43 -e indexstyle, --indexstyle indexstyle
45 Index style file to pass to makeindex instead of the dblatex
46 default index style.
47 -f figure_format, --fig-format=figure_format
49 Input figure format: fig, eps. Used when not deduced from figure
50 file extension.
51 -F input_format, --input-format=input_format
53 Input file format: sgml, xml (default).
54 -i texinputs, --texinputs texinputs
56 Path added to TEXINPUTS
57 -I figure_path, --fig-path=figure_path
59 Additional lookup path of the figures.
60 -l bst_path, --bst-path=bst_path
62 Additional lookup path of the BibTeX styles.
63 -L bib_path, --bib-path=bib_path
65 Additional lookup path of the BibTeX databases.
66 -m xslt, --xslt=xslt
68 XSLT engine to use. The available engines are: xsltproc (default),
69 4xslt, saxon.
70 -o output, --output=output
72 Output filename. When not specified, the input filename is used,
73 with the suffix of the output format. The option is ignored if
74 several books are chunked from a set. In this case the -O option is
75 applied instead.
76 -O output_dir, --output-dir=output_dir
78 Output directory of the books built from a set. When not specified,
79 the current working directory is used instead. The option is
80 ignored if a single document is outputed, and the -o is taken into
81 account.
82 -p xsl_user, --xsl-user=xsl_user
84 An XSL user stylesheet to use. Several user stylesheets can be
85 specified, but the option order is meaningful: a user stylesheet
86 takes precedence over previously defined user stylesheets.
87 -P param=value, --param=param=value
89 Set an XSL parameter from command line.
90 -q, --quiet
92 Less verbose, showing only TeX output messages and error messages.
93 -r [plugin:]script, --texpost=[plugin:]script
95 Script called at the very end of the tex compilation. Its role is
96 to modify the tex file or one of the compilation files before the
97 last round. The script can be a python plugin. In this case add the
98 prefix term 'plugin:'.
99 -s latex_style, --texstyle=latex_style
101 Latex style to apply. It can be a package name, or directly a latex
102 package path. A package name must be without a directory path and
103 without the '.sty' extension. On the contrary, a full latex package
104 path can contain a directory path, but must ends with the '.sty'
105 extension.
106 -t format, --type=format
108 Output format. Available formats: tex, dvi, ps, pdf (default).
109 --dvi
111 DVI output. Equivalent to -tdvi.
112 --pdf
114 PDF output. Equivalent to -tpdf.
115 --ps
117 PostScript output. Equivalent to -tps.
118 -T style, --style=style
120 Output style, predefined are: db2latex, simple, native (default).
121 -v, --version
123 Display the dblatex version.
124 -V, --verbose
126 Verbose mode, showing the running commands
127 -x xslt_options, --xslt-opts=xslt_options
129 Arguments directly passed to the XSLT engine
130 -X, --no-external
132 Disable the external text file support. This support is needed for
133 callouts on external files referenced by textdata or imagedata, but
134 it can be disabled if the document does not contain such callouts.
135 Disabling this support can improve the processing performance for
136 big documents.
137
139 $HOME/.dblatex/
140 User configuration directory.
141 /etc/dblatex/
143 System-wide configuration directory.
144 The predefined output styles are located in the installed package
146 directory.
147
149 DBLATEX_CONFIG_FILES
150 Extra configuration directories that may contain some dblatex
151 configuration files.
152
154 To produce myfile.pdf from myfile.xml:
155 dblatex myfile.xml
157 To set some XSL parameters from the command line:
159 dblatex -P latex.babel.language=de myfile.xml
161 To use your XSL stylesheet:
163 dblatex -p myconfig.xsl myfile.xml
165 To use the db2latex output style:
167 dblatex -T db2latex myfile.xml
169 To apply your own latex style:
171 dblatex -s mystyle myfile.xml
173 dblatex -s /path/to/mystyle.sty myfile.xml
174 To pass extra arguments to the XSLT engine:
176 dblatex -x "--path /path/to/load/entity" myfile.xml
178 To use dblatex and profiling:
180 xsltproc --param profile.attribute "'output'" \
182 --param profile.value "'pdf'" \
183 /path/to/profiling/profile.xsl \
184 myfile.xml | dblatex -o myfile.pdf -
185 To build a set of books:
187 dblatex -O /path/to/chunk/dir -Pset.book.num=all myfile.xml
189
192 The program is documented fully by "DocBook to LaTeX Publishing - User
193 Manual" available in the package's documentation directory.
194
196 Benoit Guillon
197 Upstream maintainer
198 Andreas Hoenen <andreas.hoenen@arcor.de>
200 Debian maintainer
201
203 Copyright © 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014,
204 2015 Andreas Hoenen
205 This manual page was written for the Debian(TM) system (but it may be
207 used by others).
208 Permission is granted to copy, distribute and/or modify this document
210 under the terms of the GNU General Public License, Version 2 or any
211 later version published by the Free Software Foundation.
212 On Debian(TM) systems, the complete text of the GNU General Public
214 License can be found in /usr/share/common-licenses/GPL.
215dblatex 0.3.12 March 6, 2015 DBLATEX(1)