FIND-ALL-SYMBOLS(1)

πŸ“¦
version 13.0.1 Β· 3 versions
, in ubuntu jammy

πŸ’– find-all-symbols β€” the manual page, but make it slay πŸ’–

okay bestie, gather round, because this is the manpage for find-all-symbols, and yes it's version 13, and yes we're gonna read the whole thing together like it's a group chat at 2am πŸ¦‹


✨ NAME ✨

find-all-symbols β€” it's the manual page for find-all-symbols 13, no cap πŸ’…


🌸 DESCRIPTION 🌸

so the whole vibe is this, literally:

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

and then, the OPTIONS, babes. buckle up πŸŽ€

🌈 Generic Options (the basics, the starter pack, iykyk)

  • --help β€” shows you all the available options. want even more? there's --help-hidden for that πŸ‘€
  • --help-list β€” prints out a whole list of the available options. and yeah, there's a --help-list-hidden too if you're feeling nosy ✨
  • --version β€” tells you the version of this program. iconic behaviour honestly πŸ‘‘

πŸ’œ find_all_symbols options (the real main character energy)

  • --extra-arg=<string> β€” an extra argument you want to append to the compiler command line 🫢
  • --extra-arg-before=<string> β€” an extra argument you want to prepend to the compiler command line (yes, before, it goes first, it's giving line-leader) πŸ’…
  • --merge-dir=<string> β€” the directory for merging symbols 🧚
  • --output-dir=<string> β€” the output directory where the results get saved πŸ“
  • -p=<string> β€” build path. that's it, that's the label, but bestie there's lore below ⬇️
    • -p <build-path> is used to read a compile command database.
    • for example, it can be a CMake build directory that has a file named compile_commands.json inside it. (use the -DCMAKE_EXPORT_COMPILE_COMMANDS=ON CMake option to get that output, mwah πŸ’–)
    • 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 🌈
  • <source0> ... β€” here's where you specify the paths of your source files, okay? and listen, these paths are looked up in the compile command database. the rules, bestie, are specific:
    • 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. so like, don't get cute with it πŸ™ˆ
  • More help text... β€” literally just that. more help text. that's all it says. πŸ’€

okay real talk bestie: that's genuinely every single thing on the page. nothing skipped, nothing summarised, we read the whole menu and we ate πŸ”₯

sign-off time 🫢 this was find-all-symbols 13, dated July 2023, and the source/version footer said FIND-ALL-SYMBOLS(1) on both sides, which is honestly such a symmetrical moment ✨ bye babes, go find those symbols πŸ’–πŸ‘‘

πŸ“¦ where this page comes from