ltximg(1)

🎀 NAME 🎀

okay so bestie, this is ltximg — it's from the General Commands Manual (that's section 1, the commands section, iykyk) and it does exactly one iconic thing: it turns LaTeX environments into image files and standalone files. that's the whole vibe. 💅

---

✨ SYNOPSIS ✨

ltximg [<options>] [--] <filename>.<tex|ltx>

---

🦋 DESCRIPTION 🦋

so ltximg automates the process of extracting and converting environments from a LaTeX file into image formats and standalone files, and it does that using ghostscript and poppler-utils. no cap.

it generates one file with only the extracted environments, and another file with all the extracted environments converted to \includegraphics. two files, two moods, both slay.

and by default, the extracted environments are, in this exact order:

• preview
• pspicture
• tikzpicture
• pgfpicture
• psgraph
• postscript
• PSTexample

periodt. that's the starter pack. 🌸

---

💖 OPTIONS 💖

first, the ground rules, because the way that these options work is very specific and we respect it:

• options that accept a value need either a blank space or = between the option and the value. pick your fighter.
• multiple short options can be bundled together — and if the last option in that bundle takes a comma separated list, you need -- at the end. yes really.
• relative or absolute paths for directories and files is not supported. like, at all. don't try it, bestie. 😭

and if you run it with no [<options>] at all? the extracted environments get converted to pdf image format and saved in the ./images directory, using pdflatex and the preview package for the process. easy default, no thoughts needed. 🫶

⭐ General script options ⭐

• -h, --help — show the command line help and dip out. exit stage left. 🚪
• -v, --version — show the current version and dip out.
• -V, --verbose — verbose printing information. it will tell you things. lots of things. 💬
• -l, --log — write a .log file with debug information.
• -t, --tif — create .tif files using ghostscript.
• -b, --bmp — create .bmp files using ghostscript.
• -j, --jpg — create .jpg files using ghostscript.
• -p, --png — create .png files using ghostscript.
• -e, --eps — create .eps files using pdftops.
• -s, --svg — create .svg files using pdftocairo.
• -P, --ppm — create .ppm files using pdftoppm.
• -g, --gray — gray scale for images, using ghostscript.
• -f, --force — capture \psset and \tikzset to extract. forceful. 💪
• -n, --noprew — create images files without the preview package.
• -r integer, --runs=integer — set the number of times the compiler will run on the input file for environment extraction. default: 1.
• -d integer, --dpi=integer — dots per inch resolution for images. default: 150.
• -m integer, --margins=integer — set margins in bp for pdfcrop. default: 0.
• -o filename, --output=filename — create output file.
• --imgdir=dirname — set the name of the directory to save images and files in. default: images.
• --prefix=string — set the prefix appended to each generated file. default: fig.
• --myverb=macroname — add \macroname to the verbatim inline search. default: myverb.
• --clean=doc|pst|tkz|all|off — removes specific block text in the output file. default: doc.
• --zip — compress the generated files in .zip format.
• --tar — compress the generated files in .tar.gz format.
• --srcenv — create files with only the code of environments.
• --subenv — create standalone files for environments. main character energy fr fr. 👑
• --shell — enable \write18{SHELL COMMAND}.

okay real talk about that last one: --shell turns on \write18{SHELL COMMAND}, which means shell commands can actually run. be normal about it. 🙈

• --latex — using latex>dvips>ps2pdf for compiler input and pdflatex for compiler output.
• --dvips — using latex>dvips>ps2pdf for compiler input and latex>dvips>ps2pdf for compiler output.
• --dvilua — using dvilualatex>dvips>ps2pdf for compiler input and lualatex for compiler output.
• --dvipdf — using latex>dvipdfmx for compiler input and latex>dvipdfmx for compiler output.
• --xetex — using xelatex for compiler input and output.
• --luatex — using lualatex for compiler input and output.
• --arara — use arara for compiler input and output.
• --latexmk — using latexmk for compiler output file.
• --norun — run the script, but don't create images files.
• --nopdf — don't create a .pdf image files.
• --nocrop — don't run pdfcrop.
• --extrenv=env1,env2,... — add new environments to extract.
• --skipenv=env1,env2,... — skip some of the default environments to extract.
• --verbenv=env1,env2,... — add new verbatim environments.
• --writenv=env1,env2,... — add new verbatim write environments.
• --deltenv=env1,env2,... — delete environments in the output file.

---

🌈 EXAMPLE 🌈

ltximg --latex -e -p --subenv -o test-out.ltx test-in.ltx

and here's what that actually gives you, step by step: it creates a ./images directory (if it doesn't exist — it won't yell at you, it'll just make it 💖) with all the extracted environments converted to .pdf, .eps, .png and standalone files, plus a file test-in-fig-all.ltx with all extracted environments, and the file test-out.ltx with all environments converted to \includegraphics.

all of that using latex>dvips>ps2pdf and the preview package for test-in.ltx, and pdflatex for test-out.ltx. ate. 💅

---

🧚 DOCUMENTATION 🧚

for the full documentation, use:

texdoc ltximg

go read it, bestie, it's giving thorough. 📚

---

🔥 ISSUES AND REPORTS 🔥

• Repository : https://github.com/pablgonz/ltximg
• Bug tracker: https://github.com/pablgonz/ltximg/issues

found a bug? tell the repo. they wanna know. 🫶

---

💜 AUTHOR 💜

Pablo González Luengo, pablgonz@yahoo.com.

---

👑 COPYRIGHT AND LICENSE 👑

Copyright 2013-2021 Pablo González, 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.

no warranty bestie. none. zero. the lawyers said so. 😭

---

🌸 SEE ALSO 🌸

• gs(1)
• dvips(1)
• ps2pdf(1)
• pdfcrop(1)
• pdftops(1)
• pdftocairo(1)
• pdftoppm(1)

---

and that's the whole page!! this was version 2.1, dated 2021-05-21, living in the General Commands Manual — so like, if you ever forget any of this, the manual remembers for you. byeee, go extract some environments 💖✨🎀🦋