1KLATEXFORMULA(1) User Commands KLATEXFORMULA(1)
2
3
4
6 klatexformula - manual page for klatexformula 3.2.3
7
9 klatexformula [OPTIONS] [filename1 [...]]
10
12 KLatexFormula by Philippe Faist
13
14 An easy-to-use graphical application and command-line interface for
15 generating images from LaTeX equations.
16
17 Execution Modes:
18 klatexformula [filename1 [...]]
19
20 Opens klatexformula Graphical User Interface (GUI)
21
22 klatexformula [OPTIONS]
23
24 Performs actions required by [OPTIONS], and exits
25
26 klatexformula --interactive [OPTIONS] [filename1 [...]]
27
28 Opens the GUI and performs actions required by [OPTIONS]
29
30 If additional filename arguments are passed to the command line,
31 they are interpreted as library files to load into the library
32 (only in interactive mode).
33
35 -I, --interactive
36
37 Runs KLatexFormula in interactive mode with a full-featured
38 graphical user interface. This option is on by default, except
39 if --input or --latexinput is given.
40
41 -i, --input <file|->
42
43 Specifies a file to read latex input from.
44
45 -l, --latexinput <expr>
46
47 Specifies the LaTeX code of an equation to render.
48
49 -P, --paste-clipboard
50
51 -S, --paste-selection
52
53 Specifies that the LaTeX code should be pasted from the system
54 clipboard or current mouse selection. Works only in interactive
55 mode.
56
57 -n, --noeval
58
59 Do not evaluate the LaTeX equation given, leave it to the user
60 to click on the "Evaluate" button. This option may only be used
61 in interactive mode.
62
63 -B, --base64arg
64
65 Specifies that the argument to the option immediately following
66 this one is encoded in base64. For example:
67
68 klatexformula --base64arg --latexinput="YV4yK2JeMj1jXjI="
69
70 will use the latex code "a^2+b^2=c^2". This option can be spec‐
71 ified more than once on the command line, each time indicating
72 that the argument to the immediately next option is encoded in
73 base64. This option can be useful when scripting, to avoid the
74 nuisance of having to escape latex code from the shell.
75
76 -o, --output <file|->
77
78 Specifies to write the output image (obtained from equation
79 given by --input or --latexinput) to <file> or standard output.
80
81 -F, --format <format>
82
83 Specifies the format the output should be written in. By
84 default, the format is guessed from file name extension and
85 defaults to PNG.
86
87 -f, --fgcolor <'#xxxxxx'>
88
89 Specifies a color (in web #RRGGBB hex format) to use for fore‐
90 ground color. Don't forget to escape the '#' to prevent the
91 shell from interpreting it as a comment.
92
93 -b, --bgcolor <-|'#xxxxxx'>
94
95 Specifies a color (in web #RRGGBB hex format, or '-' for trans‐
96 parent) to use as background color (defaults to transparent)
97
98 -X, --dpi <N>
99
100 Use N dots per inch (DPI) when converting latex output to image.
101 Defaults to 1200 (high-resolution image).
102
103 -m, --mathmode <expression containing '...'>
104
105 Specifies which LaTeX math mode to use, if any. The argument to
106 this option is any string containing "...", which will be
107 replaced by the equation itself. Defaults to "\[ ... \]"
108
109 -p, --preamble <LaTeX code>
110
111 Any LaTeX code that will be inserted before \begin{document}.
112 Useful for including custom packages with \usepackage{...}.
113
114 -q, --quiet [<ON|Y[ES]|T[RUE]|1 or OFF|N[O]|F[ALSE]|0>]
115
116 Disable console output of warnings and errors.
117
118 --redirect-debug <file>
119
120 Redirects debugging output to the given <file>. If the file name
121 does not end with .klfdebug, this suffix is enforced. If the
122 file exists, it is silently overwritten.
123
124 -d, --daemonize
125
126 Run a separate, detached, klatexformula process and return imme‐
127 diately. All other options, like --latexinput, may still be
128 given. They will be forwared to the daemon process.
129
130 --outlinefonts [<ON|Y[ES]|T[RUE]|1 or OFF|N[O]|F[ALSE]|0>]
131
132 Convert embedded fonts in EPS and PDF to vector outlines (gs
133 with -dNOCACHE). Useful for exporting to eg. Adobe Illustrator.
134
135 --lborderoffset <N>
136
137 --tborderoffset <N>
138
139 --rborderoffset <N>
140
141 --bborderoffset <N>
142
143 Include a margin of N postscript points on left, top, right, or
144 bottom margin respectively.
145
146 --tempdir </path/to/temp/dir>
147
148 Specify the directory in which KLatexFormula will write tempo‐
149 rary files. Defaults to a system-specific temporary directory
150 like "/tmp/".
151
152 --latex <latex executable>
153
154 --dvips <dvips executable>
155
156 --gs <gs executable>
157
158 --epstopdf <epstopdf executable>
159
160 Specifiy the executable for latex, dvips, gs or epstopdf. By
161 default, they are searched for in $PATH and in common system
162 directories.
163
164 -Q, --qtoption <qt-option>
165
166 Specify a Qt-specific option. For example, to launch KLatexFor‐
167 mula in Plastique GUI style, use
168
169 klatexformula --qtoption="-style=Plastique"
170
171 Note that if <qt-option> begins with a '-', then it must be
172 appended to the long '--qtoption=' syntax with the equal sign.
173
174 -h, --help [<filename|&N>]
175
176 Display this help text and exit. If a file name is provided,
177 the help message is appended to that file. If the argument is
178 "&<N>", then the help message is printed in file descriptor N.
179 (Reminder: N=1 for standard output 'stdout', N=2 for standard
180 error output 'stderr')
181
182 -V, --version [<filename|&N>][:<format>]
183
184 Display KLatexFormula version information and exit. The
185 optional output argument is handled as with --help, however it
186 may also contain a version string format preceded by a colon
187 where %k, and %q and %% are respectively replaced by klatexfor‐
188 mula version, Qt version and a literal %.
189
191 Create an image named filename.png from the equation
192 'a^2+b^2=c^2':
193
194 klatexformula --latexinput 'a^2+b^2=c^2' --output filename.png
195
196 Open klatexformula window with equation 'f(x)=-2\,x', but don't
197 evaluate it:
198
199 klatexformula -I --latexinput='f(x)=-2\,x' --noeval
200
201 Open klatexformula window and return immediately to shell com‐
202 mand:
203
204 klatexformula -I --daemonize
205
206 Print help message, but to standard output instead of standard
207 error output:
208
209 klatexformula --help='&1'
210
211 Notes:
212 When run in interactive mode, the newly evaluated equation is
213 appended to KLatexFormula's history.
214
215 When not run in interactive mode, no X11 server is needed.
216
217 Additional translation files and/or data can be provided to kla‐
218 texformula by specifying a list of Qt rcc files or directories
219 containing such files to import in the KLF_RESOURCES environment
220 variable. Separate the file names with ':' on unix/mac, or ';'
221 on windows. The default paths can be included with an empty sec‐
222 tion ('::') or leading or trailing ':'.
223
224 Please report any bugs and malfunctions to the author.
225
226 More information is available on http://klatexformula.sourceforge.net/.
227
228 Have a lot of fun!
229
230
231
232klatexformula 3.2.3 April 2011 KLATEXFORMULA(1)