A master configuration file, also called a specification file, can be used to list
all the customizations and options to apply. Such a file is passed by using the
option -S
.
config_file
The format of the file is the following:
Every comment starts with a “#”, and is ignored.
The file must contain one parameter by line.
The format of a parameter is the following:
<keyword>: <value>
Every parameter is mapped to an option that can be passed to dblatex.
An unknown parameter is silently ignored (the whole line is dropped).
The parameters defining a path (a file or a directory) can take absolute or relative paths. A relative path must be defined from the specification file itself. For instance, a specification file under /the/spec/directory/
with a parameter describing the file ../where/this/file/is/myfile
points to /the/spec/where/this/file/is/myfile
.
The following table lists the supported parameters and the corresponding command line option.
Keyword | Value | Corresponding option | Description |
---|---|---|---|
TexInputs | Directories | --texinputs | Defines extra path to add to TEXINPUTS |
TexStyle | Latex package name | --texstyle | Defines the LaTeX style package to use. |
TexPost | Script file name | --texpost | Defines the LaTeX post process script to use. |
XslParam | Parameter file name | -p | Defines the parameter file to use. |
FigInputs | Directories | -I | Defines the extra figures path. |
Options | Command line options | None | Lists command options to use by default when using the tool. The options specified by the parameter are directly passed to dblatex |
Here is the specification file used for this manual.
Example 4.3. User Manual Configuration File
# # Configuration file for dblatex documentation (manual, release notes) # TexInputs: ../latex// PdfInputs: ../latex/graphics TexStyle: docbook XslParam: manual.xsl Options: -b pdftex
By default dblatex tries to find the configuration files in the following paths, in respect of the order:
The current directory
$HOME/.dblatex
/etc/dblatex
The dblatex package configuration directories.
You can add some extra paths where to look for by setting the
DBLATEX_CONFIG_FILES
environment variable. The paths are
separated by ":" in Unix like systems, and by ";" on Windows. These paths are used
only when nothing is found in the default paths.