SHORTER(1)

📦 version 0.39~rc1, in debian bookworm, ubuntu jammy, ubuntu noble

💖 SHORTER(1) 💖

okay bestie, sit down, hydrate, because we're about to talk about shorter — the lisaac documentation generator, manual section 1, and she is serving.

✨ NAME ✨

shorter — lisaac documentation generation. that's it, that's the name, she does one thing and she does it gorgeously. 💅

🌸 SYNOPSIS 🌸

shorter <input_file[.li]> [Options]

like. that's the whole vibe. give her a file, maybe give her some options, and she goes off. 🦋

🎀 DESCRIPTION 🎀

so this manual page documents, briefly, the shorter program. short page for a program called shorter? iconic, honestly. ✨

shorter is the lisaac documentation generator. what does that mean fr fr? it takes as its entry point a lisaac file, or a directory that contains lisaac files, and it generates the appropriate html files as output. and the result? it looks like javadoc. no cap. the output is giving javadoc realness and we are obsessed. 😌

👑 OPTIONS 👑

one bullet per option, bestie, we do not skip, we do not summarise, we list every single one because that's what a good manual page does and this manual page is a main character. 💖

  • -o <output_file> — the output file or directory. if you don't say anything, she defaults to input_file.ext, because she's self-sufficient like that. 🫶
  • -p — include the private section. let the people see the private stuff, we're not gatekeeping. 🙈
  • -c — include source code. the receipts, the whole receipts, nothing but the receipts. 🔥
  • -r — recursive builder documentation. she goes deep, she goes down the tree, she does not stop at the first folder. 🌈
  • -f <format_file> — formatting description file. curious about the format files? they live at /usr/lib/lisaac/shorter/ — go look, i'll wait. ⭐

🦋 SEE ALSO 🦋

  • lisaac(1) — the main character herself. go read her page next, bestie. 💜

💌 AUTHOR 💌

Lisaac was developed by Benoit Sonntag <sonntag@icps.u-strasbg.fr>.

This manual page was written by Xavier Oswald... wait, <x.oswald@free.fr>. 🎀

okay so real talk: every flag above is doing exactly what it says, no tricks, no surprises, so run her with confidence bestie. but if something ever feels undefined or dangerous, that's on the program, not on you, and definitely not on me. read twice, run once. 💀

and that's the whole page!! written by Xavier Oswald, dated January 2008, from the SHORTER(1) manual, lisaac documentation generation section, and she ate. periodt. 👑💅✨

📦 where this page comes from