=head1 NAME

eqedit: command-line image generator for LaTeX

=head1 SYNOPSIS

 eqedit --help

 eqedit {options}

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

=head1 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 L<eqe>, which wraps it in a GUI with drag and drop support.

=head1 OPTIONS

All options can be abbreviated.

=head2 HELP

=over

=item B<--help>

Shows help about using eqedit.

=item B<--version>

Displays the current version.

=back

=head2 ESSENTIAL

=over

=item B<--output>=<file> [eq.png]

Sets the output file. Can be of any extension that ImageMagick supports
(including png, jpeg, eps...).

=back

=head2 FORMATTING

=over

=item B<--magnification>=<float> [3.0]

Sets the size of the output.

=item B<--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'.

=item B<--page-color>=<...> [LaTeX default]

Sets the color of the background. Available colors are those supported
by the 'color' LaTeX package, plus 'transparent'.

=item B<--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.

=item B<--displaymath>=<0|1> [0]

Whether to wrap the input in a 'displaymath' LaTeX block.

=back

=head2 ADVANCED AND EXPERIMENTAL

=over

=item B<--width>=<int>  [as defined after magnification]

=item B<--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.

=item B<--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 C<perldoc Template::Manual::Syntax>
(ie, the Template Toolkit syntax).

=item B<--use-dvipng> [off, ie use dvips]

Uses dvipng to convert the dvi to a png. Else, dvips is used.

=item B<--lumitransparency> (experimental)

Uses luminance to compute transparency (alpha). Buggy. Needs GD.

=back

=head2 LOGGING AND DEBUGGING

=over

=item B<--verbose> [no]

Displays additional messages on stderr about what eqedit is doing.

=item B<--log>=<file> [/dev/null]

Specifies a file to log messages and tools output.

=item B<--keep-temp> [no]

Whether to keep temporary files. Together with --verbose, useful
for debugging.

=back

=head1 AUTHOR

Ronan Le Hy <rlehy@free.fr>

=head1 SEE ALSO

L<eqe>, L<ImageMagick>

=cut