1dune-config(5)                    Dune manual                   dune-config(5)
2
3
4

NAME

6       dune-config - configuring the dune build system
7

SYNOPSIS

9       ~/.config/dune/config
10

DESCRIPTION

12       Unless --no-config or -p is passed, Dune will read a configuration file
13       from the user home directory. This file is used to control various
14       aspects of the behavior of Dune.
15
16       The configuration file is normally ~/.config/dune/config on Unix
17       systems and Local Settings/dune/config in the User home directory on
18       Windows. However, it is possible to specify an alternative
19       configuration file with the --config-file option.
20
21       The first line of the file must be of the form (lang dune X.Y) where
22       X.Y is the version of the dune language used in the file.
23
24       The rest of the file must be written in S-expression syntax and be
25       composed of a list of stanzas. The following sections describe the
26       stanzas available.
27

CACHING

29       Syntax: (cache ENABLED)
30
31        This stanza determines whether dune's build caching is enabled. See
32       https://dune.readthedocs.io/en/stable/caching.html for details. Valid
33       values for  ENABLED are  enabled or  disabled.
34

DISPLAY MODES

36       Syntax: (display MODE)
37
38       This stanza controls how Dune reports what it is doing to the user.
39       This parameter can also be set from the command line via --display
40       MODE. The following display modes are available:
41
42       progress
43           This is the default, Dune shows and update a status line as build
44           goals are being completed.
45
46       quiet
47           Only display errors.
48
49       short
50           Print one line per command being executed, with the binary name on
51           the left and the reason it is being executed for on the right.
52
53       verbose
54           Print the full command lines of programs being executed by Dune,
55           with some colors to help differentiate programs.
56
57       Note that when the selected display mode is progress and the output is
58       not a terminal then the quiet mode is selected instead. This rule
59       doesn't apply when running Dune inside Emacs. Dune detects whether it
60       is executed from inside Emacs or not by looking at the environment
61       variable INSIDE_EMACS that is set by Emacs. If you want the same
62       behavior with another editor, you can set this variable. If your editor
63       already sets another variable, please open a ticket on the ocaml/dune
64       GitHub project so that we can add support for it.
65

JOBS

67       Syntax: (jobs NUMBER)
68
69       Set the maximum number of jobs Dune might run in parallel. This can
70       also be set from the command line via -j NUMBER.
71
72       The default for this value is 4.
73

SANDBOXING

75       Syntax: (sandboxing_preference MODE ...)
76
77       Controls the sandboxing mode preference order used by dune. Dune will
78       use the earliest item from this list that's allowed by the action
79       dependency specification, or fall back on the hard-coded default. See
80       man dune-build for the description of individual modes.
81

BUGS

83       Check bug reports at https://github.com/ocaml/dune/issues
84
85
86
87Dune                                                            dune-config(5)
Impressum