1RC(7) User Commands RC(7)
2
6 rc - manual page for rc 2.10.117
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 [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 --is-indexed|-T [arg]
101 Check if rtags knows about, and is ready to return information
102 about, this source file.
103 --is-indexing
105 Check if rtags is currently indexing files.
106 --has-filemanager [optional]
108 Check if rtags has info about files in this directory.
109 --preprocess|-E [arg]
111 Preprocess file.
112 --reindex|-V [optional]
114 Reindex all files or all files matching pattern.
115 --check-reindex|-x [optional]
117 Check if reindexing is necessary for all files matching pattern.
118 --path|-P [optional]
120 Print files matching pattern.
121 --current-project
123 Print path for current project.
124 --dump-file|-d [arg]
126 Dump source file.
127 --check-includes [arg]
129 Check includes for source file.
130 --dump-file-maps [arg]
132 Dump file maps for file.
133 --generate-test [arg]
135 Generate a test for a given source file.
136 --rdm-log|-g
138 Receive logs from rdm.
139 --fixits [arg]
141 Get fixits for file.
142 --remove|-D [arg]
144 Remove file from project.
145 --find-project-root [arg]
147 Use to check behavior of find-project-root.
148 --find-project-build-root [arg]
150 Use to check behavior of find-project-root for builds.
151 --include-file [arg]
153 Use to generate include statement for symbol.
154 --sources [optional]
156 Dump sources for source file.
157 --dependencies [arg]
159 Dump dependencies for source file [(includes, included-by,
160 depends-on, depended-on, tree-depends-on, raw)].
161 --all-dependencies
163 Dump dependencies for all source files [(includes, included-by,
164 depends-on, depended-on, tree-depends-on, raw)].
165 --reload-file-manager|-B
167 Reload file manager.
168 --man Output XML for xmltoman to generate man page for rc :-)
170 --code-complete-at|-l [arg]
172 Code complete at location: arg is file:line:col.
173 --send-diagnostics [arg]
175 Only for debugging. Send data to all -G connections.
176 --dump-completions
178 Dump cached completions.
179 --dump-compile-commands
181 Dump compilation database for project.
182 --set-buffers [optional]
184 Set active buffers (list of filenames for active buffers in edi‐
185 tor).
186 --list-buffers
188 List active buffers.
189 --list-cursor-kinds
191 List spelling for known cursor kinds.
192 --class-hierarchy [arg]
194 Dump class hierarcy for struct/class at location.
195 --debug-locations [optional]
197 Manipulate debug locations.
198 --validate
200 Validate database files for current project.
201 --tokens [arg]
203 Dump tokens for file. --tokens file.cpp:123-321 for range.
204 Command flags:
206 --strip-paren|-p
207 Strip parens in various contexts.
208 --max|-M [arg]
210 Max lines of output for queries.
211 --reverse-sort|-O
213 Sort output reversed.
214 --rename
216 Used for --references to indicate that we're using the results
217 to rename symbols.
218 --unsaved-file [arg]
220 Pass unsaved file on command line. E.g.
221 --unsaved-file=main.cpp:1200 then write 1200 bytes on stdin.
222 --log-file|-L [arg]
224 Log to this file.
225 --no-context|-N
227 Don't print context for locations.
228 --path-filter|-i [arg]
230 Filter out results not matching with arg.
231 --dependency-filter [arg]
233 Filter out results unless argument depends on them.
234 --range-filter [arg]
236 Filter out results not in the specified range.
237 --filter-system-headers|-H
239 Don't exempt system headers from path filters.
240 --all-references|-e
242 Include definitions/declarations/constructors/destructors for
243 references. Used for rename symbol.
244 --target-usrs
246 Print all matching usr targets for -f. Used for debugging.
247 --all-targets
249 Print multiple targets for -f. Sorted by best match.
250 --elisp|-Y
252 Output elisp: (list "one" "two" ...).
253 --json Output json.
255 --diagnostics|-m
257 Receive async formatted diagnostics from rdm.
258 --match-regexp|-Z
260 Treat various text patterns as regexps (-P, -i, -V).
261 --match-icase|-I
263 Match case insensitively
264 --absolute-path|-K
266 Print files with absolute path.
267 --socket-file|-n [arg]
269 Use this socket file (default ~/.rdm).
270 --socket-address [arg]
272 Use this host:port combination (instead of --socket-file).
273 --timeout|-y [arg]
275 Max time in ms to wait for job to finish (default no timeout).
276 --find-virtuals|-k
278 Use in combinations with -R or -r to show other implementations
279 of this function.
280 --find-file-prefer-exact|-A
282 Use to make --find-file prefer exact matches over partial
283 matches.
284 --symbol-info-include-parents
286 Use to make --symbol-info include parent symbols.
287 --symbol-info-include-targets
289 Use to make --symbol-info include target symbols.
290 --symbol-info-include-references
292 Use to make --symbol-info include reference symbols.
293 --symbol-info-include-base-classes
295 Use to make --symbol-info include baseclasses' symbols.
296 --cursor-kind
298 Include cursor kind in --find-symbols output.
299 --display-name
301 Include display name in --find-symbols output.
302 --current-file [arg]
304 Pass along which file is being edited to give rdm a better
305 chance at picking the right project.
306 --declaration-only|-G
308 Filter out definitions (unless inline).
309 --definition-only
311 Filter out declarations (unless inline).
312 --kind-filter [arg]
314 Only return results matching this kind.
315 --containing-function|-o
317 Include name of containing function in output.
318 --containing-function-location
320 Include location of containing function in output.
321 --build-index [arg]
323 For sources with multiple builds, use the arg'th.
324 --compilation-flags-only
326 For --source, only print compilation flags.
327 --compilation-flags-split-line
329 For --source, print one compilation flag per line.
330 --compilation-flags-pwd
332 For --source, print pwd for compile command on the first line.
333 --dump-include-headers
335 For --dump-file, also dump dependencies.
336 --silent-query
338 Don't log this request in rdm.
339 --synchronous-completions
341 Wait for completion results and print them to stdout.
342 --synchronous-diagnostics
344 Wait for diagnostics and print them to stdout.
345 --xml Output XML
347 --no-sort-references-by-input
349 Don't sort references by input position.
350 --project-root [arg]
352 Override project root for compile commands.
353 --rtags-config [arg]
355 Print out .rtags-config for argument.
356 --wildcard-symbol-names|-a
358 Expand * like wildcards in --list-symbols and --find-symbols.
359 --no-color|-z
361 Don't colorize context.
362 --wait Wait for reindexing to finish.
364 --code-complete-include-macros
366 Include macros in code completion results.
367 --code-complete-includes
369 Give includes in completion results.
370 --code-complete-no-wait
372 Don't wait for synchronous completion if the translation unit
373 has to be created.
374 --code-complete-prefix [arg]
376 Filter out code completion results that don't start with this
377 prefix.
378 --code-completion-enabled|-b
380 Inform rdm that we're code-completing. Use with --diagnose
381 --no-spell-checking
383 Don't produce spell check info in diagnostics.
384 --tokens-include-symbols
386 Include symbols for tokens.
387 --no-realpath
389 Don't resolve paths using realpath(3).
390
392 rdm(7)
393rc 2.10.117 April 2017 RC(7)