1LaTeXML::Common::ConfigU(s3e)r Contributed Perl DocumentaLtaiToenXML::Common::Config(3)
2
3
4
6 "LaTeXML::Common::Config" - Configuration logic for LaTeXML
7
9 use LaTeXML::Common::Config;
10 my $config = LaTeXML::Common::Config->new(
11 profile=>'name',
12 timeout=>60,
13 ... );
14 $config->read(\@ARGV);
15 $config->check;
16
17 my $value = $config->get($name);
18 $config->set($name,$value);
19 $config->delete($name);
20 my $bool = $config->exists($name);
21 my @keys = $config->keys;
22 my $options_hashref = $config->options;
23 my $config_clone = $config->clone;
24
26 Configuration management class for LaTeXML options.
27 * Responsible for defining the options interface
28 and parsing the usual Perl command-line options syntax
29 * Provides the intuitive getters, setters, as well as
30 hash methods for manipulating the option values.
31 * Also supports cloning into new configuration objects.
32
33 METHODS
34 "my $config = LaTeXML::Common::Config->new(%options);"
35 Creates a new configuration object. Note that you should try
36 not to provide your own %options hash but rather create an
37 empty
38 configuration and use $config->read to read in the options.
39
40 "$config->read(\@ARGV);"
41 This is the main method for parsing in LaTeXML options.
42 The input array should either be @ARGV, e.g. when the
43 options were provided from the command line using the
44 classic Getopt::Long syntax,
45 or any other array reference that conforms to that setup.
46
47 "$config->check;"
48 Ensures that the configuration obeys the given profile and
49 performs a set of assignments of meaningful defaults
50 (when needed) and normalizations (for relative paths, etc).
51
52 "my $value = $config->get($name);"
53 Classic getter for the $value of an option $name.
54
55 "$config->set($name,$value);"
56 Classic setter for the $value of an option $name.
57
58 "$config->delete($name);"
59 Deletes option $name from the configuration.
60
61 "my $bool = $config->exists($name);"
62 Checks whether the key $name exists in the options hash of the
63 configuration.
64 Similarly to Perl's "exist" for hashes, it returns true even
65 when
66 the option's value is undefined.
67
68 "my @keys = $config->keys;"
69 Similar to "keys %hash" in Perl. Returns an array of all option
70 names.
71
72 "my $options_hashref = $config->options;"
73 Returns the actual hash reference that holds all options within the
74 configuration object.
75
76 "my $config_clone = $config->clone;"
77 Clones $config into a new LaTeXML::Common::Config object,
78 $config_clone.
79
81 latexmlc [options]
82
83 Options:
84 --VERSION show version number.
85 --help shows this help message.
86 --destination=file specifies destination file.
87 --output=file [obsolete synonym for --destination]
88 --preload=module requests loading of an optional module;
89 can be repeated
90 --preamble=file loads a tex file containing document
91 frontmatter. MUST include \begin{document}
92 or equivalent
93 --postamble=file loads a tex file containing document
94 backmatter. MUST include \end{document}
95 or equivalent
96 --includestyles allows latexml to load raw *.sty file;
97 by default it avoids this.
98 --base=dir sets the current working directory
99 --path=dir adds dir to the paths searched for files,
100 modules, etc;
101 --log=file specifies log file (default: STDERR)
102 --autoflush=count Automatically restart the daemon after
103 "count" inputs. Good practice for vast
104 batch jobs. (default: 100)
105 --timeout=secs Timecap for conversions (default 600)
106 --expire=secs Timecap for server inactivity (default 600)
107 --address=URL Specify server address (default: localhost)
108 --port=number Specify server port (default: 3354)
109 --documentid=id assign an id to the document root.
110 --quiet suppress messages (can repeat)
111 --verbose more informative output (can repeat)
112 --strict makes latexml less forgiving of errors
113 --bibtex processes a BibTeX bibliography.
114 --xml requests xml output (default).
115 --tex requests TeX output after expansion.
116 --box requests box output after expansion
117 and digestion.
118 --format=name requests "name" as the output format.
119 Supported: tex,box,xml,html4,html5,xhtml
120 html implies html5
121 --noparse suppresses parsing math (default: off)
122 --parse=name enables parsing math (default: on)
123 and selects parser framework "name".
124 Supported: RecDescent, no
125 --profile=name specify profile as defined in
126 LaTeXML::Common::Config
127 Supported: standard|math|fragment|...
128 (default: standard)
129 --mode=name Alias for profile
130 --cache_key=name Provides a name for the current option set,
131 to enable daemonized conversions without
132 needing re-initializing
133 --whatsin=chunk Defines the provided input chunk,
134 choose from document (default), fragment
135 and formula
136 --whatsout=chunk Defines the expected output chunk,
137 choose from document (default), fragment
138 and formula
139 --post requests a followup post-processing
140 --nopost forbids followup post-processing
141 --validate, --novalidate Enables (the default) or disables
142 validation of the source xml.
143 --omitdoctype omits the Doctype declaration,
144 --noomitdoctype disables the omission (the default)
145 --numbersections enables (the default) the inclusion of
146 section numbers in titles, crossrefs.
147 --nonumbersections disables the above
148 --timestamp provides a timestamp (typically a time and date)
149 to be embedded in the comments
150 --embed requests an embeddable XHTML snippet
151 (requires: --post,--profile=fragment)
152 DEPRECATED: Use --whatsout=fragment
153 TODO: Remove completely
154 --stylesheet specifies a stylesheet,
155 to be used by the post-processor.
156 --css=cssfile adds a css stylesheet to html/xhtml
157 (can be repeated)
158 --nodefaultresources disables processing built-in resources
159 --javascript=jsfile adds a link to a javascript file into
160 html/html5/xhtml (can be repeated)
161 --icon=iconfile specify a file to use as a "favicon"
162 --xsltparameter=name:value passes parameters to the XSLT.
163 --split requests splitting each document
164 --nosplit disables the above (default)
165 --splitat sets level to split the document
166 --splitpath=xpath sets xpath expression to use for
167 splitting (default splits at
168 sections, if splitting is enabled)
169 --splitnaming=(id|idrelative|label|labelrelative) specifies
170 how to name split files (idrelative).
171 --scan scans documents to extract ids,
172 labels, etc.
173 section titles, etc. (default)
174 --noscan disables the above
175 --crossref fills in crossreferences (default)
176 --nocrossref disables the above
177 --urlstyle=(server|negotiated|file) format to use for urls
178 (default server).
179 --navigationtoc=(context|none) generates a table of contents
180 in navigation bar
181 --index requests creating an index (default)
182 --noindex disables the above
183 --splitindex Splits index into pages per initial.
184 --nosplitindex disables the above (default)
185 --permutedindex permutes index phrases in the index
186 --nopermutedindex disables the above (default)
187 --bibliography=file sets a bibliography file
188 --splitbibliography splits the bibliography into pages per
189 initial.
190 --nosplitbibliography disables the above (default)
191 --prescan carries out only the split (if
192 enabled) and scan, storing
193 cross-referencing data in dbfile
194 (default is complete processing)
195 --dbfile=dbfile sets file to store crossreferences
196 --sitedirectory=dir sets the base directory of the site
197 --sourcedirectory=dir sets the base directory of the
198 original TeX source
199 --source=input as an alternative to passing the input as
200 the last argument, after the option set
201 you can also specify it as the value here.
202 useful for predictable API calls
203 --mathimages converts math to images
204 (default for html4 format)
205 --nomathimages disables the above
206 --mathimagemagnification=mag specifies magnification factor
207 --presentationmathml converts math to Presentation MathML
208 (default for xhtml & html5 formats)
209 --pmml alias for --presentationmathml
210 --nopresentationmathml disables the above
211 --linelength=n formats presentation mathml to a
212 linelength max of n characters
213 --contentmathml converts math to Content MathML
214 --nocontentmathml disables the above (default)
215 --cmml alias for --contentmathml
216 --openmath converts math to OpenMath
217 --noopenmath disables the above (default)
218 --om alias for --openmath
219 --keepXMath preserves the intermediate XMath
220 representation (default is to remove)
221 --mathtex adds TeX annotation to parallel markup
222 --nomathtex disables the above (default)
223 --unicodemath adds UnicodeMath annotation to parallel markup
224 --nounicodemath disables the above (default)
225 --parallelmath use parallel math annotations (default)
226 --noparallelmath disable parallel math annotations
227 --plane1 use plane-1 unicode for symbols
228 (default, if needed)
229 --noplane1 do not use plane-1 unicode
230 --graphicimages converts graphics to images (default)
231 --nographicimages disables the above
232 --graphicsmap=type.type specifies a graphics file mapping
233 --pictureimages converts picture environments to
234 images (default)
235 --nopictureimages disables the above
236 --svg converts picture environments to SVG
237 --nosvg disables the above (default)
238 --nocomments omit comments from the output
239 --inputencoding=enc specify the input encoding.
240 --debug=package enables debugging output for the named
241 package
242
243 If you want to provide a TeX snippet directly on input, rather than
244 supply a filename, use the "literal:" protocol to prefix your snippet.
245
247 General Options
248 "--verbose"
249 Increases the verbosity of output during processing, used twice is
250 pretty chatty.
251 Can be useful for getting more details when errors occur.
252
253 "--quiet"
254 Reduces the verbosity of output during processing, used twice is
255 pretty silent.
256
257 "--VERSION"
258 Shows the version number of the LaTeXML package..
259
260 "--debug"=package
261 Enables debugging output for the named package. The package is
262 given without the leading LaTeXML::.
263
264 "--base"=dir
265 Specifies the base working directory for the conversion server.
266 Useful when converting sets of documents that use relative
267 paths.
268
269 "--log"=file
270 Specifies the log file; be default any conversion messages are
271 printed to STDERR.
272
273 "--help"
274 Shows this help message.
275
276 Source Options
277 "--destination"=file
278 Specifies the destination file; by default the XML is written to
279 STDOUT.
280
281 "--preload"=module
282 Requests the loading of an optional module or package. This may be
283 useful if the TeX code
284 does not specifically require the module (eg. through input or
285 usepackage).
286 For example, use "--preload=LaTeX.pool" to force LaTeX mode.
287
288 "--preamble"=file
289 Requests the loading of a tex file with document frontmatter, to be
290 read in before the converted document,
291 but after all --preload entries.
292
293 Note that the given file MUST contain \begin{document} or an
294 equivalent environment start,
295 when processing LaTeX documents.
296
297 If the file does not contain content to appear in the final
298 document, but only macro definitions and
299 setting of internal counters, it is more appropriate to use
300 --preload instead.
301
302 "--postamble"=file
303 Requests the loading of a tex file with document backmatter, to be
304 read in after the converted document.
305
306 Note that the given file MUST contain \end{document} or an
307 equivalent environment end,
308 when processing LaTeX documents.
309
310 "--sourcedirectory"=source
311 Specifies the directory where the original latex source is located.
312 Unless LaTeXML is run from that directory, or it can be determined
313 from the xml filename, it may be necessary to specify this option
314 in order to find graphics and style files.
315
316 "--path"=dir
317 Add dir to the search paths used when searching for files, modules,
318 style files, etc;
319 somewhat like TEXINPUTS. This option can be repeated.
320
321 "--validate", "--novalidate"
322 Enables (or disables) the validation of the source XML document
323 (the default).
324
325 "--bibtex"
326 Forces latexml to treat the file as a BibTeX bibliography.
327 Note that the timing is slightly different than the usual
328 case with BibTeX and LaTeX. In the latter case, BibTeX simply
329 selects and formats a subset of the bibliographic entries; the
330 actual TeX expansion is carried out when the result is included
331 in a LaTeX document. In contrast, latexml processes and
332 expands
333 the entire bibliography; the selection of entries is done
334 during post-processing. This also means that any packages
335 that define macros used in the bibliography must be
336 specified using the "--preload" option.
337
338 "--inputencoding="encoding
339 Specify the input encoding, eg. "--inputencoding=iso-8859-1".
340 The encoding must be one known to Perl's Encode package.
341 Note that this only enables the translation of the input bytes
342 to
343 UTF-8 used internally by LaTeXML, but does not affect catcodes.
344 In such cases, you should be using the inputenc package.
345 Note also that this does not affect the output encoding, which
346 is
347 always UTF-8.
348
349 TeX Conversion Options
350 "--includestyles"
351 This optional allows processing of style files (files with
352 extensions "sty",
353 "cls", "clo", "cnf"). By default, these files are ignored
354 unless a latexml
355 implementation of them is found (with an extension of "ltxml").
356
357 These style files generally fall into two classes: Those
358 that merely affect document style are ignorable in the XML.
359 Others define new markup and document structure, often using
360 deeper LaTeX macros to achieve their ends. Although the
361 omission
362 will lead to other errors (missing macro definitions), it is
363 unlikely that processing the TeX code in the style file will
364 lead to a correct document.
365
366 "--timeout"=secs
367 Set time cap for conversion jobs, in seconds. Any job failing to
368 convert in the
369 time range would return with a Fatal error of timing out.
370 Default value is 600, set to 0 to disable.
371
372 "--nocomments"
373 Normally latexml preserves comments from the source file, and adds
374 a comment every 25 lines as
375 an aid in tracking the source. The option --nocomments
376 discards such comments.
377
378 "--documentid"=id
379 Assigns an ID to the root element of the XML document. This ID is
380 generally
381 inherited as the prefix of ID's on all other elements within
382 the document.
383 This is useful when constructing a site of multiple documents
384 so that
385 all nodes have unique IDs.
386
387 "--strict"
388 Specifies a strict processing mode. By default, undefined control
389 sequences and
390 invalid document constructs (that violate the DTD) give warning
391 messages, but attempt
392 to continue processing. Using "--strict" makes them generate
393 fatal errors.
394
395 "--post"
396 Request post-processing, auto-enabled by any requested post-
397 processor. Disabled by default.
398 If post-processing is enabled, the graphics and cross-
399 referencing processors are on by default.
400
401 Format Options
402 "--format"="(html|html5|html4|xhtml|xml|epub)"
403 Specifies the output format for post processing. By default, it
404 will be guessed from the file extension of the destination (if
405 given), with html implying "html5", xhtml implying "xhtml" and the
406 default being "xml", which you probably don't want.
407
408 The "html5" format converts the material to html5 form with
409 mathematics as MathML; "html5" supports SVG. "html4" format
410 converts the material to the earlier html form, version 4, and the
411 mathematics to png images. "xhtml" format converts to xhtml and
412 uses presentation MathML (after attempting to parse the
413 mathematics) for representing the math. "html5" similarly converts
414 math to presentation MathML. In these cases, any graphics will be
415 converted to web-friendly formats and/or copied to the destination
416 directory. If you simply specify "html", it will treat that as
417 "html5".
418
419 For the default, "xml", the output is left in LaTeXML's internal
420 xml, although the math can be converted by enabling one of the math
421 postprocessors, such as --pmml to obtain presentation MathML. For
422 html, html5 and xhtml, a default stylesheet is provided, but see
423 the "--stylesheet" option.
424
425 "--xml"
426 Requests XML output; this is the default.
427 DEPRECATED: use --format=xml instead
428
429 "--tex"
430 Requests TeX output for debugging purposes;
431 processing is only carried out through expansion and digestion.
432 This may not be quite valid TeX, since Unicode may be
433 introduced.
434
435 "--box"
436 Requests Box output for debugging purposes;
437 processing is carried out through expansion and digestions,
438 and the result is printed.
439
440 "--profile"
441 Variety of shorthand profiles.
442 Note that the profiles come with a variety of preset options.
443 You can examine any of them in their
444 "resources/Profiles/name.opt"
445 file.
446
447 Example: "latexmlc --profile=math 'literal:1+2=3'"
448
449 "--omitdoctype", "--noomitdoctype"
450 Omits (or includes) the document type declaration. The default is
451 to include it if the document model was based on a DTD.
452
453 "--numbersections", "--nonumbersections"
454 Includes (default), or disables the inclusion of section, equation,
455 etc, numbers in the formatted document and crossreference links.
456
457 "--stylesheet"=xslfile
458 Requests the XSL transformation of the document using the given
459 xslfile as stylesheet. If the stylesheet is omitted, a `standard'
460 one appropriate for the format (html4, html5 or xhtml) will be
461 used.
462
463 "--css"=cssfile
464 Adds cssfile as a css stylesheet to be used in the transformed
465 html/html5/xhtml. Multiple stylesheets can be used; they are
466 included in the html in the order given, following the default
467 "ltx-LaTeXML.css" (unless "--nodefaultcss"). The stylesheet is
468 copied to the destination directory, unless it is an absolute url.
469
470 Some stylesheets included in the distribution are
471 --css=navbar-left Puts a navigation bar on the left.
472 (default omits navbar)
473 --css=navbar-right Puts a navigation bar on the left.
474 --css=theme-blue A blue coloring theme for headings.
475 --css=amsart A style suitable for journal articles.
476
477 "--javascript"=jsfile
478 Includes a link to the javascript file jsfile, to be used in the
479 transformed html/html5/xhtml. Multiple javascript files can be
480 included; they are linked in the html in the order given. The
481 javascript file is copied to the destination directory, unless it
482 is an absolute url.
483
484 "--icon"=iconfile
485 Copies iconfile to the destination directory and sets up the
486 linkage in the transformed html/html5/xhtml to use that as the
487 "favicon".
488
489 "--nodefaultresources"
490 Disables the copying and inclusion of resources added by the
491 binding files; This includes CSS, javascript or other files. This
492 does not affect resources explicitly requested by the "--css" or
493 "--javascript" options.
494
495 "--timestamp"=timestamp
496 Provides a timestamp (typically a time and date) to be embedded in
497 the comments by the stock XSLT stylesheets. If you don't supply a
498 timestamp, the current time and date will be used. (You can use
499 "--timestamp=0" to omit the timestamp).
500
501 "--xsltparameter"=name:value
502 Passes parameters to the XSLT stylesheet. See the manual or the
503 stylesheet itself for available parameters.
504
505 Site & Crossreferencing Options
506 "--split", "--nosplit"
507 Enables or disables (default) the splitting of documents into
508 multiple `pages'. If enabled, the the document will be split into
509 sections, bibliography, index and appendices (if any) by default,
510 unless "--splitpath" is specified.
511
512 "--splitat="unit
513 Specifies what level of the document to split at. Should be one of
514 "chapter", "section" (the default), "subsection" or
515 "subsubsection". For more control, see "--splitpath".
516
517 "--splitpath="xpath
518 Specifies an XPath expression to select nodes that will generate
519 separate pages. The default splitpath is
520 //ltx:section | //ltx:bibliography | //ltx:appendix | //ltx:index
521
522 Specifying
523
524 --splitpath="//ltx:section | //ltx:subsection
525 | //ltx:bibliography | //ltx:appendix | //ltx:index"
526
527 would split the document at subsections as well as sections.
528
529 "--splitnaming"="(id|idrelative|label|labelrelative)"
530 Specifies how to name the files for subdocuments created by
531 splitting. The values "id" and "label" simply use the id or label
532 of the subdocument's root node for it's filename. "idrelative" and
533 "labelrelative" use the portion of the id or label that follows the
534 parent document's id or label. Furthermore, to impose structure and
535 uniqueness, if a split document has children that are also split,
536 that document (and it's children) will be in a separate
537 subdirectory with the name index.
538
539 "--scan", "--noscan"
540 Enables (default) or disables the scanning of documents for ids,
541 labels, references, indexmarks, etc, for use in filling in refs,
542 cites, index and so on. It may be useful to disable when
543 generating documents not based on the LaTeXML doctype.
544
545 "--crossref", "--nocrossref"
546 Enables (default) or disables the filling in of references, hrefs,
547 etc based on a previous scan (either from "--scan", or "--dbfile")
548 It may be useful to disable when generating documents not based on
549 the LaTeXML doctype.
550
551 "--urlstyle"="(server|negotiated|file)"
552 This option determines the way that URLs within the documents are
553 formatted, depending on the way they are intended to be served.
554 The default, "server", eliminates unnecessary trailing
555 "index.html". With "negotiated", the trailing file extension
556 (typically "html" or "xhtml") are eliminated. The scheme "file"
557 preserves complete (but relative) urls so that the site can be
558 browsed as files without any server.
559
560 "--navigationtoc"="(context|none)"
561 Generates a table of contents in the navigation bar; default is
562 "none". The `context' style of TOC, is somewhat verbose and
563 reveals more detail near the current page; it is most suitable for
564 navigation bars placed on the left or right. Other styles of TOC
565 should be developed and added here, such as a short form.
566
567 "--index", "--noindex"
568 Enables (default) or disables the generation of an index from
569 indexmarks embedded within the document. Enabling this has no
570 effect unless there is an index element in the document (generated
571 by \printindex).
572
573 "--splitindex", "--nosplitindex"
574 Enables or disables (default) the splitting of generated indexes
575 into separate pages per initial letter.
576
577 "--bibliography="pathname
578 Specifies a bibliography generated from a BibTeX file to be used to
579 fill in a bibliography element. Hand-written bibliographies placed
580 in a "thebibliography" environment do not need this. The option
581 has no effect unless there is an bibliography element in the
582 document (generated by \bibliography).
583
584 Note that this option provides the bibliography to be used to fill
585 in the bibliography element (generated by "\bibliography");
586 latexmlpost does not (currently) directly process and format such a
587 bibliography.
588
589 "--splitbibliography", "--nosplitbibliography"
590 Enables or disables (default) the splitting of generated
591 bibliographies into separate pages per initial letter.
592
593 "--prescan"
594 By default "latexmlpost" processes a single document into one (or
595 more; see "--split") destination files in a single pass. When
596 generating a complicated site consisting of several documents it
597 may be advantageous to first scan through the documents to extract
598 and store (in "dbfile") cross-referencing data (such as ids,
599 titles, urls, and so on). A later pass then has complete
600 information allowing all documents to reference each other, and
601 also constructs an index and bibliography that reflects the entire
602 document set. The same effect (though less efficient) can be
603 achieved by running "latexmlpost" twice, provided a "dbfile" is
604 specified.
605
606 "--dbfile"=file
607 Specifies a filename to use for the crossreferencing data when
608 using two-pass processing. This file may reside in the
609 intermediate destination directory.
610
611 "--sitedirectory="dir
612 Specifies the base directory of the overall web site. Pathnames in
613 the database are stored in a form relative to this directory to
614 make it more portable.
615
616 "--embed"
617 TODO: Deprecated, use --whatsout=fragment Requests an embeddable
618 XHTML div (requires: --post --format=xhtml),
619 respectively the top division of the document's body.
620 Caveat: This experimental mode is enabled only for fragment
621 profile and post-processed
622 documents (to XHTML).
623
624 Math Options
625 These options specify how math should be converted into other formats.
626 Multiple formats can be requested; how they will be combined depends on
627 the format and other options.
628
629 "--noparse"
630 Suppresses parsing math (default: parsing is on)
631
632 "--parse=name"
633 Enables parsing math (default: parsing is on)
634 and selects parser framework "name".
635 Supported: RecDescent, no
636 Tip: --parse=no is equivalent to --noparse
637
638 "--mathimages", "--nomathimages"
639 Requests or disables the conversion of math to images (png by
640 default). Conversion is the default for html4 format.
641
642 "--mathsvg", "--nomathsvg"
643 Requests or disables the conversion of math to svg images.
644
645 "--mathimagemagnification="factor
646 Specifies the magnification used for math images (both png and
647 svg), if they are made. Default is 1.75.
648
649 "--presentationmathml", "--nopresentationmathml"
650 Requests or disables conversion of math to Presentation MathML.
651 Conversion is the default for xhtml and html5 formats.
652
653 "--linelength"=number
654 (Experimental) Line-breaks the generated Presentation MathML so
655 that it is no longer than number `characters'.
656
657 "--plane1"
658 Converts the content of Presentation MathML token elements to the
659 appropriate Unicode Plane-1 codepoints according to the selected
660 font, when applicable (the default).
661
662 "--hackplane1"
663 Converts the content of Presentation MathML token elements to the
664 appropriate Unicode Plane-1 codepoints according to the selected
665 font, but only for the mathvariants double-struck, fraktur and
666 script. This gives support for current (as of August 2009)
667 versions of Firefox and MathPlayer, provided a sufficient set of
668 fonts is available (eg. STIX).
669
670 "--contentmathml", "--nocontentmathml"
671 Requests or disables conversion of math to Content MathML.
672 Conversion is disabled by default. Note that this conversion is
673 only partially implemented.
674
675 "--openmath"
676 Requests or disables conversion of math to OpenMath. Conversion is
677 disabled by default. Note that this conversion is only partially
678 implemented.
679
680 "--keepXMath", "--xmath"
681 By default, when any of the MathML or OpenMath conversions are
682 used, the intermediate math representation will be removed; this
683 option preserves it; it will be used as secondary parallel markup,
684 when it follows the options for other math representations.
685
686 Graphics Options
687 "--graphicimages", "--nographicimages"
688 Enables (default) or disables the conversion of graphics to web-
689 appropriate format (png).
690
691 "--graphicsmap="sourcetype.desttype
692 Specifies a mapping of graphics file types. Typically, graphics
693 elements specify a graphics file that will be converted to a more
694 appropriate file target format; for example, postscript files used
695 for graphics with LaTeX will be converted to png format for use on
696 the web. As with LaTeX, when a graphics file is specified without
697 a file type, the system will search for the most appropriate target
698 type file.
699
700 When this option is used, it overrides and replaces the defaults
701 and provides a mapping of sourcetype to desttype. The option can
702 be repeated to provide several mappings, with the earlier formats
703 preferred. If the desttype is omitted, it specifies copying files
704 of type sourcetype, unchanged.
705
706 The default settings is equivalent to having supplied the options:
707 svg png gif jpg jpeg eps.png ps.png ai.png pdf.png
708
709 The first formats are preferred and used unchanged, while the
710 latter ones are converted to png.
711
712 "--pictureimages", "--nopictureimages"
713 Enables (default) or disables the conversion of picture
714 environments and pstricks material into images.
715
716 "--svg", "--nosvg"
717 Enables or disables (default) the conversion of picture
718 environments and pstricks material to SVG.
719
720 Daemon, Server and Client Options
721 Options used only for daemonized conversions, e.g. talking to a remote
722 server via latexmlc, or local processing via the
723 "LaTeXML::Plugin::latexmls" plugin.
724
725 For reliable communication and a stable conversion experience, invoke
726 latexmls only through the latexmlc client (you need to set --expire to
727 a positive value, in order to request auto-spawning of a dedicated
728 conversion server).
729
730 "--autoflush"=count
731 Automatically restart the daemon after converting "count" inputs.
732 Good practice for vast batch jobs. (default: 100)
733
734 "--expire"=secs
735 Set an inactivity timeout value in seconds.
736 If the server process is not given any input for the specified
737 duration,
738 it will automatically terminate.
739 The default value is 600 seconds, set to 0 to never expire,
740 -1 to entirely opt out of using an independent server.
741
742 "--address"=URL
743 Specify server address (default: localhost)
744
745 "--port"=number
746 Specify server port (default: 3334 for math, 3344 for fragment and
747 3354 for standard)
748
750 Bruce Miller <bruce.miller@nist.gov> Deyan Ginev <deyan.ginev@nist.gov>
751
753 Public domain software, produced as part of work done by the United
754 States Government & not subject to copyright in the US.
755
756
757
758perl v5.38.0 2023-07-19 LaTeXML::Common::Config(3)