RTAGS-RC(7)

📦
version 2.44 · 3 versions
, in ubuntu stonking

✨ rtags-rc(7) ✨

okay bestie, welcome to the User Commands section, section 7 of your manual era 🎀 — this is the whole vibe for rtags-rc, the RTags client. pull up a chair, we're doing this together 💖

🌸 NAME 🌸

rtags-rc — manual page for RTags client 🦋

it's literally the manpage, for the RTags client. that's the whole name section. iconic. periodt.

✨ SYNOPSIS ✨

rtags-rc [OPTION]...

so yeah, you run rtags-rc, you can hand it some OPTIONs, and the ... is giving "as many as your heart desires, bestie" 💅

💜 DESCRIPTION 💜

rtags-rc is the RTags client application 🌈

no cap, that's it — that's the description. it's the client side of RTags, doing client things, being the main character of your RTags setup 👑

fr fr, this is the short-and-sweet part. more parts are pulling up, so stay tuned, don't go anywhere 🫶

✨ OPTIONS ✨

okay bestie, this is the big one — every single flag, no skips, we're doing this 💅

  • --verbose|-v — be more verbose. that's it, that's the whole vibe. it yaps more.
  • --version — print the current version. iconic little receipt 🧾
  • --verify-version|-t [arg] — verify that the correct protocol version is being used. takes an optional arg.
  • --silent|-Q — be silent. shhh 🤫 no output for you.
  • --help|-h — display this help. yes, the thing you're reading rn but in terminal form.
  • --config [arg] — use this file instead of ~/.rcrc.
  • --no-rc — don't load any rc files at all. zero. nada. free yourself 🦋

🖥️ Rdm:

  • --quit-rdm|-q — tell the server to shut down, with an optional exit code as the argument. dramatic exit, love that for it 💀
  • --connect-timeout [arg] — timeout for connecting to rtags-rdm in ms. default is 1000. so one whole second of patience, then we're out.

📁 Project management:

  • --clear|-C — clear projects. bye bye projects 👋
  • --project|-w [optional] — with an arg, select the project matching that if it's unique, otherwise list all the projects. with no arg, well, you get the list vibe too.
  • --delete-project|-W [arg] — delete all projects matching the regex. it's giving spring cleaning 🧹
  • --job-count|-j [optional] — set or query the current job count. and listen: prefix with l to set low-priority-job-count. yeah, a lowercase l, sneaky little thing 🙈

🗂️ Indexing commands:

  • --compile|-c [optional] — pass compilation arguments to rtags-rdm.
  • --guess-flags — guess compile flags. used together with -c.
  • --load-compile-commands|-J [optional] — load compile_commands.json from a directory.
  • --suspend|-X [optional] — with no arg, dump suspended files (aka files whose changes are not being tracked). otherwise, toggle suspension for arg. the accepted args are all, clear, project, clear-project.

