Common Options

bibtexEngine

The program to use when processing BibTeX files and the backend is set to bibtex versus biber.

cleanPatterns

A list of file glob patterns to use when executing a clean or a scrub command. Each glob pattern uses following syntax:

Patterns that begin with a slash or a backslash (/ or \) are interpreted as a file system glob pattern with the directory of the main source file as the root directory. For instance, if the main source file path is /foo/bar.tex and the pattern is /gronk/* then resulting pattern /foo/gronk/* will be used to search for files or directories to remove during clean.

Patterns that do not begin with a slash or a backslash are interpreted as a generated file glob pattern and will only match files explicitly created by a rule during a command such as build. For instance, **/*.aux will cause any auxiliary files created by LaTeX to be removed during clean.

copyTargetsToRoot

Enable the copying of targets to the directory that contains the source file. This will only be done if the output directory is not set to .. The original file will be preserved so that the dependency graph will not be broken.

dviToPdfEngine

Program to use for DVI to PDF conversion.

engine

The LaTeX engine to use when applying the LaTeX rule, e.g. latex, pdflatex or uplatex. The LaTeX rule will select the output format requested from the LaTeX engine based upon outputFormat option and the capabilities of the engine. For instance, selecting an outputFormat of pdf with and engine of latex will result in a dvi file being generated which will then be converted using the DviToPdf rule. Whereas if the engine is set to pdflatex the pdf will be generated directly.

epstopdfBoundingBox

Where epstopdf should get its bounding box from.

epstopdfOutputPath

The output path for epstopdf.

epstopdfRestricted

Use restricted mode when calling epstopdf.

filePath

Override the master source file path for a specific job. This used to build external dependencies not automatically generated by the LaTeX rule. See Job Specific Source Files for more details.

indexAutomaticRanges

Use automatic page range formation. By default, three or more successive pages are automatically abbreviated as a range (e.g. 1-3).

indexCompressBlanks

Compress blanks in index labels.

indexDictionary

Pronounciation dictionary for mendex.

indexEngine

Program used for index generation. If using a package like imakeidx which calls and configures the index generation using shell escape or notifies the user of the correct index call via LaTeX messages then the correct engine and options will deduced from those messages.

indexForceKanji

Enable forcing output of Kanji characters even if non-existent in dictionaries. Used by mendex and upmendex only.

indexLogPath

The log path of the indexing engine.

indexLogPath

The log path of the indexing engine.

indexOrdering

Ordering scheme where letter ordering ignores spaces between words and word ordering respects spaces between word.

indexOutputPath

The output path of the indexing engine.

indexSorting

Set the sorting method to default (ASCII), german, thai or using the system locale.

indexStartPage

Set the start page.

indexStyle

Use a custom style for formatting the index. For nomenclature indicies nomencl.ist is used by default. For bibref indicies bibref.ist is used by default.

intermediatePostScript

Generate PostScript using dvips when the output format is pdf. This is only used for LaTeX engines not capable of natively producing PDF.

jobName

Job name used for latex.

jobNames

Job names used for latex.

kanji

Kanji encoding for pLaTeX, upLaTeX, pBibTeX, upBibTeX and mendex.

kanjiInternal

Internal kanji encoding for pLaTeX, upLaTeX, pBibTeX, upBibTeX and mendex.

knitrConcordance

Enable/disable creation of knitr concordance file used to SyncTeX patching and source code mapping in log messages.

knitrOutputPath

lhs2texStyle

Set the style that lhs2TeX will use with the default being poly.

literateAgdaEngine

The program to preprocess literate Agda source with before sending the source to LaTeX. If none is selected then LaTeX will typeset the code directly without preprocessing.

literateHaskellEngine

The program to preprocess literate Haskell source with before sending the source to LaTeX. If none is selected then LaTeX will typeset the code directly without preprocessing.

loadCache

Load file cache generated by previous builds.

loadUserOptions

Load options from the .dicy.yaml options file in the user’s home directory.

phaseCycles

Maximum number of evaluation cycles in each phase.

outputDirectory

Name of directory for output files.

outputFormat

Output format of main generated file.

pweaveCacheDirectory

Directory used for Pweave cache.

pweaveDocumentationMode

Use documentation mode for Pweave. Chunk code and results will be loaded from cache and inline code will be hidden.

pweaveFigureDirectory

Directory used for Pweave figures.

pweaveKernel

Jupyter kernel used to run code.

pweaveOutputFormat

Format of code environments used by Pweave.

pweaveOutputPath

Output path of Pweave.

saveCache

Save file cache generated by previous builds.

saveLog

Save a transcript of the log to $NAME-log.yaml. This option is only available from the command line interface and is primarily used to construct or provide output parsible by a client.

severity

The severity of messages to display.

shellEscape

Enable shell escape (write18).

synctex

Generate SyncTeX annotations.

tests

Test programs to be executed during test command.

validateCache

Validate file cache generated by previous builds.

Environment Variables

Environment variables like TEXINPUTS may be set in any options file by prefixing the variable with a $. For instance, the following YAML file will set the environment variable FOO to the value of bar.

$FOO: bar

Environment variables may refer to system level environment variables also. For example the following will prefix the system search path with /foo/bar.

$PATH: /foo/bar:$PATH

Path resolution (as detailed in cleanPatterns) may also be done on environment variable values by using arrays. For instance, the following will set TEXINPUTS to /baz:/baz/output: if the current file path is /baz/gronk.tex.

outputDirectory: output
$TEXINPUTS:
  - $ROOTDIR
  - $ROOTDIR/$OUTDIR
  -

Kpathsea compliant TeX distributions typically use a trailing empty path to indicate that the system default search path should be appended to the search path specified by the environment variable. This convention can also be used to set the system search path. The final item will be replaced with the value of PATH (Path on Windows) from the system environment.

outputDirectory: output
$PATH:
  - $ROOTDIR
  - $ROOTDIR/$OUTDIR
  -