1LATEXMLMATH(1) User Contributed Perl Documentation LATEXMLMATH(1)
2
6 "latexmlmath" - transforms a TeX/LaTeX math expression into various
7 formats.
8
10 latexmlmath [options] texmath
11 Options:
13 --mathimage=file converts to image in file
14 --mathsvg=file converts to svg image in file
15 --magnification=mag specifies magnification factor
16 --presentationmathml=file converts to Presentation MathML
17 --pmml=file alias for --presentationmathml
18 --linelength=n do linewrapping of pMML
19 --contentmathml=file convert to Content MathML
20 --cmml=file alias for --contentmathml
21 --openmath=file convert to OpenMath
22 --om=file alias for --openmath
23 --XMath=file output LaTeXML's internal format
24 --noparse disables parsing of math
25 (not useful for cMML or openmath)
26 --preload=file loads a style file.
27 --includestyles allows processing raw *.sty files
28 (normally it avoids this)
29 --path=dir adds a search path for style files.
30 --quiet reduces verbosity (can repeat)
31 --verbose increases verbosity (can repeat)
32 --strict be more strict about errors.
33 --documentid=id assign an id to the document root.
34 --debug=package enables debugging output for the
35 named package
36 --VERSION show version number and exit.
37 --help shows this help message.
38 -- ends options
39 If texmath is '-', "latexmlmath" reads the TeX from standard input. If
41 any of the output files are '-', the result is printed on standard
42 output.
43 Input notes
45 Note that, unless you are reading texmath from standard input, the
46 texmath string will be processed by whatever shell you are using before
47 "latexmlmath" even sees it. This means that many so-called meta
48 characters, such as backslash and star, may confuse the shell or be
49 changed. Consequently, you will need to quote and/or slashify the
50 input appropriately. Most particularly, "\" will need to be doubled to
51 "\\" for "latexmlmath" to see it as a control sequence.
52 Using "--" to explicitly end the option list is useful for cases when
54 the math starts with a minus (and would otherwise be interpreted as an
55 option, probably an unrecognized one). Alternatively, wrapping the
56 texmath with {} will hide the minus.
57 Simple examples:
59 latexmlmath \\frac{-b\\pm\\sqrt{b^2-4ac}}{2a}
61 echo "\\sqrt{b^2-4ac}" | latexmlmath --pmml=quad.mml -
62
64 Conversion Options
65 These options specify what formats the math should be converted to. In
66 each case, the destination file is given. Except for mathimage, the
67 file can be given as '-', in which case the result is printed to
68 standard output.
69 If no conversion option is specified, the default is to output
71 presentation MathML to standard output.
72 "--mathimage"=file
74 Requests conversion to png images.
75 "--mathsvg"=file
77 Requests conversion to svg images.
78 "--magnification="factor
80 Specifies the magnification used for math image. Default is 1.75.
81 "--presentationmathml"=file
83 Requests conversion to Presentation MathML.
84 "--linelength"=number
86 (Experimental) Line-breaks the generated Presentation MathML so
87 that it is no longer than number `characters'.
88 "--plane1"
90 Converts the content of Presentation MathML token elements to the
91 appropriate Unicode Plane-1 codepoints according to the selected
92 font, when applicable.
93 "--hackplane1"
95 Converts the content of Presentation MathML token elements to the
96 appropriate Unicode Plane-1 codepoints according to the selected
97 font, but only for the mathvariants double-struck, fraktur and
98 script. This gives support for current (as of August 2009)
99 versions of Firefox and MathPlayer, provided a sufficient set of
100 fonts is available (eg. STIX).
101 "--contentmathml"=file
103 Requests conversion to Content MathML. Note that this conversion
104 is only partially implemented.
105 "--openmath"=file
107 Requests conversion to OpenMath. Note that this conversion is only
108 partially implemented.
109 "--XMath"=file
111 Requests convertion to LaTeXML's internal format.
112
114 "--preload"=module
115 Requests the loading of an optional module or package. This may be
116 useful if the TeX code does not specificly require the module (eg.
117 through input or usepackage). For example, use
118 "--preload=LaTeX.pool" to force LaTeX mode.
119 "--includestyles"
121 This optional allows processing of style files (files with
122 extensions "sty", "cls", "clo", "cnf"). By default, these files
123 are ignored unless a latexml implementation of them is found (with
124 an extension of "ltxml").
125 These style files generally fall into two classes: Those that
127 merely affect document style are ignorable in the XML. Others
128 define new markup and document structure, often using deeper LaTeX
129 macros to achieve their ends. Although the omission will lead to
130 other errors (missing macro definitions), it is unlikely that
131 processing the TeX code in the style file will lead to a correct
132 document.
133 "--path"=dir
135 Add dir to the search paths used when searching for files, modules,
136 style files, etc; somewhat like TEXINPUTS. This option can be
137 repeated.
138 "--documentid"=id
140 Assigns an ID to the root element of the XML document. This ID is
141 generally inherited as the prefix of ID's on all other elements
142 within the document. This is useful when constructing a site of
143 multiple documents so that all nodes have unique IDs.
144 "--quiet"
146 Reduces the verbosity of output during processing, used twice is
147 pretty silent.
148 "--verbose"
150 Increases the verbosity of output during processing, used twice is
151 pretty chatty. Can be useful for getting more details when errors
152 occur.
153 "--strict"
155 Specifies a strict processing mode. By default, undefined control
156 sequences and invalid document constructs (that violate the DTD)
157 give warning messages, but attempt to continue processing. Using
158 --strict makes them generate fatal errors.
159 "--VERSION"
161 Shows the version number of the LaTeXML package..
162 "--debug"=package
164 Enables debugging output for the named package. The package is
165 given without the leading LaTeXML::.
166 "--help"
168 Shows this help message.
169
171 This program runs much slower than would seem justified. This is a
172 result of the relatively slow initialization including loading TeX and
173 LaTeX macros and the schema. Normally, this cost would be ammortized
174 over large documents, whereas, in this case, we're processing a single
175 math expression.
176
178 latexml, latexmlpost, LaTeXML
179perl v5.28.1 2018-07-08 LATEXMLMATH(1)