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