mate-doc-common(1)

💖 mate-doc-common — bestie edition 💖

okay so this is the manual page for mate-doc-common, and honestly? she's a tiny little script with one job and she does it flawlessly. no notes. 💅

✨ NAME ✨

mate-doc-common — include the standard user documentation build files 🎀

🌸 SYNOPSIS 🌸

mate-doc-common

that's it. that's the whole thing. no args, no flags required, just vibes. 🦋

🫶 DESCRIPTION 🫶

so basically this script gets called by mate-autogen to pull the standard user documentation build files into a MATE package. it's giving "designated document-delivery bestie" and we love her for it. 💜

if you want those standard user documentation build files — that's omf.make and xmldocs.make, iconic duo — to show up in your package automatically, you gotta set:

USE_COMMON_DOC_BUILD=yes

in autogen.sh before you call the macros/autogen.sh script. yes, order matters, don't @ me. ⚠️

and then, when you're porting applications over to use this feature, please please please make sure every single reference to xmldocs.make points to $(top_srcdir)/xmldocs.make in the appropriate Makefile.am files. because some modules just assume xmldocs.make lives in some other directory (like docs/ or whatever 🙈) and that assumption will lowkey wreck you. not me warning you fr fr. 💀

🎀 OPTIONS 🎀

• --help — displays the help of the script. the classic. the icon. 👑
• --version — shows the script version, in case you need to know which era of this script you're dealing with. ⭐
• --copy — copies the files instead of making symlinks. no symlink shenanigans, just real actual files sitting there. 🌈

💖 SEE ALSO 💖

• mate-autogen(1) — her colleague, her partner in crime, the other half of this whole operation. 🦋

🌟 AUTHOR 🌟

Perberos <perberos@gmail.com> — thank you for your service, king. 🫡💐

ok that's the whole page bestie, you're officially educated. go build some docs. i'm obsessed with you. 🧚✨

source/version: mate-doc-common(1) · dated Fri, 18 May 2012 10:52:03 +0200 — periodt, that's a wrap. 💅💖