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

COMMON OPTIONS

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

MORE HELP

136       Use `dune COMMAND --help' for help on a single command.
137

ENVIRONMENT

139       These environment variables affect the execution of utop:
140
141       DUNE_BUILD_DIR
142           Specified build directory. _build if unspecified
143
144       DUNE_PROFILE
145           Build profile. dev if unspecified or release if -p is set.
146
147       DUNE_STORE_ORIG_SOURCE_DIR
148           Store original source location in dune-package metadata
149

BUGS

151       Check bug reports at https://github.com/ocaml/dune/issues
152
153
154
155Dune 11VERSION11                                                  dune-utop(1)