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-backtraces
73 Always print exception backtraces.
74 --debug-dependency-path
76 In case of error, print the dependency path from the targets on the
77 command line to the rule that failed.
78 --debug-findlib
80 Debug the findlib sub-system.
81 --default-target=TARGET (absent=@@default)
83 Set the default target that when none is specified to dune build.
84 --diff-command=VAL
86 Shell command to use to diff files. Use - to disable printing the
87 diff.
88 --disable-promotion (absent DUNE_DISABLE_PROMOTION env)
90 Disable all promotion rules
91 --display=MODE
93 Control the display mode of Dune. See dune-config(5) for more
94 details.
95 --ignore-promoted-rules
97 Ignore rules with (mode promote), except ones with (only ...). The
98 variable %{ignoring_promoted_rules} in dune files reflects whether
99 this option was passed or not.
100 -j JOBS
102 Run no more than JOBS commands simultaneously.
103 --no-buffer
105 Do not buffer the output of commands executed by dune. By default
106 dune buffers the output of subcommands, in order to prevent
107 interleaving when multiple commands are executed in parallel.
108 However, this can be an issue when debugging long running tests.
109 With --no-buffer, commands have direct access to the terminal. Note
110 that as a result their output won't be captured in the log file.
111 You should use this option in conjunction with -j 1, to avoid
112 interleaving. Additionally you should use --verbose as well, to
113 make sure that commands are printed before they are being executed.
114 --no-config
116 Do not load the configuration file
117 --no-print-directory
119 Suppress "Entering directory" messages
120 --only-packages=PACKAGES
122 Ignore stanzas referring to a package that is not in PACKAGES.
123 PACKAGES is a comma-separated list of package names. Note that this
124 has the same effect as deleting the relevant stanzas from dune
125 files. It is mostly meant for releases. During development, it is
126 likely that what you want instead is to build a particular
127 <package>.install target.
128 -p PACKAGES, --for-release-of-packages=PACKAGES
130 Shorthand for --release --only-packages PACKAGE. You must use this
131 option in your <package>.opam files, in order to build only what's
132 necessary when your project contains multiple packages as well as
133 getting reproducible builds.
134 --profile=VAL (absent DUNE_PROFILE env)
136 Select the build profile, for instance dev or release. The default
137 is dev.
138 --promote-install-files
140 Promote the generated <package>.install files to the source tree
141 --release
143 Put dune into a reproducible release mode. This is in fact a
144 shorthand for --root . --ignore-promoted-rules --no-config
145 --profile release --always-show-command-line
146 --promote-install-files --default-target @install. You should use
147 this option for release builds. For instance, you must use this
148 option in your <package>.opam files. Except if you already use -p,
149 as -p implies this option.
150 --root=DIR
152 Use this directory as workspace root instead of guessing it. Note
153 that this option doesn't change the interpretation of targets given
154 on the command line. It is only intended for scripts.
155 --store-orig-source-dir (absent DUNE_STORE_ORIG_SOURCE_DIR env)
157 Store original source location in dune-package metadata
158 --terminal-persistence=MODE
160 Changes how the log of build results are displayed to the console
161 between rebuilds while in --watch mode.
162 --trace-file=FILE
164 Output trace data in catapult format (compatible with
165 chrome://tracing)
166 --verbose
168 Same as --display verbose
169 --workspace=FILE (absent DUNE_WORKSPACE env)
171 Use this specific workspace file instead of looking it up.
172 -x VAL
174 Cross-compile using this toolchain.
175
177 Use `dune COMMAND --help' for help on a single command.
178
180 These environment variables affect the execution of utop:
181 DUNE_BUILD_DIR
183 Specified build directory. _build if unspecified
184 DUNE_CACHE
186 Activate binary cache (either `disabled' or `enabled'). Default is
187 `disabled'.
188 DUNE_CACHE_CHECK_PROBABILITY
190 Probability cached rules are rerun to check for reproducibility
191 DUNE_CACHE_DUPLICATION
193 Binary cache duplication mode
194 DUNE_CACHE_TRANSPORT
196 Binary cache protocol
197 DUNE_DISABLE_PROMOTION
199 Disable all promotion rules
200 DUNE_PROFILE
202 Build profile. dev if unspecified or release if -p is set.
203 DUNE_SANDBOX
205 Sandboxing mode to use by default. (see --sandbox)
206 DUNE_STORE_ORIG_SOURCE_DIR
208 Store original source location in dune-package metadata
209 DUNE_WORKSPACE
211 Use this specific workspace file instead of looking it up.
212
214 Check bug reports at https://github.com/ocaml/dune/issues
215Dune n/a dune-utop(1)