'\" t
.\"     Title: dblatex
.\"    Author: Benoit Guillon
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: March 6, 2015
.\"    Manual: Dblatex Manual Page
.\"    Source: dblatex \fI0.3.12\fR
.\"  Language: English
.\"
.TH "DBLATEX" "1" "March 6, 2015" "dblatex \fI0\&.3\&.12\fR" "Dblatex Manual Page"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
dblatex \- convert DocBook to LaTeX, DVI, PostScript, and PDF
.SH "SYNOPSIS"
.HP \w'\fBdblatex\fR\ 'u
\fBdblatex\fR [\fBoptions\fR] {\fIfile\fR\ |\ \-}
.SH "DESCRIPTION"
.PP
This manual page briefly documents the
\fBdblatex\fR
command\&. For more details read the
PDF
manual; see below\&.
.PP
\fBdblatex\fR
is a program that transforms your
SGML/XML
DocBook
documents to
DVI,
PostScript
or
PDF
by translating them into pure
LaTeX
as a first process\&.
MathML 2\&.0
markups are supported, too\&.
It started as a clone of DB2LaTeX\&.
.SH "OPTIONS"
.PP
A summary of options is included below\&.
For a complete description, see the PDF manual\&.
.PP
\fB\-h\fR, \fB\-\-help\fR
.RS 4
Show a help message and exit\&.
.RE
.PP
\fB\-b \fR\fB\fIbackend\fR\fR, \fB\-\-backend=\fR\fB\fIbackend\fR\fR
.RS 4
Backend driver to use:
\fIpdftex\fR
(default),
\fIdvips\fR, or
\fIxetex\fR\&.
.RE
.PP
\fB\-B\fR, \fB\-\-no\-batch\fR
.RS 4
All the tex output is printed\&.
.RE
.PP
\fB\-c \fR\fB\fIconfig\fR\fR, \fB\-S \fR\fB\fIconfig\fR\fR, \fB\-\-config=\fR\fB\fIconfig\fR\fR
.RS 4
Configuration file\&. A configuration file can be used to group all the options and customizations to apply\&.
.RE
.PP
\fB\-d\fR, \fB\-\-debug\fR
.RS 4
Debug mode: Keep the temporary directory in which dblatex actually works\&.
.RE
.PP
\fB\-D\fR, \fB\-\-dump\fR
.RS 4
Dump the error stack when an error occurs (debug purpose)\&.
.RE
.PP
\fB\-e \fR\fB\fIindexstyle\fR\fR, \fB\-\-indexstyle \fR\fB\fIindexstyle\fR\fR
.RS 4
Index style file to pass to
\fBmakeindex\fR
instead of the dblatex default index style\&.
.RE
.PP
\fB\-f \fR\fB\fIfigure_format\fR\fR, \fB\-\-fig\-format=\fR\fB\fIfigure_format\fR\fR
.RS 4
Input figure format:
\fIfig\fR,
\fIeps\fR\&. Used when not deduced from figure file extension\&.
.RE
.PP
\fB\-F \fR\fB\fIinput_format\fR\fR, \fB\-\-input\-format=\fR\fB\fIinput_format\fR\fR
.RS 4
Input file format:
\fIsgml\fR,
\fIxml\fR
(default)\&.
.RE
.PP
\fB\-i \fR\fB\fItexinputs\fR\fR, \fB\-\-texinputs \fR\fB\fItexinputs\fR\fR
.RS 4
Path added to
\fBTEXINPUTS\fR
.RE
.PP
\fB\-I \fR\fB\fIfigure_path\fR\fR, \fB\-\-fig\-path=\fR\fB\fIfigure_path\fR\fR
.RS 4
Additional lookup path of the figures\&.
.RE
.PP
\fB\-l \fR\fB\fIbst_path\fR\fR, \fB\-\-bst\-path=\fR\fB\fIbst_path\fR\fR
.RS 4
Additional lookup path of the BibTeX styles\&.
.RE
.PP
\fB\-L \fR\fB\fIbib_path\fR\fR, \fB\-\-bib\-path=\fR\fB\fIbib_path\fR\fR
.RS 4
Additional lookup path of the BibTeX databases\&.
.RE
.PP
\fB\-m \fR\fB\fIxslt\fR\fR, \fB\-\-xslt=\fR\fB\fIxslt\fR\fR
.RS 4
XSLT engine to use\&. The available engines are: xsltproc (default), 4xslt, saxon\&.
.RE
.PP
\fB\-o \fR\fB\fIoutput\fR\fR, \fB\-\-output=\fR\fB\fIoutput\fR\fR
.RS 4
Output filename\&. When not specified, the input filename is used, with the suffix of the output format\&. The option is ignored if several books are chunked from a set\&. In this case the
\fB\-O\fR
option is applied instead\&.
.RE
.PP
\fB\-O \fR\fB\fIoutput_dir\fR\fR, \fB\-\-output\-dir=\fR\fB\fIoutput_dir\fR\fR
.RS 4
Output directory of the books built from a set\&. When not specified, the current working directory is used instead\&. The option is ignored if a single document is outputed, and the
\fB\-o\fR
is taken into account\&.
.RE
.PP
\fB\-p \fR\fB\fIxsl_user\fR\fR, \fB\-\-xsl\-user=\fR\fB\fIxsl_user\fR\fR
.RS 4
An
XSL
user stylesheet to use\&. Several user stylesheets can be specified, but the option order is meaningful: a user stylesheet takes precedence over previously defined user stylesheets\&.
.RE
.PP
\fB\-P \fR\fB\fIparam\fR\fR\fB=\fR\fB\fIvalue\fR\fR, \fB\-\-param=\fR\fB\fIparam\fR\fR\fB=\fR\fB\fIvalue\fR\fR
.RS 4
Set an
XSL
parameter from command line\&.
.RE
.PP
\fB\-q\fR, \fB\-\-quiet\fR
.RS 4
Less verbose, showing only TeX output messages and error messages\&.
.RE
.PP
\fB\-r \fR\fB[plugin:]\fR\fB\fIscript\fR\fR, \fB\-\-texpost=\fR\fB[plugin:]\fR\fB\fIscript\fR\fR
.RS 4
Script called at the very end of the tex compilation\&. Its role is to modify the tex file or one of the compilation files before the last round\&. The
\fIscript\fR
can be a python plugin\&. In this case add the prefix term \*(Aqplugin:\*(Aq\&.
.RE
.PP
\fB\-s \fR\fB\fIlatex_style\fR\fR, \fB\-\-texstyle=\fR\fB\fIlatex_style\fR\fR
.RS 4
Latex style to apply\&. It can be a package name, or directly a latex package path\&. A package name must be without a directory path and without the \*(Aq\&.sty\*(Aq extension\&. On the contrary, a full latex package path can contain a directory path, but must ends with the \*(Aq\&.sty\*(Aq extension\&.
.RE
.PP
\fB\-t \fR\fB\fIformat\fR\fR, \fB\-\-type=\fR\fB\fIformat\fR\fR
.RS 4
Output format\&. Available formats:
\fItex\fR,
\fIdvi\fR,
\fIps\fR,
\fIpdf\fR
(default)\&.
.RE
.PP
\fB\-\-dvi\fR
.RS 4
DVI output\&. Equivalent to
\fB\-tdvi\fR\&.
.RE
.PP
\fB\-\-pdf\fR
.RS 4
PDF output\&. Equivalent to
\fB\-tpdf\fR\&.
.RE
.PP
\fB\-\-ps\fR
.RS 4
PostScript output\&. Equivalent to
\fB\-tps\fR\&.
.RE
.PP
\fB\-T \fR\fB\fIstyle\fR\fR, \fB\-\-style=\fR\fB\fIstyle\fR\fR
.RS 4
Output style, predefined are:
\fIdb2latex\fR,
\fIsimple\fR,
\fInative\fR
(default)\&.
.RE
.PP
\fB\-v\fR, \fB\-\-version\fR
.RS 4
Display the dblatex version\&.
.RE
.PP
\fB\-V\fR, \fB\-\-verbose\fR
.RS 4
Verbose mode, showing the running commands
.RE
.PP
\fB\-x \fR\fB\fIxslt_options\fR\fR, \fB\-\-xslt\-opts=\fR\fB\fIxslt_options\fR\fR
.RS 4
Arguments directly passed to the
XSLT engine
.RE
.PP
\fB\-X\fR, \fB\-\-no\-external\fR
.RS 4
Disable the external text file support\&. This support is needed for callouts on external files referenced by
textdata
or
imagedata, but it can be disabled if the document does not contain such callouts\&. Disabling this support can improve the processing performance for big documents\&.
.RE
.SH "FILES AND DIRECTORIES"
.PP
$HOME/\&.dblatex/
.RS 4
User configuration directory\&.
.RE
.PP
/etc/dblatex/
.RS 4
System\-wide configuration directory\&.
.RE
.PP
The predefined output styles are located in the installed package directory\&.
.SH "ENVIRONMENT VARIABLES"
.PP
\fBDBLATEX_CONFIG_FILES\fR
.RS 4
Extra configuration directories that may contain some dblatex configuration files\&.
.RE
.SH "EXAMPLES"
.PP
To produce
myfile\&.pdf
from
myfile\&.xml:
.sp
.if n \{\
.RS 4
.\}
.nf
dblatex myfile\&.xml
.fi
.if n \{\
.RE
.\}
.PP
To set some XSL parameters from the command line:
.sp
.if n \{\
.RS 4
.\}
.nf
dblatex \-P latex\&.babel\&.language=de myfile\&.xml
.fi
.if n \{\
.RE
.\}
.PP
To use your XSL stylesheet:
.sp
.if n \{\
.RS 4
.\}
.nf
dblatex \-p myconfig\&.xsl myfile\&.xml
.fi
.if n \{\
.RE
.\}
.PP
To use the db2latex output style:
.sp
.if n \{\
.RS 4
.\}
.nf
dblatex \-T db2latex myfile\&.xml
.fi
.if n \{\
.RE
.\}
.PP
To apply your own latex style:
.sp
.if n \{\
.RS 4
.\}
.nf
dblatex \-s mystyle myfile\&.xml
dblatex \-s /path/to/mystyle\&.sty myfile\&.xml
.fi
.if n \{\
.RE
.\}
.PP
To pass extra arguments to the XSLT engine:
.sp
.if n \{\
.RS 4
.\}
.nf
dblatex \-x "\-\-path /path/to/load/entity" myfile\&.xml
.fi
.if n \{\
.RE
.\}
.PP
To use
\fBdblatex\fR
and profiling:
.sp
.if n \{\
.RS 4
.\}
.nf
xsltproc \-\-param profile\&.attribute "\*(Aqoutput\*(Aq" \e
         \-\-param profile\&.value "\*(Aqpdf\*(Aq" \e
         /path/to/profiling/profile\&.xsl \e
         myfile\&.xml | dblatex \-o myfile\&.pdf \-
.fi
.if n \{\
.RE
.\}
.PP
To build a set of books:
.sp
.if n \{\
.RS 4
.\}
.nf
dblatex \-O /path/to/chunk/dir \-Pset\&.book\&.num=all myfile\&.xml
.fi
.if n \{\
.RE
.\}
.sp
.SH "SEE ALSO"
.PP
The program is documented fully by
"DocBook to LaTeX Publishing \- User Manual"
available in the package\*(Aqs documentation directory\&.
.SH "AUTHORS"
.PP
\fBBenoit Guillon\fR
.RS 4
Upstream maintainer
.RE
.PP
\fBAndreas Hoenen\fR <\&andreas\&.hoenen@arcor\&.de\&>
.RS 4
Debian maintainer
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015 Andreas Hoenen
.br
.PP
This manual page was written for the
Debian(TM)
system (but it may be used by others)\&.
.PP
Permission is granted to copy, distribute and/or modify this document under the terms of the
GNU
General Public License, Version 2 or any later version published by the Free Software Foundation\&.
.PP
On
Debian(TM)
systems, the complete text of the
GNU
General Public License can be found in
/usr/share/common\-licenses/GPL\&.
.sp