ldoc(1)

💖 ldoc — the manual page, but make it a group chat 💖

okay bestie, so this is ldoc(1), a whole manual page, and i'm gonna walk you through it like we're texting at 2am 🦋

---

✨ NAME ✨

ldoc — a LuaDoc-compatible documentation generation system. that's it, that's the vibe. she generates your docs and she plays nice with LuaDoc, no cap 💅

---

🌸 DESCRIPTION 🌸

so like, LDoc is a documentation generator for Lua, and she's compatible to LuaDoc. that's the whole personality. she takes your Lua and turns it into pretty docs. iconic behavior, honestly 👑

---

🎀 OPTIONS 🎀

okay this is the big one, there's a LOT of them, but we're going through every single one because i refuse to skip. periodt ✨

• -d, --dir — the output directory. default is docs 📁
• -o, --output — what you wanna name the output. default is 'index' ✏️
• -v, --verbose — be loud and chatty while generating docs. spill the tea about what's happening 🗣️
• -a, --all — show local functions and stuff like that in the docs. nothing gets left out, we love inclusivity 🫶
• -q, --quiet — suppress output. she's giving silence, she's giving mystery 🤫
• -m, --module — module docs as text 📝
• -s, --style — the directory for the style sheet, which is ldoc.css. default is ! 💄
• -l, --template — the directory for the template, which is ldoc.ltp. default is ! 🎨
• -p, --project — project name. default is ldoc 🏷️
• -t, --title — page title. default is Reference 📖
• -f, --format — the formatting. default is plain, and the valid options are markdown, discount or plain. so many choices, main character energy fr fr 💅
• -b, --package — top-level package basename, default ., and it's needed for module(...) 📦
• -x, --ext — output file extension. default is html 🌐
• -c, --config — configuration name. default is config.ld ⚙️
• -u, --unqualified — don't show the package name in sidebar links. minimalism, we stan 🧚
• -i, --ignore — ignore any 'no doc comment or no module' warnings. not me ignoring my problems 🙈
• -X, --not_luadoc — break LuaDoc compatibility. descriptions may continue after tags. she's a rebel, she's breaking the rules 💀
• -D, --define — set a flag to be used in config.ld. default is none 🚩
• -C, --colon — use colon style 👀
• -N, --no_args_infer — don't infer arguments from source. no guessing allowed 🚫
• -B, --boilerplate — ignore the first comment in source files 🙅
• -M, --merge — allow module merging 🧬
• -S, --simple — no return or params, no summary. stripped back, lowkey ✂️
• -O, --one — one-column output layout 📐
• --date — use this date in the generated doc. default is system 📅
• --dump — debug output dump 🗑️
• --filter — filter output as Lua data, e.g. pl.pretty.dump. default is none 🔍
• --tags — show all references to given tags, comma-separated. default is none 🏷️
• --fatalwarnings — non-zero exit status on any warning. she does NOT play about warnings, bestie ⚠️
• --testing — reproducible build; no date or version on output. consistency queen 🧪
• <file> — (string) source file or directory containing source 📄

---

🔥 EXAMPLES 🔥

look at her go, she's so good at this:

ldoc .

that reads options from a config.ld file in the same directory. self-sufficient icon ✨

ldoc -c path/to/myconfig.ld .

and this one reads options from path/to/myconfig.ld 🎯

---

💜 AUTHOR 💜

this manpage was written for Debian by Julian Wollrath and may be used by others. shoutout Julian, we appreciate you 🫶

---

and that's the whole page bestie, you're officially ldoc-pilled 💖 go generate some docs, you got this 🦋

ldoc · 02 October 2023 · she ate and left no crumbs, mwah 💅✨