mpexpand(n)

💅 mpexpand(n) — the glow-up page

okay bestie, gather round, because we're talking about mpexpand — the Markup processor — and honestly? it's giving backstage-pass-to-the-whole-doc-toolchain energy. ✨

---

🌸 NAME 🌸

mpexpand — Markup processor 🎀

---

✨ SYNOPSIS ✨

mpexpand ?-module module? format infile|- outfile|-

mpexpand.all ?-verbose? ?module?

the ?question marks? mean "optional, bestie, no pressure" — that's just how Tcl docs roll 💅

---

🦋 DESCRIPTION 🦋

So this manpage is literally about a processor/converter for manpages that are written in the doctools format, as specified in doctools_fmt. And the processor itself? Built on top of the package doctools. iconic behavior, no cap.

🌈 mpexpand ?-module module? format infile|- outfile|-

This one takes three arguments, and here's the breakdown:

• the code that says which formatting to generate as the output 🎀
• the file to read the markup from
• the file to write the generated output into

If infile is "-", the processor reads from stdin. If outfile is "-", the processor writes to stdout. classic dash behavior, we love to see it 🫶

If the option -module is present, its value overrides the internal definition of the module name. periodt.

The currently known output formats are:

• nroff — the processor generates *roff output, the standard format for unix manpages. yes, the classic. the OG. 👑
• html — the processor generates HTML output, for usage in and display by web browsers. 🌐
• tmml — the processor generates TMML output, the Tcl Manpage Markup Language, a derivative of XML. lowkey fancy 💅
• latex — the processor generates LaTeX output. for the academic girlies 📚
• wiki — the processor generates Wiki markup as understood by wikit. 🧚
• list — the processor extracts the information provided by manpage_begin. just the facts, ma'am ✨
• null — the processor does not generate any output. literally does nothing. and honestly? sometimes that's the vibe 💀

🎀 mpexpand.all ?-verbose? ?module?

This command uses mpexpand to generate all possible output formats for all manpages in the current directory. yes, all of them. she's an overachiever, we respect it 🌟

The manpages are recognized through the extension ".man".

If -verbose is specified, the command will list its actions before executing them. she announces her plans first, main character energy fr fr 🔥

The module information is passed to mpexpand.

---

⭐ NOTES ⭐

Possible future formats are plain text, pdf and postscript. (manifesting this for her 🙏✨)

---

😭 BUGS, IDEAS, FEEDBACK 😭

ngl, this document, and the package it describes, will undoubtedly contain bugs and other problems. it's not a read, it's a confession. 🙈

Please report such in the category doctools of the Tcllib Trackers at [http://core.tcl.tk/tcllib/reportlist]. Please also report any ideas for enhancements you may have for either package and/or documentation. she wants the feedback, bestie, it's a whole love language 💖

When proposing code changes, please provide unified diffs, i.e the output of diff -u.

Note further that attachments are strongly preferred over inlined patches. Attachments can be made by going to the Edit form of the ticket immediately after its creation, and then using the left-most button in the secondary navigation bar. (iykyk — the left-most button. don't make me say it twice 💅)

---

💜 SEE ALSO 💜

• expander(n)
• format(n)
• formatter(n)

---

🍓 KEYWORDS 🍓

HTML, TMML, conversion, manpage, markup, nroff

---

🌸 CATEGORY 🌸

Documentation tools

---

💖 COPYRIGHT 💖

Copyright (c) 2002 Andreas Kupries <andreas_kupries@users.sourceforge.net>
Copyright (c) 2003 Andreas Kupries <andreas_kupries@users.sourceforge.net>

---

okay that's the whole page, bestie, you ate that 🫶✨ this was tcllib version 1.0, the mpexpand(n) page, and yes we're all a little bit obsessed with her. go forth and convert some markup. 💅🎀🦋