1RDM(7) User Commands RDM(7)
2
6 rdm - manual page for rdm 2.10.117
7
9 rdm [OPTION]...
10
12 RTags is a client/server application that indexes C/C++ code and keeps
13 a persistent file-based database of references, declarations, defini‐
14 tions, symbolnames etc. There's also limited support for ObjC/ObjC++.
15 It allows you to find symbols by name (including nested class and
16 namespace scope). Most importantly we give you proper follow-symbol and
17 find-references support. We also have neat little things like
18 rename-symbol, integration with clang's "fixits"
19 (http://clang.llvm.org/diagnostics.html). We also integrate with fly‐
20 make using clang's vastly superior errors and warnings. Since RTags
21 constantly will reindex "dirty" files you get live updates of compiler
22 errors and warnings. Since we already know how to compile your sources
23 we have a way to quickly bring up the preprocessed output of the cur‐
24 rent source file in a buffer.
25 While existing taggers like gnu global, cscope, etags, ctags etc do a
27 decent job for C they often fall a little bit short for C++. With its
28 incredible lexical complexity, parsing C++ is an incredibly hard task
29 and we make no bones about the fact that the only reason we are able to
30 improve on the current tools is because of clang
31 (http://clang.llvm.org/). RTags is named RTags in recognition of
32 Roberto Raggi on whose C++ parser we intended to base this project but
33 he assured us clang was the way to go. The name stuck though.
34
36 --help|-h
37 Display this page.
38 --version
40 Display version.
41 --include-path|-I [arg]
43 Add additional include path to clang.
44 --isystem|-s [arg]
46 Add additional system include path to clang.
47 --define|-D [arg]
49 Add additional define directive to clang.
50 --default-argument [arg]
52 Add additional argument to clang.
53 --log-file|-L [arg]
55 Log to this file.
56 --crash-dump-file [arg]
58 File to dump crash log to (default is <datadir>/crash.dump).
59 --setenv|-e [arg]
61 Set this environment variable (--setenv "foobar=1").
62 --no-Wall|-W
64 Don't use -Wall.
65 --Weverything|-u
67 Use -Weverything.
68 --verbose|-v
70 Change verbosity, multiple -v's are allowed.
71 --job-count|-j [arg]
73 Spawn this many concurrent processes for indexing.
74 --header-error-job-count|-H [arg]
76 Allow this many concurrent header error jobs (default
77 std::max(1, --job-count / 2)).
78 --test|-t [arg]
80 Run this test.
81 --test-timeout|-z [arg]
83 Timeout for test to complete.
84 --clean-slate|-C
86 Clear out all data.
87 --disable-sighandler|-x
89 Disable signal handler to dump stack for crashes.
90 --silent|-S
92 No logging to stdout/stderr.
93 --exclude-filter|-X [arg]
95 Files to exclude from rdm, default "*/CMakeFiles/*;*/cmake*/Mod‐
96 ules/*;*/conftest.c*;/tmp/*;/private/tmp/*;/private/var/*".
97 --socket-file|-n [arg]
99 Use this file for the server socket (default ~/.rdm).
100 --data-dir|-d [arg]
102 Use this directory to store persistent data (default
103 $XDG_CACHE_HOME/rtags otherwise ~/.cache/rtags).
104 --ignore-printf-fixits|-F
106 Disregard any clang fixit that looks like it's trying to fix
107 format for printf and friends.
108 --error-limit|-f [arg]
110 Set error limit to argument (-ferror-limit={arg} (default 50).
111 --block-argument|-G [arg]
113 Block this argument from being passed to clang. E.g. rdm
114 --block-argument -fno-inline
115 --no-spell-checking|-l
117 Don't pass -fspell-checking.
118 --large-by-value-copy|-r [arg]
120 Use -Wlarge-by-value-copy=[arg] when invoking clang.
121 --allow-multiple-sources|-m
123 Don't merge source files added with -c.
124 --no-startup-project|-o
126 Don't restore the last current project on startup.
127 --no-no-unknown-warnings-option|-Y
129 Don't pass -Wno-unknown-warning-option.
130 --ignore-compiler|-b [arg]
132 Ignore this compiler.
133 --compiler-wrappers [arg]
135 Consider these filenames compiler wrappers (split on ;), default
136 ccache".
137 --watch-system-paths|-w
139 Watch system paths for changes.
140 --rp-visit-file-timeout|-Z [arg]
142 Timeout for rp visitfile commands in ms (0 means no timeout)
143 (default 60000).
144 --rp-indexer-message-timeout|-T [arg]
146 Timeout for rp indexer-message in ms (0 means no timeout)
147 (default 60000).
148 --rp-connect-timeout|-O [arg]
150 Timeout for connection from rp to rdm in ms (0 means no timeout)
151 (default 0).
152 --rp-connect-attempts [arg]
154 Number of times rp attempts to connect to rdm before giving up.
155 (default 3).
156 --rp-nice-value|-a [arg]
158 Nice value to use for rp (nice(2)) (default is no nicing).
159 --suspend-rp-on-crash|-q
161 Suspend rp in SIGSEGV handler (default off).
162 --rp-log-to-syslog
164 Make rp log to syslog.
165 --start-suspended|-Q
167 Start out suspended (no reindexing enabled).
168 --separate-debug-and-release|-E
170 Normally rdm doesn't consider release and debug as different
171 builds. Pass this if you want it to.
172 --separate-32-bit-and-64-bit
174 Normally rdm doesn't consider -m32 and -m64 as different builds.
175 Pass this if you want it to.
176 --ignore-include-path-differences-in-usr Don't consider sources that
178 only differ in includepaths within /usr (not including
179 /usr/home/) as different builds.
180 --max-crash-count|-K [arg]
182 Max number of crashes before giving up a sourcefile (default 5).
183 --completion-cache-size|-i [arg]
185 Number of translation units to cache (default 10).
186 --completion-no-filter
188 Don't filter private members and destructors from completions.
189 --completion-logs
191 Log more info about completions.
192 --max-include-completion-depth [arg]
194 Max recursion depth for header completion (default 3).
195 --allow-Wpedantic|-P
197 Don't strip out -Wpedantic. This can cause problems in certain
198 projects.
199 --allow-Werror
201 Don't strip out -Werror and -Wfatal-errors. By default these are
202 stripped out.
203 --enable-compiler-manager|-R
205 Query compilers for their actual include paths instead of let‐
206 ting clang use its own.
207 --enable-NDEBUG|-g
209 Don't remove -DNDEBUG from compile lines.
210 --progress|-p
212 Report compilation progress in diagnostics output.
213 --max-file-map-cache-size|-y [arg]
215 Max files to cache per query (Should not exceed maximum number
216 of open file descriptors allowed per process) (default 500).
217 --no-filemanager-watch|-M
219 Don't use a file system watcher for filemanager.
220 --no-filemanager
222 Don't scan project directory for files. (rc -P won't work).
223 --no-file-lock
225 Disable file locking. Not entirely safe but might improve per‐
226 formance on certain systems.
227 --pch-enabled
229 Enable PCH (experimental).
230 --no-filesystem-watcher|-B
232 Disable file system watching altogether. Reindexing has to be
233 triggered manually.
234 --arg-transform|-V [arg]
236 Use arg to transform arguments. [arg] should be executable with
237 (execv(3)).
238 --no-comments
240 Don't parse/store doxygen comments.
241 --inactivity-timeout [arg]
243 Time in seconds after which rdm will quit if there's been no
244 activity (N.B., once rdm has quit, something will need to re-run
245 it!).
246 --daemon
248 Run as daemon (detach from terminal).
249 --log-file-log-level [arg]
251 Log level for log file (default is error), options are: error,
252 warning, debug or verbose-debug.
253 --watch-sources-only
255 Only watch source files (not dependencies).
256 --debug-locations
258 Set debug locations.
259 --validate-file-maps
261 Spend some time validating project data on startup.
262 --tcp-port [arg]
264 Listen on this tcp socket (default none).
265 --rp-path [arg]
267 Path to rp.
268 --log-timestamp
270 Add timestamp to logs.
271 --log-flush
273 Flush stderr/stdout after each log.
274 --sandbox-root [arg]
276 Create index using relative paths by stripping dir (enables
277 copying of tag index db files without need to reindex).
278 --poll-timer [arg]
280 Poll the database of the current project every <arg> seconds.
281 --no-realpath
283 Don't use realpath(3) for files
284 --config|-c [arg]
286 Use this file (instead of ~/.rdmrc).
287 --no-rc|-N
289 Don't load any rc files.
290
292 rc(7)
293rdm 2.10.117 April 2017 RDM(7)