LaTeXM...:Config(3pm)

๐ŸŒธ NAME ๐ŸŒธ

okay so this is the LaTeXML::Common::Config(3pm) page from the User Contributed Perl Documentation, and itโ€™s literally the configuration logic for LaTeXML. no cap. ๐Ÿ’…

๐Ÿฆ‹ SYNPOSIS ๐Ÿฆ‹

bestie, hereโ€™s the whole vibe check in code form:

use LaTeXML::Common::Config;
my $config = LaTeXML::Common::Config->new(
          profile=>'name',
          timeout=>60,
          ... );
$config->read(\@ARGV);
$config->check;

my $value = $config->get($name);
$config->set($name,$value);
$config->delete($name);
my $bool = $config->exists($name);
my @keys = $config->keys;
my $options_hashref = $config->options;
my $config_clone = $config->clone;

๐Ÿ’– DESCRIPTION ๐Ÿ’–

LaTeXML::Common::Config is the configuration management class for LaTeXML options. itโ€™s giving:

  • responsible for defining the options interface and parsing the usual Perl command-line options syntax ๐ŸŒˆ
  • provides the intuitive getters, setters, as well as hash methods for manipulating the option values ๐Ÿซถ
  • also supports cloning into new configuration objects ๐Ÿ‘‘

๐Ÿงธ METHODS ๐Ÿงธ

๐Ÿ’ซ new โ€” my $config = LaTeXML::Common::Config->new(%options);

makes a shiny new configuration object. but hear me out: you should try not to provide your own %options hash here. instead, create an empty configuration and use $config->read to read in the options. thatโ€™s the move. ๐Ÿซถ

๐Ÿ“ฅ read โ€” $config->read(\@ARGV);

this is the main method for parsing in LaTeXML options. the input array should either be @ARGV โ€” like when the options were provided from the command line using the classic Getopt::Long syntax โ€” or any other array reference that conforms to that setup. yep, thatโ€™s the whole deal. โœจ

โœ… check โ€” $config->check;

ensures that the configuration obeys the given profile, and performs a set of assignments of meaningful defaults (when needed) and normalizations (for relative paths, etc). itโ€™s the lil cleanup-and-make-sure-everything-matches step. ๐Ÿ’…

๐ŸŽ get โ€” my $value = $config->get($name);

classic getter for the $value of an option $name. hand it a name, get the value back. iconic. ๐Ÿ’–

๐Ÿ› ๏ธ set โ€” $config->set($name,$value);

classic setter for the $value of an option $name. set it and forget it, bestie. ๐ŸŽ€

๐Ÿ—‘๏ธ delete โ€” $config->delete($name);

deletes option $name from the configuration. yeeted. ๐Ÿ’€

๐Ÿ” exists โ€” my $bool = $config->exists($name);

checks whether the key $name exists in the options hash of the configuration. similarly to Perlโ€™s "exist" for hashes, it returns true even when the optionโ€™s value is undefined. so yes, it can be true even if the value is undefined โ€” thatโ€™s the whole point. ๐Ÿ™ˆ

๐Ÿ”‘ keys โ€” my @keys = $config->keys;

similar to "keys %hash" in Perl. returns an array of all option names. all of them. no gatekeeping. ๐Ÿ”ฅ

๐Ÿ—‚๏ธ options โ€” my $options_hashref = $config->options;

returns the actual hash reference that holds all options within the configuration object. like, the real one. not a copy. ๐Ÿ‘‘

๐Ÿงฌ clone โ€” my $config_clone = $config->clone;

clones $config into a new LaTeXML::Common::Config object, $config_clone. so $config_clone is a whole new configuration object, periodt. ๐Ÿ’œ

๐Ÿ’ซ OPTION SYNOPSIS ๐Ÿ’ซ

okay bestie, here's the entire flag menu, literally every single one, no skips:

latexmlc [options]

