LLVM-CONFIG(1)

💖 LLVM-CONFIG 💖

okay bestie, sit down, hydrate, because this is the llvm-config page from the LLVM manual (yes, section 1, the good section) and it's literally your new best friend for building stuff against LLVM. 🫶

---

✨ NAME ✨

llvm-config — it prints LLVM compilation options for you. that's the whole job. it's giving personal assistant but for compiler flags. 💅

---

🌸 SYNOPSIS 🌸

llvm-config option [components...]

---

🦋 DESCRIPTION 🦋

so here's the vibe: llvm-config makes building applications that use LLVM so much easier, no cap. it can print out the compiler flags, the linker flags, and the object libraries you need to link against LLVM. that's it. that's the whole girl. 👑

---

🌈 EXAMPLES 🌈

say you wanna link against the JIT (iconic choice btw), you'd do:

g++ `llvm-config --cxxflags` -o HowToUseJIT.o -c HowToUseJIT.cpp
g++ `llvm-config --ldflags` -o HowToUseJIT HowToUseJIT.o \
    `llvm-config --libs engine bcreader scalaropts`

look at that backtick action. we love a command substitution moment. ✨

---

🎀 OPTIONS 🎀

one bullet per flag, as the universe intended:

• --version — prints the version number of LLVM. the "who even am i" flag. 🪞
• -help — prints a summary of llvm-config arguments. your lil cheat sheet. 💖
• --prefix — prints the installation prefix for LLVM.
• --src-root — prints the source root from which LLVM was built.
• --obj-root — prints the object root used to build LLVM.
• --bindir — prints the installation directory for LLVM binaries.
• --includedir — prints the installation directory for LLVM headers.
• --libdir — prints the installation directory for LLVM libraries.
• --cxxflags — prints the C++ compiler flags needed to use LLVM headers. these are the "please find my includes" flags. 🧚
• --ldflags — prints the flags needed to link against LLVM libraries.
• --libs — prints all the libraries needed to link against the specified LLVM components, including any dependencies. she's thorough. she does the homework. 📚
• --libnames — similar to --libs, but prints the bare filenames of the libraries, without -l or pathnames. super useful for linking against a not-yet-installed copy of LLVM. 🍓
• --libfiles — similar to --libs, but prints the full path to each library file. this is the one you want when making makefile dependencies, so a tool gets relinked if any library it uses changes. highkey essential. 🔥
• --components — prints all valid component names.
• --targets-built — prints the component names for all targets supported by this copy of LLVM.
• --build-mode — prints the build mode used when LLVM was built (e.g. Debug or Release). 👀

---

🧚 COMPONENTS 🧚

to print a list of all available components, just run llvm-config --components. easy.

in most cases, components correspond directly to LLVM libraries. but there are some useful "virtual" components too, and they're lowkey the main characters:

• all — includes all LLVM libraries. this is the default if you don't specify any components. (she does everything, no notes. 💅)
• backend — includes either a native backend or the C backend.
• engine — includes either a native JIT or the bitcode interpreter.

---

⭐ EXIT STATUS ⭐

if llvm-config succeeds, it exits with 0. 🎉

otherwise, if an error occurs, it exits with a non-zero value. 😭

heads up bestie: a non-zero exit means something went wrong — check it in your scripts, fr fr.

---

💜 AUTHOR 💜

maintained by the LLVM Team (https://llvm.org/). they're the parents of this whole situation. 🫶

---

👑 COPYRIGHT 👑

2003-2024, LLVM Project

---

and that's the page!! ok bye, this was LLVM llvm-config, manual page version 12, dated 2024-07-18 — slay, periodt, go compile something gorgeous. 💖✨🎀🦋🌸💅