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 --sandbox=VAL (absent DUNE_SANDBOX env)
50 Sandboxing mode to use by default. Some actions require a certain
51 sandboxing mode, so they will ignore this setting. The allowed
52 values are: none, symlink, copy.
53 --sections=VAL
55 sections that should be installed
56 --version
58 Show version information.
59 -w, --watch
61 Instead of terminating build after completion, wait continuously
62 for file changes.
63
65 These options are common to all commands.
66 --always-show-command-line
68 Always show the full command lines of programs executed by dune
69 --auto-promote
71 Automatically promote files. This is similar to running dune
72 promote after the build.
73 --build-dir=FILE (absent DUNE_BUILD_DIR env)
75 Specified build directory. _build if unspecified
76 --cache=VAL (absent DUNE_CACHE env)
78 Activate binary cache (either `disabled' or `enabled'). Default is
79 `disabled'.
80 --cache-check-probability=VAL (absent=0. or
82 DUNE_CACHE_CHECK_PROBABILITY env)
83 Probability cached rules are rerun to check for reproducibility
84 --cache-duplication=VAL (absent DUNE_CACHE_DUPLICATION env)
86 Binary cache duplication mode
87 --cache-transport=VAL (absent DUNE_CACHE_TRANSPORT env)
89 Binary cache protocol
90 --config-file=FILE
92 Load this configuration file instead of the default one.
93 --debug-artifact-substitution
95 Print debugging info about artifact substitution
96 --debug-backtraces
98 Always print exception backtraces.
99 --debug-dependency-path
101 In case of error, print the dependency path from the targets on the
102 command line to the rule that failed.
103 --debug-findlib
105 Debug the findlib sub-system.
106 --default-target=TARGET (absent=@@default)
108 Set the default target that when none is specified to dune build.
109 --diff-command=VAL
111 Shell command to use to diff files. Use - to disable printing the
112 diff.
113 --disable-promotion (absent DUNE_DISABLE_PROMOTION env)
115 Disable all promotion rules
116 --display=MODE
118 Control the display mode of Dune. See dune-config(5) for more
119 details.
120 --ignore-promoted-rules
122 Ignore rules with (mode promote), except ones with (only ...). The
123 variable %{ignoring_promoted_rules} in dune files reflects whether
124 this option was passed or not.
125 --instrument-with=BACKENDS (absent DUNE_INSTRUMENT_WITH env)
127 "Enable instrumentation by BACKENDS. BACKENDS is a comma-separated
128 list of library names, each one of which must declare an
129 instrumentation backend.
130 -j JOBS
132 Run no more than JOBS commands simultaneously.
133 --no-buffer
135 Do not buffer the output of commands executed by dune. By default
136 dune buffers the output of subcommands, in order to prevent
137 interleaving when multiple commands are executed in parallel.
138 However, this can be an issue when debugging long running tests.
139 With --no-buffer, commands have direct access to the terminal. Note
140 that as a result their output won't be captured in the log file.
141 You should use this option in conjunction with -j 1, to avoid
142 interleaving. Additionally you should use --verbose as well, to
143 make sure that commands are printed before they are being executed.
144 --no-config
146 Do not load the configuration file
147 --no-print-directory
149 Suppress "Entering directory" messages
150 --only-packages=PACKAGES
152 Ignore stanzas referring to a package that is not in PACKAGES.
153 PACKAGES is a comma-separated list of package names. Note that this
154 has the same effect as deleting the relevant stanzas from dune
155 files. It is mostly meant for releases. During development, it is
156 likely that what you want instead is to build a particular
157 <package>.install target.
158 -p PACKAGES, --for-release-of-packages=PACKAGES
160 Shorthand for --release --only-packages PACKAGE. You must use this
161 option in your <package>.opam files, in order to build only what's
162 necessary when your project contains multiple packages as well as
163 getting reproducible builds.
164 --profile=VAL (absent DUNE_PROFILE env)
166 Select the build profile, for instance dev or release. The default
167 is dev.
168 --promote-install-files
170 Promote the generated <package>.install files to the source tree
171 --release
173 Put dune into a reproducible release mode. This is in fact a
174 shorthand for --root . --ignore-promoted-rules --no-config
175 --profile release --always-show-command-line
176 --promote-install-files --default-target @install. You should use
177 this option for release builds. For instance, you must use this
178 option in your <package>.opam files. Except if you already use -p,
179 as -p implies this option.
180 --root=DIR
182 Use this directory as workspace root instead of guessing it. Note
183 that this option doesn't change the interpretation of targets given
184 on the command line. It is only intended for scripts.
185 --store-orig-source-dir (absent DUNE_STORE_ORIG_SOURCE_DIR env)
187 Store original source location in dune-package metadata
188 --terminal-persistence=MODE
190 Changes how the log of build results are displayed to the console
191 between rebuilds while in --watch mode.
192 --trace-file=FILE
194 Output trace data in catapult format (compatible with
195 chrome://tracing)
196 --verbose
198 Same as --display verbose
199 --workspace=FILE (absent DUNE_WORKSPACE env)
201 Use this specific workspace file instead of looking it up.
202 -x VAL
204 Cross-compile using this toolchain.
205
207 Use `dune COMMAND --help' for help on a single command.
208
210 These environment variables affect the execution of install:
211 DESTDIR
213 See option --destdir.
214 DUNE_BUILD_DIR
216 Specified build directory. _build if unspecified
217 DUNE_CACHE
219 Activate binary cache (either `disabled' or `enabled'). Default is
220 `disabled'.
221 DUNE_CACHE_CHECK_PROBABILITY
223 Probability cached rules are rerun to check for reproducibility
224 DUNE_CACHE_DUPLICATION
226 Binary cache duplication mode
227 DUNE_CACHE_TRANSPORT
229 Binary cache protocol
230 DUNE_DISABLE_PROMOTION
232 Disable all promotion rules
233 DUNE_INSTRUMENT_WITH
235 "Enable instrumentation by BACKENDS. BACKENDS is a comma-separated
236 list of library names, each one of which must declare an
237 instrumentation backend.
238 DUNE_PROFILE
240 Build profile. dev if unspecified or release if -p is set.
241 DUNE_SANDBOX
243 Sandboxing mode to use by default. (see --sandbox)
244 DUNE_STORE_ORIG_SOURCE_DIR
246 Store original source location in dune-package metadata
247 DUNE_WORKSPACE
249 Use this specific workspace file instead of looking it up.
250
252 Check bug reports at https://github.com/ocaml/dune/issues
253Dune n/a dune-install(1)