Options:

  • --VERSION โ€” shows version number.
  • --help โ€” shows this help message.
  • --destination=file โ€” specifies destination file.
  • --output=file โ€” [obsolete synonym for --destination]
  • --preload=module โ€” requests loading of an optional module; can be repeated
  • --preamble=file โ€” loads a tex file containing document frontmatter. MUST include \begin{document} or equivalent
  • --postamble=file โ€” loads a tex file containing document backmatter. MUST include \end{document} or equivalent
  • --includestyles โ€” allows latexml to load raw *.sty file; by default it avoids this.
  • --base=dir โ€” sets the current working directory
  • --path=dir โ€” adds dir to the paths searched for files, modules, etc;
  • --log=file โ€” specifies log file (default: STDERR)
  • --autoflush=count โ€” Automatically restart the daemon after "count" inputs. Good practice for vast batch jobs. (default: 100)
  • --timeout=secs โ€” Timecap for conversions (default 600)
  • --expire=secs โ€” Timecap for server inactivity (default 600)
  • --address=URL โ€” Specify server address (default: localhost)
  • --port=number โ€” Specify server port (default: 3354)
  • --documentid=id โ€” assign 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 a BibTeX bibliography.
  • --xml โ€” requests xml output (default).
  • --tex โ€” requests TeX output after expansion.
  • --box โ€” requests box output after expansion and digestion.
  • --format=name โ€” requests "name" as the output format. Supported: tex,box,xml,html4,html5,xhtml. html implies html5
  • --noparse โ€” suppresses parsing math (default: off)
  • --parse=name โ€” enables parsing math (default: on) and selects parser framework "name". Supported: RecDescent, no
  • --profile=name โ€” specify profile as defined in LaTeXML::Common::Config. Supported: standard|math|fragment|... (default: standard)
  • --mode=name โ€” Alias for profile
  • --cache_key=name โ€” Provides a name for the current option set, to enable daemonized conversions without needing re-initializing
  • --whatsin=chunk โ€” Defines the provided input chunk, choose from document (default), fragment and formula
  • --whatsout=chunk โ€” Defines the expected output chunk, choose from document (default), fragment and formula
  • --post โ€” requests a followup post-processing
  • --nopost โ€” forbids followup post-processing
  • --validate, --novalidate โ€” Enables (the default) or disables validation of the source xml.
  • --omitdoctype โ€” omits the Doctype declaration,
  • --noomitdoctype โ€” disables the omission (the default)
  • --numbersections โ€” enables (the default) the inclusion of section numbers in titles, crossrefs.
  • --nonumbersections โ€” disables the above
  • --timestamp โ€” provides a timestamp (typically a time and date) to be embedded in the comments
  • --embed โ€” requests an embeddable XHTML snippet (requires: --post,--profile=fragment)
