1RC(7) User Commands RC(7)
2
6 rc - manual page for rc 2.33.128
7
9 rc [OPTION]...
10
12 rc is the RTags client application.
13
15 --verbose|-v
16 Be more verbose.
17 --version
19 Print current version.
20 --verify-version|-t [arg]
22 Verify that the correct protocol version is used.
23 --silent|-Q
25 Be silent.
26 --help|-h
28 Display this help.
29 --config [arg]
31 Use this file (instead of ~/.rcrc).
32 --no-rc
34 Don't load any rc files.
35 Rdm:
37 --quit-rdm|-q
38 Tell server to shut down with optional exit code as argument.
39 --connect-timeout [arg]
41 Timeout for connecting to rdm in ms (default 1000).
42 Project management:
44 --clear|-C
45 Clear projects.
46 --project|-w [optional]
48 With arg, select project matching that if unique, otherwise list
49 all projects.
50 --delete-project|-W [arg]
52 Delete all projects matching regex.
53 --job-count|-j [optional]
55 Set or query current job count. (Prefix with l to set low-prior‐
56 ity-job-count).
57 Indexing commands:
59 --compile|-c [optional]
60 Pass compilation arguments to rdm.
61 --guess-flags
63 Guess compile flags (used with -c).
64 --load-compile-commands|-J [optional]
66 Load compile_commands.json from directory
67 --suspend|-X [optional]
69 Dump suspended files (don't track changes in these files) with
70 no arg. Otherwise toggle suspension for arg.
71 Query commands:
73 --follow-location|-f [arg]
74 Follow this location.
75 --references-name|-R [arg]
77 Find references matching arg.
78 --references|-r [arg]
80 Find references matching this location.
81 --list-symbols|-S [optional]
83 List symbol names matching arg.
84 --find-symbols|-F [optional]
86 Find symbols matching arg.
87 --symbol-info|-U [arg]
89 Get cursor info for this location.
90 --status|-s [optional]
92 Dump status of rdm. Arg can be symbols or symbolNames.
93 --diagnose [arg]
95 Resend diagnostics for file.
96 --diagnose-all
98 Resend diagnostics for all files.
99 --last-indexed
101 Get timestamp of the last time indexing completed for the cur‐
102 rent project.
103 --is-indexed|-T [arg]
105 Check if rtags knows about, and is ready to return information
106 about, this source file.
107 --is-indexing [optional]
109 Check if rtags is currently indexing files in any project or in
110 project matching pattern.
111 --has-filemanager [optional]
113 Check if rtags has info about files in this directory.
114 --preprocess|-E [arg]
116 Preprocess file.
117 --asm [arg]
119 Assemble file.
120 --reindex|-V [optional]
122 Reindex all files or all files matching pattern.
123 --check-reindex|-x [optional]
125 Check if reindexing is necessary for all files matching pattern.
126 --path|-P [optional]
128 Print files matching pattern.
129 --current-project
131 Print path for current project.
132 --dump-file|-d [arg]
134 Dump source file.
135 --check-includes [arg]
137 Check includes for source file.
138 --dump-file-maps [arg]
140 Dump file maps for file.
141 --generate-test [arg]
143 Generate a test for a given source file.
144 --rdm-log|-g
146 Receive logs from rdm.
147 --fixits [arg]
149 Get fixits for file.
150 --remove|-D [arg]
152 Remove file from project.
153 --find-project-root [arg]
155 Use to check behavior of find-project-root.
156 --find-project-build-root [arg]
158 Use to check behavior of find-project-root for builds.
159 --include-file [arg]
161 Use to generate include statement for symbol.
162 --sources [optional]
164 Dump sources for source file.
165 --dependencies [arg]
167 Dump dependencies for source file [(includes, included-by,
168 depends-on, depended-on, tree-depends-on, raw)].
169 --all-dependencies
171 Dump dependencies for all source files [(includes, included-by,
172 depends-on, depended-on, tree-depends-on, raw)].
173 --reload-file-manager|-B
175 Reload file manager.
176 --man Output XML for xmltoman to generate man page for rc :-)
178 --code-complete-at|-l [arg]
180 Code complete at location: arg is file:line:col.
181 --send-diagnostics [arg]
183 Only for debugging. Send data to all -G connections.
184 --dump-completions
186 Dump cached completions.
187 --dump-compile-commands
189 Dump compilation database for project.
190 --set-buffers [optional]
192 Set active buffers (list of filenames for active buffers in edi‐
193 tor).
194 --list-buffers
196 List active buffers.
197 --add-buffers [arg]
199 Add additional buffers.
200 --remove-buffers [arg]
202 Remove buffers.
203 --list-cursor-kinds
205 List spelling for known cursor kinds.
206 --class-hierarchy [arg]
208 Dump class hierarcy for struct/class at location.
209 --debug-locations [optional]
211 Manipulate debug locations.
212 --validate
214 Validate database files for current project.
215 --tokens [arg]
217 Dump tokens for file. --tokens file.cpp:123-321 for range.
218 --find-dead-functions [optional]
220 Find functions declared/defined in the current file that are
221 never in the project.
222 Command flags:
224 --strip-paren|-p
225 Strip parens in various contexts.
226 --max|-M [arg]
228 Max lines of output for queries.
229 --reverse-sort|-O
231 Sort output reversed.
232 --rename
234 Used for --references to indicate that we're using the results
235 to rename symbols.
236 --unsaved-file [arg]
238 Pass unsaved file on command line. E.g.
239 --unsaved-file=main.cpp:1200 then write 1200 bytes on stdin.
240 --log-file|-L [arg]
242 Log to this file.
243 --no-context|-N
245 Don't print context for locations.
246 --path-filter|-i [arg]
248 Filter out results not matching with arg.
249 --dependency-filter [arg]
251 Filter out results unless argument depends on them.
252 --range-filter [arg]
254 Filter out results not in the specified range.
255 --filter-system-headers|-H
257 Don't exempt system headers from path filters.
258 --all-references|-e
260 Include definitions/declarations/constructors/destructors for
261 references. Used for rename symbol.
262 --target-usrs
264 Print all matching usr targets for -f. Used for debugging.
265 --all-targets
267 Print multiple targets for -f. Sorted by best match.
268 --elisp|-Y
270 Output elisp: (list "one" "two" ...).
271 --json Output json.
273 --json-diagnostics-include-skipped
275 Output json diagnostics with skipped ranges.
276 --diagnostics|-m
278 Receive async formatted diagnostics from rdm.
279 --match-regexp|-Z
281 Treat various text patterns as regexps (-P, -i, -V, -F).
282 --match-icase|-I
284 Match case insensitively
285 --absolute-path|-K
287 Print files with absolute path.
288 --socket-file|-n [arg]
290 Use this socket file (default ~/.rdm).
291 --socket-address [arg]
293 Use this host:port combination (instead of --socket-file).
294 --timeout|-y [arg]
296 Max time in ms to wait for job to finish (default no timeout).
297 --find-virtuals|-k
299 Use in combinations with -R or -r to show other implementations
300 of this function.
301 --find-file-prefer-exact|-A
303 Use to make --find-file prefer exact matches over partial
304 matches.
305 --symbol-info-include-parents
307 Use to make --symbol-info include parent symbols.
308 --symbol-info-include-targets
310 Use to make --symbol-info include target symbols.
311 --symbol-info-include-references
313 Use to make --symbol-info include reference symbols.
314 --symbol-info-include-base-classes
316 Use to make --symbol-info include baseclasses' symbols.
317 --cursor-kind
319 Include cursor kind in --find-symbols output.
320 --display-name
322 Include display name in --find-symbols output.
323 --current-file [arg]
325 Pass along which file is being edited to give rdm a better
326 chance at picking the right project.
327 --declaration-only|-G
329 Filter out definitions (unless inline).
330 --definition-only
332 Filter out declarations (unless inline).
333 --kind-filter [arg]
335 Only return results matching this kind.
336 --containing-function|-o
338 Include name of containing function in output.
339 --containing-function-location
341 Include location of containing function in output.
342 --build-index [arg]
344 For sources with multiple builds, use the arg'th.
345 --compilation-flags-only
347 For --source, only print compilation flags.
348 --compilation-flags-split-line
350 For --source, print one compilation flag per line.
351 --compilation-flags-pwd
353 For --source, print pwd for compile command on the first line.
354 --dump-include-headers
356 For --dump-file, also dump dependencies.
357 --silent-query
359 Don't log this request in rdm.
360 --synchronous-completions
362 Wait for completion results and print them to stdout.
363 --synchronous-diagnostics
365 Wait for diagnostics and print them to stdout.
366 --xml Output XML
368 --no-sort-references-by-input
370 Don't sort references by input position.
371 --project-root [arg]
373 Override project root for compile commands.
374 --rtags-config [arg]
376 Print out .rtags-config for argument.
377 --wildcard-symbol-names|-a
379 Expand * like wildcards in --list-symbols and --find-symbols.
380 --no-color|-z
382 Don't colorize context.
383 --wait Wait for reindexing to finish.
385 --code-complete-include-macros
387 Include macros in code completion results.
388 --code-complete-includes
390 Give includes in completion results.
391 --code-complete-no-wait
393 Don't wait for synchronous completion if the translation unit
394 has to be created.
395 --code-complete-prefix [arg]
397 Filter out code completion results that don't start with this
398 prefix.
399 --code-completion-enabled|-b
401 Inform rdm that we're code-completing. Use with --diagnose
402 --no-spell-checking
404 Don't produce spell check info in diagnostics.
405 --tokens-include-symbols
407 Include symbols for tokens.
408 --no-realpath
410 Don't resolve paths using realpath(3).
411 --include-path [arg]
413 Dump include path for symbol.
414 --max-depth [arg]
416 Max search depth. Used for --include-path.
417
419 rdm(7)
420rc 2.33.128 June 2019 RC(7)