forked from ocaml/opam
-
Notifications
You must be signed in to change notification settings - Fork 4
/
opam-switch.1
137 lines (137 loc) · 5.89 KB
/
opam-switch.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
.\" Pipe this output to groff -man -Tutf8 | less
.\"
.TH "OPAM-SWITCH" 1 "" "Opam 1.0.0" "Opam Manual"
.\" Disable hyphenantion and ragged-right
.nh
.ad l
.SH NAME
.P
opam\-switch \- Manage multiple installation of compilers.
.SH SYNOPSIS
.P
\fBopam switch\fR [\fIOPTION\fR]... [\fICOMMAND\fR] [\fIARG\fR]...
.SH DESCRIPTION
.P
This command allows to switch between different compiler versions, installing the compiler if \fBopam switch\fR is used to switch to that compiler for the first time. The different compiler versions are totally independant from each other, meaning that OPAM maintains a separate state (e.g. list of installed packages...) for each.
.P
See the documentation of \fBopam switch list\fR to see the compilers which are available, and how to switch or to install a new one.
.SH ARGUMENTS
.TP 4
\fICOMMAND\fR
Name of the sub\-command. See the \fBCOMMANDS\fR section for more info. If a compiler switch is given instead of an usual command, this command will switch to the given compiler. You will then need to run \fBeval `opam config env`\fR to update your environment variables.
.SH OPTIONS
.TP 4
\fB\-a\fR \fICOMP\fR, \fB\-\-alias\-of\fR=\fICOMP\fR
The name of the compiler description which will be aliased.
.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\-\-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\-f\fR \fIFILENAME\fR, \fB\-\-filename\fR=\fIFILENAME\fR
The name of the file to export to/import from.
.TP 4
\fB\-\-fake\fR
WARNING: This option is fo testing purposes only! Using this option without care is the best way to corrupt your current compiler environement. When using this option OPAM will run a dry\-run of the solver and then fake the build and install commands
.TP 4
\fB\-i\fR, \fB\-\-installed\fR
List installed packages only.
.TP 4
\fB\-m\fR \fIMAKE\fR, \fB\-\-make\fR=\fIMAKE\fR
Use \fIMAKE\fR as the default 'make' command.
.TP 4
\fB\-n\fR, \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\-\-no\-warning\fR
Do not display any warning related to environment variables.
.TP 4
\fB\-s\fR, \fB\-\-short\fR
Output the names separated by one whitespace instead of using the usual formatting.
.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.
.SH COMMANDS
.TP 4
\fBinstall\fR
Install the given compiler. The commands fails if the package is already installed (e.g. it will not transparently switch to the installed compiler switch, as \fBopam switch <name>\fR does).
.TP 4
\fBremove\fR
Remove the given compiler.
.TP 4
\fBexport\fR
Export the list installed package to a file.
.TP 4
\fBimport\fR
Install the packages from a file.
.TP 4
\fBreinstall\fR
Reinstall the given compiler switch. This will also try reinstall the installed packages.
.TP 4
\fBlist\fR
List the available compilers. The first column displays the switch name (if any), the second one the switch state (C = current, I = installed, \-\- = not installed), the third one the compiler name and the last one the compiler description. To switch to an already installed compiler alias (with state = I), use \fBopam switch <name>\fR. If you want to use a new compiler <comp>, use \fBopam switch <comp>\fR: this will download, compile and create a fresh and independant environment where new packages can be installed. If you want to create a new compiler alias (for instance because you already have this compiler version installed), use \fBopam switch <name> \-\-alias\-of <comp>\fR. In case <name> and <comp> are the same, this is equivalent to \fBopam switch <comp>\fR.
.TP 4
\fBshow\fR
Show the current compiler.
.SH COMMON OPTIONS
.P
These options are common to all commands.
.TP 4
\fB\-\-debug\fR
Print debug message on stdout. This is equivalent to setting \fB$OPAMDEBUG\fR to a value greater or equal to 2.
.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\-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=/Users/tgazagna/.opam)
Use \fIROOT\fR as the current root path. This is equivalent to setting \fB$OPAMROOT\fR to \fIROOT\fR.
.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 either \fB$OPAMDEBUG\fR to a value greater or equal to 1 or \fB$OPAMVERBOSE\fR to a non\-empty string.
.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 FURTHER DOCUMENTATION
.P
See http://opam.ocamlpro.com.
.SH AUTHORS
.P
Thomas Gazagnaire <thomas.gazagnaire@ocamlpro.com>
.sp -1
.P
Frederic Tuong <tuong@users.gforge.inria.fr>
.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/OCamlPro/opam/issues.