LUADOC(1)

✨ LUADOC ✨

okay bestie, so this is the manual for luadoc from the General Commands Manual section, and it is genuinely so much shorter than you'd expect — which honestly? iconic of it. let's get into it 💅

🌸 NAME 🌸

luadoc — generate documentation from files 💖

like, that's the whole vibe. it reads your files and it makes docs. slay.

🎀 SYNOPSIS 🎀

luadoc [options] files

so it's luadoc, then optionally some [options], then the files you wanna feed it. that's the whole shape of the thing. no cap. ✨

🦋 DESCRIPTION 🦋

so real talk: this manual page documents briefly the luadoc utility. brief. concise. minimal. it's giving "i said what i said" energy and i respect it.

luadoc is a program that generates documentation from source files. that's it. that's the job. it looks at your files and it produces documentation. main character behavior honestly 🫶

👑 OPTIONS 👑

here's where the lore actually lives, bestie. every single one of these matters:

• -d path — sets the output directory path. ⚠️ important: this should be an empty, writable directory. like, empty-empty. if you point it at a folder that's already full of your stuff, that's on you, not on luadoc. 💀
• -t path — the template directory path. this is where your templates live so the output can look how you want it to look. ✨
• --noindexpage — do not generate the global index page. no index. none. bye 👋
• --nofiles — do not generate documentation for files. so it just... skips that part. 🍓
• --nomodules — do not generate documentation for modules. same energy, different target. 💜
• --doclet doclet_module — specify the doclet module to generate output. so that's the module doing the actual output-making. 🎀
• --taglet taglet_module — specify the taglet module to parse input code. that's the one chewing through your source. 🧚
• -q, --quiet — suppress all normal output. all of it. the silence is intentional, don't panic. 🔥
• -v, --version — print version information. (yes, there's a period at the end of that in the original. we keep it. it's part of the aesthetic.) ⭐

💜 AUTHOR 💜

this manual page was written by Enrico Tassi <gareuselesinge@debian.org>, for the Debian project — but, and i quote, it may be used by others. so generous. so giving. we love that for them. 🫶

and that's the whole page, bestie!! it's dated July 31, 2007, it comes to you from the LUADOC(1) of the General Commands Manual, and honestly? short, sweet, gets the job done. obsessed. go generate some docs. mwah 💖✨🎀