CLANG-INCLUDE-FIXER(1)

πŸ“¦
version 17.0.6 Β· 4 versions
, in debian trixie, ubuntu questing

πŸ’– NAME πŸ’–

clang-include-fixer β€” it's the manual page for clang-include-fixer 17, bestie. Yes, the whole thing. Grab a strawberry πŸ“ and let's go.


✨ DESCRIPTION ✨

okay so here's the vibe. The usage is literally:

USAGE: clang-include-fixer [options] <source0> [... <sourceN>]

and then, and this is the part where you sit up straight:

OPTIONS:

Let's break it down, babes. πŸ’…

🌸 Generic Options 🌸

  • --help β€” shows you the options you can actually use. (Want the hidden ones too? That's --help-hidden. πŸ™ˆ)
  • --help-list β€” prints a whole list of the available options. (--help-list-hidden if you're feeling nosy about the hidden ones too.)
  • --version β€” tells you what version of this program you're running. Iconic.

πŸ‘‘ Tool options πŸ‘‘

  • --db=<value> β€” specifies the input format. And the formats are:
    • =fixed β€” a hard-coded mapping.
    • =yaml β€” a Yaml database created by find-all-symbols.
    • =fuzzyYaml β€” a Yaml database, but with fuzzy-matched names. ✨
  • --extra-arg=<string> β€” an additional argument to append to the compiler command line.
  • --extra-arg-before=<string> β€” an additional argument to prepend to the compiler command line.
  • --input=<string> β€” a string to initialize the database with.
  • --insert-header=<string> β€” inserts a specific header. Heads up: this should run with STDIN mode, and the result gets written to stdout. It's currently used for editor integration, and it supports YAML/JSON format, like:
-insert-header="{
  FilePath: "/path/to/foo.cc", QuerySymbolInfos: [
    {RawIdentifier: foo,
     Range: {Offset: 0, Length: 3}}
  ], HeaderInfos: [ {Headers: "\"foo_a.h\"",
    QualifiedName: "a::foo"} ]}"
  • --minimize-paths β€” whether to minimize added include paths.
  • --output-headers β€” prints the symbol being queried and all its relevant headers in JSON format to stdout, like:
{
  "FilePath": "/path/to/foo.cc", "QuerySymbolInfos": [
    {"RawIdentifier": "foo",
     "Range": {"Offset": 0, "Length": 3}}
  ], "HeaderInfos": [ {"Header": "\"foo_a.h\"",
    "QualifiedName": "a::foo"} ]
}
  • -p <string> β€” build path.
  • -q β€” reduces terminal output. (Shy queen behavior. πŸŽ€)
  • --query-symbol=<string> β€” queries a given symbol (e.g. "a::b::foo") in the database directly, without parsing the file. no cap.
  • --stdin β€” overrides the source file's content (in the overlaying virtual file system) with input from <stdin>, then runs the tool on the new content using the compilation options of the source file. This mode is currently used for editor integration. πŸ¦‹
  • --style=<string> β€” the fallback style for reformatting after inserting new headers, used when there's no clang-format config file found. πŸ’œ
lowkey important: <source0> [... <sourceN>] means you can pass more than one source file. Bring the whole friend group. 🫢

🌈 SEE ALSO 🌈

ngl bestie, the original page didn't send you anywhere else. It's giving self-sufficient main character energy. πŸ’…


that's the whole manual, fr fr. this was clang-include-fixer 17, page dated June 2025, straight out of User Commands. go forth and fix those includes, queen. πŸ‘‘βœ¨πŸŽ€

πŸ“¦ where this page comes from