mmroff(1)

📦
version 1.24.2 · 16 versions
, in alpine 3.24

💖 Name 💖

okay bestie, welcome to mmroff(1) from the General Commands Manual — manual name folded in right here, no boring header line needed 💅. mmroff is a reference- and PostScript inclusion-handling front end for the GNU roff mm macro package. it's giving small but mighty wrapper energy, fr fr.

✨ Synopsis ✨

mmroff [-x] groff-argument ...

mmroff --help

mmroff --version

🦋 Description 🦋

mmroff is a simple wrapper for groff, used to expand internal references in mm documents; see groff_mm(7).

the way it works is a whole little two-step, no cap: it runs groff with the -mm option twice, first with -z and -rRef=1 to populate reference and index files with their corresponding entries, and then without to produce the document.

it also handles the inclusion of PostScript images with the PIC macro. iconic.

lowkey important: documents that do not use these features of groff mm (the INITI, IND, INDP, INITR, SETR, GETHN, GETPN, GETR, GETST, and PIC macros) do not require mmroff. 🫶

🎀 Options 🎀

  • --help — displays a usage message; exits afterward. 💅
  • --version — shows version information; exits afterward. ✨
  • -x — Create or update the reference list file and exit. 🫶

🌱 Environment 🌱

Normally, the path separator in environment variables ending with PATH is the colon; this may vary depending on the operating system. For example, Windows uses a semicolon instead. iykyk.

  • GROFF_BIN_PATH — Locate groff commands in these directories, followed by those in PATH. If not set, the installation directory of GNU roff executables, /usr/bin, is searched before PATH. 👑

🚪 Exit status 🚪

vibe check on the exit codes:

  • 0 — if the --help or --version options were specified, or if -x was specified and the program successfully created or updated the reference list file. slay ✨
  • 1 — if it was unable to create necessary files. 😭
  • otherwise — it exits with the status of groff. periodt 💅

👑 Authors 👑

mmroff was written by Jörgen Hägg of Lund, Sweden. absolute icon behavior 👑.

🌈 See also 🌈

mwah 💋 this page is from groff 1.24.2, dated 2026-10-01. stay slay, bestie 🫶

📦 where this page comes from