1DUNE-INSTALLED-LIBRARIES(1) Dune Manual DUNE-INSTALLED-LIBRARIES(1)
2
6 dune-installed-libraries - Print out libraries installed on the system.
7
9 dune installed-libraries [OPTION]…
10
12 --action-stderr-on-success=VAL
13 Same as --action-stdout-on-success but for the standard output for
14 error messages. A good default for large mono-repositories is
15 --action-stdout-on-success=swallow
16 --action-stderr-on-success=must-be-empty. This ensures that a
17 successful build has a "clean" empty output.
18 --action-stdout-on-success=VAL
20 Specify how to deal with the standard output of actions when they
21 succeed. Possible values are: print to just print it to Dune's
22 output, swallow to completely ignore it and must-be-empty to
23 enforce that the action printed nothing. With must-be-empty, Dune
24 will consider that the action failed if it printed something to its
25 standard output. The default is print.
26 --build-info
28 Show build information.
29 --display-separate-messages
31 Separate error messages with a blank line.
32 --error-reporting=VAL (absent=deterministic)
34 Controls when the build errors are reported. early - report errors
35 as soon as they are discovered. deterministic - report errors at
36 the end of the build in a deterministic order. twice - report each
37 error twice: once as soon as the error is discovered and then again
38 at the end of the build, in a deterministic order.
39 -f, --force
41 Force actions associated to aliases to be re-executed even if their
42 dependencies haven't changed.
43 --file-watcher=VAL (absent=automatic)
45 Mechanism to detect changes in the source. Automatic to make dune
46 run an external program to detect changes. Manual to notify dune
47 that files have changed manually."
48 --not-available, --na
50 List libraries that are not available and explain why
51 --passive-watch-mode
53 Similar to [--watch], but only start a build when instructed
54 externally by an RPC.
55 --react-to-insignificant-changes
57 react to insignificant file system changes; this is only useful for
58 benchmarking dune
59 --sandbox=VAL (absent DUNE_SANDBOX env)
61 Sandboxing mode to use by default. Some actions require a certain
62 sandboxing mode, so they will ignore this setting. The allowed
63 values are: none, symlink, copy, hardlink.
64 -w, --watch
66 Instead of terminating build after completion, wait continuously
67 for file changes.
68 --wait-for-filesystem-clock
70 Dune digest file contents for better incrementally. These digests
71 are themselves cached. In some cases, Dune needs to drop some
72 digest cache entries in order for things to be reliable. This
73 option makes Dune wait for the file system clock to advance so that
74 it doesn't need to drop anything. You should probably not care
75 about this option; it is mostly useful for Dune developers to make
76 Dune tests of the digest cache more reproducible.
77
79 --always-show-command-line
80 Always show the full command lines of programs executed by dune
81 --auto-promote
83 Automatically promote files. This is similar to running dune
84 promote after the build.
85 --build-dir=FILE (absent DUNE_BUILD_DIR env)
87 Specified build directory. _build if unspecified
88 --cache=VAL (absent DUNE_CACHE env)
90 Enable or disable Dune cache (either enabled or disabled). Default
91 is `disabled'.
92 --cache-check-probability=VAL (absent DUNE_CACHE_CHECK_PROBABILITY env)
94 Check build reproducibility by re-executing randomly chosen rules
95 and comparing their results with those stored in Dune cache. Note:
96 by increasing the probability of such checks you slow down the
97 build. The default probability is zero, i.e. no rules are checked.
98 --cache-storage-mode=VAL (absent DUNE_CACHE_STORAGE_MODE env)
100 Dune cache storage mode (one of auto, hardlink or copy). Default is
101 `auto'.
102 --config-file=FILE
104 Load this configuration file instead of the default one.
105 --debug-artifact-substitution
107 Print debugging info about artifact substitution
108 --debug-backtraces
110 Always print exception backtraces.
111 --debug-cache=VAL
113 Show debug messages on cache misses for the given cache layers.
114 Value is a comma-separated list of cache layer names. All available
115 cache layers: shared,workspace-local,fs.
116 --debug-dependency-path
118 In case of error, print the dependency path from the targets on the
119 command line to the rule that failed.
120 --debug-digests
122 Explain why Dune decides to re-digest some files
123 --debug-load-dir
125 Print debugging info about directory loading
126 --debug-store-digest-preimage
128 Store digest preimage for all computed digests, so that it's
129 possible to reverse them later, for debugging. The digests are
130 stored in the shared cache (see --cache flag) as values, even if
131 cache is otherwise disabled. This should be used only for
132 debugging, since it's slow and it litters the shared cache.
133 --default-target=TARGET (absent=@@default)
135 Set the default target that when none is specified to dune build.
136 --diff-command=VAL (absent DUNE_DIFF_COMMAND env)
138 Shell command to use to diff files. Use - to disable printing the
139 diff.
140 --disable-promotion (absent DUNE_DISABLE_PROMOTION env)
142 Disable all promotion rules
143 --display=MODE
145 Control the display mode of Dune. See dune-config(5) for more
146 details. Valid values for this option are progress, verbose, short,
147 quiet or tui.
148 --dump-gc-stats=FILE
150 Dump the garbage collector stats to a file after the build is
151 complete.
152 --dump-memo-graph=FILE
154 Dumps the dependency graph to a file after the build is complete
155 --dump-memo-graph-format=FORMAT (absent=gexf)
157 File format to be used when dumping dependency graph
158 --dump-memo-graph-with-timing
160 With --dump-memo-graph, will re-run each cached node in the Memo
161 graph after building and include the runtime in the output. Since
162 all nodes contain a cached value, this will measure just the
163 runtime of each node
164 --help[=FMT] (default=auto)
166 Show this help in format FMT. The value FMT must be one of auto,
167 pager, groff or plain. With auto, the format is pager or plain
168 whenever the TERM env var is dumb or undefined.
169 --ignore-promoted-rules
171 Ignore rules with (mode promote), except ones with (only ...). The
172 variable %{ignoring_promoted_rules} in dune files reflects whether
173 this option was passed or not.
174 --instrument-with=BACKENDS (absent DUNE_INSTRUMENT_WITH env)
176 "Enable instrumentation by BACKENDS. BACKENDS is a comma-separated
177 list of library names, each one of which must declare an
178 instrumentation backend.
179 -j JOBS
181 Run no more than JOBS commands simultaneously.
182 --no-buffer
184 Do not buffer the output of commands executed by dune. By default
185 dune buffers the output of subcommands, in order to prevent
186 interleaving when multiple commands are executed in parallel.
187 However, this can be an issue when debugging long running tests.
188 With --no-buffer, commands have direct access to the terminal. Note
189 that as a result their output won't be captured in the log file.
190 You should use this option in conjunction with -j 1, to avoid
191 interleaving. Additionally you should use --verbose as well, to
192 make sure that commands are printed before they are being executed.
193 --no-config
195 Do not load the configuration file
196 --no-print-directory
198 Suppress "Entering directory" messages
199 --only-packages=PACKAGES
201 Ignore stanzas referring to a package that is not in PACKAGES.
202 PACKAGES is a comma-separated list of package names. Note that this
203 has the same effect as deleting the relevant stanzas from dune
204 files. It is mostly meant for releases. During development, it is
205 likely that what you want instead is to build a particular
206 <package>.install target.
207 -p PACKAGES, --for-release-of-packages=PACKAGES (required)
209 Shorthand for --release --only-packages PACKAGE. You must use this
210 option in your <package>.opam files, in order to build only what's
211 necessary when your project contains multiple packages as well as
212 getting reproducible builds.
213 --print-metrics
215 Print out various performance metrics after every build
216 --profile=VAL (absent DUNE_PROFILE env)
218 Select the build profile, for instance dev or release. The default
219 is dev.
220 --promote-install-files[=VAL] (default=true)
222 Promote the generated <package>.install files to the source tree
223 --release
225 Put dune into a reproducible release mode. This is in fact a
226 shorthand for --root . --ignore-promoted-rules --no-config
227 --profile release --always-show-command-line
228 --promote-install-files --default-target @install
229 --require-dune-project-file. You should use this option for release
230 builds. For instance, you must use this option in your
231 <package>.opam files. Except if you already use -p, as -p implies
232 this option.
233 --require-dune-project-file[=VAL] (default=true)
235 Fail if a dune-project file is missing.
236 --root=DIR
238 Use this directory as workspace root instead of guessing it. Note
239 that this option doesn't change the interpretation of targets given
240 on the command line. It is only intended for scripts.
241 --store-orig-source-dir (absent DUNE_STORE_ORIG_SOURCE_DIR env)
243 Store original source location in dune-package metadata
244 --terminal-persistence=MODE
246 Changes how the log of build results are displayed to the console
247 between rebuilds while in --watch mode. Supported modes: preserve,
248 clear-on-rebuild, clear-on-rebuild-and-flush-history.
249 --trace-extended
251 Output extended trace data (requires trace-file)
252 --trace-file=FILE
254 Output trace data in catapult format (compatible with
255 chrome://tracing)
256 --verbose
258 Same as --display verbose
259 --version
261 Show version information.
262 --watch-exclusions=REGEX
264 Adds a POSIX regular expression that will exclude matching
265 directories from `dune build --watch`. The option
266 --watch-exclusions can be repeated to add multiple exclusions.
267 Semicolons can be also used as a separator. If no exclusions are
268 provided, then a standard set of exclusions is used; however, if
269 one or more --watch-exclusions are used, none of the standard
270 exclusions are used. The standard exclusions are: ^_opam /_opam
271 ^_esy /_esy ^\.#.* /\.#.* ~$ ^#[^#]*#$ /#[^#]*#$ ^4913$ /4913$
272 /.git /.hg :/windows
273 --workspace=FILE (absent DUNE_WORKSPACE env)
275 Use this specific workspace file instead of looking it up.
276 -x VAL
278 Cross-compile using this toolchain.
279
281 installed-libraries exits with the following status:
282 0 on success.
284 1 if an error happened.
286 130 if it was interrupted by a signal.
288
290 These environment variables affect the execution of
291 installed-libraries:
292 DUNE_BUILD_DIR
294 Specified build directory. _build if unspecified
295 DUNE_CACHE
297 Enable or disable Dune cache (either enabled or disabled). Default
298 is `disabled'.
299 DUNE_CACHE_CHECK_PROBABILITY
301 Check build reproducibility by re-executing randomly chosen rules
302 and comparing their results with those stored in Dune cache. Note:
303 by increasing the probability of such checks you slow down the
304 build. The default probability is zero, i.e. no rules are checked.
305 DUNE_CACHE_STORAGE_MODE
307 Dune cache storage mode (one of auto, hardlink or copy). Default is
308 `auto'.
309 DUNE_DIFF_COMMAND
311 Shell command to use to diff files. Use - to disable printing the
312 diff.
313 DUNE_DISABLE_PROMOTION
315 Disable all promotion rules
316 DUNE_INSTRUMENT_WITH
318 "Enable instrumentation by BACKENDS. BACKENDS is a comma-separated
319 list of library names, each one of which must declare an
320 instrumentation backend.
321 DUNE_PROFILE
323 Build profile. dev if unspecified or release if -p is set.
324 DUNE_SANDBOX
326 Sandboxing mode to use by default. (see --sandbox)
327 DUNE_STORE_ORIG_SOURCE_DIR
329 Store original source location in dune-package metadata
330 DUNE_WORKSPACE
332 Use this specific workspace file instead of looking it up.
333
335 dune(1)
336Dune n/a DUNE-INSTALLED-LIBRARIES(1)