CM2XML(1)

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

💖 CM2XML(1) 💖

okay so bestie, welcome to the cm2xml page — it lives in the recommonmark Python package, and no, you're not lost, you're exactly where you need to be. sit down, hydrate, let's go 🫶

✨ NAME ✨

cm2xml — turns a CommonMark file into an XML document. that's it. that's the whole job. slay.

🦋 SYNOPSIS 🦋

cm2xml [options] [<source> [<destination>]]

🌸 DESCRIPTION 🌸

so like, this thing generates an XML document from markdown sources. it reads from <source> — and if you don't give it one, it just reads from stdin, no big deal — and it writes to <destination>, which defaults to stdout because of course it does.

and if you want the full detailed settings reference, it's literally right here, go look: https://docutils.sourceforge.io/docs/user/config.html

🎀 OPTIONS 🎀

General Docutils Options 💅

  • --title=TITLE — sets the document title as metadata. name your doc, icon behaviour.
  • --generator, -g — adds a "Generated by Docutils" credit and link. give credit where credit is due bestie.
  • --no-generator — do not include a generator credit.
  • --date, -d — slaps the date at the end of the document (UTC).
  • --time, -t — includes the time and date (UTC). timestamped and thriving.
  • --no-datestamp — no datestamp of any kind. zero. none. invisible.
  • --source-link, -s — includes a "View document source" link.
  • --source-url=<URL> — uses <URL> for the source link; this one implies --source-link automatically, sneaky but cute.
  • --no-source-link — no "View document source" link. it's giving mystery.
  • --toc-entry-backlinks — links from section headers to TOC entries. (default)
  • --toc-top-backlinks — links from section headers to the top of the TOC instead.
  • --no-toc-backlinks — disables backlinks to the table of contents entirely.
  • --footnote-backlinks — links from footnotes/citations to references. (default)
  • --no-footnote-backlinks — disables backlinks from footnotes and citations.
  • --section-numbering — enables section numbering by Docutils. (default)
  • --no-section-numbering — disables section numbering by Docutils.
  • --strip-comments — removes comment elements from the document tree. bye bestie 👋
  • --leave-comments — leaves comment elements in the document tree. (default)
  • --strip-elements-with-class=<class> — removes all elements with classes="<class>" from the document tree.
⚠️ warning: potentially dangerous; use with caution. (Multiple-use option.)
  • --strip-class=<class> — removes all classes="<class>" attributes from elements in the document tree.
⚠️ warning: potentially dangerous; use with caution. (Multiple-use option.)
  • --report=<level>, -r <level> — reports system messages at or higher than <level>. the levels are: "info" or "1", "warning"/"2" (default), "error"/"3", "severe"/"4", "none"/"5".
  • --verbose, -v — reports all system messages. (same as "--report=1".)
  • --quiet, -q — reports no system messages. (same as "--report=5".) shhh 🤫
  • --halt=<level> — halts execution at system messages at or above <level>. levels work the same as in --report. default: 4 (severe).
  • --strict — halts at the slightest problem. same as "--halt=info". it's giving perfectionist.
  • --exit-status=<level> — enables a non-zero exit status for non-halting system messages at or above <level>. default: 5 (disabled).
  • --debug — enables debug-level system messages and diagnostics. detective mode 🔍
  • --no-debug — disables debug output. (default)
  • --warnings=<file> — sends the output of system messages to <file>.
  • --traceback — enables Python tracebacks when Docutils is halted.
  • --no-traceback — disables Python tracebacks. (default)
  • --input-encoding=<name[:handler]>, -i <name[:handler]> — specifies the encoding and optionally the error handler of input text. default: <auto-detect>:strict.
  • --input-encoding-error-handler=INPUT_ENCODING_ERROR_HANDLER — specifies the error handler for undecodable characters. choices: "strict" (default), "ignore", and "replace".
  • --output-encoding=<name[:handler]>, -o <name[:handler]> — specifies the text encoding and optionally the error handler for output. default: utf-8:strict.
  • --output-encoding-error-handler=OUTPUT_ENCODING_ERROR_HANDLER — specifies the error handler for unencodable output characters: "strict" (default), "ignore", "replace", "xmlcharrefreplace", "backslashreplace".
  • --error-encoding=<name[:handler]>, -e <name[:handler]> — specifies 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 — specifies the error handler for unencodable characters in error output. default: backslashreplace.
  • --language=<name>, -l <name> — specifies the language (as a BCP 47 language tag). default: en.
  • --record-dependencies=<file> — writes output file dependencies to <file>.
  • --config=<file> — reads configuration settings from <file>, if it exists. (if it doesn't, no drama.)
  • --version, -V — shows this program's version number and exits.
  • --help, -h — shows this help message and exits. the classic.

Generic Parser Options 🌈

  • --no-file-insertion — disables directives that insert the contents of an external file; they get replaced with a "warning" system message.
  • --file-insertion-enabled — enables directives that insert the contents of an external file. (default)
  • --no-raw — disables the "raw" directive; replaced with a "warning" system message.
  • --raw-enabled — enables 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 — disables the promotion of a lone top-level section title to document title (and the subsequent promotion of a section title to document subtitle; this whole thing is enabled by default).
  • --no-doc-info — disables the bibliographic field list transform (enabled by default).
  • --section-subtitles — activates the promotion of lone subsection titles to section subtitles (disabled by default).
  • --no-section-subtitles — deactivates the promotion of lone subsection titles.

Docutils XML Writer Options 🧚

  • --newlines — generates XML with newlines before and after tags.
  • --indents — generates XML with indents and newlines. aesthetic ✨
  • --no-xml-declaration — omits the XML declaration.
⚠️ use with caution.
  • --no-doctype — omits the DOCTYPE declaration.

👑 AUTHOR 👑

Steve Genoud and Luca Barbato

Copyright (C) 2014 Steve Genoud and Luca Barbato

and that's the whole page bestie, you ate it up fr fr 🍓 this one's from recommonmark (Debian 0.7.1+ds-5), dated February 2023 — CM2XML(1), periodt 💅

📦 where this page comes from