CM2XETEX(1)

📦
version 0.7.1 · 4 versions
, in debian bookworm, ubuntu noble

🎀 CM2XETEX(1) 🎀

okay bestie, welcome to the cm2xetex page 💖 this one ships with the recommonmark Python package, and it's literally just here to turn your CommonMark files into XeTeX source. no cap.

✨ NAME ✨

cm2xetex — convert CommonMark file to XeTeX source 🦋

🌸 SYNOPSIS 🌸

cm2xetex [options] [<source> [<destination>]]

💫 DESCRIPTION 💫

So the whole vibe is: you feed it markdown, it hands you a xetex document. It reads from <source> (and if you don't give it one, it just reads from stdin — she's flexible like that 💅), then writes to <destination> (and if that's missing too, she writes to stdout). iconic behavior fr fr.

If you want the full settings reference, go peek at https://docutils.sourceforge.io/docs/user/config.html 👑

👑 OPTIONS 👑

🌈 General Docutils Options:

  • --title=TITLE — set the document title as metadata ✨
  • --generator, -g — tack on a "Generated by Docutils" credit and link 🫶
  • --no-generator — no generator credit, we're humble today
  • --date, -d — drop the date at the end of the document (UTC) 📅
  • --time, -t — drop the time & date (UTC) ⏰
  • --no-datestamp — no datestamp of any kind, periodt
  • --source-link, -s — add a "View document source" link 🔗
  • --source-url=<URL> — use <URL> for a source link; this implies --source-link
  • --no-source-link — no "View document source" link
  • --toc-entry-backlinks — link from section headers to TOC entries. (default) 🔙
  • --toc-top-backlinks — link from section headers to the top of the TOC ⬆️
  • --no-toc-backlinks — disable backlinks to the table of contents
  • --footnote-backlinks — link from footnotes/citations to references. (default)
  • --no-footnote-backlinks — disable backlinks from footnotes and citations
  • --section-numbering — enable section numbering by Docutils. (default) 🔢
  • --no-section-numbering — disable section numbering by Docutils
  • --strip-comments — remove comment elements from the document tree 🧹
  • --leave-comments — leave comment elements in the document tree. (default)
  • --strip-elements-with-class=<class> — remove all elements with classes="<class>" from the document tree.
⚠️ Warning: potentially dangerous; use with caution. (Multiple-use option.)
  • --strip-class=<class> — remove all classes="<class>" attributes from elements in the document tree.
⚠️ Warning: potentially dangerous; use with caution. (Multiple-use option.)
  • --report=<level>, -r <level> — report system messages at or higher than <level>: "info" or "1", "warning"/"2" (default), "error"/"3", "severe"/"4", "none"/"5" 📢
  • --verbose, -v — report all system messages. (Same as "--report=1".) 🗣️
  • --quiet, -q — report no system messages. (Same as "--report=5".) 🤫
  • --halt=<level> — halt execution at system messages at or above <level>. Levels as in --report. Default: 4 (severe) 🛑
  • --strict — halt at the slightest problem. Same as "--halt=info". 😤
  • --exit-status=<level> — enable a non-zero exit status for non-halting system messages at or above <level>. Default: 5 (disabled)
  • --debug — enable debug-level system messages and diagnostics 🐛
  • --no-debug — disable debug output. (default)
  • --warnings=<file> — send the output of system messages to <file> 📝
  • --traceback — enable Python tracebacks when Docutils is halted
  • --no-traceback — disable Python tracebacks. (default)
  • --input-encoding=<name[:handler]>, -i <name[:handler]> — specify the encoding and optionally the error handler of input text. Default: <auto-detect>:strict.
  • --input-encoding-error-handler=INPUT_ENCODING_ERROR_HANDLER — specify the error handler for undecodable characters. Choices: "strict" (default), "ignore", and "replace".
  • --output-encoding=<name[:handler]>, -o <name[:handler]> — specify the text encoding and optionally the error handler for output. Default: utf-8:strict.
  • --output-encoding-error-handler=OUTPUT_ENCODING_ERROR_HANDLER — specify error handler for unencodable output characters; "strict" (default), "ignore", "replace", "xmlcharrefreplace", "backslashreplace".
  • --error-encoding=<name[:handler]>, -e <name[:handler]> — specify text encoding and optionally error handler for error output. Default text encoding: system encoding. Default error handler: backslashreplace.
  • --error-encoding-error-handler=ERROR_ENCODING_ERROR_HANDLER — specify the error handler for unencodable characters in error output. Default: backslashreplace.
  • --language=<name>, -l <name> — specify the language (as BCP 47 language tag). Default: en 🌍
  • --record-dependencies=<file> — write output file dependencies to <file>
  • --config=<file> — read configuration settings from <file>, if it exists
  • --version, -V — show this program's version number and exit 🏷️
  • --help, -h — show this help message and exit 🆘

🧚 Generic Parser Options:

  • --no-file-insertion — disable directives that insert the contents of an external file; replaced with a "warning" system message
  • --file-insertion-enabled — enable directives that insert the contents of an external file. (default)
  • --no-raw — disable the "raw" directive; replaced with a "warning" system message
  • --raw-enabled — enable the "raw" directive. (default)
  • --line-length-limit=<length> — maximal number of characters in an input line. Default 10 000. 📏

🦋 Standalone Reader Options:

  • --no-doc-title — disable the promotion of a lone top-level section title to document title (and subsequent section title to document subtitle promotion; enabled by default)
  • --no-doc-info — disable the bibliographic field list transform (enabled by default)
  • --section-subtitles — activate the promotion of lone subsection titles to section subtitles (disabled by default)
  • --no-section-subtitles — deactivate the promotion of lone subsection titles

💅 LaTeX-Specific Options:

  • --documentclass=DOCUMENTCLASS — specify LaTeX documentclass. Default: "article".
  • --documentoptions=DOCUMENTOPTIONS — specify document options. Multiple options can be given, separated by commas. Default: "a4paper".
  • --footnote-references=<format> — format for footnote references: one of "superscript" or "brackets". Default: "superscript".
  • --use-latex-citations — use \cite command for citations. (future default)
  • --figure-citations — use figure floats for citations (might get mixed with real figures). (provisional default) 🖼️
  • --attribution=<format> — format for block quote attributions: one of "dash" (em-dash prefix), "parentheses"/"parens", or "none". Default: "dash".
  • --stylesheet=<file[,file,...]> — specify LaTeX packages/stylesheets. A style is referenced with "\usepackage" if extension is ".sty" or omitted and with "\input" else. Overrides previous --stylesheet and --stylesheet-path settings. 💐
  • --stylesheet-path=<file[,file,...]> — comma separated list of LaTeX packages/stylesheets. Relative paths are expanded if a matching file is found in the --stylesheet-dirs. With --linkstylesheet, the path is rewritten relative to the output *.tex file.
  • --link-stylesheet — link to the stylesheet(s) in the output file. (default) 🔗
  • --embed-stylesheet — embed the stylesheet(s) in the output file. Stylesheets must be accessible during processing.
  • --stylesheet-dirs=<dir[,dir,...]> — comma-separated list of directories where stylesheets are found. Used by --stylesheet-path when expanding relative path arguments. Default: ".".
  • --latex-preamble=LATEX_PREAMBLE — customization by LaTeX code in the preamble. Default: select PDF standard fonts (Times, Helvetica, Courier).
  • --template=<file> — specify the template file. Default: "default.tex".
  • --use-latex-toc — table of contents by LaTeX. (default)
  • --use-docutils-toc — table of contents by Docutils (without page numbers).
  • --use-part-section — add parts on top of the section hierarchy.
  • --use-docutils-docinfo — attach author and date to the document info table. (default)
  • --use-latex-docinfo — attach author and date to the document title.
  • --topic-abstract — typeset abstract as topic. (default)
  • --use-latex-abstract — use LaTeX abstract environment for the document's abstract.
  • --hyperlink-color=HYPERLINK_COLOR — color of any hyperlinks embedded in text. Default: "blue" (use "false" to disable). 🌈
  • --hyperref-options=HYPERREF_OPTIONS — additional options to the "hyperref" package.
  • --compound-enumerators — enable compound enumerators for nested enumerated lists (e.g. "1.2.a.ii"). 🔢
  • --no-compound-enumerators — disable compound enumerators for nested enumerated lists. (default)
  • --section-prefix-for-enumerators — enable section ("." subsection ...) prefixes for compound enumerators. This has no effect without --compound-enumerators.
  • --no-section-prefix-for-enumerators — disable section prefixes for compound enumerators. (default)
  • --section-enumerator-separator=<char> — set the separator between section number and enumerator for compound enumerated lists. Default: "-".
  • --literal-block-env=LITERAL_BLOCK_ENV — when possible, use the specified environment for literal-blocks. Default: "" (fall back to "alltt").
  • --use-verbatim-when-possible — deprecated alias for "--literal-block-env=verbatim". 🚨
heads up bestie, this one's deprecated — it's just an alias now.
  • --table-style=<format> — table style. "standard" with horizontal and vertical lines, "booktabs" (LaTeX booktabs style) only horizontal lines above and below the table and below the header, or "borderless". Default: "standard"
  • --graphicx-option=GRAPHICX_OPTION — LaTeX graphicx package option. Possible values are "dvipdfmx", "dvips", "dvisvgm", "luatex", "pdftex", and "xetex".Default: "".
  • --font-encoding=FONT_ENCODING — LaTeX font encoding. Possible values are "", "T1" (default), "OT1", "LGR,T1" or any other combination of options to the fontenc package.
  • --reference-label=REFERENCE_LABEL — per default the latex-writer puts the reference title into hyperreferences. Specify "ref*" or "pageref*" to get the section number or the page number.
  • --use-bibtex=USE_BIBTEX — specify style and database for bibtex, for example "--use-bibtex=mystyle,mydb1,mydb2". 📚
  • --legacy-class-functions — bestie, this one rolls old-school: it uses the legacy functions with a class value list for \DUtitle and \DUadmonition. vintage vibes only 💅
  • --new-class-functions — the glow-up option ✨ it uses \DUrole and "DUclass" wrappers for class values, and drops admonition content into an environment. this is the default, so if you do nothing, you already got it 🫶
  • --legacy-column-widths — uses the legacy algorithm to figure out table column widths. it's the provisional default rn, like, it's holding the spot but we all know things are shifting 👀
  • --new-column-widths — uses the new algorithm to determine table column widths. labeled the future default because it's giving main character energy that just hasn't premiered yet 🦋
  • --docutils-footnotes — footnotes with numbers/symbols, courtesy of Docutils. this is the default 💖 (and the alternative, --latex-footnotes, is not implemented yet — so don't come for her, she's literally not ready 😭)

👑 AUTHOR 👑

Steve Genoud and Luca Barbato

Copyright (C) 2014 Steve Genoud and Luca Barbato

okay bestie that's the whole page, we ate and left no crumbs 💅 this came to you from recommonmark (Debian 0.7.1+ds-5), dated February 2023 — and the page is CM2XETEX(1), fr fr 🌸 go forth and convert those docs, ily, bye 🫶✨

📦 where this page comes from