DEPRECATED: Use --whatsout=fragment
TODO: Remove completely
  • --stylesheet โ€” specifies a stylesheet, to be used by the post-processor.
  • --css=cssfile โ€” adds a css stylesheet to html/xhtml (can be repeated)
  • --nodefaultresources โ€” disables processing built-in resources
  • --javascript=jsfile โ€” adds a link to a javascript file into html/html5/xhtml (can be repeated)
  • --icon=iconfile โ€” specify a file to use as a "favicon"
  • --xsltparameter=name:value โ€” passes parameters to the XSLT.
  • --split โ€” requests splitting each document
  • --nosplit โ€” disables the above (default)
  • --splitat โ€” sets level to split the document
  • --splitpath=xpath โ€” sets xpath expression to use for splitting (default splits at sections, if splitting is enabled)
  • --splitnaming=(id|idrelative|label|labelrelative) โ€” specifies how to name split files (idrelative).
  • --scan โ€” scans documents to extract ids, labels, etc. section titles, etc. (default)
  • --noscan โ€” disables the above
  • --crossref โ€” fills in crossreferences (default)
  • --nocrossref โ€” disables the above
  • --urlstyle=(server|negotiated|file) โ€” format to use for urls (default server).
  • --navigationtoc=(context|none) โ€” generates a table of contents in navigation bar
  • --index โ€” requests creating an index (default)
  • --noindex โ€” disables the above
  • --splitindex โ€” Splits index into pages per initial.
  • --nosplitindex โ€” disables the above (default)
  • --permutedindex โ€” permutes index phrases in the index
  • --nopermutedindex โ€” disables the above (default)
  • --bibliography=file โ€” sets a bibliography file
  • --splitbibliography โ€” splits the bibliography into pages per initial.
  • --nosplitbibliography โ€” disables the above (default)
  • --prescan โ€” carries out only the split (if enabled) and scan, storing cross-referencing data in dbfile (default is complete processing)
  • --dbfile=dbfile โ€” sets file to store crossreferences
  • --sitedirectory=dir โ€” sets the base directory of the site
  • --sourcedirectory=dir โ€” sets the base directory of the original TeX source
  • --source=input โ€” as an alternative to passing the input as the last argument, after the option set you can also specify it as the value here. useful for predictable API calls
  • --mathimages โ€” converts math to images (default for html4 format)
  • --nomathimages โ€” disables the above
  • --mathimagemagnification=mag โ€” specifies magnification factor
  • --presentationmathml โ€” converts math to Presentation MathML (default for xhtml & html5 formats)
  • --pmml โ€” alias for --presentationmathml
  • --nopresentationmathml โ€” disables the above
  • --linelength=n โ€” formats presentation mathml to a linelength max of n characters
  • --contentmathml โ€” converts math to Content MathML
  • --nocontentmathml โ€” disables the above (default)
  • --cmml โ€” alias for --contentmathml
  • --openmath โ€” converts math to OpenMath
  • --noopenmath โ€” disables the above (default)
  • --om โ€” alias for --openmath
  • --keepXMath โ€” preserves the intermediate XMath representation (default is to remove)
  • --mathtex โ€” adds TeX annotation to parallel markup
  • --nomathtex โ€” disables the above (default)
  • --unicodemath โ€” adds UnicodeMath annotation to parallel markup
  • --nounicodemath โ€” disables the above (default)
  • --parallelmath โ€” use parallel math annotations (default)
  • --noparallelmath โ€” disable parallel math annotations
  • --plane1 โ€” use plane-1 unicode for symbols (default, if needed)
  • --noplane1 โ€” do not use plane-1 unicode
  • --graphicimages โ€” converts graphics to images (default)
  • --nographicimages โ€” disables the above
  • --graphicsmap=type.type โ€” specifies a graphics file mapping
  • --pictureimages โ€” converts picture environments to images (default)
  • --nopictureimages โ€” disables the above
  • --svg โ€” converts picture environments to SVG
  • --nosvg โ€” disables the above (default)
  • --nocomments โ€” omit comments from the output
  • --inputencoding=enc โ€” specify the input encoding.
  • --debug=package โ€” enables debugging output for the named package

quick lil side note bestie ๐ŸŽ€ โ€” if you wanna hand over a TeX snippet directly on input instead of pointing at a filename, just slap the literal: protocol in front of your snippet and you're golden. iykyk.


๐Ÿ”ฅ OPTIONS AND ARGUMENTS ๐Ÿ”ฅ

๐Ÿ› ๏ธ General Options ๐Ÿ› ๏ธ

--verbose

Increases the verbosity of output during processing โ€” use it twice and it's pretty chatty. Can be useful for getting more details when errors occur. (aka: when the vibes go bad, crank this up and read the receipts ๐Ÿ‘€)

--quiet

Reduces the verbosity of output during processing โ€” use it twice and it's pretty silent. shhh ๐Ÿคซ

--VERSION

