FIND-ALL-SYMBOLS(1)

💖 FIND-ALL-SYMBOLS 💖

okay bestie, welcome to find-all-symbols, a User Commands manual-page situation, version 17 — and yes she's that girl. 💅

---

✨ NAME ✨

find-all-symbols — literally the manual page for find-all-symbols 17. that's it, that's the name. 🎀

---

🌸 DESCRIPTION 🌸

so here's the whole vibe, starting with how you actually run it:

USAGE: find-all-symbols [options] <source0> [... <sourceN>]

then we get into OPTIONS, and bestie there are categories, we love a categorized queen 👑

🫶 Generic Options

these are the universal besties, they work everywhere:

• --help — shows you all the available options. and if you're feeling extra there's --help-hidden for even more 👀
• --help-list — gives you a straight-up list of the available options. and again, --help-list-hidden exists if you want the hidden ones too 🙈
• --version — tells you what version of this program you're running. no cap. ⭐

🧚 find_all_symbols options

okay now the main-character options, specifically for find_all_symbols:

• --extra-arg=<string> — an extra argument to append to the compiler command line 🍓
• --extra-arg-before=<string> — an extra argument to prepend to the compiler command line (yes, before, that's the whole point, that's the difference, don't mix them up bestie 😭)
• --merge-dir=<string> — the directory for merging symbols ✨
• --output-dir=<string> — the output directory where the results get saved 💾
• -p <string> — Build path 🔥

🌈 about that build path

so -p <build-path> is what you use to read a compile command database. iconic behavior honestly.

for example, it can be a CMake build directory that has a file named compile_commands.json inside it — and to get that output you use the -DCMAKE_EXPORT_COMPILE_COMMANDS=ON CMake option. periodt. 💅

and when you don't specify a build path at all? she goes looking for compile_commands.json herself, attempting a search through all the parent paths of the first input file 🕵️‍♀️

if you want a whole example of setting up Clang Tooling on a source tree, the docs point you here: https://clang.llvm.org/docs/HowToSetupToolingForLLVM.html

🦋 about the source files

<source0> ... — this is where you specify the paths of your source files.

here's the tea on how those paths get handled, because the rules are specific:

• these paths are looked up in the compile command database 🔍
• if the path of a file is absolute, it needs to point into CMake's source tree
• if the path is relative, then the current working directory needs to be in the CMake source tree, and the file must be in a subdirectory of the current working directory
• "./" prefixes in the relative files get automatically removed — the universe handles that for you, no stress 🌸
• but the rest of a relative path must be a suffix of a path in the compile command database. non-negotiable, that's the rule 🎀

---

More help text... 👑

---

and that's the whole page bestie, you ate that 💖✨

signing off with the official receipts: this was find-all-symbols 17, dated June 2025, and that's the source + version + date all wrapped up in a little bow 🎀🫶 no cap, go read your compile command database, mwah 💅