CM2PSEUDOXML(1)

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

💅 CM2PSEUDOXML — the manual page, but make it make sense

okay bestie, so this is cm2pseudoxml, straight out of the recommonmark Python package. It's a whole little program and I'm about to explain it to you like we're texting at 1am. 🫶

✨ NAME ✨

cm2pseudoxml — the girlies' favourite way to turn a CommonMark file into a pseudo-XML document. no cap, that's literally the whole job. 💖

🌸 SYNOPSIS 🌸

cm2pseudoxml [options] [<source> [<destination>]]

🦋 DESCRIPTION 🦋

So here's the tea: this thing generates a pseudo-XML document from markdown sources. 🎀

It reads from <source> — and if you don't give it one, it just reads from stdin like a chill little gremlin. It writes to <destination> — and if you don't give it one of those either, it writes to stdout. periodt. ✨

And if you want the full detailed settings reference (like, the whole encyclopedia), it's over at https://docutils.sourceforge.io/docs/user/config.html. go off, docutils. 👑

💅 OPTIONS 💅

👑 General Docutils Options:

  • --title=TITLE — sets the document title as metadata. it's giving "yes, I have a name, thanks for asking". 💖
  • --generator, -g — adds a "Generated by Docutils" credit and link, so everyone knows who did it. main character credits energy.
  • --no-generator — no generator credit. humble era. 🙈
  • --date, -d — stamps the date at the end of the document (UTC). timezone-correct and proud. 🌈
  • --time, -t — stamps the time & date (UTC). more precise, more iconic. ⭐
  • --no-datestamp — no datestamp of any kind. we're timeless, bestie. 💀
  • --source-link, -s — adds a "View document source" link. transparency queen. 🦋
  • --source-url=<URL> — uses <URL> for a source link; this implies --source-link. (yes, it brings its friend along, that's the vibe.) 🔥
  • --no-source-link — no "View document source" link. mystery era. 🎀
  • --toc-entry-backlinks — links from section headers to TOC entries. this is the default, so it's already doing this. slay.
  • --toc-top-backlinks — links from section headers to the top of the TOC instead. lil change of plans, still cute. 💜
  • --no-toc-backlinks — disables backlinks to the table of contents entirely. bye 👋
  • --footnote-backlinks — links from footnotes/citations to references. also the default. 🌸
  • --no-footnote-backlinks — disables backlinks from footnotes and citations. no jumping back, we live in the moment. ✨
  • --section-numbering — enables section numbering by Docutils. default, and honestly? organized. 💅
  • --no-section-numbering — disables section numbering by Docutils. chaos era, valid. 😭
  • --strip-comments — removes comment elements from the document tree. not me deleting the receipts. 💀
  • --leave-comments — leaves comment elements in the document tree. this is the default. they stay. 🫶
  • --strip-elements-with-class=<class> — removes all elements with classes="<class>" from the document tree. > ⚠️ warning: potentially dangerous; use with caution. also it's a multiple-use option, so you can stack it. 💖
  • --strip-class=<class> — removes all classes="<class>" attributes from elements in the document tree. > ⚠️ warning: potentially dangerous; use with caution. and yes, multiple-use option again. 🔥
  • --report=<level>, -r <level> — reports system messages at or higher than <level>. your choices are "info" or "1", "warning"/"2" (that one's the default), "error"/"3", "severe"/"4", and "none"/"5". pick your volume, bestie. 🎀
  • --verbose, -v — reports all system messages. literally same as "--report=1". it's giving "tell me everything". 🦋
  • --quiet, -q — reports no system messages at all. same as "--report=5". shhh era. 🤫
  • --halt=<level> — halts execution at system messages at or above <level>. levels work the same as --report. default: 4 (severe). it will simply stop. 💀
  • --strict — halts at the slightest problem. same as "--halt=info". no crumbs of tolerance. 😭
  • --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. this is the default. 🎀
  • --warnings=<file> — sends the output of system messages to <file>. gossip goes in the folder. 💌
  • --traceback — enables Python tracebacks when Docutils is halted. we love a paper trail. 🐍
  • --no-traceback — disables Python tracebacks. default. no receipts. 🙈
  • --input-encoding=<name[:handler]>, -i <name[:handler]> — specifies the encoding and optionally the error handler of input text. default: <auto-detect>:strict. she figures it out herself. ✨
  • --input-encoding-error-handler=INPUT_ENCODING_ERROR_HANDLER — 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. iconic, obviously. 💖
  • --output-encoding-error-handler=OUTPUT_ENCODING_ERROR_HANDLER — the error handler for unencodable output characters. your picks: "strict" (default), "ignore", "replace", "xmlcharrefreplace", "backslashreplace". 🌈
  • --error-encoding=<name[:handler]>, -e <name[:handler]> — specifies text encoding and optionally the error handler for error output. default text encoding: system encoding. default error handler: backslashreplace. 💜
  • --error-encoding-error-handler=ERROR_ENCODING_ERROR_HANDLER — 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>. keeping tabs, respectfully. 📝
  • --config=<file> — reads configuration settings from <file>, if it exists. if it doesn't exist, 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 instead. 🙅
  • --file-insertion-enabled — enables directives that insert the contents of an external file. default, so it's on. 🫶
  • --no-raw — disables the "raw" directive; it gets replaced with a "warning" system message. 🔥
  • --raw-enabled — enables the "raw" directive. default. 🌸
  • --line-length-limit=<length> — the maximal number of characters in an input line. default 10 000. that's a long line, bestie. 😭

🌈 Standalone Reader Options:

  • --no-doc-title — disables the promotion of a lone top-level section title to document title (and the subsequent section title to document subtitle promotion, which is enabled by default). ✨
  • --no-doc-info — disables the bibliographic field list transform (which is 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 pseudo-XML Writer Options:

  • --detailed — pretty-prints <#text> nodes. it's giving ✨aesthetic✨. 💖

💖 AUTHOR 💖

Steve Genoud and Luca Barbato. legends, honestly. 🫶

Copyright (C) 2014 Steve Genoud and Luca Barbato

okay that's the whole thing, bestie, you're officially fluent. 💅✨

recommonmark (Debian 0.7.1+ds-5), February 2023 — that's the source, the version and the date, and that's the sign-off, love u, bye 🎀🦋💜

📦 where this page comes from