Shows the version number of the LaTeXML package.. (yes, the double period is canon, we don't ask questions)

--debug=package

Enables debugging output for the named package. The package is given without the leading LaTeXML::. ๐Ÿ›โœจ

--base=dir

Specifies the base working directory for the conversion server. Useful when converting sets of documents that use relative paths. (very much the "set up camp here first" energy ๐Ÿ•๏ธ)

--log=file

Specifies the log file; be default any conversion messages are printed to STDERR.

--help

Shows this help message. the original "just tell me what's going on" button ๐Ÿซถ


๐Ÿ“ฅ Source Options ๐Ÿ“ฅ

--destination=file

Specifies the destination file; by default the XML is written to STDOUT. literally "where does the output go" and by default the answer is "your screen, bestie" ๐Ÿ˜ญ

--preload=module

Requests the loading of an optional module or package. This may be useful if the TeX code does not specifically require the module (eg. through input or usepackage). For example, use --preload=LaTeX.pool to force LaTeX mode. ๐Ÿ‘‘

--preamble=file

Requests the loading of a tex file with document frontmatter, to be read in before the converted document, but after all --preload entries.

heads up fr fr โ€” the given file MUST contain \begin{document} or an equivalent environment start, when processing LaTeX documents. no \begin{document}, no vibes. ๐Ÿ’€

Okay so if the file doesnโ€™t contain content that shows up in the final document and only has macro definitions + setting of internal counters, itโ€™s way more of a --preload situation instead. ๐Ÿ’…

  • --postamble=file โ€” asks latexml to load a tex file with document backmatter, to be read in after the converted document. > โš ๏ธ The given file MUST contain \end{document} or an equivalent environment end when processing LaTeX documents. No cap, this is not optional.
  • --sourcedirectory=source โ€” tells it where the original latex source is located. Unless LaTeXML is run from that directory, or it can be determined from the xml filename, you may need to specify this option so it can find graphics and style files. Lowkey essential when files go missing.
  • --path=dir โ€” adds dir to the search paths used when searching for files, modules, style files, etc; somewhat like TEXINPUTS. This option can be repeated, so stack those paths, bestie. ๐Ÿซถ
  • --validate, --novalidate โ€” enables (or disables) validation of the source XML document. Validation is the default, so --novalidate is the off switch.
  • --bibtex โ€” forces latexml to treat the file as a BibTeX bibliography. The timing is slightly different than the usual case with BibTeX and LaTeX. With BibTeX + LaTeX, BibTeX simply selects and formats a subset of the bibliographic entries; the actual TeX expansion is carried out when the result is included in a LaTeX document. In contrast, latexml processes and expands the entire bibliography; the selection of entries is done during post-processing. This also means any packages that define macros used in the bibliography must be specified using the --preload option. Big preload energy. ๐Ÿ”ฅ
  • --inputencoding=encoding โ€” specify the input encoding, e.g. --inputencoding=iso-8859-1. The encoding must be one known to Perlโ€™s Encode package. Note that this only enables the translation of the input bytes to UTF-8 used internally by LaTeXML, but does not affect catcodes. In such cases, you should be using the inputenc package. Also note this does not affect the output encoding, which is always UTF-8. Periodt.

โœจ TeX Conversion Options โœจ

  • --includestyles โ€” this option allows processing of style files (files with extensions sty, cls, clo, cnf). By default, these files are ignored unless a latexml implementation of them is found (with an extension of ltxml).

These style files generally fall into two classes: those that merely affect document style are ignorable in the XML. Others define new markup and document structure, often using deeper LaTeX macros to achieve their ends. Although the omission will lead to other errors (missing macro definitions), it is unlikely that processing the TeX code in the style file will lead to a correct document. So itโ€™s very much โ€œyou can, but should you?โ€ energy. ๐Ÿ’€

  • --timeout=secs โ€” sets a time cap for conversion jobs, in seconds. Any job failing to convert in the time range would return with a Fatal error of timing out. Default value is 600; set to 0 to disable.
  • --nocomments โ€” normally latexml preserves comments from the source file, and adds a comment every 25 lines as an aid in tracking the source. The option --nocomments discards such comments.
  • --documentid=id โ€” assigns an ID to the root element of the XML document. This ID is generally inherited as the prefix of IDs on all other elements within the document. This is useful when constructing a site of multiple documents so that all nodes have unique IDs. Very main-character ID behavior. ๐Ÿ‘‘
  • --strict โ€” specifies a strict processing mode. By default, undefined control sequences and invalid document constructs (that violate the DTD) give warning messages, but attempt to continue processing. Using --strict makes them generate fatal errors. > So this is the โ€œno more warnings, we die like legendsโ€ mode ๐Ÿ˜ญ Use with intention.
  • --post โ€” requests post-processing; auto-enabled by any requested post-processor. Disabled by default. If post-processing is enabled, the graphics and cross-referencing processors are on by default.

๐Ÿฆ‹ Format Options ๐Ÿฆ‹

  • --format=format โ€” specifies the output format for post processing. The allowed values are (html|html5|html4|xhtml|xml|epub). By default, it will be guessed from the file extension of the destination (if given), with html implying html5, xhtml implying xhtml, and the default being xml, which you probably donโ€™t want.

The html5 format converts the material to html5 form with mathematics as MathML; html5 supports SVG. html4 format converts the material to the earlier html form, version 4, and the mathematics to png images. xhtml format converts to xhtml and uses presentation MathML (after attempting to parse the mathematics) for representing the math. html5 similarly converts math to presentation MathML. In these cases, any graphics will be converted to web-friendly formats and/or copied to the destination directory. If you simply specify html, it will treat that as html5.

For the default, xml, the output is left in LaTeXMLโ€™s internal xml, although the math can be converted by enabling one of the math postprocessors, such as --pmml to obtain presentation MathML. For html, html5 and xhtml, a default stylesheet is provided, but see the --stylesheet option.

  • --xml โ€” requests XML output; this is the default. > DEPRECATED: use --format=xml instead. ๐Ÿ’€
  • --tex โ€” requests TeX output for debugging purposes; processing is only carried out through expansion and digestion. This may not be quite valid TeX, since Unicode may be introduced.
  • --box โ€” requests Box output for debugging purposes; processing is carried out through expansion and digestions, and the result is printed.
  • --profile โ€” a variety of shorthand profiles. Note that the profiles come with a variety of preset options. You can examine any of them in their resources/Profiles/name.opt file.

Example: latexmlc --profile=math 'literal:1+2=3'

  • --omitdoctype, --noomitdoctype โ€” omits (or includes) the document type declaration. The default is to include it if the document model was based on a DTD.
  • --numbersections, --nonumbersections โ€” includes (default), or disables the inclusion of section, equation, etc, numbers in the formatted document and crossreference links.
  • --stylesheet=xslfile โ€” requests the XSL transformation of the document using the given xslfile as stylesheet. If the stylesheet is omitted, a standard one appropriate for the format (html4, html5 or xhtml) will be used.
  • --css=cssfile โ€” adds cssfile as a css stylesheet to be used in the transformed html/html5/xhtml. Multiple stylesheets can be used; they are included in the html in the order given, following the default ltx-LaTeXML.css (unless --nodefaultcss). The stylesheet is copied to the destination directory, unless it is an absolute url.

Some stylesheets included in the distribution are:

  • --css=navbar-left โ€” puts a navigation bar on the left. (default omits navbar)
  • --css=navbar-right โ€” puts a navigation bar on the left. (Yes, the original says left here too โ€” Iโ€™m not changing it ๐Ÿ’€)
  • --css=theme-blue โ€” a blue coloring theme for headings.
  • --css=amsart โ€” a style suitable for journal articles.
  • --javascript=jsfile โ€” includes a link to the javascript file jsfile, to be used in the transformed html/html5/xhtml. Multiple javascript files can be included; they are linked in the html in the order given. The javascript file is copied to the destination directory, unless it is an absolute url.
  • --icon=iconfile โ€” copies iconfile to the destination directory and sets up the linkage in the transformed html/html5/xhtml to use that as the favicon. Cute little browser-tab moment. ๐ŸŽ€
  • --nodefaultresources โ€” disables the copying and inclusion of resources added by the binding files; this includes CSS, javascript or other files. This does not affect resources explicitly requested by the --css or --javascript options.
  • --timestamp=timestamp โ€” provides a timestamp (typically a time and date) to be embedded in the comments by the stock XSLT stylesheets. If you donโ€™t supply a timestamp, the current time and date will be used. (You can use --timestamp=0 to omit the timestamp.)
  • --xsltparameter=name:value โ€” passes parameters to the XSLT stylesheet. See the manual or the stylesheet itself for available parameters.

๐ŸŒˆ Site & Crossreferencing Options ๐ŸŒˆ

  • --split, --nosplit โ€” enables or disables (default) the splitting of documents into multiple pages. If enabled, the document will be split into sections, bibliography, index and appendices (if any) by default, unless --splitpath is specified.
  • --splitat=unit โ€” specifies what level of the document to split at. Should be one of chapter, section (the default), subsection or subsubsection. For more control, see --splitpath.
  • --splitpath=xpath โ€” specifies an XPath expression to select nodes that will generate separate pages. The default splitpath is:
//ltx:section | //ltx:bibliography | //ltx:appendix | //ltx:index

Specifying:

--splitpath="//ltx:section | //ltx:subsection
       | //ltx:bibliography | //ltx:appendix | //ltx:index"

would split the document at subsections as well as sections. Slay. โœจ

  • --splitnaming=(id|idrelative|label|labelrelative) โ€” specifies how to name the files for subdocuments created by splitting. The values id and label simply use the id or label of the subdocumentโ€™s root node for its filename. idrelative and labelrelative use the portion of the id or label that follows the parent documentโ€™s id or label. Furthermore, to impose structure and uniqueness, if a split document has children that are also split, that document (and its children) will be in a separate subdirectory with the name index.
  • --scan, --noscan โ€” enables (default) or disables the scanning of documents for ids, labels, references, indexmarks, etc, for use in filling in refs, cites, index and so on. It may be useful to disable when generating documents not based on the LaTeXML doctype.
  • --crossref, --nocrossref โ€” turns on (thatโ€™s the default, bestie) or turns off the filling-in of references, hrefs, etc. based on a previous scan (either from --scan or --dbfile). Lowkey useful to disable when youโ€™re generating documents not based on the LaTeXML doctype.
  • --urlstyle=(server|negotiated|file) โ€” this controls how URLs inside the documents are formatted, depending on how youโ€™re planning to serve them. The default, server, gets rid of unnecessary trailing index.html. With negotiated, the trailing file extension (typically html or xhtml) gets eliminated. The file scheme preserves complete (but relative) urls so the site can be browsed as files without any server at all. iconic serving flexibility ๐Ÿ’…
  • --navigationtoc=(context|none) โ€” generates a table of contents in the navigation bar; default is none. The context TOC style is somewhat verbose and reveals more detail near the current page; itโ€™s most suitable for navigation bars placed on the left or right. Other styles of TOC should be developed and added here, such as a short form.
  • --index, --noindex โ€” enables (default) or disables generation of an index from indexmarks embedded within the document. Heads up: enabling this has no effect unless thereโ€™s an index element in the document (generated by \printindex).
  • --splitindex, --nosplitindex โ€” enables or disables (default) the splitting of generated indexes into separate pages per initial letter.
  • --bibliography=pathname โ€” specifies a bibliography generated from a BibTeX file to be used to fill in a bibliography element. Hand-written bibliographies placed in a thebibliography environment do not need this. This option has no effect unless thereโ€™s a bibliography element in the document (generated by \bibliography).

Note: this option provides the bibliography to be used to fill in the bibliography element (generated by \bibliography); latexmlpost does not (currently) directly process and format such a bibliography.

  • --splitbibliography, --nosplitbibliography โ€” enables or disables (default) the splitting of generated bibliographies into separate pages per initial letter.
  • --prescan โ€” by default latexmlpost processes a single document into one (or more; see --split) destination files in a single pass. When generating a complicated site consisting of several documents, it may be advantageous to first scan through the documents to extract and store (in dbfile) cross-referencing data (such as ids, titles, urls, and so on). A later pass then has complete information allowing all documents to reference each other, and also constructs an index and bibliography that reflects the entire document set. The same effect (though less efficient) can be achieved by running latexmlpost twice, provided a dbfile is specified. two-pass era โœจ
  • --dbfile=file โ€” specifies a filename to use for the crossreferencing data when using two-pass processing. This file may reside in the intermediate destination directory.
  • --sitedirectory=dir โ€” specifies the base directory of the overall web site. Pathnames in the database are stored in a form relative to this directory to make it more portable.
  • --embed โ€” TODO: Deprecated, use --whatsout=fragment. It requests an embeddable XHTML div (requires: --post --format=xhtml), a.k.a. the top division of the documentโ€™s body.
Caveat: this experimental mode is enabled only for fragment profile and post-processed documents (to XHTML).

๐Ÿงฎ Math Options ๐Ÿงฎ

These options specify how math should be converted into other formats. Multiple formats can be requested; how they will be combined depends on the format and other options.

  • --noparse โ€” suppresses parsing math (default: parsing is on).
  • --parse=name โ€” enables parsing math (default: parsing is on) and selects parser framework name. Supported: RecDescent, no.

Tip: --parse=no is equivalent to --noparse.

  • --mathimages, --nomathimages โ€” requests or disables the conversion of math to images (png by default). Conversion is the default for html4 format.
  • --mathsvg, --nomathsvg โ€” requests or disables the conversion of math to svg images.
  • --mathimagemagnification=factor โ€” specifies the magnification used for math images (both png and svg), if they are made. Default is 1.75.
  • --presentationmathml, --nopresentationmathml โ€” requests or disables conversion of math to Presentation MathML. Conversion is the default for xhtml and html5 formats.
  • --linelength=number โ€” (Experimental) line-breaks the generated Presentation MathML so that it is no longer than number characters.
  • --plane1 โ€” converts the content of Presentation MathML token elements to the appropriate Unicode Plane-1 codepoints according to the selected font, when applicable (the default).
  • --hackplane1 โ€” converts the content of Presentation MathML token elements to the appropriate Unicode Plane-1 codepoints according to the selected font, but only for the mathvariants double-struck, fraktur and script. This gives support for current (as of August 2009) versions of Firefox and MathPlayer, provided a sufficient set of fonts is available (eg. STIX). time capsule behavior ๐Ÿ•ฐ๏ธ
  • --contentmathml, --nocontentmathml โ€” requests or disables conversion of math to Content MathML. Conversion is disabled by default. Note that this conversion is only partially implemented.
  • --openmath โ€” requests or disables conversion of math to OpenMath. Conversion is disabled by default. Note that this conversion is only partially implemented.
  • --keepXMath, --xmath โ€” by default, when any of the MathML or OpenMath conversions are used, the intermediate math representation will be removed; this option preserves it; it will be used as secondary parallel markup, when it follows the options for other math representations.

๐Ÿ–ผ๏ธ Graphics Options ๐Ÿ–ผ๏ธ

  • --graphicimages, --nographicimages โ€” enables (default) or disables the conversion of graphics to web-appropriate format (png).
  • --graphicsmap=sourcetype.desttype โ€” specifies a mapping of graphics file types. Typically, graphics elements specify a graphics file that will be converted to a more appropriate file target format; for example, postscript files used for graphics with LaTeX will be converted to png format for use on the web. As with LaTeX, when a graphics file is specified without a file type, the system will search for the most appropriate target type file.

When this option is used, it overrides and replaces the defaults and provides a mapping of sourcetype to desttype. The option can be repeated to provide several mappings, with the earlier formats preferred. If the desttype is omitted, it specifies copying files of type sourcetype, unchanged.

The default settings are equivalent to having supplied the options:

svg png gif jpg jpeg eps.png ps.png ai.png pdf.png

The first formats are preferred and used unchanged, while the latter ones are converted to png. graphics glow-up unlocked ๐ŸŽ€

  • --pictureimages, --nopictureimages โ€” enables (default) or disables the conversion of picture environments and pstricks material into images.
  • --svg, --nosvg โ€” enables or disables (default) the conversion of picture environments and pstricks material to SVG.

๐Ÿ›ฐ๏ธ Daemon, Server and Client Options ๐Ÿ›ฐ๏ธ

Options used only for daemonized conversions, e.g. talking to a remote server via latexmlc, or local processing via the LaTeXML::Plugin::latexmls plugin.

For reliable communication and a stable conversion experience, invoke latexmls only through the latexmlc client (you need to set --expire to a positive value, in order to request auto-spawning of a dedicated conversion server). stable connection era ๐Ÿซถ

  • --autoflush=count โ€” automatically restart the daemon after converting count inputs. Good practice for vast batch jobs. (default: 100)
  • --expire=secs โ€” set an inactivity timeout value in seconds. If the server process is not given any input for the specified duration, it will automatically terminate. The default value is 600 seconds, set to 0 to never expire, -1 to entirely opt out of using an independent server.
  • --address=URL โ€” specify server address (default: localhost).
  • --port=number โ€” specify server port (default: 3334 for math, 3344 for fragment and 3354 for standard).

๐Ÿ‘‘ AUTHOR ๐Ÿ‘‘

Bruce Miller <bruce.miller@nist.gov> Deyan Ginev <deyan.ginev@nist.gov>

Public domain software, produced as part of work done by the United States Government & not subject to copyright in the US.


๐Ÿ’– Thatโ€™s a wrap on LaTeXM...:Config(3pm), bestie! Source/version check: perl v5.40.1, dated 2025-11-16 โ€” now go forth and post-process, icon โœจ๐Ÿ’…

๐Ÿ“ฆ where this page comes from