.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.13.
.TH RTAGS-RC "7" "December 2020" "rc 2.41.133" "User Commands"
.SH NAME
rtags-rc \- manual page for RTags client
.SH SYNOPSIS
rtags-rc [OPTION]...
.SH DESCRIPTION
rtags-rc is the RTags client application.
.PP
.SH OPTIONS
.TP
\fB\-\-verbose\fR|\-v
Be more verbose.
.TP
\fB\-\-version\fR
Print current version.
.TP
\fB\-\-verify\-version\fR|\-t [arg]
Verify that the correct protocol version is used.
.TP
\fB\-\-silent\fR|\-Q
Be silent.
.TP
\fB\-\-help\fR|\-h
Display this help.
.TP
\fB\-\-config\fR [arg]
Use this file (instead of ~/.rcrc).
.TP
\fB\-\-no\-rc\fR
Don't load any rc files.
.SS "Rdm:"
.TP
\fB\-\-quit\-rdm\fR|\-q
Tell server to shut down with optional exit code as argument.
.TP
\fB\-\-connect\-timeout\fR [arg]
Timeout for connecting to rtags-rdm in ms (default 1000).
.SS "Project management:"
.TP
\fB\-\-clear\fR|\-C
Clear projects.
.TP
\fB\-\-project\fR|\-w [optional]
With arg, select project matching that if unique, otherwise list all projects.
.TP
\fB\-\-delete\-project\fR|\-W [arg]
Delete all projects matching regex.
.TP
\fB\-\-job\-count\fR|\-j [optional]
Set or query current job count. (Prefix with l to set low\-priority\-job\-count).
.SS "Indexing commands:"
.TP
\fB\-\-compile\fR|\-c [optional]
Pass compilation arguments to rtags-rdm.
.TP
\fB\-\-guess\-flags\fR
Guess compile flags (used with \fB\-c\fR).
.TP
\fB\-\-load\-compile\-commands\fR|\-J [optional]
Load compile_commands.json from directory
.TP
\fB\-\-suspend\fR|\-X [optional]
Dump suspended files (don't track changes in these files) with no arg. Otherwise toggle suspension for arg.
.SS "Query commands:"
.TP
\fB\-\-follow\-location\fR|\-f [arg]
Follow this location.
.TP
\fB\-\-references\-name\fR|\-R [arg]
Find references matching arg.
.TP
\fB\-\-references\fR|\-r [arg]
Find references matching this location.
.TP
\fB\-\-list\-symbols\fR|\-S [optional]
List symbol names matching arg.
.TP
\fB\-\-find\-symbols\fR|\-F [optional]
Find symbols matching arg.
.TP
\fB\-\-symbol\-info\fR|\-U [arg]
Get cursor info for this location.
.TP
\fB\-\-status\fR|\-s [optional]
Dump status of rtags-rdm. Arg can be symbols or symbolNames.
.TP
\fB\-\-diagnose\fR [arg]
Resend diagnostics for file.
.TP
\fB\-\-diagnose\-all\fR
Resend diagnostics for all files.
.TP
\fB\-\-last\-indexed\fR
Get timestamp of the last time indexing completed for the current project.
.TP
\fB\-\-is\-indexed\fR|\-T [arg]
Check if rtags knows about, and is ready to return information about, this source file.
.TP
\fB\-\-is\-indexing\fR [optional]
Check if rtags is currently indexing files in any project or in project matching pattern.
.TP
\fB\-\-has\-filemanager\fR [optional]
Check if rtags has info about files in this directory.
.TP
\fB\-\-preprocess\fR|\-E [arg]
Preprocess file.
.TP
\fB\-\-asm\fR [arg]
Assemble file.
.TP
\fB\-\-reindex\fR|\-V [optional]
Reindex all files or all files matching pattern.
.TP
\fB\-\-check\-reindex\fR|\-x [optional]
Check if reindexing is necessary for all files matching pattern.
.TP
\fB\-\-path\fR|\-P [optional]
Print files matching pattern.
.TP
\fB\-\-current\-project\fR
Print path for current project.
.TP
\fB\-\-dump\-file\fR|\-d [arg]
Dump source file.
.TP
\fB\-\-check\-includes\fR [arg]
Check includes for source file.
.TP
\fB\-\-dump\-file\-maps\fR [arg]
Dump file maps for file.
.TP
\fB\-\-generate\-test\fR [arg]
Generate a test for a given source file.
.TP
\fB\-\-rdm\-log\fR|\-g
Receive logs from rtags-rdm.
.TP
\fB\-\-fixits\fR [arg]
Get fixits for file.
.TP
\fB\-\-remove\fR|\-D [arg]
Remove file from project.
.TP
\fB\-\-find\-project\-root\fR [arg]
Use to check behavior of find\-project\-root.
.TP
\fB\-\-find\-project\-build\-root\fR [arg]
Use to check behavior of find\-project\-root for builds.
.TP
\fB\-\-include\-file\fR [arg]
Use to generate include statement for symbol.
.TP
\fB\-\-sources\fR [optional]
Dump sources for source file.
.TP
\fB\-\-dependencies\fR [arg]
Dump dependencies for source file [(includes, included\-by, depends\-on, depended\-on, tree\-depends\-on, raw)].
.TP
\fB\-\-all\-dependencies\fR
Dump dependencies for all source files [(includes, included\-by, depends\-on, depended\-on, tree\-depends\-on, raw)].
.TP
\fB\-\-reload\-file\-manager\fR|\-B
Reload file manager.
.TP
\fB\-\-code\-complete\-at\fR|\-l [arg]
Code complete at location: arg is file:line:col.
.TP
\fB\-\-send\-diagnostics\fR [arg]
Only for debugging. Send data to all \fB\-G\fR connections.
.TP
\fB\-\-dump\-completions\fR
Dump cached completions.
.TP
\fB\-\-dump\-compile\-commands\fR
Dump compilation database for project.
.TP
\fB\-\-set\-buffers\fR [optional]
Set active buffers (list of filenames for active buffers in editor).
.TP
\fB\-\-list\-buffers\fR
List active buffers.
.TP
\fB\-\-add\-buffers\fR [arg]
Add additional buffers.
.TP
\fB\-\-remove\-buffers\fR [arg]
Remove buffers.
.TP
\fB\-\-list\-cursor\-kinds\fR
List spelling for known cursor kinds.
.TP
\fB\-\-class\-hierarchy\fR [arg]
Dump class hierarcy for struct/class at location.
.TP
\fB\-\-debug\-locations\fR [optional]
Manipulate debug locations.
.TP
\fB\-\-validate\fR
Validate database files for current project.
.TP
\fB\-\-tokens\fR [arg]
Dump tokens for file. \fB\-\-tokens\fR file.cpp:123\-321 for range.
.TP
\fB\-\-find\-dead\-functions\fR [optional]
Find functions declared/defined in the current file that are never used in the project.
.SS "Command flags:"
.TP
\fB\-\-strip\-paren\fR|\-p
Strip parens in various contexts.
.TP
\fB\-\-max\fR|\-M [arg]
Max lines of output for queries.
.TP
\fB\-\-reverse\-sort\fR|\-O
Sort output reversed.
.TP
\fB\-\-rename\fR
Used for \fB\-\-references\fR to indicate that we're using the results to rename symbols.
.TP
\fB\-\-unsaved\-file\fR [arg]
Pass unsaved file on command line. E.g. \fB\-\-unsaved\-file\fR=\fI\,main\/\fR.cpp:1200 then write 1200 bytes on stdin.
.TP
\fB\-\-log\-file\fR|\-L [arg]
Log to this file.
.TP
\fB\-\-no\-context\fR|\-N
Don't print context for locations.
.TP
\fB\-\-path\-filter\fR|\-i [arg]
Filter out results not matching with arg.
.TP
\fB\-\-dependency\-filter\fR [arg]
Filter out results unless argument depends on them.
.TP
\fB\-\-range\-filter\fR [arg]
Filter out results not in the specified range.
.TP
\fB\-\-filter\-system\-headers\fR|\-H
Don't exempt system headers from path filters.
.TP
\fB\-\-all\-references\fR|\-e
Include definitions/declarations/constructors/destructors for references. Used for rename symbol.
.TP
\fB\-\-target\-usrs\fR
Print all matching usr targets for \fB\-f\fR. Used for debugging.
.TP
\fB\-\-all\-targets\fR
Print multiple targets for \fB\-f\fR. Sorted by best match.
.TP
\fB\-\-elisp\fR|\-Y
Output elisp: (list "one" "two" ...).
.TP
\fB\-\-json\fR
Output json.
.TP
\fB\-\-json\-diagnostics\-include\-skipped\fR
Output json diagnostics with skipped ranges.
.TP
\fB\-\-diagnostics\fR|\-m
Receive async formatted diagnostics from rtags-rdm.
.TP
\fB\-\-match\-regexp\fR|\-Z
Treat various text patterns as regexps (\fB\-P\fR, \fB\-i\fR, \fB\-V\fR, \fB\-F\fR).
.TP
\fB\-\-match\-icase\fR|\-I
Match case insensitively
.TP
\fB\-\-absolute\-path\fR|\-K
Print files with absolute path.
.TP
\fB\-\-socket\-file\fR|\-n [arg]
Use this socket file (default is XDG_RUNTIME_DIR/rdm.socket else ~/.rdm)
.TP
\fB\-\-socket\-address\fR [arg]
Use this host:port combination (instead of \fB\-\-socket\-file\fR).
.TP
\fB\-\-timeout\fR|\-y [arg]
Max time in ms to wait for job to finish (default no timeout).
.TP
\fB\-\-find\-virtuals\fR|\-k
Use in combinations with \fB\-R\fR or \fB\-r\fR to show other implementations of this function.
.TP
\fB\-\-find\-file\-prefer\-exact\fR|\-A
Use to make \fB\-\-find\-file\fR prefer exact matches over partial matches.
.TP
\fB\-\-symbol\-info\-include\-parents\fR
Use to make \fB\-\-symbol\-info\fR include parent symbols.
.TP
\fB\-\-symbol\-info\-include\-targets\fR
Use to make \fB\-\-symbol\-info\fR include target symbols.
.TP
\fB\-\-symbol\-info\-include\-references\fR
Use to make \fB\-\-symbol\-info\fR include reference symbols.
.TP
\fB\-\-symbol\-info\-include\-base\-classes\fR
Use to make \fB\-\-symbol\-info\fR include baseclasses' symbols.
.TP
\fB\-\-symbol\-info\-include\-source\-code\fR
Use to make \fB\-\-symbol\-info\fR include source code.
.TP
\fB\-\-cursor\-kind\fR
Include cursor kind in \fB\-\-find\-symbols\fR output.
.TP
\fB\-\-display\-name\fR
Include display name in \fB\-\-find\-symbols\fR output.
.TP
\fB\-\-current\-file\fR [arg]
Pass along which file is being edited to give rtags-rdm a better chance at picking the right project.
.TP
\fB\-\-declaration\-only\fR|\-G
Filter out definitions (unless inline).
.TP
\fB\-\-definition\-only\fR
Filter out declarations (unless inline).
.TP
\fB\-\-kind\-filter\fR [arg]
Only return results matching this kind.
.TP
\fB\-\-containing\-function\fR|\-o
Include name of containing function in output.
.TP
\fB\-\-containing\-function\-location\fR
Include location of containing function in output.
.TP
\fB\-\-build\-index\fR [arg]
For sources with multiple builds, use the arg'th.
.TP
\fB\-\-compilation\-flags\-only\fR
For \fB\-\-source\fR, only print compilation flags.
.TP
\fB\-\-compilation\-flags\-split\-line\fR
For \fB\-\-source\fR, print one compilation flag per line.
.TP
\fB\-\-compilation\-flags\-pwd\fR
For \fB\-\-source\fR, print pwd for compile command on the first line.
.TP
\fB\-\-dump\-include\-headers\fR
For \fB\-\-dump\-file\fR, also dump dependencies.
.TP
\fB\-\-silent\-query\fR
Don't log this request in rtags-rdm.
.TP
\fB\-\-synchronous\-completions\fR
Wait for completion results and print them to stdout.
.TP
\fB\-\-synchronous\-diagnostics\fR
Wait for diagnostics and print them to stdout.
.TP
\fB\-\-xml\fR
Output XML
.TP
\fB\-\-no\-sort\-references\-by\-input\fR
Don't sort references by input position.
.TP
\fB\-\-project\-root\fR [arg]
Override project root for compile commands.
.TP
\fB\-\-rtags\-config\fR [arg]
Print out .rtags\-config for argument.
.TP
\fB\-\-wildcard\-symbol\-names\fR|\-a
Expand * like wildcards in \fB\-\-list\-symbols\fR and \fB\-\-find\-symbols\fR.
.TP
\fB\-\-no\-color\fR|\-z
Don't colorize context.
.TP
\fB\-\-wait\fR
Wait for reindexing to finish.
.TP
\fB\-\-code\-complete\-include\-macros\fR
Include macros in code completion results.
.TP
\fB\-\-code\-complete\-includes\fR
Give includes in completion results.
.TP
\fB\-\-code\-complete\-no\-wait\fR
Don't wait for synchronous completion if the translation unit has to be created.
.TP
\fB\-\-code\-complete\-prefix\fR [arg]
Filter out code completion results that don't start with this prefix.
.TP
\fB\-\-code\-completion\-enabled\fR|\-b
Inform rtags-rdm that we're code\-completing. Use with \fB\-\-diagnose\fR
.TP
\fB\-\-no\-spell\-checking\fR
Don't produce spell check info in diagnostics.
.TP
\fB\-\-tokens\-include\-symbols\fR
Include symbols for tokens.
.TP
\fB\-\-no\-realpath\fR
Don't resolve paths using realpath(3).
.TP
\fB\-\-include\-path\fR [arg]
Dump include path for symbol.
.TP
\fB\-\-max\-depth\fR [arg]
Max search depth. Used for \fB\-\-include\-path\fR.
.SH "SEE ALSO"
rtags-rdm(7)