GST-DOC(1)

📦
version 3.2.5 · 2 versions
, in ubuntu jammy

💖 GST-DOC(1) — the girlies' guide to the GNU Smalltalk documentation generator 💖

okay so bestie, welcome to gst-doc, aka the GNU Smalltalk documentation generator ✨ it lives in section 1 of the manual (User Commands, if you're keeping track 🎀) and it is literally the tool that turns your classes into actual documentation. no cap.

🌸 NAME 🌸

gst-doc — GNU Smalltalk documentation generator 🦋

✨ DESCRIPTION ✨

🫶 Usage

like, here's the vibe, the whole entire mood of how you call her:

gst-doc [ flag ... ] class ...

so you throw some flags at her, and then you name the classes you want documented. that's it. that's the whole thing. 💅

👑 OPTIONS 👑

every single flag, in order, no skips, no skimming, we are thorough in this house 🎀

  • -I, --image-file=FILE — she goes looking for classes inside the given image. give her a FILE and she'll dig through it. 🔍
  • -p, --package=PKG — instead of an image, she looks for classes in the given package. yes, PKG, that's your package name, periodt.
  • -f, --file=FILE — orrr she looks for classes in the given file. pick your source, bestie, you have options 💖
  • -n, --namespace=NAMESP — load files in the given namespace. NAMESP is the namespace, and she'll load everything in it, slay.
  • -o, --output=FILE — emits the documentation into the given file. and here's the tea: the default is stdout ☕ so if you don't say anything, it just comes pouring out at you.
  • --kernel-dir=PATH — use the specified kernel directory. yes, PATH, she needs directions, we've all been there 🙈
  • -F, --output-format=KIND — picks which publisher to use. you can ask for HTML, or the default is Texinfo. that's the default, so if you say nothing, Texinfo it is ✨
  • -h, --help — shows this message. the classic. the icon. the "help me help you" moment 🫶
  • -v, --verbose — prints extra information while processing. basically she narrates her life while she works, and honestly? relatable 💀
  • --version — prints the version information and then exits, she's done, she's leaving, goodbye 👋

🌈 SEE ALSO 🌈

so the full documentation for gst-doc is maintained as a Texinfo manual — yes, the whole deep lore lives there, not in this little page 📖

and if info and gst-doc are properly installed on your site, this command right here:

info gst

should give you access to the complete manual. go read it, bestie, it's giving ✨ educated ✨ 💜

🎀 a lil sign-off, because you deserve it: this page is for gst-doc version 3.2.5, and it's dated September 2021. iconic. timeless. the moment. 💅✨🦋

okay bye love u, go generate some docs 🫶🌸💖

📦 where this page comes from