From 75955a0dece2b1996d51d4f43ad5778cd6d5b4cc Mon Sep 17 00:00:00 2001 From: Norbert Preining Date: Wed, 19 Aug 2020 03:03:01 +0000 Subject: CTAN sync 202008190303 --- support/ltximg/README.md | 122 ++++++++++++++++++++++++++++------------------- 1 file changed, 72 insertions(+), 50 deletions(-) (limited to 'support/ltximg/README.md') diff --git a/support/ltximg/README.md b/support/ltximg/README.md index de487ceabd..f61e27dd66 100644 --- a/support/ltximg/README.md +++ b/support/ltximg/README.md @@ -1,38 +1,50 @@ -## LTXimg – LaTeX environments to image format +## LTXimg – Extract LaTeX environments to image format and standalone files + +Release v1.8 \[2020-08-18\] ## 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 in individual files using `ghostscript` and `poppler-utils`. Generates a file -with only extracted environments and other with environments converted to `\includegraphics`. +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 -```bash -$ ltximg [] [] [--] . + ``` +$ ltximg [] [--] . +``` + +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 -```bash + +``` $ ltximg --latex [] $ ltximg --arara [] $ ltximg [] $ ltximg ``` -If used without `[]` and `[]` the extracted environments are converted to `pdf` image format -and saved in the `/images` directory using `pdflatex` and `preview` package. Relative or absolute `paths` for files -and directories is not supported. If the last `[]` take a *list separated by commas*, you need `--` at the end. + +If used without `[]` the extracted environments are converted to `pdf` image format +and saved in the `./images` directory using `pdflatex` and `preview` package to process ``. ## Default environments extract -```bash - pspicture tikzpicture pgfpicture psgraph postscript PSTexample + +``` + preview pspicture tikzpicture pgfpicture psgraph postscript PSTexample ``` + ## Options -```bash +``` [default] -h, --help Display command line help and exit [off] --l, --license Display GPL license and exit [off] --v, --version Display current version (1.7) and exit [off] +-v, --version Display current version (1.8) 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] @@ -42,65 +54,75 @@ and directories is not supported. If the last `[]` take a *list separat -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 whitout "preview" package [off] +-n, --noprew Create images files without "preview" package [off] +-r , --runs + Set the number of times the compiler will run + on the input file for environment extraction [1] -d , --dpi Dots per inch resolution for images [150] --m , --margin - Set margins for pdfcrop [0] ---imgdir Set name of directory to save images [images] ---zip Compress files generated in .zip format [off] ---tar Compress files generated in .tar.gz format [off] +-m , --margins + Set margins in bp for pdfcrop [0] -o , --output Create output file [off] ---verbose Verbose printing [off] ---srcenv Create files whit only code environment [off] ---subenv Create files whit preamble and code [off] +--imgdir Set name of directory to save images/files [images] +--prefix Set prefix append to each generated files [fig] +--myverb 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] ---arara Use arara for compiler input and 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] ---dvipdf Using dvipdfmx for compiler input and output [off] --luatex Using lualatex for compiler input and output [off] ---prefix Set prefix append to each image file [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] ---verbcmd Set "\cmdname" verbatim command [myverb] ---clean (doc|pst|tkz|all|off) - Removes specific text in output file [doc] --extrenv Add new environments to extract [empty] ---skipenv Skip environments to extract [empty] ---verbenv Add verbatim environments [empty] ---writenv Add verbatim write environments [empty] +--skipenv Skip some default environments to extract [empty] +--verbenv Add new verbatim environments [empty] +--writenv Add new verbatim write environments [empty] --deltenv Delete environments in output file [empty] ``` + ## Example -```bash -$ ltximg --latex -e -p --srcenv --imgdir=mypics -o test-out test-in.ltx + ``` -```bash -$ ltximg --latex -ep --srcenv --imgdir mypics -o test-out test-in.ltx +$ ltximg --latex -e -p --subenv --imgdir mypics -o test-out test-in.ltx ``` - Create a `/mypics` directory whit all extracted environments converted to - image formats (`.pdf`, `.eps`, `.png`), individual files whit source code (`.tex`) - for all extracted environments, a file `test-out.ltx` whit all environments converted to `\includegraphics` - and file `test-in-fig-all.tex` with only the extracted environments using - `latex>dvips>ps2pdf` and `preview` package for `` and `pdflatex` - for ``. + +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 `` and `pdflatex` for ``. ## Documentation - For full documentation use: -```bash + +For full documentation use: + +``` $ texdoc ltximg ``` - For recreation all documentation use: -```bash -$ arara ltximg-doc.dtx + +For recreation all documentation use: + +``` +$ arara ltximg-doc.dtx -H ``` ## Licence + 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. @@ -111,8 +133,8 @@ License for more details. ## Author -Written by Pablo González L , last update 2019-08-24. +Written by Pablo González L ``. ## Copyright -Copyright 2013 - 2019 by Pablo González L +Copyright 2013 - 2020 by Pablo González L. -- cgit v1.2.3