1dune-external-lib-deps(1) Dune Manual dune-external-lib-deps(1)
2
6 dune-external-lib-deps - Print out external libraries needed to build
7 the given targets.
8
10 dune external-lib-deps [OPTION]... TARGET...
11
13 Print out the external libraries needed to build the given targets.
14 The output of dune external-lib-deps @install should be included in
16 what is written in your <package>.opam file.
17
19 --build-info
20 Show build information.
21 -f, --force
23 Force actions associated to aliases to be re-executed even if their
24 dependencies haven't changed.
25 --help[=FMT] (default=auto)
27 Show this help in format FMT. The value FMT must be one of `auto',
28 `pager', `groff' or `plain'. With `auto', the format is `pager` or
29 `plain' whenever the TERM env var is `dumb' or undefined.
30 --missing
32 Only print out missing dependencies
33 --sandbox=VAL (absent DUNE_SANDBOX env)
35 Sandboxing mode to use by default. Some actions require a certain
36 sandboxing mode, so they will ignore this setting. The allowed
37 values are: none, symlink, copy.
38 --sexp
40 Produce a s-expression output
41 --unstable-by-dir
43 Print dependencies per directory (this feature is currently
44 unstable)
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 --cache=VAL (absent DUNE_CACHE env)
67 Activate binary cache (either `disabled' or `enabled'). Default is
68 `disabled'.
69 --cache-check-probability=VAL (absent=0. or
71 DUNE_CACHE_CHECK_PROBABILITY env)
72 Probability cached rules are rerun to check for reproducibility
73 --cache-duplication=VAL (absent DUNE_CACHE_DUPLICATION env)
75 Binary cache duplication mode
76 --cache-transport=VAL (absent DUNE_CACHE_TRANSPORT env)
78 Binary cache protocol
79 --config-file=FILE
81 Load this configuration file instead of the default one.
82 --debug-artifact-substitution
84 Print debugging info about artifact substitution
85 --debug-backtraces
87 Always print exception backtraces.
88 --debug-dependency-path
90 In case of error, print the dependency path from the targets on the
91 command line to the rule that failed.
92 --debug-findlib
94 Debug the findlib sub-system.
95 --default-target=TARGET (absent=@@default)
97 Set the default target that when none is specified to dune build.
98 --diff-command=VAL
100 Shell command to use to diff files. Use - to disable printing the
101 diff.
102 --disable-promotion (absent DUNE_DISABLE_PROMOTION env)
104 Disable all promotion rules
105 --display=MODE
107 Control the display mode of Dune. See dune-config(5) for more
108 details.
109 --ignore-promoted-rules
111 Ignore rules with (mode promote), except ones with (only ...). The
112 variable %{ignoring_promoted_rules} in dune files reflects whether
113 this option was passed or not.
114 --instrument-with=BACKENDS (absent DUNE_INSTRUMENT_WITH env)
116 "Enable instrumentation by BACKENDS. BACKENDS is a comma-separated
117 list of library names, each one of which must declare an
118 instrumentation backend.
119 -j JOBS
121 Run no more than JOBS commands simultaneously.
122 --no-buffer
124 Do not buffer the output of commands executed by dune. By default
125 dune buffers the output of subcommands, in order to prevent
126 interleaving when multiple commands are executed in parallel.
127 However, this can be an issue when debugging long running tests.
128 With --no-buffer, commands have direct access to the terminal. Note
129 that as a result their output won't be captured in the log file.
130 You should use this option in conjunction with -j 1, to avoid
131 interleaving. Additionally you should use --verbose as well, to
132 make sure that commands are printed before they are being executed.
133 --no-config
135 Do not load the configuration file
136 --no-print-directory
138 Suppress "Entering directory" messages
139 --only-packages=PACKAGES
141 Ignore stanzas referring to a package that is not in PACKAGES.
142 PACKAGES is a comma-separated list of package names. Note that this
143 has the same effect as deleting the relevant stanzas from dune
144 files. It is mostly meant for releases. During development, it is
145 likely that what you want instead is to build a particular
146 <package>.install target.
147 -p PACKAGES, --for-release-of-packages=PACKAGES
149 Shorthand for --release --only-packages PACKAGE. You must use this
150 option in your <package>.opam files, in order to build only what's
151 necessary when your project contains multiple packages as well as
152 getting reproducible builds.
153 --profile=VAL (absent DUNE_PROFILE env)
155 Select the build profile, for instance dev or release. The default
156 is dev.
157 --promote-install-files
159 Promote the generated <package>.install files to the source tree
160 --release
162 Put dune into a reproducible release mode. This is in fact a
163 shorthand for --root . --ignore-promoted-rules --no-config
164 --profile release --always-show-command-line
165 --promote-install-files --default-target @install. You should use
166 this option for release builds. For instance, you must use this
167 option in your <package>.opam files. Except if you already use -p,
168 as -p implies this option.
169 --root=DIR
171 Use this directory as workspace root instead of guessing it. Note
172 that this option doesn't change the interpretation of targets given
173 on the command line. It is only intended for scripts.
174 --store-orig-source-dir (absent DUNE_STORE_ORIG_SOURCE_DIR env)
176 Store original source location in dune-package metadata
177 --terminal-persistence=MODE
179 Changes how the log of build results are displayed to the console
180 between rebuilds while in --watch mode.
181 --trace-file=FILE
183 Output trace data in catapult format (compatible with
184 chrome://tracing)
185 --verbose
187 Same as --display verbose
188 --workspace=FILE (absent DUNE_WORKSPACE env)
190 Use this specific workspace file instead of looking it up.
191 -x VAL
193 Cross-compile using this toolchain.
194
196 Use `dune COMMAND --help' for help on a single command.
197
199 These environment variables affect the execution of external-lib-deps:
200 DUNE_BUILD_DIR
202 Specified build directory. _build if unspecified
203 DUNE_CACHE
205 Activate binary cache (either `disabled' or `enabled'). Default is
206 `disabled'.
207 DUNE_CACHE_CHECK_PROBABILITY
209 Probability cached rules are rerun to check for reproducibility
210 DUNE_CACHE_DUPLICATION
212 Binary cache duplication mode
213 DUNE_CACHE_TRANSPORT
215 Binary cache protocol
216 DUNE_DISABLE_PROMOTION
218 Disable all promotion rules
219 DUNE_INSTRUMENT_WITH
221 "Enable instrumentation by BACKENDS. BACKENDS is a comma-separated
222 list of library names, each one of which must declare an
223 instrumentation backend.
224 DUNE_PROFILE
226 Build profile. dev if unspecified or release if -p is set.
227 DUNE_SANDBOX
229 Sandboxing mode to use by default. (see --sandbox)
230 DUNE_STORE_ORIG_SOURCE_DIR
232 Store original source location in dune-package metadata
233 DUNE_WORKSPACE
235 Use this specific workspace file instead of looking it up.
236
238 Check bug reports at https://github.com/ocaml/dune/issues
239Dune n/a dune-external-lib-deps(1)