mpexpand(1)

💅 mpexpand — Markup processor (yes bestie, it's giving documentation toolbox)

okay so welcome to the mpexpand(1) page, the manual page manual page processor, we're going meta today 🌸

---

✨ SYNOPSIS ✨

mpexpand ?-module module? format infile|- outfile|-
mpexpand.all ?-verbose? ?module?

---

🦋 DESCRIPTION 🦋

This page is literally about a processor / converter for manpages that are written in the doctools format, as specified in doctools_fmt. The whole thing is built on top of the package doctools. iconic, no notes 💖

🎀 the mpexpand command

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

So this one takes three arguments, bestie, and you need all of them:

1. the code that says which formatting to generate as the output,
2. the file to read the markup from, and
3. the file to write the generated output into.

If infile is -, the processor reads from stdin instead. If outfile is -, it writes to stdout instead. yes, dashes are doing main character energy here 🫶

If the option -module is present, its value overrides the internal definition of the module name. that's it, that's the override.

🌈 the currently known output formats

• nroff — the processor generates *roff output, the standard format for unix manpages. the classic. the blueprint. 💀
• html — generates HTML output, for usage in and display by web browsers. web girlies rise up 🌐
• tmml — generates TMML output, the Tcl Manpage Markup Language, which is a derivative of XML.
• latex — generates LaTeX output. for the academic besties ✨
• wiki — generates Wiki markup as understood by wikit.
• list — the processor extracts the information provided by manpage_begin. just the info, no vibes.
• null — the processor does not generate any output. it said "no thoughts, head empty" 🧚

🍓 the mpexpand.all command

mpexpand.all ?-verbose? ?module?

This command uses mpexpand to generate all possible output formats for all manpages in the current directory. an overachiever fr fr 👑

The manpages get recognized through the extension .man — that's the vibe check they have to pass.

If -verbose is specified, the command will list its actions before executing them. very "narrating my own life" of it.

The module information is passed to mpexpand. (that's the ?module? up there, iykyk)

---

⭐ NOTES ⭐

Possible future formats are plain text, pdf and postscript. not here yet, but the vision is real 🔮

---

💀 BUGS, IDEAS, FEEDBACK 💀

This document, and the package it describes, will undoubtedly contain bugs and other problems. honestly, same. 😭

Please report such in the category doctools of the Tcllib Trackers [http://core.tcl.tk/tcllib/reportlist]. Please also report any ideas for enhancements you may have for either package and/or documentation. they want the ideas, bestie, send them 🫶

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. yes, the left-most one, don't make me repeat it 💅

---

🌸 SEE ALSO 🌸

• expander(3tcl)
• format(3tcl)
• formatter(3tcl)

---

💜 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>

---

and that's the whole page, bestie!! brought to you by tcllib, version 1.0, in the mpexpand(1) era — stay slay, stay documented, and remember: if infile is -, it's stdin, periodt 💖🎀🦋