## LTXimg – LaTeX environments to image and standalone files
Release v2.1 \[2021-05-21\]
## Description
**ltximg** is a perl *script* that automates the process of extracting and converting
environments provided by **TikZ**, **PStricks** and other packages from input file
to image formats and standalone files using `ghostscript` and `poppler-utils`. Generates a
file with only extracted environments and another with all extracted environments converted to `\includegraphics`.
## Syntax
```
$ ltximg [<options>] [--] <input file>.<tex|ltx>
```
Relative or absolute `paths` for directories and files is not supported. Options that accept a _value_ require either a blank
space or `=` between the option and the _value_. Multiple short options can be bundling and if the last option takes a _comma
separated list_ you need `--` at the end.
## Usage
```
$ ltximg --latex [<options>] <file.tex>
$ ltximg --arara [<options>] <file.tex>
$ ltximg [<options>] <file.tex>
$ ltximg <file.tex>
```
If used without `[<options>]` the extracted environments are converted to `pdf` image format
and saved in the `./images` directory using `pdflatex` and `preview` package to process `<input file>`.
## Default environments extract
```
preview pspicture tikzpicture pgfpicture psgraph postscript PSTexample
```
## Options
```
[default]
-h, --help Display command line help and exit [off]
-v, --version Display current version (2.1) and exit [off]
-V, --verbose Verbose printing information [off]
-l, --log Write .log file with debug information [off]
-t, --tif Create .tif files using ghostscript [gs]
-b, --bmp Create .bmp files using ghostscript [gs]
-j, --jpg Create .jpg files using ghostscript [gs]
-p, --png Create .png files using ghostscript [gs]
-e, --eps Create .eps files using poppler-utils [pdftops]
-s, --svg Create .svg files using poppler-utils [pdftocairo]
-P, --ppm Create .ppm files using poppler-utils [pdftoppm]
-g, --gray Gray scale for images using ghostscript [off]
-f, --force Capture "\psset" and "\tikzset" to extract [off]
-n, --noprew Create images files without "preview" package [off]
-r <integer>, --runs=<integer>
Set the number of times the compiler will run
on the input file for environment extraction [1]
-d <integer>, --dpi=<integer>
Dots per inch resolution for images [150]
-m <integer>, --margins=<integer>
Set margins in bp for pdfcrop [0]
-o <filename>, --output=<filename>
Create output file [off]
--imgdir=<dirname> Set name of directory to save images/files [images]
--prefix=<string> Set prefix append to each generated files [fig]
--myverb=<macroname> Add "\macroname" to verbatim inline search [myverb]
--clean=doc|pst|tkz|all|off
Removes specific block text in output file [doc]
--zip Compress files generated in .zip [off]
--tar Compress files generated in .tar.gz [off]
--srcenv Create files with only code of environments [off]
--subenv Create standalone files for environments [off]
--shell Enable \write18{SHELL COMMAND} [off]
--latex Using latex>dvips>ps2pdf for compiler input
and pdflatex for compiler output [off]
--dvips Using latex>dvips>ps2pdf for compiler input
and latex>dvips>ps2pdf for compiler output [off]
--dvilua Using dvilualatex>dvips>ps2pdf for compiler
input and lualatex for compiler output [off]
--dvipdf Using latex>dvipdfmx for compiler input and
latex>dvipdfmx for compiler output [off]
--xetex Using xelatex for compiler input and output [off]
--luatex Using lualatex for compiler input and output [off]
--arara Use arara for compiler input and output [off]
--latexmk Using latexmk for compiler output file [off]
--norun Run script, but no create images files [off]
--nopdf Don't create a ".pdf" image files [off]
--nocrop Don't run pdfcrop [off]
--extrenv=<env1,...> Add new environments to extract [empty]
--skipenv=<env1,...> Skip some default environments to extract [empty]
--verbenv=<env1,...> Add new verbatim environments [empty]
--writenv=<env1,...> Add new verbatim write environments [empty]
--deltenv=<env1,...> Delete environments in output file [empty]
```
## Example
```
$ ltximg --latex -e -p --subenv --imgdir mypics -o test-out test-in.ltx
```
Create a `./mypics` directory (if it doesn’t exist) with all extracted environments
converted to images (`.pdf`, `.eps`, `.png`) and _standalone_ files (`.ltx`), a file `test-in-fig-all.ltx`
with all extracted environments and the file `test-out.ltx` with all environments converted to `\includegraphics`
using `latex>dvips>ps2pdf` and `preview` package for `<input file>` and `pdflatex` for `<output file>`.
## Documentation
For full documentation use:
```
$ texdoc ltximg
```
For recreation all documentation use:
```
$ arara ltximg-doc.tex -H
```
## Author
Pablo González L, `<pablgonz@yahoo.com>`.
## Copyright and Licence
Copyright 2013 - 2021 Pablo González L `<pablgonz@yahoo.com>`.
This program is free software; you can redistribute it and/or modify it under the terms of the GNU
General Public License as published by the Free Software Foundation; either version 3 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 General Public
License for more details.
Generated by dwww version 1.15 on Thu Jun 27 10:15:46 CEST 2024.