1DUNE-INSTALL(1) Dune Manual DUNE-INSTALL(1)
2
6 dune-install - Install packages.
7
9 dune install [OPTION]... [PACKAGE]...
10
12 --build-info
13 Show build information.
14 --context=CONTEXT
16 Select context to install from. By default, install files from all
17 defined contexts.
18 --destdir=PATH (absent DESTDIR env)
20 When passed, this directory is prepended to all installed paths.
21 --dry-run
23 Only display the file operations that would be performed.
24 -f, --force
26 Force actions associated to aliases to be re-executed even if their
27 dependencies haven't changed.
28 --help[=FMT] (default=auto)
30 Show this help in format FMT. The value FMT must be one of `auto',
31 `pager', `groff' or `plain'. With `auto', the format is `pager` or
32 `plain' whenever the TERM env var is `dumb' or undefined.
33 --libdir=PATH
35 Directory where library files are copied, relative to prefix or
36 absolute. If --prefix is specified the default is $prefix/lib,
37 otherwise it is the output of ocamlfind printconf destdir
38 --mandir=PATH
40 When passed, manually override the directory to install man pages
41 --prefix=PREFIX
43 Directory where files are copied. For instance binaries are copied
44 into $prefix/bin, library files into $prefix/lib, etc... It
45 defaults to the current opam prefix if opam is available and
46 configured, otherwise it uses the same prefix as the ocaml
47 compiler.
48 --relocatable
50 Make the binaries relocatable (the installation directory can be
51 moved).
52 --sandbox=VAL (absent DUNE_SANDBOX env)
54 Sandboxing mode to use by default. Some actions require a certain
55 sandboxing mode, so they will ignore this setting. The allowed
56 values are: none, symlink, copy.
57 --sections=VAL
59 sections that should be installed
60 --version
62 Show version information.
63 -w, --watch
65 Instead of terminating build after completion, wait continuously
66 for file changes.
67
69 These options are common to all commands.
70 --always-show-command-line
72 Always show the full command lines of programs executed by dune
73 --auto-promote
75 Automatically promote files. This is similar to running dune
76 promote after the build.
77 --build-dir=FILE (absent DUNE_BUILD_DIR env)
79 Specified build directory. _build if unspecified
80 --cache=VAL (absent DUNE_CACHE env)
82 Activate binary cache (either `disabled' or `enabled'). Default is
83 `disabled'.
84 --cache-check-probability=VAL (absent=0. or
86 DUNE_CACHE_CHECK_PROBABILITY env)
87 Probability cached rules are rerun to check for reproducibility
88 --cache-duplication=VAL (absent DUNE_CACHE_DUPLICATION env)
90 Binary cache duplication mode
91 --cache-transport=VAL (absent DUNE_CACHE_TRANSPORT env)
93 Binary cache protocol
94 --config-file=FILE
96 Load this configuration file instead of the default one.
97 --debug-artifact-substitution
99 Print debugging info about artifact substitution
100 --debug-backtraces
102 Always print exception backtraces.
103 --debug-dependency-path
105 In case of error, print the dependency path from the targets on the
106 command line to the rule that failed.
107 --debug-findlib
109 Debug the findlib sub-system.
110 --default-target=TARGET (absent=@@default)
112 Set the default target that when none is specified to dune build.
113 --diff-command=VAL
115 Shell command to use to diff files. Use - to disable printing the
116 diff.
117 --disable-promotion (absent DUNE_DISABLE_PROMOTION env)
119 Disable all promotion rules
120 --display=MODE
122 Control the display mode of Dune. See dune-config(5) for more
123 details.
124 --ignore-promoted-rules
126 Ignore rules with (mode promote), except ones with (only ...). The
127 variable %{ignoring_promoted_rules} in dune files reflects whether
128 this option was passed or not.
129 --instrument-with=BACKENDS (absent DUNE_INSTRUMENT_WITH env)
131 "Enable instrumentation by BACKENDS. BACKENDS is a comma-separated
132 list of library names, each one of which must declare an
133 instrumentation backend.
134 -j JOBS
136 Run no more than JOBS commands simultaneously.
137 --no-buffer
139 Do not buffer the output of commands executed by dune. By default
140 dune buffers the output of subcommands, in order to prevent
141 interleaving when multiple commands are executed in parallel.
142 However, this can be an issue when debugging long running tests.
143 With --no-buffer, commands have direct access to the terminal. Note
144 that as a result their output won't be captured in the log file.
145 You should use this option in conjunction with -j 1, to avoid
146 interleaving. Additionally you should use --verbose as well, to
147 make sure that commands are printed before they are being executed.
148 --no-config
150 Do not load the configuration file
151 --no-print-directory
153 Suppress "Entering directory" messages
154 --only-packages=PACKAGES
156 Ignore stanzas referring to a package that is not in PACKAGES.
157 PACKAGES is a comma-separated list of package names. Note that this
158 has the same effect as deleting the relevant stanzas from dune
159 files. It is mostly meant for releases. During development, it is
160 likely that what you want instead is to build a particular
161 <package>.install target.
162 -p PACKAGES, --for-release-of-packages=PACKAGES
164 Shorthand for --release --only-packages PACKAGE. You must use this
165 option in your <package>.opam files, in order to build only what's
166 necessary when your project contains multiple packages as well as
167 getting reproducible builds.
168 --profile=VAL (absent DUNE_PROFILE env)
170 Select the build profile, for instance dev or release. The default
171 is dev.
172 --promote-install-files
174 Promote the generated <package>.install files to the source tree
175 --release
177 Put dune into a reproducible release mode. This is in fact a
178 shorthand for --root . --ignore-promoted-rules --no-config
179 --profile release --always-show-command-line
180 --promote-install-files --default-target @install. You should use
181 this option for release builds. For instance, you must use this
182 option in your <package>.opam files. Except if you already use -p,
183 as -p implies this option.
184 --root=DIR
186 Use this directory as workspace root instead of guessing it. Note
187 that this option doesn't change the interpretation of targets given
188 on the command line. It is only intended for scripts.
189 --store-orig-source-dir (absent DUNE_STORE_ORIG_SOURCE_DIR env)
191 Store original source location in dune-package metadata
192 --terminal-persistence=MODE
194 Changes how the log of build results are displayed to the console
195 between rebuilds while in --watch mode. Supported modes: preserve,
196 clear-on-rebuild.
197 --trace-file=FILE
199 Output trace data in catapult format (compatible with
200 chrome://tracing)
201 --verbose
203 Same as --display verbose
204 --workspace=FILE (absent DUNE_WORKSPACE env)
206 Use this specific workspace file instead of looking it up.
207 -x VAL
209 Cross-compile using this toolchain.
210
212 Use `dune COMMAND --help' for help on a single command.
213
215 These environment variables affect the execution of install:
216 DESTDIR
218 See option --destdir.
219 DUNE_BUILD_DIR
221 Specified build directory. _build if unspecified
222 DUNE_CACHE
224 Activate binary cache (either `disabled' or `enabled'). Default is
225 `disabled'.
226 DUNE_CACHE_CHECK_PROBABILITY
228 Probability cached rules are rerun to check for reproducibility
229 DUNE_CACHE_DUPLICATION
231 Binary cache duplication mode
232 DUNE_CACHE_TRANSPORT
234 Binary cache protocol
235 DUNE_DISABLE_PROMOTION
237 Disable all promotion rules
238 DUNE_INSTRUMENT_WITH
240 "Enable instrumentation by BACKENDS. BACKENDS is a comma-separated
241 list of library names, each one of which must declare an
242 instrumentation backend.
243 DUNE_PROFILE
245 Build profile. dev if unspecified or release if -p is set.
246 DUNE_SANDBOX
248 Sandboxing mode to use by default. (see --sandbox)
249 DUNE_STORE_ORIG_SOURCE_DIR
251 Store original source location in dune-package metadata
252 DUNE_WORKSPACE
254 Use this specific workspace file instead of looking it up.
255
257 Check bug reports at https://github.com/ocaml/dune/issues
258Dune n/a DUNE-INSTALL(1)