1DUNE-PRINTENV(1) Dune Manual DUNE-PRINTENV(1)
2
6 dune-printenv - Print the environment of a directory
7
9 dune printenv [OPTION]… [PATH]
10
12 dune printenv DIR prints the environment of a directory
13
15 --action-stderr-on-success=VAL
16 Same as --action-stdout-on-success but for the standard output for
17 error messages. A good default for large mono-repositories is
18 --action-stdout-on-success=swallow
19 --action-stderr-on-success=must-be-empty. This ensures that a
20 successful build has a "clean" empty output.
21 --action-stdout-on-success=VAL
23 Specify how to deal with the standard output of actions when they
24 succeed. Possible values are: print to just print it to Dune's
25 output, swallow to completely ignore it and must-be-empty to
26 enforce that the action printed nothing. With must-be-empty, Dune
27 will consider that the action failed if it printed something to its
28 standard output. The default is print.
29 --build-info
31 Show build information.
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 --field=FIELD
45 Only print this field. This option can be repeated multiple times
46 to print multiple fields.
47 --file-watcher=VAL (absent=automatic)
49 Mechanism to detect changes in the source. Automatic to make dune
50 run an external program to detect changes. Manual to notify dune
51 that files have changed manually."
52 --passive-watch-mode
54 Similar to [--watch], but only start a build when instructed
55 externally by an RPC.
56 --react-to-insignificant-changes
58 react to insignificant file system changes; this is only useful for
59 benchmarking dune
60 --sandbox=VAL (absent DUNE_SANDBOX env)
62 Sandboxing mode to use by default. Some actions require a certain
63 sandboxing mode, so they will ignore this setting. The allowed
64 values are: none, symlink, copy, hardlink.
65 -w, --watch
67 Instead of terminating build after completion, wait continuously
68 for file changes.
69 --wait-for-filesystem-clock
71 Dune digest file contents for better incrementally. These digests
72 are themselves cached. In some cases, Dune needs to drop some
73 digest cache entries in order for things to be reliable. This
74 option makes Dune wait for the file system clock to advance so that
75 it doesn't need to drop anything. You should probably not care
76 about this option; it is mostly useful for Dune developers to make
77 Dune tests of the digest cache more reproducible.
78
80 These options are common to all commands.
81 --always-show-command-line
83 Always show the full command lines of programs executed by dune
84 --auto-promote
86 Automatically promote files. This is similar to running dune
87 promote after the build.
88 --build-dir=FILE (absent DUNE_BUILD_DIR env)
90 Specified build directory. _build if unspecified
91 --cache=VAL (absent DUNE_CACHE env)
93 Enable or disable Dune cache (either enabled or disabled). Default
94 is `disabled'.
95 --cache-check-probability=VAL (absent DUNE_CACHE_CHECK_PROBABILITY env)
97 Check build reproducibility by re-executing randomly chosen rules
98 and comparing their results with those stored in Dune cache. Note:
99 by increasing the probability of such checks you slow down the
100 build. The default probability is zero, i.e. no rules are checked.
101 --cache-storage-mode=VAL (absent DUNE_CACHE_STORAGE_MODE env)
103 Dune cache storage mode (one of auto, hardlink or copy). Default is
104 `auto'.
105 --config-file=FILE
107 Load this configuration file instead of the default one.
108 --debug-artifact-substitution
110 Print debugging info about artifact substitution
111 --debug-backtraces
113 Always print exception backtraces.
114 --debug-cache=VAL
116 Show debug messages on cache misses for the given cache layers.
117 Value is a comma-separated list of cache layer names. All available
118 cache layers: shared,workspace-local,fs.
119 --debug-dependency-path
121 In case of error, print the dependency path from the targets on the
122 command line to the rule that failed.
123 --debug-digests
125 Explain why Dune decides to re-digest some files
126 --debug-findlib
128 Debug the findlib sub-system.
129 --debug-load-dir
131 Print debugging info about directory loading
132 --debug-store-digest-preimage
134 Store digest preimage for all computed digests, so that it's
135 possible to reverse them later, for debugging. The digests are
136 stored in the shared cache (see --cache flag) as values, even if
137 cache is otherwise disabled. This should be used only for
138 debugging, since it's slow and it litters the shared cache.
139 --default-target=TARGET (absent=@@default)
141 Set the default target that when none is specified to dune build.
142 --diff-command=VAL (absent DUNE_DIFF_COMMAND env)
144 Shell command to use to diff files. Use - to disable printing the
145 diff.
146 --disable-promotion (absent DUNE_DISABLE_PROMOTION env)
148 Disable all promotion rules
149 --display=MODE
151 Control the display mode of Dune. See dune-config(5) for more
152 details.
153 --dump-memo-graph=FILE
155 Dumps the dependency graph to a file after the build is complete
156 --dump-memo-graph-format=FORMAT (absent=gexf)
158 File format to be used when dumping dependency graph
159 --dump-memo-graph-with-timing
161 With --dump-memo-graph, will re-run each cached node in the Memo
162 graph after building and include the runtime in the output. Since
163 all nodes contain a cached value, this will measure just the
164 runtime of each node
165 --help[=FMT] (default=auto)
167 Show this help in format FMT. The value FMT must be one of auto,
168 pager, groff or plain. With auto, the format is pager or plain
169 whenever the TERM env var is dumb or undefined.
170 --ignore-promoted-rules
172 Ignore rules with (mode promote), except ones with (only ...). The
173 variable %{ignoring_promoted_rules} in dune files reflects whether
174 this option was passed or not.
175 --instrument-with=BACKENDS (absent DUNE_INSTRUMENT_WITH env)
177 "Enable instrumentation by BACKENDS. BACKENDS is a comma-separated
178 list of library names, each one of which must declare an
179 instrumentation backend.
180 -j JOBS
182 Run no more than JOBS commands simultaneously.
183 --no-buffer
185 Do not buffer the output of commands executed by dune. By default
186 dune buffers the output of subcommands, in order to prevent
187 interleaving when multiple commands are executed in parallel.
188 However, this can be an issue when debugging long running tests.
189 With --no-buffer, commands have direct access to the terminal. Note
190 that as a result their output won't be captured in the log file.
191 You should use this option in conjunction with -j 1, to avoid
192 interleaving. Additionally you should use --verbose as well, to
193 make sure that commands are printed before they are being executed.
194 --no-config
196 Do not load the configuration file
197 --no-print-directory
199 Suppress "Entering directory" messages
200 --only-packages=PACKAGES
202 Ignore stanzas referring to a package that is not in PACKAGES.
203 PACKAGES is a comma-separated list of package names. Note that this
204 has the same effect as deleting the relevant stanzas from dune
205 files. It is mostly meant for releases. During development, it is
206 likely that what you want instead is to build a particular
207 <package>.install target.
208 -p PACKAGES, --for-release-of-packages=PACKAGES (required)
210 Shorthand for --release --only-packages PACKAGE. You must use this
211 option in your <package>.opam files, in order to build only what's
212 necessary when your project contains multiple packages as well as
213 getting reproducible builds.
214 --print-metrics
216 Print out various performance metrics after every build
217 --profile=VAL (absent DUNE_PROFILE env)
219 Select the build profile, for instance dev or release. The default
220 is dev.
221 --promote-install-files[=VAL] (default=true)
223 Promote the generated <package>.install files to the source tree
224 --release
226 Put dune into a reproducible release mode. This is in fact a
227 shorthand for --root . --ignore-promoted-rules --no-config
228 --profile release --always-show-command-line
229 --promote-install-files --default-target @install
230 --require-dune-project-file. You should use this option for release
231 builds. For instance, you must use this option in your
232 <package>.opam files. Except if you already use -p, as -p implies
233 this option.
234 --require-dune-project-file[=VAL] (default=true)
236 Fail if a dune-project file is missing.
237 --root=DIR
239 Use this directory as workspace root instead of guessing it. Note
240 that this option doesn't change the interpretation of targets given
241 on the command line. It is only intended for scripts.
242 --store-orig-source-dir (absent DUNE_STORE_ORIG_SOURCE_DIR env)
244 Store original source location in dune-package metadata
245 --terminal-persistence=MODE
247 Changes how the log of build results are displayed to the console
248 between rebuilds while in --watch mode. Supported modes: preserve,
249 clear-on-rebuild, clear-on-rebuild-and-flush-history.
250 --trace-file=FILE
252 Output trace data in catapult format (compatible with
253 chrome://tracing)
254 --verbose
256 Same as --display verbose
257 --version
259 Show version information.
260 --workspace=FILE (absent DUNE_WORKSPACE env)
262 Use this specific workspace file instead of looking it up.
263 -x VAL
265 Cross-compile using this toolchain.
266
268 Use `dune COMMAND --help' for help on a single command.
269
271 printenv exits with the following status:
272 0 on success.
274 123 on indiscriminate errors reported on standard error.
276 124 on command line parsing errors.
278 125 on unexpected internal errors (bugs).
280
282 These environment variables affect the execution of printenv:
283 DUNE_BUILD_DIR
285 Specified build directory. _build if unspecified
286 DUNE_CACHE
288 Enable or disable Dune cache (either enabled or disabled). Default
289 is `disabled'.
290 DUNE_CACHE_CHECK_PROBABILITY
292 Check build reproducibility by re-executing randomly chosen rules
293 and comparing their results with those stored in Dune cache. Note:
294 by increasing the probability of such checks you slow down the
295 build. The default probability is zero, i.e. no rules are checked.
296 DUNE_CACHE_STORAGE_MODE
298 Dune cache storage mode (one of auto, hardlink or copy). Default is
299 `auto'.
300 DUNE_DIFF_COMMAND
302 Shell command to use to diff files. Use - to disable printing the
303 diff.
304 DUNE_DISABLE_PROMOTION
306 Disable all promotion rules
307 DUNE_INSTRUMENT_WITH
309 "Enable instrumentation by BACKENDS. BACKENDS is a comma-separated
310 list of library names, each one of which must declare an
311 instrumentation backend.
312 DUNE_PROFILE
314 Build profile. dev if unspecified or release if -p is set.
315 DUNE_SANDBOX
317 Sandboxing mode to use by default. (see --sandbox)
318 DUNE_STORE_ORIG_SOURCE_DIR
320 Store original source location in dune-package metadata
321 DUNE_WORKSPACE
323 Use this specific workspace file instead of looking it up.
324
326 Check bug reports at https://github.com/ocaml/dune/issues
327
329 dune(1)
330Dune n/a DUNE-PRINTENV(1)