1dune-utop(1) Dune Manual dune-utop(1)
2
6 dune-utop - Load library in utop
7
9 dune utop [OPTION]... [DIR] [ARGS]...
10
12 dune utop DIR build and run utop toplevel with libraries defined in DIR
13
15 --build-info
16 Show build information.
17 --context=CONTEXT (absent=default)
19 Select context where to build/run utop.
20 -f, --force
22 Force actions associated to aliases to be re-executed even if their
23 dependencies haven't changed.
24 --help[=FMT] (default=auto)
26 Show this help in format FMT. The value FMT must be one of `auto',
27 `pager', `groff' or `plain'. With `auto', the format is `pager` or
28 `plain' whenever the TERM env var is `dumb' or undefined.
29 --sandbox=VAL (absent DUNE_SANDBOX env)
31 Sandboxing mode to use by default. Some actions require a certain
32 sandboxing mode, so they will ignore this setting. The allowed
33 values are: none, symlink, copy.
34 --version
36 Show version information.
37 -w, --watch
39 Instead of terminating build after completion, wait continuously
40 for file changes.
41
43 These options are common to all commands.
44 --always-show-command-line
46 Always show the full command lines of programs executed by dune
47 --auto-promote
49 Automatically promote files. This is similar to running dune
50 promote after the build.
51 --build-dir=FILE (absent DUNE_BUILD_DIR env)
53 Specified build directory. _build if unspecified
54 --cache=VAL (absent DUNE_CACHE env)
56 Activate binary cache (either `disabled' or `enabled'). Default is
57 `disabled'.
58 --cache-check-probability=VAL (absent=0. or
60 DUNE_CACHE_CHECK_PROBABILITY env)
61 Probability cached rules are rerun to check for reproducibility
62 --cache-duplication=VAL (absent DUNE_CACHE_DUPLICATION env)
64 Binary cache duplication mode
65 --cache-transport=VAL (absent DUNE_CACHE_TRANSPORT env)
67 Binary cache protocol
68 --config-file=FILE
70 Load this configuration file instead of the default one.
71 --debug-artifact-substitution
73 Print debugging info about artifact substitution
74 --debug-backtraces
76 Always print exception backtraces.
77 --debug-dependency-path
79 In case of error, print the dependency path from the targets on the
80 command line to the rule that failed.
81 --debug-findlib
83 Debug the findlib sub-system.
84 --default-target=TARGET (absent=@@default)
86 Set the default target that when none is specified to dune build.
87 --diff-command=VAL
89 Shell command to use to diff files. Use - to disable printing the
90 diff.
91 --disable-promotion (absent DUNE_DISABLE_PROMOTION env)
93 Disable all promotion rules
94 --display=MODE
96 Control the display mode of Dune. See dune-config(5) for more
97 details.
98 --ignore-promoted-rules
100 Ignore rules with (mode promote), except ones with (only ...). The
101 variable %{ignoring_promoted_rules} in dune files reflects whether
102 this option was passed or not.
103 --instrument-with=BACKENDS (absent DUNE_INSTRUMENT_WITH env)
105 "Enable instrumentation by BACKENDS. BACKENDS is a comma-separated
106 list of library names, each one of which must declare an
107 instrumentation backend.
108 -j JOBS
110 Run no more than JOBS commands simultaneously.
111 --no-buffer
113 Do not buffer the output of commands executed by dune. By default
114 dune buffers the output of subcommands, in order to prevent
115 interleaving when multiple commands are executed in parallel.
116 However, this can be an issue when debugging long running tests.
117 With --no-buffer, commands have direct access to the terminal. Note
118 that as a result their output won't be captured in the log file.
119 You should use this option in conjunction with -j 1, to avoid
120 interleaving. Additionally you should use --verbose as well, to
121 make sure that commands are printed before they are being executed.
122 --no-config
124 Do not load the configuration file
125 --no-print-directory
127 Suppress "Entering directory" messages
128 --only-packages=PACKAGES
130 Ignore stanzas referring to a package that is not in PACKAGES.
131 PACKAGES is a comma-separated list of package names. Note that this
132 has the same effect as deleting the relevant stanzas from dune
133 files. It is mostly meant for releases. During development, it is
134 likely that what you want instead is to build a particular
135 <package>.install target.
136 -p PACKAGES, --for-release-of-packages=PACKAGES
138 Shorthand for --release --only-packages PACKAGE. You must use this
139 option in your <package>.opam files, in order to build only what's
140 necessary when your project contains multiple packages as well as
141 getting reproducible builds.
142 --profile=VAL (absent DUNE_PROFILE env)
144 Select the build profile, for instance dev or release. The default
145 is dev.
146 --promote-install-files
148 Promote the generated <package>.install files to the source tree
149 --release
151 Put dune into a reproducible release mode. This is in fact a
152 shorthand for --root . --ignore-promoted-rules --no-config
153 --profile release --always-show-command-line
154 --promote-install-files --default-target @install. You should use
155 this option for release builds. For instance, you must use this
156 option in your <package>.opam files. Except if you already use -p,
157 as -p implies this option.
158 --root=DIR
160 Use this directory as workspace root instead of guessing it. Note
161 that this option doesn't change the interpretation of targets given
162 on the command line. It is only intended for scripts.
163 --store-orig-source-dir (absent DUNE_STORE_ORIG_SOURCE_DIR env)
165 Store original source location in dune-package metadata
166 --terminal-persistence=MODE
168 Changes how the log of build results are displayed to the console
169 between rebuilds while in --watch mode.
170 --trace-file=FILE
172 Output trace data in catapult format (compatible with
173 chrome://tracing)
174 --verbose
176 Same as --display verbose
177 --workspace=FILE (absent DUNE_WORKSPACE env)
179 Use this specific workspace file instead of looking it up.
180 -x VAL
182 Cross-compile using this toolchain.
183
185 Use `dune COMMAND --help' for help on a single command.
186
188 These environment variables affect the execution of utop:
189 DUNE_BUILD_DIR
191 Specified build directory. _build if unspecified
192 DUNE_CACHE
194 Activate binary cache (either `disabled' or `enabled'). Default is
195 `disabled'.
196 DUNE_CACHE_CHECK_PROBABILITY
198 Probability cached rules are rerun to check for reproducibility
199 DUNE_CACHE_DUPLICATION
201 Binary cache duplication mode
202 DUNE_CACHE_TRANSPORT
204 Binary cache protocol
205 DUNE_DISABLE_PROMOTION
207 Disable all promotion rules
208 DUNE_INSTRUMENT_WITH
210 "Enable instrumentation by BACKENDS. BACKENDS is a comma-separated
211 list of library names, each one of which must declare an
212 instrumentation backend.
213 DUNE_PROFILE
215 Build profile. dev if unspecified or release if -p is set.
216 DUNE_SANDBOX
218 Sandboxing mode to use by default. (see --sandbox)
219 DUNE_STORE_ORIG_SOURCE_DIR
221 Store original source location in dune-package metadata
222 DUNE_WORKSPACE
224 Use this specific workspace file instead of looking it up.
225
227 Check bug reports at https://github.com/ocaml/dune/issues
228Dune n/a dune-utop(1)