NAME

eqedit: command-line image generator for LaTeX

SYNOPSIS

 eqedit --help
 eqedit {options}
 echo '\LaTeX{} equations are nice' | eqedit --page-color=transparent -o nice.png; display nice.png

DESCRIPTION

eqedit is a command-line utility to generate an image from LaTeX input. It reads LaTeX input from stdin, and writes the output as a file specified with the --output option. The output format can be any format ImageMagick supports.

It is used by eqe, which wraps it in a GUI with drag and drop support.

OPTIONS

All options can be abbreviated.

HELP

--help: Shows help about using eqedit.
--version: Displays the current version.

ESSENTIAL

--output=<file> [eq.png]: Sets the output file. Can be of any extension that ImageMagick supports (including png, jpeg, eps...).

FORMATTING

--magnification=<float> [3.0]: Sets the size of the output.
--text-color=<black|white|red|green|blue|cyan|magenta|yellow|transparent> [LaTeX default]: Sets the color of the text. Available colors are those supported by the 'color' LaTeX package, plus 'transparent'.
--page-color=<...> [LaTeX default]: Sets the color of the background. Available colors are those supported by the 'color' LaTeX package, plus 'transparent'.
--font=<8r|avant|bookman|chancery|charter|courier|helvet|mathpazo|mathpple|mathptm|mathptmx|newcent|palatino|pifont|times> [LaTeX default]: Sets the font. Available fonts are those known to the LaTeX installation.
--displaymath=<0|1> [0]: Whether to wrap the input in a 'displaymath' LaTeX block.

ADVANCED AND EXPERIMENTAL

--width=<int> [as defined after magnification]
--height=<int> [as defined after magnification]: Set the dimensions of the output image. The default is to use the magnification to compute the size of the text, and to crop all the blank area around it.
--latex-template=<file> [template.tt.tex]: LaTeX template to use. eqedit searches for the template (by default, template.tt.tex) in $HOME/.eqe/, /usr/local/share/eqe/, /usr/share/eqe/. If it cannot be found, it uses a builtin template. You may specify just a name (searched for in the search path), or an absolute or relative path to the template to be used. The template is in a format described in "perldoc Template::Manual::Syntax" (ie, the Template Toolkit syntax).
--use-dvipng [off, ie use dvips]: Uses dvipng to convert the dvi to a png. Else, dvips is used.
--lumitransparency (experimental): Uses luminance to compute transparency (alpha). Buggy. Needs GD.

LOGGING AND DEBUGGING

--verbose [no]: Displays additional messages on stderr about what eqedit is doing.
--log=<file> [/dev/null]: Specifies a file to log messages and tools output.
--keep-temp [no]: Whether to keep temporary files. Together with --verbose, useful for debugging.

AUTHOR

Ronan Le Hy <rlehy@free.fr>