QUICKBOOK(1)

📦 version 1.92.0, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 QUICKBOOK(1) 💖

hey bestie!! welcome to the User Commands corner of the manual, where we're talking about Quickbook — yeah, the section header literally says QUICKBOOK(1) and I am obsessed with how much this little tool can do. sit down, grab a boba, let's get into it 🧋✨

✨ NAME ✨

Quickbook</purl> — it's a WikiWiki style documentation tool, and it is geared towards C++ documentation. periodt. 💅

🌸 DESCRIPTION 🌸

Okay so picture this: QuickBook is a WikiWiki style documentation tool geared towards C++ documentation, using simple rules and markup for simple formatting tasks. It's giving "I don't want to write raw HTML by hand" and honestly? relatable. 😭

Here's the glow-up: QuickBook extends the WikiWiki concept. Like the WikiWiki, QuickBook documents are just simple text files. But the way that ONE QuickBook document can generate a fully linked set of nice HTML and PostScript/PDF documents — complete with images and syntax-colorized source code?? no cap, that's main character energy. 👑

🎀 Features include 🎀

  • generate BoostBook xml, to generate HTML, PostScript and PDF
  • simple markup to link to Doxygen-generated entities
  • macro system for simple text substitution
  • simple markup for italics, bold, preformatted, blurbs, code samples, tables, URLs, anchors, images, etc.
  • automatic syntax coloring of code samples
  • CSS support

💅 Allowed options 💅

okay bestie, here's the full menu. no skips, no skimming — every single flag is below:

  • --help — produce help message 🫶
  • --version — print version string
  • --no-pretty-print — disable XML pretty printing
  • --indent arg — indent spaces
  • --linewidth arg — line width
  • --input-file arg — input file
  • --output-file arg — output file
  • --debug — debug mode (for developers) 🙈
  • --ms-errors — use Microsoft Visual Studio style error & warn message format
  • -I [ --include-path ] arg — include path
lowkey important: that last one is written -I [ --include-path ] arg in the original, so --include-path shows up in brackets. iykyk. 💀

🦋 SEE ALSO 🦋

The full documentation for Quickbook is maintained in HTML; see /usr/share/doc/libboostX.Y-doc/HTML/doc/html/quickbook.html ✨

and that's the whole vibe!! this page is from Quickbook Version 1.4, dated July 2009, living under QUICKBOOK(1) in User Commands. mwah 💋 go write some docs, bestie, you got this 💖🎀🦋

📦 where this page comes from