Debian Codegraph @

texmf-dist/doc/man/man1/ltximg.1

raw
1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings. \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
21 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 . ds -- \(*W-
28 . ds PI pi
29 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
31 . ds L" ""
32 . ds R" ""
33 . ds C` ""
34 . ds C' ""
35 'br\}
36 .el\{\
37 . ds -- \|\(em\|
38 . ds PI \(*p
39 . ds L" ``
40 . ds R" ''
41 . ds C`
42 . ds C'
43 'br\}
44 .\"
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
46 .ie \n(.g .ds Aq \(aq
47 .el .ds Aq '
48 .\"
49 .\" If the F register is >0, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD. Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
53 .\"
54 .\" Avoid warning from groff about undefined register 'F'.
55 .de IX
56 ..
57 .nr rF 0
58 .if \n(.g .if rF .nr rF 1
59 .if (\n(rF:(\n(.g==0)) \{\
60 . if \nF \{\
61 . de IX
62 . tm Index:\\$1\t\\n%\t"\\$2"
63 ..
64 . if !\nF==2 \{\
65 . nr % 0
66 . nr F 2
67 . \}
68 . \}
69 .\}
70 .rr rF
71 .\" ========================================================================
72 .\"
73 .IX Title "ltximg 1"
74 .TH ltximg 1 "2021-05-21" "2.1" "General Commands Manual"
75 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
76 .\" way too many mistakes in technical documents.
77 .if n .ad l
78 .nh
79 .SH "NAME"
80 ltximg \- LaTeX environments to image and standalone files
81 .SH "SYNOPSIS"
82 .IX Header "SYNOPSIS"
83 \&\fBltximg\fR [<\fIoptions\fR>] [\-\-] <\fIfilename\fR>.<\fItex\fR|\fIltx\fR>
84 .SH "DESCRIPTION"
85 .IX Header "DESCRIPTION"
86 \&\fBltximg\fR automates the process of extracting and converting
87 environments from LaTeX file to image formats and \fIstandalone\fR files
88 using \fIghostscript\fR and \fIpoppler-utils\fR. Generates a one file with
89 only extracted environments and other with all extracted environments
90 converted to \f(CW\*(C`\eincludegraphics\*(C'\fR.
91 .PP
92 By default the extracted environments are:
93 .PP
94 \&\fBpreview\fR \fBpspicture\fR \fBtikzpicture\fR \fBpgfpicture\fR \fBpsgraph\fR \fBpostscript\fR \fBPSTexample\fR
95 .SH "OPTIONS"
96 .IX Header "OPTIONS"
97 Options that accept a value require either a blank space or \f(CW\*(C`=\*(C'\fR between
98 the option and the value. Multiple short options can be bundling and
99 if the last option takes a comma separated list you need \f(CW\*(C`\-\-\*(C'\fR at the end.
100 Relative or absolute paths for directories and files is not supported.
101 .PP
102 If used without [<\fIoptions\fR>] the extracted environments are converted
103 to \fIpdf\fR image format and saved in \f(CW\*(C`./images\*(C'\fR directory using \f(CW\*(C`pdflatex\*(C'\fR
104 and \fIpreview\fR package for process.
105 .PP
106 General script options:
107 .IP "\fB\-h\fR, \fB\-\-help\fR" 4
108 .IX Item "-h, --help"
109 Display command line help and exit.
110 .IP "\fB\-v\fR, \fB\-\-version\fR" 4
111 .IX Item "-v, --version"
112 Display current version and exit.
113 .IP "\fB\-V\fR, \fB\-\-verbose\fR" 4
114 .IX Item "-V, --verbose"
115 Verbose printing information.
116 .IP "\fB\-l\fR, \fB\-\-log\fR" 4
117 .IX Item "-l, --log"
118 Write \f(CW\*(C`.log\*(C'\fR file with debug information.
119 .IP "\fB\-t\fR, \fB\-\-tif\fR" 4
120 .IX Item "-t, --tif"
121 Create \f(CW\*(C`.tif\*(C'\fR files using \fIghostscript\fR.
122 .IP "\fB\-b\fR, \fB\-\-bmp\fR" 4
123 .IX Item "-b, --bmp"
124 Create \f(CW\*(C`.bmp\*(C'\fR files using \fIghostscript\fR.
125 .IP "\fB\-j\fR, \fB\-\-jpg\fR" 4
126 .IX Item "-j, --jpg"
127 Create \f(CW\*(C`.jpg\*(C'\fR files using \fIghostscript\fR.
128 .IP "\fB\-p\fR, \fB\-\-png\fR" 4
129 .IX Item "-p, --png"
130 Create \f(CW\*(C`.png\*(C'\fR files using \fIghostscript\fR.
131 .IP "\fB\-e\fR, \fB\-\-eps\fR" 4
132 .IX Item "-e, --eps"
133 Create \f(CW\*(C`.eps\*(C'\fR files using \fIpdftops\fR.
134 .IP "\fB\-s\fR, \fB\-\-svg\fR" 4
135 .IX Item "-s, --svg"
136 Create \f(CW\*(C`.svg\*(C'\fR files using \fIpdftocairo\fR.
137 .IP "\fB\-P\fR, \fB\-\-ppm\fR" 4
138 .IX Item "-P, --ppm"
139 Create \f(CW\*(C`.ppm\*(C'\fR files using \fIpdftoppm\fR.
140 .IP "\fB\-g\fR, \fB\-\-gray\fR" 4
141 .IX Item "-g, --gray"
142 Gray scale for images using \fIghostscript\fR.
143 .IP "\fB\-f\fR, \fB\-\-force\fR" 4
144 .IX Item "-f, --force"
145 Capture \f(CW\*(C`\epsset\*(C'\fR and \f(CW\*(C`\etikzset\*(C'\fR to extract.
146 .IP "\fB\-n\fR, \fB\-\-noprew\fR" 4
147 .IX Item "-n, --noprew"
148 Create images files without \fIpreview\fR package.
149 .IP "\fB\-r\fR \fIinteger\fR, \fB\-\-runs\fR=\fIinteger\fR" 4
150 .IX Item "-r integer, --runs=integer"
151 Set the number of times the compiler will run on the \fIinput\fR file for
152 environment extraction (default: 1).
153 .IP "\fB\-d\fR \fIinteger\fR, \fB\-\-dpi\fR=\fIinteger\fR" 4
154 .IX Item "-d integer, --dpi=integer"
155 Dots per inch resolution for images (default: 150).
156 .IP "\fB\-m\fR \fIinteger\fR, \fB\-\-margins\fR=\fIinteger\fR" 4
157 .IX Item "-m integer, --margins=integer"
158 Set margins in bp for \fIpdfcrop\fR (default: 0).
159 .IP "\fB\-o\fR \fIfilename\fR, \fB\-\-output\fR=\fIfilename\fR" 4
160 .IX Item "-o filename, --output=filename"
161 Create \fIoutput\fR file.
162 .IP "\fB\-\-imgdir\fR=\fIdirname\fR" 4
163 .IX Item "--imgdir=dirname"
164 Set name of directory to save images and files (default: images).
165 .IP "\fB\-\-prefix\fR=\fIstring\fR" 4
166 .IX Item "--prefix=string"
167 Set \fIprefix\fR append to each generated files (default: fig).
168 .IP "\fB\-\-myverb\fR=\fImacroname\fR" 4
169 .IX Item "--myverb=macroname"
170 Add \f(CW\*(C`\emacroname\*(C'\fR to verbatim inline search (default: myverb).
171 .IP "\fB\-\-clean\fR=\fIdoc\fR|\fIpst\fR|\fItkz\fR|\fIall\fR|\fIoff\fR" 4
172 .IX Item "--clean=doc|pst|tkz|all|off"
173 Removes specific block text in \fIoutput\fR file (default: doc).
174 .IP "\fB\-\-zip\fR" 4
175 .IX Item "--zip"
176 Compress files generated in \f(CW\*(C`.zip\*(C'\fR format.
177 .IP "\fB\-\-tar\fR" 4
178 .IX Item "--tar"
179 Compress files generated in \f(CW\*(C`.tar.gz\*(C'\fR format.
180 .IP "\fB\-\-srcenv\fR" 4
181 .IX Item "--srcenv"
182 Create files with only code of environments.
183 .IP "\fB\-\-subenv\fR" 4
184 .IX Item "--subenv"
185 Create standalone files for environments.
186 .IP "\fB\-\-shell\fR" 4
187 .IX Item "--shell"
188 Enable \f(CW\*(C`\ewrite18{SHELL COMMAND}\*(C'\fR.
189 .IP "\fB\-\-latex\fR" 4
190 .IX Item "--latex"
191 Using \f(CW\*(C`latex>dvips>ps2pdf\*(C'\fR for compiler \fIinput\fR and \f(CW\*(C`pdflatex\*(C'\fR for compiler
192 \&\fIoutput\fR.
193 .IP "\fB\-\-dvips\fR" 4
194 .IX Item "--dvips"
195 Using \f(CW\*(C`latex>dvips>ps2pdf\*(C'\fR for compiler \fIinput\fR and \f(CW\*(C`latex>dvips>ps2pdf\*(C'\fR for
196 compiler \fIoutput\fR.
197 .IP "\fB\-\-dvilua\fR" 4
198 .IX Item "--dvilua"
199 Using \f(CW\*(C`dvilualatex>dvips>ps2pdf\*(C'\fR for compiler \fIinput\fR and \f(CW\*(C`lualatex\*(C'\fR for
200 compiler \fIoutput\fR.
201 .IP "\fB\-\-dvipdf\fR" 4
202 .IX Item "--dvipdf"
203 Using \f(CW\*(C`latex>dvipdfmx\*(C'\fR for compiler \fIinput\fR and \f(CW\*(C`latex>dvipdfmx\*(C'\fR for compiler
204 \&\fIoutput\fR.
205 .IP "\fB\-\-xetex\fR" 4
206 .IX Item "--xetex"
207 Using \f(CW\*(C`xelatex\*(C'\fR for compiler \fIinput\fR and \fIoutput\fR.
208 .IP "\fB\-\-luatex\fR" 4
209 .IX Item "--luatex"
210 Using \f(CW\*(C`lualatex\*(C'\fR for compiler \fIinput\fR and \fIoutput\fR.
211 .IP "\fB\-\-arara\fR" 4
212 .IX Item "--arara"
213 Use \f(CW\*(C`arara\*(C'\fR for compiler \fIinput\fR and \fIoutput\fR.
214 .IP "\fB\-\-latexmk\fR" 4
215 .IX Item "--latexmk"
216 Using \f(CW\*(C`latexmk\*(C'\fR for compiler \fIoutput\fR file.
217 .IP "\fB\-\-norun\fR" 4
218 .IX Item "--norun"
219 Run script, but no create images files.
220 .IP "\fB\-\-nopdf\fR" 4
221 .IX Item "--nopdf"
222 Don't create a \f(CW\*(C`.pdf\*(C'\fR image files.
223 .IP "\fB\-\-nocrop\fR" 4
224 .IX Item "--nocrop"
225 Don't run \fIpdfcrop\fR.
226 .IP "\fB\-\-extrenv\fR=\fIenv1,env2,...\fR" 4
227 .IX Item "--extrenv=env1,env2,..."
228 Add new environments to extract.
229 .IP "\fB\-\-skipenv\fR=\fIenv1,env2,...\fR" 4
230 .IX Item "--skipenv=env1,env2,..."
231 Skip some default environments to extract.
232 .IP "\fB\-\-verbenv\fR=\fIenv1,env2,...\fR" 4
233 .IX Item "--verbenv=env1,env2,..."
234 Add new verbatim environments.
235 .IP "\fB\-\-writenv\fR=\fIenv1,env2,...\fR" 4
236 .IX Item "--writenv=env1,env2,..."
237 Add new verbatim write environments.
238 .IP "\fB\-\-deltenv\fR=\fIenv1,env2,...\fR" 4
239 .IX Item "--deltenv=env1,env2,..."
240 Delete environments in \fIoutput\fR file.
241 .SH "EXAMPLE"
242 .IX Header "EXAMPLE"
243 \&\fBltximg\fR \-\-latex \-e \-p \-\-subenv \-o test\-out.ltx test\-in.ltx
244 .PP
245 Create a \f(CW\*(C`./images\*(C'\fR directory (if it doesn't exist) with all extracted
246 environments converted to \f(CW\*(C`.pdf\*(C'\fR, \f(CW\*(C`.eps\*(C'\fR, \f(CW\*(C`.png\*(C'\fR and \fIstandalone\fR
247 files, a file \fItest\-in\-fig\-all.ltx\fR with all extracted environments
248 and the file \fItest\-out.ltx\fR with all environments converted to
249 \&\f(CW\*(C`\eincludegraphics\*(C'\fR using \f(CW\*(C`latex>dvips>ps2pdf\*(C'\fR and \fIpreview\fR
250 package for \fItest\-in.ltx\fR and \f(CW\*(C`pdflatex\*(C'\fR for \fItest\-out.ltx\fR.
251 .SH "DOCUMENTATION"
252 .IX Header "DOCUMENTATION"
253 For full documentation use:
254 .PP
255 texdoc \fBltximg\fR
256 .SH "ISSUES AND REPORTS"
257 .IX Header "ISSUES AND REPORTS"
258 \&\fBRepository\fR : <https://github.com/pablgonz/ltximg>
259 .PP
260 \&\fBBug tracker\fR: <https://github.com/pablgonz/ltximg/issues>
261 .SH "AUTHOR"
262 .IX Header "AUTHOR"
263 Pablo González Luengo, \[email protected]\fR.
264 .SH "COPYRIGHT AND LICENSE"
265 .IX Header "COPYRIGHT AND LICENSE"
266 Copyright 2013\-2021 Pablo González, \[email protected]\fR.
267 .PP
268 This program is free software; you can redistribute it and/or modify
269 it under the terms of the \s-1GNU\s0 General Public License as published by
270 the Free Software Foundation; either version 3 of the License, or
271 (at your option) any later version.
272 .PP
273 This program is distributed in the hope that it will be useful, but
274 \&\s-1WITHOUT ANY WARRANTY\s0; without even the implied warranty of
275 \&\s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE.\s0 See the \s-1GNU\s0
276 General Public License for more details.
277 .SH "SEE ALSO"
278 .IX Header "SEE ALSO"
279 \&\fBgs\fR\|(1), \fBdvips\fR\|(1), \fBps2pdf\fR\|(1), \fBpdfcrop\fR\|(1), \fBpdftops\fR\|(1), \fBpdftocairo\fR\|(1), \fBpdftoppm\fR\|(1)