FIND-ALL-SYMBOLS(1)

🦋 NAME 🦋

find-all-symbols — it's the manual page for find-all-symbols 12, bestie 💖 literally what it says on the tin.

---

✨ DESCRIPTION ✨

Okay so here's the whole vibe. This is how you run it:

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

And then the OPTIONS, which we're gonna go through one by one because I love you and I want you to actually understand this 🫶

🌸 Generic Options 🌸

The chill, universal ones, the ones every tool has, the group chat regulars:

• --help — shows you all the available options 💅 (and if you want even more, there's --help-hidden, no cap)
• --help-list — displays a straight-up list of the available options (and yeah, --help-list-hidden exists for even more of them 👀)
• --version — displays the version of this program, iconic, no notes ✨

🎀 find_all_symbols options 🎀

The ones that are actually specific to this tool, the main characters:

• --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 (before, bestie, not after, they are NOT the same 💀)
• --merge-dir=<string> — the directory for merging symbols 🧚
• --output-dir=<string> — the output directory for saving the results 💾
• -p=<string> — Build path 🛠️

🍓 so like, what IS -p tho 🍓

-p <build-path> is used to read a compile command database.

For example, it can be a CMake build directory in which a file named compile_commands.json exists — use the -DCMAKE_EXPORT_COMPILE_COMMANDS=ON CMake option to get this output, that's the lil trick that makes it appear ✨

When no build path is specified, a search for compile_commands.json will be attempted through all parent paths of the first input file.

See: https://clang.llvm.org/docs/HowToSetupToolingForLLVM.html for an example of setting up Clang Tooling on a source tree 🌳

🦋 and the source files 🦋

<source0> ... — specify the paths of source files. 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, 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 will be automatically removed, but the rest of a relative path must be a suffix of a path in the compile command database.

okay this relative-path thing is genuinely the part that eats people alive so read it twice, bestie 😭 the rules are strict and the tool will simply Not Help You if you get it wrong

💜 one more thing 💜

More help text...

---

and that's the whole page, mwah 💅 this was find-all-symbols 12, from February 2022, and it says it's a User Commands situation — so go forth, point it at your sources, and slay 👑💖✨