1KLATEXFORMULA(1) User Commands KLATEXFORMULA(1)
2
6 klatexformula - manual page for klatexformula 3.2.3
7
9 klatexformula [OPTIONS] [filename1 [...]]
10
12 KLatexFormula by Philippe Faist
13 An easy-to-use graphical application and command-line interface for
15 generating images from LaTeX equations.
16 Execution Modes:
18 klatexformula [filename1 [...]]
19 Opens klatexformula Graphical User Interface (GUI)
21 klatexformula [OPTIONS]
23 Performs actions required by [OPTIONS], and exits
25 klatexformula --interactive [OPTIONS] [filename1 [...]]
27 Opens the GUI and performs actions required by [OPTIONS]
29 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 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 -i, --input <file|->
42 Specifies a file to read latex input from.
44 -l, --latexinput <expr>
46 Specifies the LaTeX code of an equation to render.
48 -P, --paste-clipboard
50 -S, --paste-selection
52 Specifies that the LaTeX code should be pasted from the system
54 clipboard or current mouse selection. Works only in interactive
55 mode.
56 -n, --noeval
58 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 -B, --base64arg
64 Specifies that the argument to the option immediately following
66 this one is encoded in base64. For example:
67 klatexformula --base64arg --latexinput="YV4yK2JeMj1jXjI="
69 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 -o, --output <file|->
77 Specifies to write the output image (obtained from equation
79 given by --input or --latexinput) to <file> or standard output.
80 -F, --format <format>
82 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 -f, --fgcolor <'#xxxxxx'>
88 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 -b, --bgcolor <-|'#xxxxxx'>
94 Specifies a color (in web #RRGGBB hex format, or '-' for trans‐
96 parent) to use as background color (defaults to transparent)
97 -X, --dpi <N>
99 Use N dots per inch (DPI) when converting latex output to image.
101 Defaults to 1200 (high-resolution image).
102 -m, --mathmode <expression containing '...'>
104 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 -p, --preamble <LaTeX code>
110 Any LaTeX code that will be inserted before \begin{document}.
112 Useful for including custom packages with \usepackage{...}.
113 -q, --quiet [<ON|Y[ES]|T[RUE]|1 or OFF|N[O]|F[ALSE]|0>]
115 Disable console output of warnings and errors.
117 --redirect-debug <file>
119 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 -d, --daemonize
125 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 --outlinefonts [<ON|Y[ES]|T[RUE]|1 or OFF|N[O]|F[ALSE]|0>]
131 Convert embedded fonts in EPS and PDF to vector outlines (gs
133 with -dNOCACHE). Useful for exporting to eg. Adobe Illustrator.
134 --lborderoffset <N>
136 --tborderoffset <N>
138 --rborderoffset <N>
140 --bborderoffset <N>
142 Include a margin of N postscript points on left, top, right, or
144 bottom margin respectively.
145 --tempdir </path/to/temp/dir>
147 Specify the directory in which KLatexFormula will write tempo‐
149 rary files. Defaults to a system-specific temporary directory
150 like "/tmp/".
151 --latex <latex executable>
153 --dvips <dvips executable>
155 --gs <gs executable>
157 --epstopdf <epstopdf executable>
159 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 -Q, --qtoption <qt-option>
165 Specify a Qt-specific option. For example, to launch KLatexFor‐
167 mula in Plastique GUI style, use
168 klatexformula --qtoption="-style=Plastique"
170 Note that if <qt-option> begins with a '-', then it must be
172 appended to the long '--qtoption=' syntax with the equal sign.
173 -h, --help [<filename|&N>]
175 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 -V, --version [<filename|&N>][:<format>]
183 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 klatexformula --latexinput 'a^2+b^2=c^2' --output filename.png
195 Open klatexformula window with equation 'f(x)=-2\,x', but don't
197 evaluate it:
198 klatexformula -I --latexinput='f(x)=-2\,x' --noeval
200 Open klatexformula window and return immediately to shell com‐
202 mand:
203 klatexformula -I --daemonize
205 Print help message, but to standard output instead of standard
207 error output:
208 klatexformula --help='&1'
210 Notes:
212 When run in interactive mode, the newly evaluated equation is
213 appended to KLatexFormula's history.
214 When not run in interactive mode, no X11 server is needed.
216 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 Please report any bugs and malfunctions to the author.
225 More information is available on http://klatexformula.sourceforge.net/.
227 Have a lot of fun!
229klatexformula 3.2.3 April 2011 KLATEXFORMULA(1)