forked from ocaml/opam
/
opam-install.1
161 lines (161 loc) · 6.05 KB
/
opam-install.1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
.\" Pipe this output to groff -man -Tutf8 | less
.\"
.TH "OPAM-INSTALL" 1 "" "Opam 1.1.1" "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.
.SH OPTIONS
.TP 4
\fB\-b\fR, \fB\-\-keep\-build\-dir\fR
Keep the build directory. This is equivalent to setting \fB$OPAMKEEPBUILDIR\fR to a non\-empty string.
.TP 4
\fB\-\-cudf\fR=\fIFILENAME\fR
Save the CUDF request sent to the solver to \fIFILENAME\fR\-<n>.cudf.
.TP 4
\fB\-d\fR, \fB\-\-build\-doc\fR
Build the package documentation. This is equivalent to setting \fB$OPAMBUILDDOC\fR to a non\-empty string.
.TP 4
\fB\-\-deps\-only\fR
Install all its dependencies, but don't actually install the package.
.TP 4
\fB\-\-dry\-run\fR
Simply call the solver without actually performing any build/install operations.
.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
WARNING: This option is for testing purposes only! Using this option without care is the best way to corrupt your current compiler environment. When using this option OPAM will run a dry\-run of the solver and then fake the build and install commands.
.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 a non\-empty string.
.TP 4
\fB\-\-set\-root\fR
Mark given packages as installed roots. This is the default for newly manually\-installed packages.
.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 a non\-empty string.
.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\-\-debug\fR
Print debug message on stdout. This is equivalent to setting \fB$OPAMDEBUG\fR to a non\-empty value.
.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\-aspcud\fR
Do not use the external aspcud solver, even if available.
.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\-q\fR, \fB\-\-quiet\fR
Be quiet when installing a new compiler.
.TP 4
\fB\-r\fR \fIROOT\fR, \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\-\-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\-v\fR, \fB\-\-verbose\fR
Be more verbose. This is equivalent to setting \fB$OPAMVERBOSE\fR to a non\-empty value.
.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 a non\-empty string.
.SH ENVIRONMENT VARIABLES
.P
OPAM makes use of the environment variables listed here. Boolean variables are considered true when set to a non\-empty string.
.P
\fIOPAMCOLOR\fR, when set to \fIalways\fR or \fInever\fR, sets a default value for the \-\-color option.
.P
\fIOPAMCURL\fR can be used to define an alternative for the 'curl' command\-line utility to download files.
.P
\fIOPAMDEBUG\fR see option `\-\-debug'.
.P
\fIOPAMJOBS\fR sets the maximum number of parallel workers to run.
.P
\fIOPAMNOASPCUD\fR see option `\-\-no\-aspcud'.
.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
\fIOPAMUTF8MSGS\fR use nice UTF8 characters in OPAM messages.
.P
\fIOPAMVERBOSE\fR see option `\-\-verbose'.
.P
\fIOPAMYES\fR see option `\-\-yes'.
.SH FURTHER DOCUMENTATION
.P
See https://opam.ocaml.org.
.SH AUTHORS
.P
Thomas Gazagnaire <thomas@gazagnaire.org>
.sp -1
.P
Anil Madhavapeddy <anil@recoil.org>
.sp -1
.P
Fabrice Le Fessant <Fabrice.Le_fessant@inria.fr>
.sp -1
.P
Frederic Tuong <tuong@users.gforge.inria.fr>
.sp -1
.P
Louis Gesbert <louis.gesbert@ocamlpro.com>
.sp -1
.P
Vincent Bernardoff <vb@luminar.eu.org>
.sp -1
.P
Guillem Rieu <guillem.rieu@ocamlpro.com>
.SH BUGS
.P
Check bug reports at https://github.com/ocaml/opam/issues.