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 --prefix=PREFIX
40 Directory where files are copied. For instance binaries are copied
41 into $prefix/bin, library files into $prefix/lib, etc... It
42 defaults to the current opam prefix if opam is available and
43 configured, otherwise it uses the same prefix as the ocaml
44 compiler.
45 --version
47 Show version information.
48 -w, --watch
50 Instead of terminating build after completion, wait continuously
51 for file changes.
52
54 These options are common to all commands.
55 --always-show-command-line
57 Always show the full command lines of programs executed by dune
58 --auto-promote
60 Automatically promote files. This is similar to running dune
61 promote after the build.
62 --build-dir=FILE (absent DUNE_BUILD_DIR env)
64 Specified build directory. _build if unspecified
65 --config-file=FILE
67 Load this configuration file instead of the default one.
68 --debug-backtraces
70 Always print exception backtraces.
71 --debug-dependency-path
73 In case of error, print the dependency path from the targets on the
74 command line to the rule that failed.
75 --debug-findlib
77 Debug the findlib sub-system.
78 --default-target=TARGET (absent=@@default)
80 Set the default target that when none is specified to dune build.
81 --dev
83 Same as --profile dev
84 --diff-command=VAL
86 Shell command to use to diff files. Use - to disable printing the
87 diff.
88 --display=MODE
90 Control the display mode of Dune. See dune-config(5) for more
91 details.
92 --ignore-promoted-rules
94 Ignore rules with (mode promote), except ones with (only ...). The
95 variable %{ignoring_promoted_rules} in dune files reflects whether
96 this option was passed or not.
97 -j JOBS
99 Run no more than JOBS commands simultaneously.
100 --no-buffer
102 Do not buffer the output of commands executed by dune. By default
103 dune buffers the output of subcommands, in order to prevent
104 interleaving when multiple commands are executed in parallel.
105 However, this can be an issue when debugging long running tests.
106 With --no-buffer, commands have direct access to the terminal. Note
107 that as a result their output won't be captured in the log file.
108 You should use this option in conjunction with -j 1, to avoid
109 interleaving. Additionally you should use --verbose as well, to
110 make sure that commands are printed before they are being executed.
111 --no-config
113 Do not load the configuration file
114 --no-print-directory
116 Suppress "Entering directory" messages
117 --only-packages=PACKAGES
119 Ignore stanzas referring to a package that is not in PACKAGES.
120 PACKAGES is a comma-separated list of package names. Note that this
121 has the same effect as deleting the relevant stanzas from jbuild
122 files. It is mostly meant for releases. During development, it is
123 likely that what you want instead is to build a particular
124 <package>.install target.
125 -p PACKAGES, --for-release-of-packages=PACKAGES
127 Shorthand for --root . --only-packages PACKAGE
128 --ignore-promoted-rules --no-config --profile release. You must use
129 this option in your <package>.opam files, in order to build only
130 what's necessary when your project contains multiple packages as
131 well as getting reproducible builds.
132 --profile=VAL (absent DUNE_PROFILE env)
134 Select the build profile, for instance dev or release. The default
135 is dev.
136 --root=DIR
138 Use this directory as workspace root instead of guessing it. Note
139 that this option doesn't change the interpretation of targets given
140 on the command line. It is only intended for scripts.
141 --store-orig-source-dir (absent DUNE_STORE_ORIG_SOURCE_DIR env)
143 Store original source location in dune-package metadata
144 --trace-file=FILE
146 Output trace data in catapult format (compatible with
147 chrome://tracing)
148 --verbose
150 Same as --display verbose
151 --workspace=FILE (absent DUNE_WORKSPACE env)
153 Use this specific workspace file instead of looking it up.
154 -x VAL
156 Cross-compile using this toolchain.
157
159 Use `dune COMMAND --help' for help on a single command.
160
162 These environment variables affect the execution of install:
163 DESTDIR
165 See option --destdir.
166 DUNE_BUILD_DIR
168 Specified build directory. _build if unspecified
169 DUNE_PROFILE
171 Build profile. dev if unspecified or release if -p is set.
172 DUNE_STORE_ORIG_SOURCE_DIR
174 Store original source location in dune-package metadata
175 DUNE_WORKSPACE
177 Use this specific workspace file instead of looking it up.
178
180 Check bug reports at https://github.com/ocaml/dune/issues
181Dune n/a dune-install(1)