1DUNE-DESCRIBE(1)                  Dune Manual                 DUNE-DESCRIBE(1)
2
3
4

NAME

6       dune-describe - Describe the workspace.
7

SYNOPSIS

9       dune describe [OPTION]... [STRING]...
10

DESCRIPTION

12       Describe what is in the current workspace in either human or machine
13       readable form. By default, this command output a human readable
14       description of the current workspace. This output is aimed at human and
15       is not suitable for machine processing. In particular, it is not
16       versioned. If you want to interpret the output of this command from a
17       program, you must use the --format option to specify a machine readable
18       format as well as the --lang option to get a stable output.
19

ARGUMENTS

21       STRING
22           What to describe. The syntax of this desciption is tied to the
23           version passed to --lang
24

OPTIONS

26       --build-info
27           Show build information.
28
29       --context=CONTEXT (absent=default)
30           Build context to use.
31
32       -f, --force
33           Force actions associated to aliases to be re-executed even if their
34           dependencies haven't changed.
35
36       --format=FORMAT (absent=sexp)
37           Output format.
38
39       --help[=FMT] (default=auto)
40           Show this help in format FMT. The value FMT must be one of `auto',
41           `pager', `groff' or `plain'. With `auto', the format is `pager` or
42           `plain' whenever the TERM env var is `dumb' or undefined.
43
44       --lang=VERSION (absent=0.1)
45           Behave the same as this version of Dune.
46
47       --sandbox=VAL (absent DUNE_SANDBOX env)
48           Sandboxing mode to use by default. Some actions require a certain
49           sandboxing mode, so they will ignore this setting. The allowed
50           values are: none, symlink, copy.
51
52       --version
53           Show version information.
54
55       -w, --watch
56           Instead of terminating build after completion, wait continuously
57           for file changes.
58

COMMON OPTIONS

