gallandarakhneorg/autolatex2
Folders and files
| Name | Name | Last commit date | ||
|---|---|---|---|---|
Repository files navigation
NAME
autolatex - compile LaTeX and TeX documents
SYNOPSIS
autolatex [options] command [command ...]
DESCRIPTION
AutoLaTeX is a tool for managing small to large LaTeX documents. It
simplifies the process of producing PDF files or viewing documents by
tracking file changes and automating the execution of required programs.
One of AutoLaTeX's best features is its translator rules (also known as
translators), which automatically generate drawings for inclusion in the
PDF from various source formats such as SVG and GNU Plot.
For example, consider a document with a single LaTeX file, mydoc.tex.
Without AutoLaTeX, producing a .pdf file might require the following
commands:
F<pdflatex mydoc.tex>
F<bibtex mydoc>
F<makeindex mydoc>
F<makeglossaries mydoc>
F<pdflatex mydoc.tex>
F<pdflatex mydoc.tex>
F<pdflatex mydoc.tex>
The triple invocation of LaTeX ensures that all references are resolved
and layout changes are accounted for. While not overly complex, this
process still involves multiple commands. With AutoLaTeX, you can
simplify this to:
F<autolatex -f mydoc.tex>
or simply:
F<autolatex>
For documents requiring additional tools to generate PDF versions of
included drawings or to run BibTeX/Biber for bibliographies, manual
compilation becomes cumbersome. AutoLaTeX automates these tasks: it
calls the necessary translators and tools for you. Each translator
converts a source file (e.g., EPS, SVG, Gnuplot) into a PDF or PNG file.
This introduction demonstrates how AutoLaTeX simplifies LaTeX document
management. The system is user-friendly for small projects and robust
enough for large ones. The rest of this manual provides comprehensive
documentation on using, configuring, and installing AutoLaTeX.
COMMANDS
AutoLaTeX provides a fixed set of commands to perform specific actions
on your document. The default command is all. Some commands accept
optional arguments; use --help after the command name for details.
The available commands are:
all Equivalent to the images, document and view commands, but the viewer
is launched only if enabled in the configuration or via the command
line.
biblio
Processes all tasks required to generate the bibliography (BibTeX,
Biber, etc.).
clean
Removes all LaTeX temporary files and other temporary files created
during project processing from the current working directory. The
drawings that are automatically generated by the images command are
not removed.
cleanall
Same as clean, but also removes Emacs ~ files, other backup files,
generated figures, and the produced PDF. This command is also known
as mrproper.
createconfig
Creates a standard configuration file in the current directory based
on the command-line configuration.
createist
Creates a default MakeIndex style file in the document directory,
named default.ist.
createsty
Creates a default LaTeX package file in the document directory that
provides standard LaTeX control sequences.AutoLaTeX. The package
file is named autolatex.sty.
commit
Commits changes to a version control system (GIT, CVS, SVN...). The
command line must be provided in the configuration file.
documentation
Performs all processing required to produce the .pdf, .dvi, or .ps
file for the document. This command is also known as gen_doc.
glossaries
Performs all processing required to generate glossaries
(makeglossaries). This command is also known as makeglossaries.
images
Automatically generates drawings by invoking the translators.
index
Performs all processing required to generate the index (makeindex).
This command is also known as makeindex.
init
Creates an empty LaTeX document in the current directory following a
standard folder structure supported by AutoLaTeX.
makeflat
Creates a version of the document in a specific folder (default:
./flat_version/) with a single LaTeX or TeX file and all other files
in the same directory, excluding subfolders. This command is also
known as preparepublish.
This command is useful for creating a version of the document that
can be directly uploaded to online publication sites (e.g.,
Elsevier), which do not support subfolder uploads.
This command provides the CLI option --externalbiblio to specify
whether the bibliography should be placed in a BibTeX file
(external) or inlined in the TeX file (default: inlined).
showconfig
Displays the configuration definitions read from the configuration
files.
showconfigfiles
Displays the list of configuration filenames read by AutoLaTeX.
showimages
Displays the filenames of figures that should be processed by a
translator. This command offers specific options to control the type
of information displayed.
showinstalledtranslators
Displays the list of installed translators. This command is also
known as installedtranslators.
showloadedtranslators
Displays the list of loaded translators. This command is also known
as translators.
showpath
Displays the value of the PATH environment variable that is
considered by AutoLaTeX.
unusedimages
Displays (or removes) figures in the document folder that are not
included in the document.
update
Updates the local copy with changes from a version control system
(GIT, CVS, SVN...). The command line must be provided in the
configuration file.
view
Launches the document viewer. The command line of the viewer must be
provided in the configuration file.
GLOBAL OPTIONS
--asyncview
--noasyncview
Enables or disables asynchronous viewer launching. If enabled,
AutoLaTeX does not wait for the viewer to close before stopping
execution. If disabled, AutoLaTeX waits for the viewer to close.
--auto
--noauto
Enables or disables automatic figure generation using translators.
--biblio
--nobiblio
Enables or disables the bibliography tool (BibTeX, Biber, etc.) if
not explicitly invoked from the command line.
--continuous [sleep_duration]
--nocontinuous
Runs AutoLaTeX continuously, repeatedly performing the specified
actions. This option causes AutoLaTeX to loop infinitely, similar to
the following script (in bash):
while 1
do
autolatex "$@"
sleep B<sleep_duration>
done
The sleep_duration parameter specifies the waiting time between
loops. If not provided, it defaults to 0. The --continuous option
forces --asyncview to be enabled.
With a compatible viewer, the display will update automatically.
Some UNIX/Linux versions of "gv -watch" support this for PostScript
files, which can be configured via a variable. Many other previewers
require manual updates.
Note: Adobe Acrobat Reader on MS-Windows locks the PDF file,
preventing updates, so it is not recommended for continuous mode.
--debug
Runs AutoLaTeX with the logging level set to 'debug'. The available
levels (from least to most verbose) are: off, critical, error,
warning, info, fine_info, debug, trace.
--defaultist
Allows AutoLaTeX to use MakeIndex with the default style (.ist
file). The default style is provided by the AutoLaTeX distribution.
The --index and --noindex options modify AutoLaTeX's behavior
regarding MakeIndex.
-d directory
--directory directory
Specifies a directory containing a LaTeX document to compile. You
can specify this option for each directory containing a LaTeX
document. If not specified, the current directory is used.
--dvi
Specifies that the result of the AutoLaTeX process is a DVI or XDVI
document, which will be converted to PostScript. This option has the
same effect as --ps.
-e name
--exclude name
Prevents AutoLaTeX from loading the translator named name. See below
for available translators. The --include option includes a
translator, and --include-path specifies where to find translator
scripts.
-f file
--file file
Specifies the main LaTeX file to compile. If not specified,
AutoLaTeX searches for a TeX file in the document directory.
--file-line-warning
--nofile-line-warning
Experimental: Enables or disables the extended warning format for
LaTeX. This format adds the filename and line number to the warning
message, which is useful for extracting warnings from the log file.
--gloss
--glossary
--nogloss
--noglossary
Enables or disables the use of MakeGlossaries.
-h
--help
Displays the manual. If used before any command, the global manual
is shown. If used after a command, only the manual page for that
command is displayed.
-D directory
--imgdirectory directory
Specifies a directory where AutoLaTeX will find figures to be
processed by translators. Each use of this option adds a directory
to the list.
-i name
--include name
Forces AutoLaTeX to load the translator named name. See below for
available translators. The --exclude option excludes a translator,
and --include-path specifies where to find translator scripts.
-I paths
--include-path paths
Notifies AutoLaTeX of directories containing translator scripts.
paths can be a list separated by the operating system's path
separator (':' on Unix, ';' on Windows). The --exclude option
excludes a translator, and --include includes a translator.
--index [style_file]
--noindex
Allows AutoLaTeX to use MakeIndex. If a value is provided, it is
assumed to be an .ist file for MakeIndex. If no value is provided,
AutoLaTeX uses MakeIndex and attempts to detect a MakeIndex style
file (.ist) in the document directory. If none is found, no style is
passed to MakeIndex. The --defaultist and --noindex options modify
AutoLaTeX's behavior regarding MakeIndex.
--info
Runs AutoLaTeX with the logging level set to 'info'. The available
levels (from least to most verbose) are: off, critical, error,
warning, info, fine_info, debug, trace.
--latex
Uses the LaTeX command: latex. See also: --pdflatex, --lualatex, and
--xelatex.
--lualatex
Uses the LaTeX command: lualatex. See also: --pdflatex, --latex, and
--xelatex.
--pdf
Specifies that the result of the AutoLaTeX process is a PDF
document.
--pdflatex
Uses the LaTeX command: pdflatex. See also: --latex, --lualatex, and
--xelatex.
--ps
Specifies that the result of the AutoLaTeX process is a PostScript
document. This option has the same effect as --dvi.
-q
--quiet
Runs AutoLaTeX with only critical and error messages. The available
levels (from least to most verbose) are: off, critical, error,
warning, info, fine_info, debug, trace.
--search-project-from file
When specified, AutoLaTeX searches for a configuration file (usually
.autolatex_project.cfg on Unix) in the directory of the specified
file or its ancestors. This option does not replace the -d or -f
options.
--showloglevel
Show the current level of logging on the console. This option
depends on the usage of the other logging options, such as --verbose
or --debug for example.
--silent
Runs AutoLaTeX without logging messages (off logging level). The
available levels (from least to most verbose) are: off, critical,
error, warning, info, fine_info, debug, trace.
--stderr
--stdout
Directs AutoLaTeX to output regular messages (not logged) to
standard output (stdout) or standard error (stderr).
--synctex
--nosynctex
Enables or disables the generation of SyncTeX-compatible output
files. SyncTeX links a viewer and a TeX editor, allowing you to
click in one and highlight the corresponding line in the other.
--testlogs
Show the a message for each level of logging. This option enables to
show the behavior of the logging system that is used by AutoLaTeX.
This option depends on the usage of the other logging options, such
as --verbose or --debug for example.
-v
--verbose
Increases verbosity each time this option is specified. The
available levels (from least to most verbose) are: off, critical,
error, warning, info, fine_info, debug, trace.
Note: If you specify more verbosity than 'trace', AutoLaTeX stops
immediately and displays the current in-memory configuration.
--version
Displays the version of AutoLaTeX.
--view
--noview
Enables or disables the document viewer at the end of compilation.
--Wall
Runs AutoLaTeX with the logging level set to 'fine_info'. The
available levels (from least to most verbose) are: off, critical,
error, warning, info, fine_info, debug, trace.
--Wnone
Runs AutoLaTeX with the logging level set to 'error', suppressing
warnings. The available levels (from least to most verbose) are:
off, critical, error, warning, info, fine_info, debug, trace.
--xelatex
Uses the LaTeX command: xelatex. See also: --pdflatex, --latex, and
--lualatex.
OPTIONS FOR COMMANDS
*all*
See options for the *images*, *document* and *view* commands, if
any.
*biblio*
--nochdir Prevents AutoLaTeX from changing the current directory
to the document's root directory before starting the
build process.
*clean*
--nochdir Prevents AutoLaTeX from changing the current directory
to the document's root directory before starting the
build process.
--norecursive
Disables cleaning in subfolders.
--simulate Simulates file removal without actually deleting files.
--all If specified, the clean command behaves like the
*cleanall* command.
*cleanall*
See the options for *clean*, except for --all, which is implicit for
*cleanall*.
*createconfig*
--force Overwrites the configuration file if it exists.
*createist*
--force Overwrites the .ist file if it exists.
*createsty*
--force Overwrites the .sty file if it exists.
*document*
--nochdir Prevents AutoLaTeX from changing the current directory
to the document's root directory before starting the
build process.
*glossaries*
--nochdir Prevents AutoLaTeX from changing the current directory
to the document's root directory before starting the
build process.
*images*
--force Forces the overwriting of all generated figures,
ensuring AutoLaTeX runs the translators for all of them.
*index*
--nochdir Prevents AutoLaTeX from changing the current directory
to the document's root directory before starting the
build process.
*init*
--force Overwrites all generated files and folders if they
exist.
--out directory
Specifies the directory where the generated document
structure will be written.
*makeflat*
--externalbiblio
Forces the use of an external BibTeX file (i.e., a .bib
file) instead of inlining the bibliography database in
the TeX file.
--out directory
Specifies the output directory for the flat version. The
default directory name is flat_version.
*showimages*
--changed Shows only images not associated with up-to-date
generated files, i.e., images requiring translator
processing.
--translators
Shows all images and their associated translators.
--valid Shows only images associated with up-to-date generated
files, i.e., images that do not require translator
processing.
*showinstalledtranslators*
--level
--nolevel Shows or hides the installation levels for each
translator.
*showloadedtranslators*
--level
--nolevel Shows or hides the activation levels for each
translator.
*unusedimages*
--delete Deletes unused images instead of just listing them.
AUTO GENERATION OF FIGURES
A converter, called a translator, transforms a source figure into a
target format supported by LaTeX. This converter can be an external
program (e.g., epstopdf) or an internal Python, Perl, Ruby, or Bash
script.
Each supported translator is defined in a .transdef2 file (the old
format in the Perl implementation of AutoLaTeX uses .transdef). This
file contains the shell command line or code to execute. To create a new
translator, copy and modify an existing .transdef2 file. Even if
excluded from the command line, a translator is automatically included
by AutoLaTeX if invoked by another included translator.
The provided translators are:
Astah/Jude (asta) to Portable Document Format (pdf)
Name: astah2pdf
Use external converter: astah-pro, astah-uml, astah-com
Use translator: svg2pdf
Input format: .asta .jude .juth
Output format: .pdf
Astah/Jude (asta) to Portable Network Graphic (png)
Name: astah2png
Use external converter: astah-pro, astah-uml, astah-com
Use translator:
Input format: .asta .jude .juth
Output format: .png
Astah SysML (asml) to Portable Document Format (pdf)
Name: asml2pdf
Use external converter: astah-sysml
Use translator: svg2pdf
Input format: .asml
Output format: .pdf
Asymptote (asy) to Portable Document Format (pdf)
Name: asy2pdf
Use external converter: asy
Use translator: eps2pdf
Input format: .asy
Output format: .pdf
C/C++ Source Code (.cpp, .c, .hpp, .h) to TeX Source Code (tex): TeXify
variant
Name: cpp2tex_texify
Use external converter: texifyc++
Use translator:
Input format: .cpp, .c, .hpp, .h, .c++, .h++
Output format: .tex
Compressed Bitmap to Uncompressed Bitmap
Based on zcat. This translator assumes input files are compressed
with the '.gz' extension. It allows storing compressed figures in
the project as raw material for the LaTeX compiler. The bitmaps are
decompressed into a file with the same name, excluding the '.gz'
extension.
Name: imggz2img
Use external converter: zcat
Use translator:
Input format: XXX.gz
Output format: XXX
Diagram Editor (dia) to Portable Document Format (pdf)
Name: dia2pdf
Use external converter: dia
Use translator: eps2pdf
Input format: .dia
Output format: .pdf
Diagram Editor (dia) to TeX embedded in Portable Document Format
(pdf+tex)
PDF part:
Name: dia2pdf+tex
Use external converter: dia
Use translator:
Input format: .dia_tex .diat .dia+tex .diatex .tex.dia +tex.dia
Output format: .pdf
TeX part:
Name: dia2pdf+tex
Use external converter: dia
Use translator:
Input format: .dia_tex .diat .dia+tex .diatex .tex.dia +tex.dia
Output format: .pdftex_t
Dot Graphviz (dot) to Portable Document Format (pdf)
Name: dot2pdf
Use external converter: dot
Use translator:
Input format: .dot
Output format: .pdf
Dot Graphviz (dot) to Portable Network Graphic (png)
Name: dot2png
Use external converter: dot
Use translator:
Input format: .dot
Output format: .png
Dot Graphviz (dot) to TeX (tex)
Name: dot2tex
Use external converter: dot
Use translator:
Input format: .dot
Output format: .tex
Encapsulated PostScript (eps) to Portable Document Format (pdf)
Name: eps2pdf_epstopdf
Use external converter: epstopdf
Use translator:
Input format: .eps
Output format: .pdf
XFig document (fig) to Portable Document Format (pdf)
Name: fig2pdf
Use external converter: fig2dev
Use translator:
Input format: .fig
Output format: .pdf
XFig document (fig) to TeX embedded in Portable Document Format
(pdf+tex)
PDF part:
Name: fig2pdf+tex
Use external converter: fig2dev
Use translator:
Input format: .figt .fig_tex .figtex .fig+tex .tex.fig +tex.fig
Output format: .pdf
TeX part:
Name: fig2pdf+tex
Use external converter: fig2dev
Use translator:
Input format: .figt .fig_tex .figtex .fig+tex .tex.fig +tex.fig
Output format: .pdftex_t
Graph eXchange Language (gxl) to Portable Document Format (pdf)
Name: gxl2pdf
Use external converter: gxl2dot
Use translator: dot2pdf
Input format: .gxl
Output format: .pdf
Graph eXchange Language (gxl) to Portable Network Graphic (png)
Name: gxl2png
Use external converter: gxl2dot
Use translator: dot2png
Input format: .gxl
Output format: .png
Graphics Layout Engine (gle) to Portable Document Format (pdf)
Name: gle2pdf
Use external converter: gle
Use translator:
Input format: .gle
Output format: .pdf
Graphics Layout Engine (gle) to Portable Network Graphic (png)
Name: gle2png
Use external converter: gle
Use translator:
Input format: .gle
Output format: .png
Java Source Code (java) to TeX Source Code (tex): TeXify variant
Name: java2tex_texify
Use external converter: texifyjava
Use translator:
Input format: .java
Output format: .tex
Lisp Script (lisp) to TeX Source Code (tex): TeXify variant
Name: lisp2tex_texify
Use external converter: texifylisp
Use translator:
Input format: .lisp
Output format: .tex
MatLab Script (m) to TeX Source Code (tex): TeXify variant
Name: matlab2tex_texify
Use external converter: texifymatlab
Use translator:
Input format: .m
Output format: .tex
ML Script (ml) to TeX Source Code (tex): TeXify variant
Name: ml2tex_texify
Use external converter: texifyml
Use translator:
Input format: .ml
Output format: .tex
Perl Script (perl) to TeX Source Code (tex): TeXify variant
Name: perl2tex_texify
Use external converter: texifyperl
Use translator:
Input format: .perl .pl
Output format: .tex
Gnuplot (plot) to Portable Document Format (pdf)
Name: plot2pdf
Use external converter: gnuplot
Use translator: eps2pdf
Input format: .plot .gnu
Output format: .pdf
Gnuplot (plot) to TeX embedded in Portable Document Format (pdf+tex)
PDF part:
Name: plot2pdf+tex
Use external converter: gnuplot
Use translator: eps2pdf
Input format: .plott .plot_tex .plottex .plot+tex .tex.plot
+tex.plot .gnut .gnu_tex .gnutex .gnu+tex .tex.gnu +tex.gnu
Output format: .pdf
TeX part:
Name: plot2pdf+tex
Use external converter: gnuplot
Use translator:
Input format: .plott .plot_tex .plottex .plot+tex .tex.plot
+tex.plot .gnut .gnu_tex .gnutex .gnu+tex .tex.gnu +tex.gnu
Output format: .pdftex_t
Python Source Code (py) to TeX Source Code (tex): TeXify variant
Name: python2tex_texify
Use external converter: texifypython
Use translator:
Input format: .py
Output format: .tex
Ruby Source Code (rb) to TeX Source Code (tex): TeXify variant
Name: ruby2tex_texify
Use external converter: texifyruby
Use translator:
Input format: .rb
Output format: .tex
SQL Script (sql) to TeX Source Code (tex): TeXify variant
Name: sql2tex_texify
Use external converter: texifysql
Use translator:
Input format: .sql
Output format: .tex
Scalable Vector Graphic (svg) to Portable Document Format (pdf):
Inkscape variant
Name: svg2pdf_inkscape
Use external converter: inkscape
Use translator:
Input format: .svg
Output format: .pdf
Scalable Vector Graphic (svg) to TeX embedded in Portable Document
Format (pdf+tex)
PDF part:
Name: svg2pdf+tex_inkscape
Use external converter: inkscape
Use translator:
Input format: .svgt .svg_t .svgtex .svg+tex .tex.svg +tex.svg
Output format: .pdf
TeX part:
Name: svg2pdf+tex_inkscape
Use external converter: inkscape
Use translator:
Input format: .svgt .svg_t .svgtex .svg+tex .tex.svg +tex.svg
Output format: .pdftex_t
Scalable Vector Graphic (svg) to Portable Network Graphic (png):
Inkscape variant
Name: svg2png_inkscape
Use external converter: inkscape
Use translator:
Input format: .svg
Output format: .png
Scalable Vector Graphic with layers (svg) to Beamer Overlays
Name: svg2pdf+layers_inkscape
Use external converter: inkscape
Use translator:
Input format: .svgl .svg_l .svglayers .svg+layers .layers.svg
+layers.svg
Output format: .pdftex_t .pdf
Scalable Vector Graphic with layers (svg) to TeX embedded in Beamer
Overlays
PDF part:
Name: svg2pdf+layers+tex_inkscape
Use external converter: inkscape
Use translator:
Input format: .svglt .svg_lt .svglayerstex .svgtexlayers
.svg+layers+tex .svg+tex+layers .layers.tex.svg .tex.layers.svg
+layers+tex.svg +tex+layers.svg
Output format: .pdf
TeX part:
Name: svg2pdf+layers+tex_inkscape
Use external converter: inkscape
Use translator:
Input format: .svglt .svg_lt .svglayerstex .svgtexlayers
.svg+layers+tex .svg+tex+layers .layers.tex.svg .tex.layers.svg
+layers+tex.svg +tex+layers.svg
Output format: .pdftex_t
PGF/TikZ (tikz) to Portable Document Format (pdf)
Name: tikz2pdf
Use external converter: pdflatex
Use translator:
Input format: .tikz
Output format: .pdf
Gimp (xcf) to Portable Document Format (pdf)
Name: xcf2pdf
Use external converter: convert
Use translator:
Input format: .xcf
Output format: .pdf
Gimp (xcf) to Portable Network Graphic (png)
Name: xcf2png
Use external converter: convert
Use translator:
Input format: .xcf
Output format: .png
UML Metadata Interchange (xmi) to Portable Document Format (pdf):
Umbrello variant
Name: xmi2pdf_umbrello
Use external converter: umbrello
Use translator: eps2pdf
Input format: .xmi
Output format: .pdf
Visio Binary Draw (vsd) to Portable Document Format (pdf)
Name: vsd2pdf
Use external converter: inkscape
Use translator:
Input format: .vsd .vdx .vsdx
Output format: .pdf
LATEX STYLE PACKAGE
AutoLaTeX provides a LaTeX style package called autolatex.sty, which
includes the following functions:
\includegraphicswtex[options]{filename}
Includes a figure with combined TeX macros. The filename must have
one of the following extensions: .pdftex_t, .pdftex_t, .pstex_t,
.pdf_tex, .ps_tex. The options must be either width=XX or height=XX,
where XX is a length.
\includefigurewtex[options]{filename}
Same as \includegraphicswtex.
\includeanimatedfigure[options]{filename}
Includes the layers of a figure in a Beamer presentation. The layers
are assumed to be in separate PDF files. The figure is a TeX file
that includes the PDF files in a Beamer-compatible environment. The
filename must have one of the following extensions: .pdftex_t,
.pdftex_t, .pstex_t, .pdf_tex, .ps_tex. The options must be either
width=XX or height=XX, where XX is a length.
By default, a layer replaces the previous layer when displayed. You
can change the overlay specification by adding the string <spec> to
the layer title in your SVG editor. The spec part defines the slide
numbers on which the layer appears in Beamer. For example, <2> means
"only on slide 2"; <6-> means "from slide 6 to the end."
\includeanimatedfigurewtex[options]{filename}
Includes the layers of a figure combined with TeX macros in a Beamer
presentation. The layers are assumed to be in separate PDF files.
The figure is a TeX file that includes the PDF files in a
Beamer-compatible environment. The filename must have one of the
following extensions: .pdftex_t, .pdftex_t, .pstex_t, .pdf_tex,
.ps_tex. The options must be either width=XX or height=XX, where XX
is a length.
By default, a layer replaces the previous layer when displayed. You
can change the overlay specification by adding the string <spec> to
the layer title in your SVG editor. The spec part defines the slide
numbers on which the layer appears in Beamer. For example, <2> means
"only on slide 2"; <6-> means "from slide 6 to the end."
\DeclareGraphicsExtensionsWtex{extensions}
Defines the filename extensions used by \includegraphicswtex to
locate figure files.
\graphicspath{{path1},{path2}...}
This macro is from the TeX package 'graphicx.sty'. It defines the
search paths for figures.
CONFIGURATION FILE
Location of the Configuration Files
AutoLaTeX configuration files can be located in several places:
* System Configuration (for all users): In the directory where
AutoLaTeX is installed (typically /usr/lib/autolatex on Unix
systems).
* User Configuration: Two cases apply: either the configuration
directory ($HOME/.autolatex on Unix or
C:\Documents and Settings\<user>\Local Settings\Application Data\aut
olatex on Windows) exists, or it does not.
In the first case, the configuration file is stored in the directory
and named autolatex.conf.
In the second case, the configuration file is in the user directory
and named $HOME/.autolatex on Unix, or
C:\Documents and Settings\<user>\Local Settings\Application Data\aut
olatex.conf on Windows.
* Project Configuration: The configuration file is in the same
directory as the main TeX file of the document. It is named
.autolatex_project.cfg on Unix and autolatex_project.cfg on Windows.
Syntax of the Configuration Files
Configuration files follow a syntax similar to Windows .ini files.
Comments start with '#' or ';' and continue to the end of the line.
Each configuration directive must be within a configuration section,
declared by its name in brackets (e.g., [mysection]).
Each directive is declared as: directive name = value
Several section names are reserved by AutoLaTeX; others are assumed to
be translator configurations.
[Viewer] section
This section configures the viewer used by AutoLaTeX. Recognized
directives:
*view*: Indicates whether AutoLaTeX should launch a viewer after LaTeX
compilation. Accepted values: yes or no.
*viewer*: The path or command line of the viewer to launch. Accepted
value: any command line.
[Generation] section
This section configures the generation process used by AutoLaTeX.
Recognized directives:
*main file*: Specifies the basename of the main TeX file to compile.
This option is only available in the project's configuration file.
*generate images*: Indicates whether AutoLaTeX automatically generates
figures. Accepted values: yes or no.
*image directory*: Specifies directories where AutoLaTeX finds pictures
to be processed by translators. Paths are separated by the
path-separator character (':' on Unix, ';' on Windows).
*generation type*: Indicates the type of generation. Accepted values:
pdf - generate a PDF document
dvi - generate a DVI or XDV document
ps - generate a PS document
*tex compiler*: Indicates the TeX compiler to use. Accepted values:
latex - use latex
pdflatex - use pdflatex
xelatex - use xelatex
lualatex - use lualatex
*synctex*: Indicates whether the output document should be produced with
SyncTeX support.
*makeindex style*: Specifies the style to be used by MakeIndex. This is
a comma-separated list of values in order of preference. Values include:
<filename> - if a filename is specified, AutoLaTeX assumes it is the
.ist file;
@system - AutoLaTeX uses the system default .ist file (from the
AutoLaTeX distribution);
@detect - AutoLaTeX attempts to find a .ist file in the project's
directory. If none is found, no style is passed to MakeIndex;
@none - AutoLaTeX assumes no .ist file should be passed to
MakeIndex;
<empty> - AutoLaTeX assumes no .ist file should be passed to
MakeIndex.
If the list contains multiple values, AutoLaTeX applies the
corresponding behaviors in sequence.
*translator include path*: Specifies additional directories from which
translator scripts can be loaded. This is a list of paths separated by
commas or the operating system's path separator (':' on Unix, ';' on
Windows). If a path contains a comma, enclose it in quotes.
*latex_cmd*: Specifies the LaTeX tool command line. Accepted value: any
command line.
*bibtex_cmd*: Specifies the BibTeX tool command line. Accepted value:
any command line.
*biber_cmd*: Specifies the Biber tool command line. Accepted value: any
command line.
*makeglossaries_cmd*: Specifies the MakeGlossaries tool command line.
Accepted value: any command line.
*makeindex_cmd*: Specifies the MakeIndex tool command line. Accepted
value: any command line.
*dvi2ps_cmd*: Specifies the dvips tool command line. Accepted value: any
command line.
*latex_flags*: Specifies options to pass to the LaTeX tool. Accepted
value: any command line.
*bibtex_flags*: Specifies options to pass to the BibTeX tool. Accepted
value: any command line.
*biber_flags*: Specifies options to pass to the Biber tool. Accepted
value: any command line.
*makeglossaries_flags*: Specifies options to pass to the MakeGlossaries
tool. Accepted value: any command line.
*makeindex_flags*: Specifies options to pass to the MakeIndex tool.
Accepted value: any command line.
*dvi2ps_flags*: Specifies options to pass to the dvips tool. Accepted
value: any command line.
[Clean] section
This section configures the cleaning features of AutoLaTeX (targets
clean and cleanall). Recognized directives:
*files to clean*: A list of files to remove when the 'clean' target is
invoked. Shell wildcards are allowed.
*files to desintegrate*: A list of files to remove when the 'cleanall'
target is invoked. Shell wildcards are allowed.
[Scm] section
This section configures the SCM support of AutoLaTeX (CVS, SVN, or
others). Recognized directives:
*scm commit*: Specifies the command line to use when committing changes.
*scm update*: Specifies the command line to use when updating the local
copy.
Translator section
A translator section shares the name of the translator it configures.
Recognized directives:
*include module*: Indicates whether the translator should be loaded by
default. Accepted values: yes or no.
*files to convert*: A list of files to be converted by this translator.
Files are separated by the operating system's path separator (':' on
Unix, ';' on Windows).
BUG REPORT AND FEEDBACK
To report bugs, provide feedback, or suggest new features (in preferred
order): a) Visit the developer site on GitHub:
<https://github.com/gallandarakhneorg/autolatex2/> b) Visit the
AutoLaTeX main page: <http://www.arakhne.org/autolatex/> c) Send an
email to the main author: galland@arakhne.org.
SYSTEM REQUIREMENTS
AutoLaTeX can be used directly from any directory where it is
uncompressed, but you may want to compile and install additional files
(manuals, etc.).
To configure and install AutoLaTeX, you may need Python 3.12 or higher
and several Python packages, which are installed by the setup.py script.
To use AutoLaTeX, you will require:
LaTeX. AutoLaTeX was developed using the TeX Live distribution.
Python 3.12 or higher.
Several Python packages, typically included in your Python distribution.
INSTALLATION
To install AutoLaTeX, run the setup.py script to compile and install
AutoLaTeX. The basic commands are:
cd path_to_autoloader_sources/
./setup.py build install
AUTOLATEX LICENSE
GNU Lesser General Public License (LGPL)
Copyright (c) 1998-2026 Stephane GALLAND <galland@arakhne.org>
This program is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License
<http://www.gnu.org/copyleft/lgpl.html> as published by the Free
Software Foundation <http://www.fsf.org/>; either version 2 of the
License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with this program; see the file COPYING. If not, write to the Free
Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
02111-1307, USA.
MANUAL COPYRIGHT
GNU Free Documentation License (FDL)
Copyright (c) 1998-2026 Stephane Galland <galland@arakhne.org>.
Permission is granted to copy, distribute, and/or modify this document
under the terms of the GNU Free Documentation License
<http://www.gnu.org/licenses/fdl.txt>, Version 1.2 or any later version
published by the Free Software Foundation <http://www.fsf.org/>; with
the Invariant Sections being AUTOLATEX LICENSE and MANUAL COPYRIGHT, no
Front-Cover Texts, and no Back-Cover Texts. A copy of the license is
included in the file GNU Free Documentation License.txt.
SEE ALSO
pdflatex, latex, bibtex, biber, epstopdf, fig2dev, gnuplot, inkscape,
umbrello, zcat, texify