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 --error-reporting=VAL (absent=deterministic)
31 Controls when the build errors are reported. early - report errors
32 as soon as they are discovered. deterministic - report errors at
33 the end of the build in a deterministic order. twice - report each
34 error twice: once as soon as the error is discovered and then again
35 at the end of the build, in a deterministic order.
36 -f, --force
38 Force actions associated to aliases to be re-executed even if their
39 dependencies haven't changed.
40 --file-watcher=VAL (absent=automatic)
42 Mechanism to detect changes in the source. Automatic to make dune
43 run an external program to detect changes. Manual to notify dune
44 that files have changed manually."
45 --not-available, --na
47 List libraries that are not available and explain why
48 --passive-watch-mode
50 Similar to [--watch], but only start a build when instructed
51 externally by an RPC.
52 --react-to-insignificant-changes
54 react to insignificant file system changes; this is only useful for
55 benchmarking dune
56 --sandbox=VAL (absent DUNE_SANDBOX env)
58 Sandboxing mode to use by default. Some actions require a certain
59 sandboxing mode, so they will ignore this setting. The allowed
60 values are: none, symlink, copy, hardlink.
61 -w, --watch
63 Instead of terminating build after completion, wait continuously
64 for file changes.
65 --wait-for-filesystem-clock
67 Dune digest file contents for better incrementally. These digests
68 are themselves cached. In some cases, Dune needs to drop some
69 digest cache entries in order for things to be reliable. This
70 option makes Dune wait for the file system clock to advance so that
71 it doesn't need to drop anything. You should probably not care
72 about this option; it is mostly useful for Dune developers to make
73 Dune tests of the digest cache more reproducible.
74
76 --always-show-command-line
77 Always show the full command lines of programs executed by dune
78 --auto-promote
80 Automatically promote files. This is similar to running dune
81 promote after the build.
82 --build-dir=FILE (absent DUNE_BUILD_DIR env)
84 Specified build directory. _build if unspecified
85 --cache=VAL (absent DUNE_CACHE env)
87 Enable or disable Dune cache (either enabled or disabled). Default
88 is `disabled'.
89 --cache-check-probability=VAL (absent DUNE_CACHE_CHECK_PROBABILITY env)
91 Check build reproducibility by re-executing randomly chosen rules
92 and comparing their results with those stored in Dune cache. Note:
93 by increasing the probability of such checks you slow down the
94 build. The default probability is zero, i.e. no rules are checked.
95 --cache-storage-mode=VAL (absent DUNE_CACHE_STORAGE_MODE env)
97 Dune cache storage mode (one of auto, hardlink or copy). Default is
98 `auto'.
99 --config-file=FILE
101 Load this configuration file instead of the default one.
102 --debug-artifact-substitution
104 Print debugging info about artifact substitution
105 --debug-backtraces
107 Always print exception backtraces.
108 --debug-cache=VAL
110 Show debug messages on cache misses for the given cache layers.
111 Value is a comma-separated list of cache layer names. All available
112 cache layers: shared,workspace-local,fs.
113 --debug-dependency-path
115 In case of error, print the dependency path from the targets on the
116 command line to the rule that failed.
117 --debug-digests
119 Explain why Dune decides to re-digest some files
120 --debug-load-dir
122 Print debugging info about directory loading
123 --debug-store-digest-preimage
125 Store digest preimage for all computed digests, so that it's
126 possible to reverse them later, for debugging. The digests are
127 stored in the shared cache (see --cache flag) as values, even if
128 cache is otherwise disabled. This should be used only for
129 debugging, since it's slow and it litters the shared cache.
130 --default-target=TARGET (absent=@@default)
132 Set the default target that when none is specified to dune build.
133 --diff-command=VAL (absent DUNE_DIFF_COMMAND env)
135 Shell command to use to diff files. Use - to disable printing the
136 diff.
137 --disable-promotion (absent DUNE_DISABLE_PROMOTION env)
139 Disable all promotion rules
140 --display=MODE
142 Control the display mode of Dune. See dune-config(5) for more
143 details. Valid values for this option are One of progress, verbose,
144 short or quiet
145 --dump-memo-graph=FILE
147 Dumps the dependency graph to a file after the build is complete
148 --dump-memo-graph-format=FORMAT (absent=gexf)
150 File format to be used when dumping dependency graph
151 --dump-memo-graph-with-timing
153 With --dump-memo-graph, will re-run each cached node in the Memo
154 graph after building and include the runtime in the output. Since
155 all nodes contain a cached value, this will measure just the
156 runtime of each node
157 --help[=FMT] (default=auto)
159 Show this help in format FMT. The value FMT must be one of auto,
160 pager, groff or plain. With auto, the format is pager or plain
161 whenever the TERM env var is dumb or undefined.
162 --ignore-promoted-rules
164 Ignore rules with (mode promote), except ones with (only ...). The
165 variable %{ignoring_promoted_rules} in dune files reflects whether
166 this option was passed or not.
167 --instrument-with=BACKENDS (absent DUNE_INSTRUMENT_WITH env)
169 "Enable instrumentation by BACKENDS. BACKENDS is a comma-separated
170 list of library names, each one of which must declare an
171 instrumentation backend.
172 -j JOBS
174 Run no more than JOBS commands simultaneously.
175 --no-buffer
177 Do not buffer the output of commands executed by dune. By default
178 dune buffers the output of subcommands, in order to prevent
179 interleaving when multiple commands are executed in parallel.
180 However, this can be an issue when debugging long running tests.
181 With --no-buffer, commands have direct access to the terminal. Note
182 that as a result their output won't be captured in the log file.
183 You should use this option in conjunction with -j 1, to avoid
184 interleaving. Additionally you should use --verbose as well, to
185 make sure that commands are printed before they are being executed.
186 --no-config
188 Do not load the configuration file
189 --no-print-directory
191 Suppress "Entering directory" messages
192 --only-packages=PACKAGES
194 Ignore stanzas referring to a package that is not in PACKAGES.
195 PACKAGES is a comma-separated list of package names. Note that this
196 has the same effect as deleting the relevant stanzas from dune
197 files. It is mostly meant for releases. During development, it is
198 likely that what you want instead is to build a particular
199 <package>.install target.
200 -p PACKAGES, --for-release-of-packages=PACKAGES (required)
202 Shorthand for --release --only-packages PACKAGE. You must use this
203 option in your <package>.opam files, in order to build only what's
204 necessary when your project contains multiple packages as well as
205 getting reproducible builds.
206 --print-metrics
208 Print out various performance metrics after every build
209 --profile=VAL (absent DUNE_PROFILE env)
211 Select the build profile, for instance dev or release. The default
212 is dev.
213 --promote-install-files[=VAL] (default=true)
215 Promote the generated <package>.install files to the source tree
216 --release
218 Put dune into a reproducible release mode. This is in fact a
219 shorthand for --root . --ignore-promoted-rules --no-config
220 --profile release --always-show-command-line
221 --promote-install-files --default-target @install
222 --require-dune-project-file. You should use this option for release
223 builds. For instance, you must use this option in your
224 <package>.opam files. Except if you already use -p, as -p implies
225 this option.
226 --require-dune-project-file[=VAL] (default=true)
228 Fail if a dune-project file is missing.
229 --root=DIR
231 Use this directory as workspace root instead of guessing it. Note
232 that this option doesn't change the interpretation of targets given
233 on the command line. It is only intended for scripts.
234 --store-orig-source-dir (absent DUNE_STORE_ORIG_SOURCE_DIR env)
236 Store original source location in dune-package metadata
237 --terminal-persistence=MODE
239 Changes how the log of build results are displayed to the console
240 between rebuilds while in --watch mode. Supported modes: preserve,
241 clear-on-rebuild, clear-on-rebuild-and-flush-history.
242 --trace-file=FILE
244 Output trace data in catapult format (compatible with
245 chrome://tracing)
246 --verbose
248 Same as --display verbose
249 --version
251 Show version information.
252 --workspace=FILE (absent DUNE_WORKSPACE env)
254 Use this specific workspace file instead of looking it up.
255 -x VAL
257 Cross-compile using this toolchain.
258
260 installed-libraries exits with the following status:
261 0 on success.
263 123 on indiscriminate errors reported on standard error.
265 124 on command line parsing errors.
267 125 on unexpected internal errors (bugs).
269
271 These environment variables affect the execution of
272 installed-libraries:
273 DUNE_BUILD_DIR
275 Specified build directory. _build if unspecified
276 DUNE_CACHE
278 Enable or disable Dune cache (either enabled or disabled). Default
279 is `disabled'.
280 DUNE_CACHE_CHECK_PROBABILITY
282 Check build reproducibility by re-executing randomly chosen rules
283 and comparing their results with those stored in Dune cache. Note:
284 by increasing the probability of such checks you slow down the
285 build. The default probability is zero, i.e. no rules are checked.
286 DUNE_CACHE_STORAGE_MODE
288 Dune cache storage mode (one of auto, hardlink or copy). Default is
289 `auto'.
290 DUNE_DIFF_COMMAND
292 Shell command to use to diff files. Use - to disable printing the
293 diff.
294 DUNE_DISABLE_PROMOTION
296 Disable all promotion rules
297 DUNE_INSTRUMENT_WITH
299 "Enable instrumentation by BACKENDS. BACKENDS is a comma-separated
300 list of library names, each one of which must declare an
301 instrumentation backend.
302 DUNE_PROFILE
304 Build profile. dev if unspecified or release if -p is set.
305 DUNE_SANDBOX
307 Sandboxing mode to use by default. (see --sandbox)
308 DUNE_STORE_ORIG_SOURCE_DIR
310 Store original source location in dune-package metadata
311 DUNE_WORKSPACE
313 Use this specific workspace file instead of looking it up.
314
316 dune(1)
317Dune n/a DUNE-INSTALLED-LIBRARIES(1)