RC(7)

📦
version 2.38 · 3 versions
, in opensuse-leap 16.0

🎀 NAME 🎀

rc — manual page for rc 2.38.130

okay so before we even get into it: this whole thing lives in the User Commands corner of the manual, and it's literally the glow-up guide to rc, the RTags client app 💅

✨ SYNOPSIS ✨

rc [OPTION]...

🦋 DESCRIPTION 🦋

rc is the RTags client application. that's it, that's the whole vibe — it's the client, rdm is the server, they're a duo, it's giving main character energy 🫶

💖 OPTIONS 💖

🌸 the basics 🌸

  • --verbose, -v — be more verbose. say more words. spill the tea 🍵
  • --version — print the current version.
  • --verify-version, -t [arg] — verify that the correct protocol version is being used.
  • --silent, -Q — be silent. not a peep 🙈
  • --help, -h — display this help.
  • --config [arg] — use this file instead of ~/.rcrc.
  • --no-rc — don't load any rc files at all. zero. none. bye 👋

👑 Rdm 👑

  • --quit-rdm, -q — tell the server to shut down, with an optional exit code as the argument.
  • --connect-timeout [arg] — timeout for connecting to rdm, in ms (default 1000).

🧚 Project management 🧚

  • --clear, -C — clear projects.
  • --project, -w [optional] — with an arg, select the project matching it if it's unique; otherwise list all projects.
  • --delete-project, -W [arg] — delete all projects matching regex.
  • --job-count, -j [optional] — set or query the current job count. (prefix with l to set low-priority-job-count 🫡)

🔥 Indexing commands 🔥

  • --compile, -c [optional] — pass compilation arguments to rdm.
  • --guess-flags — guess compile flags (used with -c).
  • --load-compile-commands, -J [optional] — load compile_commands.json from directory.
  • --suspend, -X [optional] — dump suspended files (don't track changes in these files) with no arg. otherwise, toggle suspension for arg.

🌈 Query commands 🌈

  • --follow-location, -f [arg] — follow this location.
  • --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 rdm. arg can be symbols or symbolNames.
  • --diagnose [arg] — resend diagnostics for file.
  • --diagnose-all — resend diagnostics for all files.
  • --last-indexed — get 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 file.
  • --asm [arg] — assemble 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 path for current project.
  • --dump-file, -d [arg] — dump source file.
  • --check-includes [arg] — check includes for source file.
  • --dump-file-maps [arg] — dump file maps for file.
  • --generate-test [arg] — generate a test for a given source file.
  • --rdm-log, -g — receive logs from rdm.
  • --fixits [arg] — get fixits for file.
  • --remove, -D [arg] — remove file from project.
  • --find-project-root [arg] — use to check behavior of find-project-root.
  • --find-project-build-root [arg] — use to check behavior of find-project-root for builds.
  • --include-file [arg] — use to generate include statement for symbol.
  • --sources [optional] — dump sources for source file.
  • --dependencies [arg] — dump dependencies for source file [(includes, included-by, depends-on, depended-on, tree-depends-on, raw)].
  • --all-dependencies — dump dependencies for all source files [(includes, included-by, depends-on, depended-on, tree-depends-on, raw)].
  • --reload-file-manager, -B — reload file manager.
  • --code-complete-at, -l [arg] — code complete at location: arg is file:line:col.
  • --send-diagnostics [arg] — only for debugging. send data to all -G connections.
  • --dump-completions — dump cached completions.
  • --dump-compile-commands — dump compilation database for project.
  • --set-buffers [optional] — set active buffers (list of filenames for active buffers in editor).
  • --list-buffers — list active buffers.
  • --add-buffers [arg] — add additional buffers.
  • --remove-buffers [arg] — remove buffers.
  • --list-cursor-kinds — list spelling for known cursor kinds.
  • --class-hierarchy [arg] — dump class hierarcy for struct/class at location. (their spelling, not mine, iykyk 💀)
  • --debug-locations [optional] — manipulate debug locations.
  • --validate — validate database files for current project.
  • --tokens [arg] — dump tokens for file. --tokens file.cpp:123-321 for a range.
  • --find-dead-functions [optional] — find functions declared/defined in the current file that are never in the project. rip to those functions 😭

🌟 Command flags 🌟

  • --strip-paren, -p — strip parens in various contexts.
  • --max, -M [arg] — max lines of output for queries.
  • --reverse-sort, -O — sort output reversed.
  • --rename — used for --references to indicate that we're using the results to rename symbols.
  • --unsaved-file [arg] — pass unsaved file on command line. e.g. --unsaved-file=main.cpp:1200 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.
  • --elisp, -Y — output elisp: (list "one" "two" ...).
  • --json — output json.
  • --json-diagnostics-include-skipped — output json diagnostics with skipped ranges.
  • --diagnostics, -m — receive async formatted diagnostics from 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 ~/.rdm).
  • --socket-address [arg] — use this host:port combination (instead of --socket-file).
  • --timeout, -y [arg] — max time in ms to wait for job to finish (default no timeout).
  • --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 rdm a better chance at picking the right project.
  • --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 name of containing function in output.
  • --containing-function-location — include location of containing function in output.
  • --build-index [arg] — for sources with multiple builds, use the arg'th.
  • --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 compile command on the first line.
  • --dump-include-headers — for --dump-file, also dump dependencies.
  • --silent-query — don't log this request in rdm.
  • --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. (sad, but valid 🥲)
  • --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 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.

⭐ SEE ALSO ⭐

  • rdm(7) — the other half of the duo, go say hi 🫶

and that's the page, bestie 💜 this was rc 2.38.130, dated January 2020, filed under RC(7) — slay, go index something 🎀✨

📦 where this page comes from