.\" Pipe this output to groff -man -Tutf8 | less .\" .TH "OPAM-INSTALL" 1 "" "Opam 1.2.0" "Opam Manual" .\" Disable hyphenantion and ragged-right .nh .ad l .SH NAME .P opam\-install \- Install a list of packages. .SH SYNOPSIS .P \fBopam install\fR [\fIOPTION\fR]... \fIPACKAGES\fR... .SH DESCRIPTION .P This command installs one or more packages to the currently selected compiler. To install packages for another compiler, you need to switch compilers using \fBopam switch\fR. You can remove installed packages with \fBopam remove\fR, and list installed packages with \fBopam list \-i\fR. See \fBopam pin\fR as well to understand how to manage package versions. .P This command makes OPAM use the dependency solver to compute the transitive closure of dependencies to be installed, and will also handle conflicts. If the dependency solver returns more than one solution, OPAM will arbitrarily select the first one. If dependencies are to be installed, OPAM will confirm if the installation should proceed. .SH ARGUMENTS .TP 4 \fIPACKAGES\fR List of package names, with an optional version or constraint, e.g `pkg', `pkg.1.0' or `pkg>=0.5'. .SH OPTIONS .TP 4 \fB\-b\fR, \fB\-\-keep\-build\-dir\fR Keep the build directory. This is equivalent to setting \fB$OPAMKEEPBUILDDIR\fR to "true". .TP 4 \fB\-d\fR, \fB\-\-build\-doc\fR Build the package documentation. This is equivalent to setting \fB$OPAMBUILDDOC\fR to "true". .TP 4 \fB\-\-deps\-only\fR Install all its dependencies, but don't actually install the package. .TP 4 \fB\-\-dry\-run\fR Simulate the command, but don't actually perform any changes. .TP 4 \fB\-e\fR \fITAGS\fR, \fB\-\-external\fR=\fITAGS\fR Display the external packages associated to the given tags. .TP 4 \fB\-\-fake\fR This option registers the actions into the OPAM database, without actually performing them. WARNING: This option is dangerous and likely to break your OPAM environment. You probably want `\-\-dry\-run'. You've been warned. .TP 4 \fB\-j\fR \fIJOBS\fR, \fB\-\-jobs\fR=\fIJOBS\fR Set the maximal number of concurrent jobs to use. You can also set it using the \fB$OPAMJOBS\fR environment variable. .TP 4 \fB\-\-json\fR=\fIFILENAME\fR Save the result output of an OPAM run in a computer\-readable file .TP 4 \fB\-m\fR \fIMAKE\fR, \fB\-\-make\fR=\fIMAKE\fR Use \fIMAKE\fR as the default 'make' command. .TP 4 \fB\-\-no\-checksums\fR Do not verify the checksum of downloaded archives.This is equivalent to setting \fB$OPAMNOCHECKSUMS\fR to "true". .TP 4 \fB\-\-require\-checksums\fR Reject the installation of packages that don't provide a checksum for the upstream archives. This is equivalent to setting \fB$OPAMREQUIRECHECKSUMS\fR to "true". .TP 4 \fB\-\-set\-root\fR Mark given packages as installed roots. This is the default for newly manually\-installed packages. .TP 4 \fB\-\-show\-actions\fR Call the solver and display the actions. Don't perform any changes. .TP 4 \fB\-t\fR, \fB\-\-build\-test\fR Build and \fBrun\fR the package unit\-tests. This is equivalent to setting \fB$OPAMBUILDTEST\fR to "true". .TP 4 \fB\-\-unset\-root\fR Mark given packages as "installed automatically". .SH COMMON OPTIONS .P These options are common to all commands. .TP 4 \fB\-\-color\fR=\fIWHEN\fR (absent=auto) Colorize the output. \fIWHEN\fR must be `always', `never' or `auto'. .TP 4 \fB\-\-compat\-mode\-1.0\fR Compatibility mode with OPAM 1.0 .TP 4 \fB\-\-criteria\fR=\fICRITERIA\fR Specify user \fIpreferences\fR for dependency solving for this run. Overrides both \fB$OPAMCRITERIA\fR and \fB$OPAMUPGRADECRITERIA\fR. For details on the supported language, and the external solvers available, see \fI http://opam.ocaml.org/doc/Specifying_Solver_Preferences.html\fR. A general guide to using solver preferences can be found at \fI http://www.dicosmo.org/Articles/usercriteria.pdf\fR. The default value is \-count(down),\-count(removed),\-notuptodate(solution),\-count(new) for upgrades, and \-count(removed),\-notuptodate(request),\-count(down),\-notuptodate(changed),\-count(changed),\-notuptodate(solution) otherwise. .TP 4 \fB\-\-cudf\fR=\fIFILENAME\fR Debug option: Save the CUDF requests sent to the solver to \fIFILENAME\fR\-.cudf. .TP 4 \fB\-\-debug\fR Print debug message to stderr. This is equivalent to setting \fB$OPAMDEBUG\fR to "true". .TP 4 \fB\-\-debug\-level\fR=\fILEVEL\fR Like `\-\-debug', but allows specifying the debug level (`\-\-debug' sets it to 1). Equivalent to setting \fB$OPAMDEBUG\fR to a positive integer. .TP 4 \fB\-\-git\-version\fR Print the git version if it exists and exit. .TP 4 \fB\-\-help\fR[=\fIFMT\fR] (default=pager) Show this help in format \fIFMT\fR (pager, plain or groff). .TP 4 \fB\-\-no\-base\-packages\fR Do not install base packages (useful for testing purposes). This is equivalent to setting \fB$OPAMNOBASEPACKAGES\fR to a non\-empty string. .TP 4 \fB\-\-no\-self\-upgrade\fR OPAM will replace itself with a newer binary found at \fBOPAMROOT/opam\fR if present. This disables this behaviour. .TP 4 \fB\-q\fR, \fB\-\-quiet\fR Be quiet when installing a new compiler. .TP 4 \fB\-\-root\fR=\fIROOT\fR (absent=~/.opam) Use \fIROOT\fR as the current root path. This is equivalent to setting \fB$OPAMROOT\fR to \fIROOT\fR. .TP 4 \fB\-\-safe\fR Make sure nothing will be automatically updated or rewritten. Useful for calling from completion scripts, for example. Will fail whenever such an operation is needed ; also avoids waiting for locks, skips interactive questions and overrides the OPAMDEBUG variable. .TP 4 \fB\-\-solver\fR=\fICMD\fR Specify the name of the external dependency \fIsolver\fR. The default value is aspcud .TP 4 \fB\-\-strict\fR Fail whenever an error is found in a package definition or a configuration file. The default is to continue silently if possible. .TP 4 \fB\-\-switch\fR=\fISWITCH\fR Use \fISWITCH\fR as the current compiler switch. This is equivalent to setting \fB$OPAMSWITCH\fR to \fISWITCH\fR. .TP 4 \fB\-\-use\-internal\-solver\fR, \fB\-\-no\-aspcud\fR Force use of internal heuristics, even if an external solver is available. .TP 4 \fB\-v\fR, \fB\-\-verbose\fR Be more verbose. Show output of all sub\-commands. This is equivalent to setting \fB$OPAMVERBOSE\fR to "true". .TP 4 \fB\-\-version\fR Show version information. .TP 4 \fB\-y\fR, \fB\-\-yes\fR Disable interactive mode and answer yes to all questions that would otherwise be asked to the user. This is equivalent to setting \fB$OPAMYES\fR to "true". .SH ENVIRONMENT VARIABLES .P OPAM makes use of the environment variables listed here. Boolean variables should be set to "0", "no" of "false" to disable, "1", "yes" or "true" to enable. .P \fIOPAMCOLOR\fR, when set to \fIalways\fR or \fInever\fR, sets a default value for the \-\-color option. .P \fIOPAMCRITERIA\fR specifies user \fIpreferences\fR for dependency solving.The default value is \-count(removed),\-notuptodate(request),\-count(down),\-notuptodate(changed),\-count(changed),\-notuptodate(solution). See also option \-\-criteria .P \fIOPAMCURL\fR can be used to define an alternative for the 'curl' command\-line utility to download files. .P \fIOPAMDEBUG\fR see options `\-\-debug' and `\-\-debug\-level'. .P \fIOPAMEXTERNALSOLVER\fR see option `\-\-solver'. .P \fIOPAMJOBS\fR sets the maximum number of parallel workers to run. .P \fIOPAMNOASPCUD\fR see option `\-\-no\-aspcud'. .P \fIOPAMNOSELFUPGRADE\fR see option `\-\-no\-self\-upgrade'. .P \fIOPAMROOT\fR see option `\-\-root'. This is automatically set by `opam config env \-\-root=DIR' when DIR is non\-default. .P \fIOPAMSOLVERTIMEOUT\fR change the time allowance of the internal solver. .P \fIOPAMSWITCH\fR see option `\-\-switch'. Automatically set by `opam config env \-\-switch=SWITCH'. .P \fIOPAMUPGRADECRITERIA\fR specifies user \fIpreferences\fR for dependency solving when performing an upgrade. Overrides \fIOPAMCRITERIA\fR in upgrades if both are set.The default value is \-count(down),\-count(removed),\-notuptodate(solution),\-count(new). See also option \-\-criteria .P \fIOPAMUTF8MSGS\fR use nice UTF8 characters in OPAM messages. .P \fIOPAMVERBOSE\fR see option `\-\-verbose'. .P \fIOPAMVAR_var\fR overrides the contents of the variable \fIvar\fR when substituting `%{var}%` strings in `opam` files. .P \fIOPAMVAR_package_var\fR overrides the contents of the variable \fIpackage:var\fR when substituting `%{package:var}%` strings in `opam` files. .P \fIOPAMUSEINTERNALSOLVER\fR see option `\-\-use\-internal\-solver'. .P \fIOPAMYES\fR see option `\-\-yes'. .SH FURTHER DOCUMENTATION .P See https://opam.ocaml.org. .SH AUTHORS .P Thomas Gazagnaire .sp -1 .P Anil Madhavapeddy .sp -1 .P Fabrice Le Fessant .sp -1 .P Frederic Tuong .sp -1 .P Louis Gesbert .sp -1 .P Vincent Bernardoff .sp -1 .P Guillem Rieu .sp -1 .P Roberto Di Cosmo .SH BUGS .P Check bug reports at https://github.com/ocaml/opam/issues.