1dune-utop(1)                      Dune Manual                     dune-utop(1)
2
3
4

NAME

6       dune-utop - Load library in utop
7

SYNOPSIS

9       dune utop [OPTION]... [DIR] [ARGS]...
10

DESCRIPTION

12       dune utop DIR build and run utop toplevel with libraries defined in DIR
13

OPTIONS

15       --build-info
16           Show build information.
17
18       --context=CONTEXT (absent=default)
19           Select context where to build/run utop.
20
21       -f, --force
22           Force actions associated to aliases to be re-executed even if their
23           dependencies haven't changed.
24
25       --help[=FMT] (default=auto)
26           Show this help in format FMT. The value FMT must be one of `auto',
27           `pager', `groff' or `plain'. With `auto', the format is `pager` or
28           `plain' whenever the TERM env var is `dumb' or undefined.
29
30       --version
31           Show version information.
32
33       -w, --watch
34           Instead of terminating build after completion, wait continuously
35           for file changes.
36

COMMON OPTIONS

38       These options are common to all commands.
39
40       --always-show-command-line
41           Always show the full command lines of programs executed by dune
42
43       --auto-promote
44           Automatically promote files. This is similar to running dune
45           promote after the build.
46
47       --build-dir=FILE (absent DUNE_BUILD_DIR env)
48           Specified build directory. _build if unspecified
49
50       --config-file=FILE
51           Load this configuration file instead of the default one.
52
53       --debug-backtraces
54           Always print exception backtraces.
55
56       --debug-dependency-path
57           In case of error, print the dependency path from the targets on the
58           command line to the rule that failed.
59
60       --debug-findlib
61           Debug the findlib sub-system.
62
63       --default-target=TARGET (absent=@@default)
64           Set the default target that when none is specified to dune build.
65
66       --dev
67           Same as --profile dev
68
69       --diff-command=VAL
70           Shell command to use to diff files. Use - to disable printing the
71           diff.
72
73       --display=MODE
74           Control the display mode of Dune. See dune-config(5) for more
75           details.
76
77       --ignore-promoted-rules
78           Ignore rules with (mode promote), except ones with (only ...). The
79           variable %{ignoring_promoted_rules} in dune files reflects whether
80           this option was passed or not.
81
82       -j JOBS
83           Run no more than JOBS commands simultaneously.
84
85       --no-buffer
86           Do not buffer the output of commands executed by dune. By default
87           dune buffers the output of subcommands, in order to prevent
88           interleaving when multiple commands are executed in parallel.
89           However, this can be an issue when debugging long running tests.
90           With --no-buffer, commands have direct access to the terminal. Note
91           that as a result their output won't be captured in the log file.
92           You should use this option in conjunction with -j 1, to avoid
93           interleaving. Additionally you should use --verbose as well, to
94           make sure that commands are printed before they are being executed.
95
96       --no-config
97           Do not load the configuration file
98
99       --no-print-directory
100           Suppress "Entering directory" messages
101
102       --only-packages=PACKAGES
103           Ignore stanzas referring to a package that is not in PACKAGES.
104           PACKAGES is a comma-separated list of package names. Note that this
105           has the same effect as deleting the relevant stanzas from jbuild
106           files. It is mostly meant for releases. During development, it is
107           likely that what you want instead is to build a particular
108           <package>.install target.
109
110       -p PACKAGES, --for-release-of-packages=PACKAGES
111           Shorthand for --root . --only-packages PACKAGE
112           --ignore-promoted-rules --no-config --profile release. You must use
113           this option in your <package>.opam files, in order to build only
114           what's necessary when your project contains multiple packages as
115           well as getting reproducible builds.
116
117       --profile=VAL (absent DUNE_PROFILE env)
118           Select the build profile, for instance dev or release. The default
119           is dev.
120
121       --root=DIR
122           Use this directory as workspace root instead of guessing it. Note
123           that this option doesn't change the interpretation of targets given
124           on the command line. It is only intended for scripts.
125
126       --store-orig-source-dir (absent DUNE_STORE_ORIG_SOURCE_DIR env)
127           Store original source location in dune-package metadata
128
129       --trace-file=FILE
130           Output trace data in catapult format (compatible with
131           chrome://tracing)
132
133       --verbose
134           Same as --display verbose
135
136       --workspace=FILE (absent DUNE_WORKSPACE env)
137           Use this specific workspace file instead of looking it up.
138
139       -x VAL
140           Cross-compile using this toolchain.
141

MORE HELP

143       Use `dune COMMAND --help' for help on a single command.
144

ENVIRONMENT

146       These environment variables affect the execution of utop:
147
148       DUNE_BUILD_DIR
149           Specified build directory. _build if unspecified
150
151       DUNE_PROFILE
152           Build profile. dev if unspecified or release if -p is set.
153
154       DUNE_STORE_ORIG_SOURCE_DIR
155           Store original source location in dune-package metadata
156
157       DUNE_WORKSPACE
158           Use this specific workspace file instead of looking it up.
159

BUGS

161       Check bug reports at https://github.com/ocaml/dune/issues
162
163
164
165Dune n/a                                                          dune-utop(1)
Impressum