FIND-ALL-SYMBOLS(1)

💖 NAME 💖

find-all-symbols — the manual page for find-all-symbols 16, bestie ✨

---

🎀 DESCRIPTION 🎀

okay so basically, here's the vibe check 👑

🦋 USAGE 🦋

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

🌸 OPTIONS 🌸

✨ Generic Options ✨

• --help — shows you the available options, periodt. (and if you add --help-hidden you get EVEN MORE 👀)
• --help-list — prints a whole list of the available options. (again, --help-list-hidden exists if you're nosy like me 🙈)
• --version — tells you which version of this program you're running, no cap 💅

🎀 find_all_symbols options 🎀

• --extra-arg=<string> — an extra argument that gets appended to the compiler command line ✨
• --extra-arg-before=<string> — an extra argument that gets prepended to the compiler command line 💜
• --merge-dir=<string> — the directory for merging symbols 🧚
• --output-dir=<string> — the output directory where the results get saved 🍓
• -p <string> — build path 🫶

💫 the -p build path thing 💫

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

like, for example, it can be a CMake build directory where a file called compile_commands.json lives (use the -DCMAKE_EXPORT_COMPILE_COMMANDS=ON CMake option to get that output). and when there's no build path specified, a search for compile_commands.json will be attempted through all the 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 ✨

🌈 the source files 🌈

<source0> ... — specify the paths of source files. these paths are looked up in the compile command database 💖

and like, here's the tea:

• 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 💅

⭐ More help text... ⭐

More help text...

---

not me writing a whole manpage and still saying "More help text..." — iconic, honestly 💀

mwah, this was find-all-symbols 16, dated October 2023 — bye bestie, go slay some symbols 💅✨🦋