🔍 Query commands:

  • --follow-location|-f [arg] — follow this location. main character energy, just following it around fr.
  • --references-name|-R [arg] — find references matching arg.
  • --references|-r [arg] — find references matching this location.
  • --list-symbols|-S [optional] — list symbol names matching arg.
  • --find-symbols|-F [optional] — find symbols matching arg.
  • --symbol-info|-U [arg] — get cursor info for this location.
  • --status|-s [optional] — dump status of rtags-rdm. the arg can be symbols or symbolNames.
  • --diagnose [arg] — resend diagnostics for a file.
  • --diagnose-all — resend diagnostics for ALL the files. every last one 🔥
  • --last-indexed — get the timestamp of the last time indexing completed for the current project.
  • --is-indexed|-T [arg] — check if rtags knows about — and is ready to return information about — this source file.
  • --is-indexing [optional] — check if rtags is currently indexing files in any project, or in the project matching pattern.
  • --has-filemanager [optional] — check if rtags has info about files in this directory.
  • --preprocess|-E [arg] — preprocess a file.
  • --asm [arg] — assemble a file.
  • --reindex|-V [optional] — reindex all files, or all files matching pattern.
  • --check-reindex|-x [optional] — check if reindexing is necessary for all files matching pattern.
  • --path|-P [optional] — print files matching pattern.
  • --current-project — print the path for the current project.
  • --dump-file|-d [arg] — dump a source file.
  • --check-includes [arg] — check includes for a source file.
  • --dump-file-maps [arg] — dump file maps for a file.
  • --generate-test [arg] — generate a test for a given source file.
  • --rdm-log|-g — receive logs from rtags-rdm.
  • --fixits [arg] — get fixits for a file.
  • --find-project-root [arg] — use this to check the behavior of find-project-root.
  • --find-project-build-root [arg] — use this to check the behavior of find-project-root for builds.
  • --include-file [arg] — use this to generate an include statement for a symbol.
  • --sources [optional] — dump sources for a source file.
  • --dependencies [arg] — dump dependencies for a source file. the options are (includes, included-by, depends-on, depended-on, tree-depends-on, raw).
  • --all-dependencies — dump dependencies for all source files. same list: (includes, included-by, depends-on, depended-on, tree-depends-on, raw).
  • --reload-file-manager|-B — reload the file manager. fresh start ✨
  • --code-complete-at|-l [arg] — code complete at a location, where arg is file:line:col.
  • --send-diagnostics [arg] — only for debugging. sends data to all -G connections. lowkey chaotic but okay.
  • --dump-completions — dump cached completions.
  • --dump-compile-commands — dump the compilation database for the project.
  • --set-buffers [optional] — set active buffers (that's a list of filenames for the active buffers in your editor).
  • --list-buffers — list active buffers.
  • --add-buffers [arg] — add additional buffers.
  • --remove-buffers [arg] — remove buffers. (the anti---add-buffers, we love a balanced queen)
  • --list-cursor-kinds — list the spelling for known cursor kinds.
  • --class-hierarchy [arg] — dump the class hierarchy for the struct/class at a location.
  • --debug-locations [optional] — manipulate debug locations.
  • --validate — validate database files for the current project.
  • --tokens [arg] — dump tokens for a file. and psst, --tokens file.cpp:123-321 gets you a range 👑
  • --find-dead-functions [optional] — find functions declared/defined in the current file that are never used anywhere in the project. rip to them, they're done 💀

🏷️ Command flags:

  • --strip-paren|-p — strip parens in various contexts.
  • --max|-M [arg] — max lines of output for queries.
  • --multi-project — search in all projects with the same source dir.
  • --reverse-sort|-O — sort output reversed. backwards bestie 🔄
  • --rename — used for --references to indicate that we're using the results to rename symbols.
  • --unsaved-file [arg] — pass an unsaved file on the command line. e.g. --unsaved-file=main.cpp:1200 and then write 1200 bytes on stdin.
  • --log-file|-L [arg] — log to this file.
  • --no-context|-N — don't print context for locations.
  • --path-filter|-i [arg] — filter out results not matching with arg.
  • --dependency-filter [arg] — filter out results unless argument depends on them.
  • --range-filter [arg] — filter out results not in the specified range.
  • --filter-system-headers|-H — don't exempt system headers from path filters.
  • --all-references|-e — include definitions/declarations/constructors/destructors for references. used for rename symbol.
  • --target-usrs — print all matching usr targets for -f. used for debugging.
  • --all-targets — print multiple targets for -f. sorted by best match. the algorithm is picking favorites, and honestly, fair.
  • --elisp|-Y — output elisp: (list "one" "two" ...).
  • --json — output json. that's the whole description, she's concise 🎀
  • --json-diagnostics-include-skipped — output json diagnostics with skipped ranges.
  • --diagnostics|-m — receive async formatted diagnostics from rtags-rdm.
  • --match-regexp|-Z — treat various text patterns as regexps: -P, -i, -V, -F.
  • --match-icase|-I — match case insensitively.
  • --absolute-path|-K — print files with absolute path.
  • --socket-file|-n [arg] — use this socket file. default is XDG_RUNTIME_DIR/rdm.socket, else ~/.rdm.
  • --socket-address [arg] — use this host:port combination instead of --socket-file.
  • --timeout|-y [arg] — max time in ms to wait for a job to finish. default is no timeout at all, she waits forever, devoted 💖
  • --find-virtuals|-k — use in combination with -R or -r to show other implementations of this function.
  • --find-file-prefer-exact|-A — use to make --find-file prefer exact matches over partial matches.
  • --symbol-info-include-parents — use to make --symbol-info include parent symbols.
  • --symbol-info-include-targets — use to make --symbol-info include target symbols.
  • --symbol-info-include-references — use to make --symbol-info include reference symbols.
  • --symbol-info-include-base-classes — use to make --symbol-info include baseclasses' symbols.
  • --symbol-info-include-source-code — use to make --symbol-info include source code.
  • --cursor-kind — include cursor kind in --find-symbols output.
  • --display-name — include display name in --find-symbols output.
  • --current-file [arg] — pass along which file is being edited, to give rtags-rdm a better chance at picking the right project. help her out a little 🫶
  • --declaration-only|-G — filter out definitions (unless inline).
  • --definition-only — filter out declarations (unless inline).
  • --kind-filter [arg] — only return results matching this kind.
  • --containing-function|-o — include the name of the containing function in output.
  • --containing-function-location — include the location of the containing function in output.
  • --build-index [arg] — for sources with multiple builds, use the arg'th one.
  • --compilation-flags-only — for --source, only print compilation flags.
  • --compilation-flags-split-line — for --source, print one compilation flag per line.
  • --compilation-flags-pwd — for --source, print pwd for the compile command on the first line.
  • --dump-include-headers — for --dump-file, also dump dependencies.
  • --silent-query — don't log this request in rtags-rdm. sneaky link 🤫
  • --synchronous-completions — wait for completion results and print them to stdout.
  • --synchronous-diagnostics — wait for diagnostics and print them to stdout.
  • --xml — output XML.
  • --no-sort-references-by-input — don't sort references by input position.
  • --project-root [arg] — override project root for compile commands.
  • --rtags-config [arg] — print out .rtags-config for argument.
  • --wildcard-symbol-names|-a — expand * like wildcards in --list-symbols and --find-symbols.
  • --no-color|-z — don't colorize context. (colorless, mood: minimalism 🎀)
  • --wait — wait for reindexing to finish.
  • --code-complete-include-macros — include macros in code completion results.
  • --code-complete-includes — give includes in completion results.
  • --code-complete-no-wait — don't wait for synchronous completion if the translation unit has to be created.
  • --code-complete-prefix [arg] — filter out code completion results that don't start with this prefix.
  • --code-completion-enabled|-b — inform rtags-rdm that we're code-completing. use with --diagnose.
  • --no-spell-checking — don't produce spell check info in diagnostics.
  • --tokens-include-symbols — include symbols for tokens.
  • --no-realpath — don't resolve paths using realpath(3).
  • --include-path [arg] — dump include path for symbol.
  • --max-depth [arg] — max search depth. used for --include-path. don't go too deep, bestie 🕳️

🌈 SEE ALSO

rtags-rdm(7)

and that's the whole page, bestie!! you officially know every single flag 🫶 this was rc version 2.44.135, from February 2026, filed under RTAGS-RC(7) — go forth and query things flawlessly, no cap 👑💜

📦 where this page comes from