1DUNE-OCAML-MERLIN(1) Dune Manual DUNE-OCAML-MERLIN(1)
2
6 dune-ocaml-merlin - Start a merlin configuration server
7
9 dune ocaml-merlin [OPTION]...
10
12 dune ocaml-merlin starts a server that can be queried to get .merlin
13 information. It is meant to be used by Merlin itself and does not
14 provide a user-friendly output.
15
17 --build-info
18 Show build information.
19 --dump-config=VAL
21 Prints the entire content of the merlin configuration for the given
22 folder in a user friendly form. This is for testing and debugging
23 purposes only and should not be considered as a stable ouptut.
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 --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 --version
40 Show version information.
41 -w, --watch
43 Instead of terminating build after completion, wait continuously
44 for file changes.
45
47 These options are common to all commands.
48 --always-show-command-line
50 Always show the full command lines of programs executed by dune
51 --auto-promote
53 Automatically promote files. This is similar to running dune
54 promote after the build.
55 --build-dir=FILE (absent DUNE_BUILD_DIR env)
57 Specified build directory. _build if unspecified
58 --cache=VAL (absent DUNE_CACHE env)
60 Activate binary cache (either `disabled' or `enabled'). Default is
61 `disabled'.
62 --cache-check-probability=VAL (absent=0. or
64 DUNE_CACHE_CHECK_PROBABILITY env)
65 Probability cached rules are rerun to check for reproducibility
66 --cache-duplication=VAL (absent DUNE_CACHE_DUPLICATION env)
68 Binary cache duplication mode
69 --cache-transport=VAL (absent DUNE_CACHE_TRANSPORT env)
71 Binary cache protocol
72 --config-file=FILE
74 Load this configuration file instead of the default one.
75 --debug-artifact-substitution
77 Print debugging info about artifact substitution
78 --debug-backtraces
80 Always print exception backtraces.
81 --debug-dependency-path
83 In case of error, print the dependency path from the targets on the
84 command line to the rule that failed.
85 --debug-findlib
87 Debug the findlib sub-system.
88 --default-target=TARGET (absent=@@default)
90 Set the default target that when none is specified to dune build.
91 --diff-command=VAL
93 Shell command to use to diff files. Use - to disable printing the
94 diff.
95 --disable-promotion (absent DUNE_DISABLE_PROMOTION env)
97 Disable all promotion rules
98 --display=MODE
100 Control the display mode of Dune. See dune-config(5) for more
101 details.
102 --ignore-promoted-rules
104 Ignore rules with (mode promote), except ones with (only ...). The
105 variable %{ignoring_promoted_rules} in dune files reflects whether
106 this option was passed or not.
107 --instrument-with=BACKENDS (absent DUNE_INSTRUMENT_WITH env)
109 "Enable instrumentation by BACKENDS. BACKENDS is a comma-separated
110 list of library names, each one of which must declare an
111 instrumentation backend.
112 -j JOBS
114 Run no more than JOBS commands simultaneously.
115 --no-buffer
117 Do not buffer the output of commands executed by dune. By default
118 dune buffers the output of subcommands, in order to prevent
119 interleaving when multiple commands are executed in parallel.
120 However, this can be an issue when debugging long running tests.
121 With --no-buffer, commands have direct access to the terminal. Note
122 that as a result their output won't be captured in the log file.
123 You should use this option in conjunction with -j 1, to avoid
124 interleaving. Additionally you should use --verbose as well, to
125 make sure that commands are printed before they are being executed.
126 --no-config
128 Do not load the configuration file
129 --no-print-directory
131 Suppress "Entering directory" messages
132 --only-packages=PACKAGES
134 Ignore stanzas referring to a package that is not in PACKAGES.
135 PACKAGES is a comma-separated list of package names. Note that this
136 has the same effect as deleting the relevant stanzas from dune
137 files. It is mostly meant for releases. During development, it is
138 likely that what you want instead is to build a particular
139 <package>.install target.
140 -p PACKAGES, --for-release-of-packages=PACKAGES (required)
142 Shorthand for --release --only-packages PACKAGE. You must use this
143 option in your <package>.opam files, in order to build only what's
144 necessary when your project contains multiple packages as well as
145 getting reproducible builds.
146 --profile=VAL (absent DUNE_PROFILE env)
148 Select the build profile, for instance dev or release. The default
149 is dev.
150 --promote-install-files[=VAL] (default=true)
152 Promote the generated <package>.install files to the source tree
153 --release
155 Put dune into a reproducible release mode. This is in fact a
156 shorthand for --root . --ignore-promoted-rules --no-config
157 --profile release --always-show-command-line
158 --promote-install-files --default-target @install. You should use
159 this option for release builds. For instance, you must use this
160 option in your <package>.opam files. Except if you already use -p,
161 as -p implies this option.
162 --root=DIR
164 Use this directory as workspace root instead of guessing it. Note
165 that this option doesn't change the interpretation of targets given
166 on the command line. It is only intended for scripts.
167 --store-orig-source-dir (absent DUNE_STORE_ORIG_SOURCE_DIR env)
169 Store original source location in dune-package metadata
170 --terminal-persistence=MODE
172 Changes how the log of build results are displayed to the console
173 between rebuilds while in --watch mode. Supported modes: preserve,
174 clear-on-rebuild.
175 --trace-file=FILE
177 Output trace data in catapult format (compatible with
178 chrome://tracing)
179 --verbose
181 Same as --display verbose
182 --workspace=FILE (absent DUNE_WORKSPACE env)
184 Use this specific workspace file instead of looking it up.
185 -x VAL
187 Cross-compile using this toolchain.
188
190 Use `dune COMMAND --help' for help on a single command.
191
193 These environment variables affect the execution of ocaml-merlin:
194 DUNE_BUILD_DIR
196 Specified build directory. _build if unspecified
197 DUNE_CACHE
199 Activate binary cache (either `disabled' or `enabled'). Default is
200 `disabled'.
201 DUNE_CACHE_CHECK_PROBABILITY
203 Probability cached rules are rerun to check for reproducibility
204 DUNE_CACHE_DUPLICATION
206 Binary cache duplication mode
207 DUNE_CACHE_TRANSPORT
209 Binary cache protocol
210 DUNE_DISABLE_PROMOTION
212 Disable all promotion rules
213 DUNE_INSTRUMENT_WITH
215 "Enable instrumentation by BACKENDS. BACKENDS is a comma-separated
216 list of library names, each one of which must declare an
217 instrumentation backend.
218 DUNE_PROFILE
220 Build profile. dev if unspecified or release if -p is set.
221 DUNE_SANDBOX
223 Sandboxing mode to use by default. (see --sandbox)
224 DUNE_STORE_ORIG_SOURCE_DIR
226 Store original source location in dune-package metadata
227 DUNE_WORKSPACE
229 Use this specific workspace file instead of looking it up.
230
232 Check bug reports at https://github.com/ocaml/dune/issues
233
235 Check bug reports at https://github.com/ocaml/dune/issues
236Dune n/a DUNE-OCAML-MERLIN(1)