.\" Pipe this output to groff -Tutf8 | less .\" .mso an.tmac .TH "dune-install" 1 "" "Dune 1.6.2" "Dune Manual" .\" Disable hyphenation and ragged-right .nh .ad l .SH NAME .P dune\N'45'install \N'45' Install packages\N'46' .SH SYNOPSIS .P \fBdune install\fR [\fIOPTION\fR]\N'46'\N'46'\N'46' [\fIPACKAGE\fR]\N'46'\N'46'\N'46' .SH OPTIONS .TP 4 \fB\N'45'\N'45'destdir\fR=\fIPATH\fR (absent \fBDESTDIR\fR env) When passed, this directory is prepended to all installed paths\N'46' .TP 4 \fB\N'45'\N'45'dry\N'45'run\fR Only display the file operations that would be performed\N'46' .TP 4 \fB\N'45'f\fR, \fB\N'45'\N'45'force\fR Force actions associated to aliases to be re\N'45'executed even if their dependencies haven\N'39't changed\N'46' .TP 4 \fB\N'45'\N'45'help\fR[=\fIFMT\fR] (default=auto) Show this help in format \fIFMT\fR\N'46' The value \fIFMT\fR must be one of `auto\N'39', `pager\N'39', `groff\N'39' or `plain\N'39'\N'46' With `auto\N'39', the format is `pager` or `plain\N'39' whenever the \fBTERM\fR env var is `dumb\N'39' or undefined\N'46' .TP 4 \fB\N'45'\N'45'libdir\fR=\fIPATH\fR Directory where library files are copied, relative to \fBprefix\fR or absolute\N'46' If \fB\N'45'\N'45'prefix\fR is specified the default is \fI$prefix/lib\fR, otherwise it is the output of \fBocamlfind printconf destdir\fR .TP 4 \fB\N'45'\N'45'prefix\fR=\fIPREFIX\fR Directory where files are copied\N'46' For instance binaries are copied into \fI$prefix/bin\fR, library files into \fI$prefix/lib\fR, etc\N'46'\N'46'\N'46' It defaults to the current opam prefix if opam is available and configured, otherwise it uses the same prefix as the ocaml compiler\N'46' .TP 4 \fB\N'45'\N'45'version\fR Show version information\N'46' .TP 4 \fB\N'45'w\fR, \fB\N'45'\N'45'watch\fR Instead of terminating build after completion, wait continuously for file changes\N'46' .SH COMMON OPTIONS .P These options are common to all commands\N'46' .TP 4 \fB\N'45'\N'45'auto\N'45'promote\fR Automatically promote files\N'46' This is similar to running \fBdune promote\fR after the build\N'46' .TP 4 \fB\N'45'\N'45'build\N'45'dir\fR=\fIFILE\fR (absent \fBDUNE_BUILD_DIR\fR env) Specified build directory\N'46' _build if unspecified .TP 4 \fB\N'45'\N'45'config\N'45'file\fR=\fIFILE\fR Load this configuration file instead of the default one\N'46' .TP 4 \fB\N'45'\N'45'debug\N'45'backtraces\fR Always print exception backtraces\N'46' .TP 4 \fB\N'45'\N'45'debug\N'45'dependency\N'45'path\fR In case of error, print the dependency path from the targets on the command line to the rule that failed\N'46' .TP 4 \fB\N'45'\N'45'debug\N'45'findlib\fR Debug the findlib sub\N'45'system\N'46' .TP 4 \fB\N'45'\N'45'default\N'45'target\fR=\fITARGET\fR Set the default target that when none is specified to \fBdune build\fR\N'46' It defaults to @@default\N'46' .TP 4 \fB\N'45'\N'45'dev\fR Same as \fB\N'45'\N'45'profile dev\fR .TP 4 \fB\N'45'\N'45'diff\N'45'command\fR=\fIVAL\fR Shell command to use to diff files\N'46' Use \N'45' to disable printing the diff\N'46' .TP 4 \fB\N'45'\N'45'display\fR=\fIMODE\fR Control the display mode of Dune\N'46' See \fBdune\N'45'config(5)\fR for more details\N'46' .TP 4 \fB\N'45'\N'45'ignore\N'45'promoted\N'45'rules\fR Ignore rules with (mode promote) .TP 4 \fB\N'45'j\fR \fIJOBS\fR Run no more than \fIJOBS\fR commands simultaneously\N'46' .TP 4 \fB\N'45'\N'45'no\N'45'buffer\fR Do not buffer the output of commands executed by dune\N'46' By default dune buffers the output of subcommands, in order to prevent interleaving when multiple commands are executed in parallel\N'46' However, this can be an issue when debugging long running tests\N'46' With \fB\N'45'\N'45'no\N'45'buffer\fR, commands have direct access to the terminal\N'46' Note that as a result their output won\N'39't be captured in the log file\N'46' You should use this option in conjunction with \fB\N'45'j 1\fR, to avoid interleaving\N'46' Additionally you should use \fB\N'45'\N'45'verbose\fR as well, to make sure that commands are printed before they are being executed\N'46' .TP 4 \fB\N'45'\N'45'no\N'45'config\fR Do not load the configuration file .TP 4 \fB\N'45'\N'45'only\N'45'packages\fR=\fIPACKAGES\fR Ignore stanzas referring to a package that is not in \fBPACKAGES\fR\N'46' \fBPACKAGES\fR is a comma\N'45'separated list of package names\N'46' Note that this has the same effect as deleting the relevant stanzas from jbuild files\N'46' It is mostly meant for releases\N'46' During development, it is likely that what you want instead is to build a particular \fB\N'46'install\fR target\N'46' .TP 4 \fB\N'45'p\fR \fIPACKAGES\fR, \fB\N'45'\N'45'for\N'45'release\N'45'of\N'45'packages\fR=\fIPACKAGES\fR Shorthand for \fB\N'45'\N'45'root \N'46' \N'45'\N'45'only\N'45'packages PACKAGE \N'45'\N'45'ignore\N'45'promoted\N'45'rules \N'45'\N'45'no\N'45'config \N'45'\N'45'profile release\fR\N'46' You must use this option in your \fI\N'46'opam\fR files, in order to build only what\N'39's necessary when your project contains multiple packages as well as getting reproducible builds\N'46' .TP 4 \fB\N'45'\N'45'profile\fR=\fIVAL\fR Select the build profile, for instance \fBdev\fR or \fBrelease\fR\N'46' The default is \fBdev\fR\N'46' .TP 4 \fB\N'45'\N'45'root\fR=\fIDIR\fR Use this directory as workspace root instead of guessing it\N'46' Note that this option doesn\N'39't change the interpretation of targets given on the command line\N'46' It is only intended for scripts\N'46' .TP 4 \fB\N'45'\N'45'stats\fR Record and print statistics about Dune resource usage\N'46' .TP 4 \fB\N'45'\N'45'verbose\fR Same as \fB\N'45'\N'45'display verbose\fR .TP 4 \fB\N'45'\N'45'workspace\fR=\fIFILE\fR Use this specific workspace file instead of looking it up\N'46' .TP 4 \fB\N'45'x\fR \fIVAL\fR Cross\N'45'compile using this toolchain\N'46' .SH MORE HELP .P Use `\fBdune\fR \fICOMMAND\fR \N'45'\N'45'help\N'39' for help on a single command\N'46' .SH ENVIRONMENT .P These environment variables affect the execution of \fBinstall\fR: .TP 4 \fBDESTDIR\fR See option \fB\N'45'\N'45'destdir\fR\N'46' .TP 4 \fBDUNE_BUILD_DIR\fR Specified build directory\N'46' _build if unspecified .SH BUGS .P Check bug reports at https://github\N'46'com/ocaml/dune/issues