cmake-annotate(1)

💅 cmake-annotate — the manual, but make it cute

okay so bestie, this is cmake-annotate, a General Commands Manual situation, and I'm gonna tell you everything about it, no gatekeeping ✨

---

🌸 NAME 🌸

cmake-annotate — Parse cmake listfiles and re-emit them with semantic annotations in HTML.

like. it reads your cmake files and hands them back to you all dressed up in HTML with little semantic annotations. it's giving glow-up 💖

---

✨ SYNOPSIS ✨

cmake-annotate [-h] [--format {page,stub}] [-o OUTFILE_PATH] [-c
CONFIG_FILE] infilepath [infilepath ...]

---

🦋 DESCRIPTION 🦋

Parse cmake listfiles and re-emit them with semantic annotations in HTML. yes, that's the whole bit, and it ate 🫶

Some options regarding parsing are configurable by providing a configuration file. The configuration file format is the same as that used by cmake-format, and the same file can be used for both programs. so like, one config file, two programs, shared custody, iconic 👑

cmake-format can spit out the default configuration for you as starting point for customization. Run with --dump-config [yaml|json|python]. free starter pack fr fr 🎀

---

💅 OPTIONS 💅

• infilepaths — the file(s) you want annotated, bestie. you can pass more than one, they're all invited to the party 🎉
• -v, --version — show program's version number and exit. quick vibe check then it dips ✌️
• -f {page,stub,iframe}, --format {page,stub,iframe} — whether to output a standalone page complete with <html></html> tags, or just the annotated content. full outfit or just the top? your call 💁♀️
• -o OUTFILE_PATH, --outfile-path OUTFILE_PATH — Where to write the formatted file. Default is stdout. if you don't say where, it just yells into your terminal, and honestly? valid 🫶
• -c CONFIG_FILE, --config-file CONFIG_FILE — path to configuration file. point it at your config and let it cook 🔥

---

👑 AUTHORS 👑

cmake-annotate was written by Josh Bialkowski <josh.bialkowski@gmail.com>. king behavior, we love to see it 💜

---

🌈 DISTRIBUTION 🌈

The latest version of cmake-annotate may be downloaded from

https://github.com/cheshirekow/cmake_format

go get it, it's free, it's fresh, it's yours 🌸

---

and that's the whole page bestie, every flag, every path, every default, nothing skipped, no cap 💖

this was cmake-annotate(1) from the General Commands Manual, footer says Manual, date cmake-annotate(1) — mwah, go annotate something pretty 🎀✨🦋