repository·master·Indexed 22 days ago
https://github.com/brucemiller/latexmlA converter that transforms TeX and LaTeX source files into structured output formats including XML, HTML, MathML, ePub, and JATS. This documentation covers the latexml CLI for general conversion, latexmlc for client/server processing, latexmlfind for searching objects within LaTeXML XML files, and latexmlmath for converting mathematical expressions into MathML, OpenMath, UnicodeMath, XMath, and images.
When generating a website with multiple documents, use two-pass processing to allow documents to cross-reference each other (IDs, titles, URLs, etc.) and to create a unified index and bibliography.
--prescan: Instructs latexmlpost to first scan documents to extract and store cross-referencing data.--dbfile=<file>: Specifies the filename for the cross-referencing data used during the two-pass process.--sitedirectory=<dir>: Specifies the base directory of the website. Pathnames in the database are stored relative to this directory to ensure portability.The latexmlpost command is a post-processing tool for XML files generated by latexml. It is used to perform common tasks such as converting mathematics to images or MathML, processing graphics for the web, and splitting large documents into multiple files.
Basic usage:
latexmlpost [options] <xmlfile>If <xmlfile> is -, the tool reads the XML from standard input.
latexmlpost [options] I<xmlfile>The latexmlmath command-line tool transforms TeX/LaTeX mathematical expressions into various formats including MathML (Presentation and Content), OpenMath, UnicodeMath, XMath, and images (PNG, SVG).
Input Handling:
- as the input, the tool reads the TeX from standard input (stdin).\ or *), you must often quote or slashify your input to prevent the shell from interpreting them. For example, use \\ to ensure a single backslash reaches the tool.-a + b), the shell might interpret it as an option. Use -- to signal the end of options, or wrap the expression in curly braces {}.Output Handling:
-, the result is printed to stdout.The latexmlc command is a client-side tool for LaTeXML that can perform conversions in three modes: stand-alone (local), via a local socket server (using latexmls), or via a remote web service. It automatically attempts to set up a local server using latexmls if necessary.
By default, latexmlc performs a stand-alone conversion. You can force stand-alone mode by using the --expire=-1 flag. To use the client/server model, you can specify a remote address and port.
Input can be provided as a file path or via STDIN by using - as the source.
The latexml command is the main entrypoint for transforming TeX/LaTeX files into XML, TeX, or Box formats. By default, it produces XML output and writes it to stdout unless a destination is specified.
Basic Usage:
latexml [options] <texfile>Reading from Standard Input:
If you provide - as the <texfile>, latexml will read the TeX source from stdin.
Processing BibTeX:
If the input file has a .bib extension, latexml automatically processes it as a BibTeX bibliography. You can also force this mode using the --bibtex flag.
Output Formats:
--xml to request XML output.--tex to request TeX output after expansion (useful for debugging).--box to request Box output after expansion and digestion (useful for debugging).latexml [options] I<texfile>When communicating with a remote LaTeXML web service or a local daemon, use the following flags to specify the connection details:
--address: The hostname or IP address of the server (defaults to 127.0.0.1 if not specified or if set to localhost).--port: The port number for the connection (defaults to 3334 for local connections and 80 for remote connections).--expire: Controls the server expiration. Setting --expire=-1 requests a stand-alone conversion without using a server.You can control the amount of information latexmlfind prints to the terminal using the following flags:
--quiet: Suppresses messages. This flag can be repeated to increase silence.--verbose: Increases the amount of information provided. This flag can be repeated to increase verbosity (e.g., to see the exact XPath used or to get more detailed output when errors occur).Output Behavior:
stdout.--verbose is used, the utility may print the raw XML nodes or more detailed context.Use the following flags to specify the desired output format. For most formats, providing a filename will save the output to that file; using - will print it to stdout.
| Flag | Alias | Description |
|---|---|---|
--mathimage=file | Converts to PNG images (supports .png, .gif, .jpg, .jpeg, .svg). | |
--mathsvg=file | Converts to SVG images. | |
--presentationmathml=file | --pmml=file | Converts to Presentation MathML (Default). |
--contentmathml=file | --cmml=file | Converts to Content MathML (Partially implemented). |
--openmath=file | --om=file | Converts to OpenMath (Partially implemented). |
--unicodemath=file | Converts to UnicodeMath (unstructured Unicode string). | |
--XMath=file | Outputs LaTeXML's internal format. |
Image Options:
--magnification=factor: Specifies the magnification factor for math images. Default is 1.75.When generating Presentation MathML (--pmml), you can use these specific flags to control the output structure and character encoding:
--linelength=n: (Experimental) Line-breaks the generated Presentation MathML so that it is no longer than n characters.--plane1: Converts the content of Presentation MathML token elements to the appropriate Unicode Plane-1 codepoints according to the selected font, when applicable.--hackplane1: Converts the content of Presentation MathML token elements to the appropriate Unicode Plane-1 codepoints for mathvariants (double-struck, fraktur, and script). This provides support for older versions of Firefox and MathPlayer if suitable fonts (like STIX) are available.Full list of available command-line options for latexml:
--destination=file sets destination file (default stdout).
--output=file [obsolete synonym for --destination]
--preload=module requests loading of an optional module; can be repeated
--preamble=file sets a preamble file which will effectively be prepended to the main file.
--postamble=file sets a postamble file which will effectively be appended to the main file.
--includestyles allows latexml to load raw *.sty file; by default it avoids this.
--path=dir adds to the paths searched for files, modules, etc;
--log=file specifies log file (default is file named after job name)
--documentid=id assigns an id to the document root.
--quiet suppress messages (can repeat)
--verbose more informative output (can repeat)
--strict makes latexml less forgiving of errors
--bibtex processes as a BibTeX bibliography.
--xml requests xml output (default).
--tex requests TeX output after expansion.
--box requests box output after expansion and digestion.
--noparse suppresses parsing math
--nocomments omit comments from the output
--inputencoding=enc specify the input encoding.
--VERSION shows version number.
--debug=package enables debugging output for the named package.
--help shows this help message.Use these flags to control how latexmlmath parses and searches for TeX resources.
| Flag | Description |
|---|---|
--preload=file | Loads an optional module or package (e.g., --preload=LaTeX.pool). |
--includestyles | Allows processing of raw .sty files (normally ignored). |
--path=dir | Adds a directory to the search path for files, modules, and style files (can be repeated). |
--noparse | Disables parsing of math (not useful for cMML or OpenMath). |
--strict | Enables strict mode; undefined control sequences or invalid constructs become fatal errors instead of warnings. |
--inputencoding=enc | Specifies the input encoding (must be known to Perl's Encode package). Output is always UTF-8. |
--documentid=id | Assigns an ID to the root element of the XML document. |
--debug=package | Enables debugging for a specific package (omit the LaTeXML:: prefix). |
--quiet | Reduces verbosity (can be repeated). |
--verbose | Increases verbosity (can be repeated). |