mdoc-validate(1)

✨ mdoc-validate(1) ✨

okay bestie, so this is a page from the General Commands Manual, and it's literally all about mdoc validate 💖

🦋 NAME 🦋

mdoc validate</purpose> — validate XML documents against a schema. that's it, that's the whole vibe. no cap. ✨

🌸 SYNOPSIS 🌸

mdoc validate [OPTIONS]* PATHS+

💜 DESCRIPTION 💜

so like, mdoc validate takes the PATHS you give it and checks them against a schema for whatever format you picked. that's the whole job. it's giving quality control but make it XML 🎀

💅 OPTIONS 💅

• --format=FORMAT — the documentation format you wanna validate your PATHS against. supported formats include: ecma. (yes, just peep the FORMATS section down below for the whole tea on these formats.) and if you don't say anything? the default format is ecma. so that's the one you get. periodt. 👑
• -h, -?, --help — prints a help message and dips out. iconic behaviour honestly 🫶

🌈 FORMATS 🌈

here's the documentation formats we support, bestie:

🍓 ecma

the Mono ECMA Documentation Format validates all the output generated by mdoc-update(1) against an XML schema — that includes the index.xml, the ns-*.xml files, and the NamespaceName/TypeName.xml files. all of them. every single one. 💀

wanna know the deets on this file format? check out mdoc(5) 📖

✨ EXAMPLES ✨

say you wanna validate the mdoc-update(1) output stored inside a directory (and every bit of documentation in that directory, recursively — yes, it goes all the way down 🦋), you'd do:

mdoc validate /path/to/ecma/docs

slay.

💌 MAILING LISTS 💌

want the details? go visit http://lists.ximian.com/mailman/listinfo/mono-docs-list 💖

🌐 WEB SITE 🌐

want more details? visit http://www.mono-project.com/docs/tools+libraries/tools/mdoc/ 🌸

and that's the whole page, bestie! it came from the mdoc-validate(1) corner of the manual — same title, same date energy, we just gave it the main character treatment 👑💅

mwah, go validate something 💜