60       These options are common to all commands.
61
62       --always-show-command-line
63           Always show the full command lines of programs executed by dune
64
65       --auto-promote
66           Automatically promote files. This is similar to running dune
67           promote after the build.
68
69       --build-dir=FILE (absent DUNE_BUILD_DIR env)
70           Specified build directory. _build if unspecified
71
72       --cache=VAL (absent DUNE_CACHE env)
73           Activate binary cache (either `disabled' or `enabled'). Default is
74           `disabled'.
75
76       --cache-check-probability=VAL (absent=0. or
77       DUNE_CACHE_CHECK_PROBABILITY env)
78           Probability cached rules are rerun to check for reproducibility
79
80       --cache-duplication=VAL (absent DUNE_CACHE_DUPLICATION env)
81           Binary cache duplication mode
82
83       --cache-transport=VAL (absent DUNE_CACHE_TRANSPORT env)
84           Binary cache protocol
85
86       --config-file=FILE
87           Load this configuration file instead of the default one.
88
89       --debug-artifact-substitution
90           Print debugging info about artifact substitution
91
92       --debug-backtraces
93           Always print exception backtraces.
94
95       --debug-dependency-path
96           In case of error, print the dependency path from the targets on the
97           command line to the rule that failed.
98
99       --debug-findlib
100           Debug the findlib sub-system.
101
102       --default-target=TARGET (absent=@@default)
103           Set the default target that when none is specified to dune build.
104
105       --diff-command=VAL
106           Shell command to use to diff files. Use - to disable printing the
107           diff.
108
109       --disable-promotion (absent DUNE_DISABLE_PROMOTION env)
110           Disable all promotion rules
111
112       --display=MODE
113           Control the display mode of Dune. See dune-config(5) for more
114           details.
115
116       --ignore-promoted-rules
117           Ignore rules with (mode promote), except ones with (only ...). The
118           variable %{ignoring_promoted_rules} in dune files reflects whether
119           this option was passed or not.
120
121       --instrument-with=BACKENDS (absent DUNE_INSTRUMENT_WITH env)
122           "Enable instrumentation by BACKENDS. BACKENDS is a comma-separated
123           list of library names, each one of which must declare an
124           instrumentation backend.
125
126       -j JOBS
127           Run no more than JOBS commands simultaneously.
128
129       --no-buffer
130           Do not buffer the output of commands executed by dune. By default
131           dune buffers the output of subcommands, in order to prevent
132           interleaving when multiple commands are executed in parallel.
133           However, this can be an issue when debugging long running tests.
134           With --no-buffer, commands have direct access to the terminal. Note
135           that as a result their output won't be captured in the log file.
136           You should use this option in conjunction with -j 1, to avoid
137           interleaving. Additionally you should use --verbose as well, to
138           make sure that commands are printed before they are being executed.
139
140       --no-config
141           Do not load the configuration file
142
143       --no-print-directory
144           Suppress "Entering directory" messages
145
146       --only-packages=PACKAGES
147           Ignore stanzas referring to a package that is not in PACKAGES.
148           PACKAGES is a comma-separated list of package names. Note that this
149           has the same effect as deleting the relevant stanzas from dune
150           files. It is mostly meant for releases. During development, it is
151           likely that what you want instead is to build a particular
152           <package>.install target.
153
154       -p PACKAGES, --for-release-of-packages=PACKAGES (required)
155           Shorthand for --release --only-packages PACKAGE. You must use this
156           option in your <package>.opam files, in order to build only what's
157           necessary when your project contains multiple packages as well as
158           getting reproducible builds.
159
160       --profile=VAL (absent DUNE_PROFILE env)
161           Select the build profile, for instance dev or release. The default
162           is dev.
163
164       --promote-install-files[=VAL] (default=true)
165           Promote the generated <package>.install files to the source tree
166
167       --release
168           Put dune into a reproducible release mode. This is in fact a
169           shorthand for --root . --ignore-promoted-rules --no-config
170           --profile release --always-show-command-line
171           --promote-install-files --default-target @install. You should use
172           this option for release builds. For instance, you must use this
173           option in your <package>.opam files. Except if you already use -p,
174           as -p implies this option.
175
176       --root=DIR
177           Use this directory as workspace root instead of guessing it. Note
178           that this option doesn't change the interpretation of targets given
179           on the command line. It is only intended for scripts.
180
181       --store-orig-source-dir (absent DUNE_STORE_ORIG_SOURCE_DIR env)
182           Store original source location in dune-package metadata
183
184       --terminal-persistence=MODE
185           Changes how the log of build results are displayed to the console
186           between rebuilds while in --watch mode. Supported modes: preserve,
187           clear-on-rebuild.
188
189       --trace-file=FILE
190           Output trace data in catapult format (compatible with
191           chrome://tracing)
192
193       --verbose
194           Same as --display verbose
195
196       --workspace=FILE (absent DUNE_WORKSPACE env)
197           Use this specific workspace file instead of looking it up.
198
199       -x VAL
200           Cross-compile using this toolchain.
201

MORE HELP

203       Use `dune COMMAND --help' for help on a single command.
204

ENVIRONMENT

206       These environment variables affect the execution of describe:
207
208       DUNE_BUILD_DIR
209           Specified build directory. _build if unspecified
210
211       DUNE_CACHE
212           Activate binary cache (either `disabled' or `enabled'). Default is
213           `disabled'.
214
215       DUNE_CACHE_CHECK_PROBABILITY
216           Probability cached rules are rerun to check for reproducibility
217
218       DUNE_CACHE_DUPLICATION
219           Binary cache duplication mode
220
221       DUNE_CACHE_TRANSPORT
222           Binary cache protocol
223
224       DUNE_DISABLE_PROMOTION
225           Disable all promotion rules
226
227       DUNE_INSTRUMENT_WITH
228           "Enable instrumentation by BACKENDS. BACKENDS is a comma-separated
229           list of library names, each one of which must declare an
230           instrumentation backend.
231
232       DUNE_PROFILE
233           Build profile. dev if unspecified or release if -p is set.
234
235       DUNE_SANDBOX
236           Sandboxing mode to use by default. (see --sandbox)
237
238       DUNE_STORE_ORIG_SOURCE_DIR
239           Store original source location in dune-package metadata
240
241       DUNE_WORKSPACE
242           Use this specific workspace file instead of looking it up.
243

BUGS

245       Check bug reports at https://github.com/ocaml/dune/issues
246
247
248
249Dune n/a                                                      DUNE-DESCRIBE(1)
Impressum