1opam-unpin(1) Opam Manual opam-unpin(1)
2
6 opam-unpin - An alias for pin remove.
7
9 opam unpin [OPTION]... [ARG]...
10
12 opam unpin is an alias for opam pin remove.
13 See opam pin --help for details.
15
17 -b, --keep-build-dir
18 Keep the build directories after compiling packages. This is
19 equivalent to setting $OPAMKEEPBUILDDIR to "true".
20 -d, --with-doc, --build-doc
22 Build the package documentation. This only affects packages listed
23 on the command-line. The --build-doc form is deprecated as this
24 does also installation. This is equivalent to setting $OPAMWITHDOC
25 (or the deprecated $OPAMBUILDDOC) to "true".
26 --dry-run
28 Simulate the command, but don't actually perform any changes.
29 --fake
31 This option registers the actions into the opam database, without
32 actually performing them. WARNING: This option is dangerous and
33 likely to break your opam environment. You probably want
34 `--dry-run'. You've been warned.
35 --ignore-constraints-on[=PACKAGES] (default=)
37 Forces opam to ignore version constraints on all dependencies to
38 the listed packages. This can be used to test compatibility, but
39 expect builds to break when using this. Note that version
40 constraints on optional dependencies and conflicts are unaffected.
41 --inplace-build
43 When compiling a package which has its source bound to a local
44 directory, process the build and install actions directly in that
45 directory, rather than in a clean copy handled by opam. This only
46 affects packages that are explicitly listed on the command-line.
47 This is equivalent to setting $OPAMINPLACEBUILD to "true".
48 --locked[=SUFFIX] (default=locked)
50 In commands that use opam files found from pinned sources, if a
51 variant of the file with an added .SUFFIX extension is found (e.g.
52 foo.opam.locked besides foo.opam), that will be used instead. This
53 is typically useful to offer a more specific set of dependencies
54 and reproduce similar build contexts, hence the name. The opam lock
55 plugin can be used to generate such files, based on the versions of
56 the dependencies currently installed on the host. This is
57 equivalent to setting the $OPAMLOCK environment variable. Note that
58 this option doesn't generally affect already pinned packages.
59 -m MAKE, --make=MAKE
61 Use MAKE as the default 'make' command. Deprecated: use opam config
62 set[-global] make MAKE instead. Has no effect if the make variable
63 is defined.
64 --no-checksums
66 Do not verify the checksum of downloaded archives.This is
67 equivalent to setting $OPAMNOCHECKSUMS to "true".
68 --require-checksums
70 Reject the installation of packages that don't provide a checksum
71 for the upstream archives. This is equivalent to setting
72 $OPAMREQUIRECHECKSUMS to "true".
73 --reuse-build-dir
75 Reuse existing build directories (kept by using --keep-build-dir),
76 instead of compiling from a fresh clone of the source. This can be
77 faster, but also lead to failures if the build systems of the
78 packages don't handle upgrades of dependencies well. This is
79 equivalent to setting $OPAMREUSEBUILDDIR to "true".
80 --show-actions
82 Call the solver and display the actions. Don't perform any changes.
83 --skip-updates
85 When running an install, upgrade or reinstall on source-pinned
86 packages, they are normally updated from their origin first. This
87 flag disables that behaviour and will keep them to their version in
88 cache.
89 -t, --with-test, --build-test
91 Build and run the package unit-tests. This only affects packages
92 listed on the command-line. The --build-test form is deprecated as
93 this also affects installation. This is equivalent to setting
94 $OPAMWITHTEST (or the deprecated $OPAMBUILDTEST) to "true".
95 --unlock-base
97 Allow changes to the packages set as switch base (typically, the
98 main compiler). Use with caution.
99
101 --dev-repo
102 Pin to the upstream package source for the latest development
103 version
104 -e, --edit
106 With opam pin add, edit the opam file as with `opam pin edit' after
107 pinning.
108 --help[=FMT] (default=auto)
110 Show this help in format FMT. The value FMT must be one of `auto',
111 `pager', `groff' or `plain'. With `auto', the format is `pager` or
112 `plain' whenever the TERM env var is `dumb' or undefined.
113 -j JOBS, --jobs=JOBS
115 Set the maximal number of concurrent jobs to use. The default value
116 is calculated from the number of cores. You can also set it using
117 the $OPAMJOBS environment variable.
118 -k KIND, --kind=KIND
120 Sets the kind of pinning. Must be one of one of `version', `path',
121 `http', `git', `darcs', `hg', `none' or `auto'. If unset or auto,
122 is inferred from the format of the target, defaulting to the
123 appropriate version control if one is detected in the given
124 directory, or to path otherwise. OPAMPINKINDAUTO can be set to "0"
125 to disable automatic detection of version control.Use none to pin
126 without a target (for virtual packages).
127 -n, --no-action
129 Just record the new pinning status, and don't prompt for
130 (re)installation or removal of affected packages.
131 -s, --short
133 Output raw lists of names, one per line, skipping any details.
134 --version
136 Show version information.
137
139 These options are common to all commands.
140 --best-effort
142 Don't fail if all requested packages can't be installed: try to
143 install as many as possible. Note that not all external solvers may
144 support this option (recent versions of aspcud or mccs should).
145 --color=WHEN
147 Colorize the output. WHEN must be one of `always', `never' or
148 `auto'.
149 --criteria=CRITERIA
151 Specify user preferences for dependency solving for this run.
152 Overrides both $OPAMCRITERIA and $OPAMUPGRADECRITERIA. For details
153 on the supported language, and the external solvers available, see
154 http://opam.ocaml.org/doc/Specifying_Solver_Preferences.html. A
155 general guide to using solver preferences can be found at
156 http://www.dicosmo.org/Articles/usercriteria.pdf.
157 --cudf=FILENAME
159 Debug option: Save the CUDF requests sent to the solver to
160 FILENAME-<n>.cudf.
161 --debug
163 Print debug message to stderr. This is equivalent to setting
164 $OPAMDEBUG to "true".
165 --debug-level=LEVEL
167 Like --debug, but allows specifying the debug level (--debug sets
168 it to 1). Equivalent to setting $OPAMDEBUG to a positive integer.
169 --git-version
171 Print the git version of opam, if set (i.e. you are using a
172 development version), and exit.
173 --ignore-pin-depends
175 Ignore extra pins required by packages that get pinned, either
176 manually through opam pin or through opam install DIR. This is
177 equivalent to setting IGNOREPINDEPENDS=true.
178 --json=FILENAME
180 Save the results of the opam run in a computer-readable file. If
181 the filename contains the character `%', it will be replaced by an
182 index that doesn't overwrite an existing file. Similar to setting
183 the $OPAMJSON variable.
184 --no-auto-upgrade
186 When configuring or updating a repository that is written for an
187 earlier opam version (1.2), opam internally converts it to the
188 current format. This disables this behaviour. Note that
189 repositories should define their format version in a 'repo' file at
190 their root, or they will be assumed to be in the older format. It
191 is, in any case, preferable to upgrade the repositories manually
192 using opam admin upgrade [--mirror URL] when possible.
193 --no-self-upgrade
195 Opam will replace itself with a newer binary found at OPAMROOT/opam
196 if present. This disables this behaviour.
197 -q, --quiet
199 Disables --verbose.
200 --root=ROOT
202 Use ROOT as the current root path. This is equivalent to setting
203 $OPAMROOT to ROOT.
204 --safe, --readonly
206 Make sure nothing will be automatically updated or rewritten.
207 Useful for calling from completion scripts, for example. Will fail
208 whenever such an operation is needed ; also avoids waiting for
209 locks, skips interactive questions and overrides the $OPAMDEBUG
210 variable.
211 --solver=CMD
213 Specify the CUDF solver to use for resolving package installation
214 problems. This is either a predefined solver (this version of opam
215 supports builtin-mccs+lp(), builtin-mccs+glpk, aspcud, mccs,
216 aspcud-old, packup), or a custom command that should contain the
217 variables %{input}%, %{output}%, %{criteria}%, and optionally
218 %{timeout}%.
219 --strict
221 Fail whenever an error is found in a package definition or a
222 configuration file. The default is to continue silently if
223 possible.
224 --switch=SWITCH
226 Use SWITCH as the current compiler switch. This is equivalent to
227 setting $OPAMSWITCH to SWITCH.
228 --use-internal-solver, --no-aspcud
230 Disable any external solver, and use the built-in one (this
231 requires that opam has been compiled with a built-in solver).
232 -v, --verbose
234 Be more verbose. One -v shows all package commands, repeat to also
235 display commands called internally (e.g. tar, curl, patch etc.)
236 Repeating n times is equivalent to setting $OPAMVERBOSE to "n".
237 -w, --working-dir
239 Whenever updating packages that are bound to a local,
240 version-controlled directory, update to the current working state
241 of their source instead of the last committed state, or the ref
242 they are pointing to. This only affects packages explicitly listed
243 on the command-line.
244 -y, --yes
246 Answer yes to all yes/no questions without prompting. This is
247 equivalent to setting $OPAMYES to "true".
248
250 Opam makes use of the environment variables listed here. Boolean
251 variables should be set to "0", "no", "false" or the empty string to
252 disable, "1", "yes" or "true" to enable.
253 OPAMCOLOR, when set to always or never, sets a default value for the
255 --color option.
256 OPAMCRITERIA specifies user preferences for dependency solving. The
258 default value depends on the solver version, use `config report` to
259 know the current setting. See also option --criteria
260 OPAMCURL can be used to select a given 'curl' program. See OPAMFETCH
262 for more options.
263 OPAMDEBUG see options `--debug' and `--debug-level'.
265 OPAMDOWNLOADJOBS sets the maximum number of simultaneous downloads.
267 OPAMERRLOGLEN sets the number of log lines printed when a sub-process
269 fails. 0 to print all.
270 OPAMEXTERNALSOLVER see option `--solver'.
272 OPAMFETCH specifies how to download files: either `wget', `curl' or a
274 custom command where variables %{url}%, %{out}%, %{retry}%,
275 %{compress}% and %{checksum}% will be replaced. Overrides the
276 'download-command' value from the main config file.
277 OPAMJOBS sets the maximum number of parallel workers to run.
279 OPAMJSON log json output to the given file (use character `%' to index
281 the files)
282 OPAMLOCK see option `--lock'.
284 OPAMNOAUTOUPGRADE disables automatic internal upgrade of repositories
286 in an earlier format to the current one, on 'update' or 'init'.
287 OPAMKEEPLOGS tells opam to not remove some temporary command logs and
289 some backups. This skips some finalisers and may also help to get more
290 reliable backtraces
291 OPAMLOCKRETRIES sets the number of tries after which OPAM gives up
293 acquiring its lock and fails. <= 0 means infinite wait.
294 OPAMNO answer no to any question asked.
296 OPAMNOASPCUD see option `--no-aspcud'.
298 OPAMNOSELFUPGRADE see option `--no-self-upgrade'.
300 OPAMPINKINDAUTO sets whether version control systems should be detected
302 when pinning to a local path. Enabled by default since 1.3.0.
303 OPAMREQUIRECHECKSUMS Enables option `--require-checksums' when
305 available (e.g. for `opam install`).
306 OPAMRETRY sets the number of tries before failing downloads.
308 OPAMROOT see option `--root'. This is automatically set by `opam env
310 --root=DIR --set-root'.
311 OPAMROOTISOK don't complain when running as root.
313 OPAMSAFE see option `--safe'
315 OPAMSKIPVERSIONCHECKS bypasses some version checks. Unsafe, for
317 compatibility testing only.
318 OPAMSOLVERTIMEOUT change the time allowance of the solver. Default is
320 60.0, set to 0 for unlimited. Note that all solvers may not support
321 this option.
322 OPAMSTATUSLINE display a dynamic status line showing what's currently
324 going on on the terminal. (one of one of `always', `never' or `auto')
325 OPAMSWITCH see option `--switch'. Automatically set by `opam env
327 --switch=SWITCH --set-switch'.
328 OPAMUPGRADECRITERIA specifies user preferences for dependency solving
330 when performing an upgrade. Overrides OPAMCRITERIA in upgrades if both
331 are set. See also option --criteria
332 OPAMUSEINTERNALSOLVER see option `--use-internal-solver'.
334 OPAMUTF8 use UTF8 characters in output (one of one of `always', `never'
336 or `auto'). By default `auto', which is determined from the locale).
337 OPAMUTF8MSGS use extended UTF8 characters (camels) in opam messages.
339 Implies OPAMUTF8. This is set by default on OSX only.
340 OPAMVAR_var overrides the contents of the variable var when
342 substituting `%{var}%` strings in `opam` files.
343 OPAMVAR_package_var overrides the contents of the variable package:var
345 when substituting `%{package:var}%` strings in `opam` files.
346 OPAMVERBOSE see option `--verbose'.
348 OPAMYES see option `--yes'.
350
352 As an exception to the following, the `exec' command returns 127 if the
353 command was not found or couldn't be executed, and the command's exit
354 value otherwise.
355 0 Success, or true for boolean queries.
357 1 False. Returned when a boolean return value is expected, e.g. when
359 running with --check, or for queries like opam lint.
360 2 Bad command-line arguments, or command-line arguments pointing to
362 an invalid context (e.g. file not following the expected format).
363 5 Not found. You requested something (package, version, repository,
365 etc.) that couldn't be found.
366 10 Aborted. The operation required confirmation, which wasn't given.
368 15 Could not acquire the locks required for the operation.
370 20 There is no solution to the user request. This can be caused by
372 asking to install two incompatible packages, for example.
373 30 Error in package definition, or other metadata files. Using
375 --strict raises this error more often.
376 31 Package script error. Some package operations were unsuccessful.
378 This may be an error in the packages or an incompatibility with
379 your system. This can be a partial error.
380 40 Sync error. Could not fetch some remotes from the network. This can
382 be a partial error.
383 50 Configuration error. Opam or system configuration doesn't allow
385 operation, and needs fixing.
386 60 Solver failure. The solver failed to return a sound answer. It can
388 be due to a broken external solver, or an error in solver
389 configuration.
390 99 Internal error. Something went wrong, likely due to a bug in opam
392 itself.
393 130 User interrupt. SIGINT was received, generally due to the user
395 pressing Ctrl-C.
396
398 See https://opam.ocaml.org/doc.
399
401 Vincent Bernardoff <vb@luminar.eu.org>
402 Raja Boujbel <raja.boujbel@ocamlpro.com>
403 Roberto Di Cosmo <roberto@dicosmo.org>
404 Thomas Gazagnaire <thomas@gazagnaire.org>
405 Louis Gesbert <louis.gesbert@ocamlpro.com>
406 Fabrice Le Fessant <Fabrice.Le_fessant@inria.fr>
407 Anil Madhavapeddy <anil@recoil.org>
408 Guillem Rieu <guillem.rieu@ocamlpro.com>
409 Ralf Treinen <ralf.treinen@pps.jussieu.fr>
410 Frederic Tuong <tuong@users.gforge.inria.fr>
411
413 Check bug reports at https://github.com/ocaml/opam/issues.
414Opam 2.0.1 opam-unpin(1)