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. This
29 also can be set with environment variable $OPAMDEBUG.
30 --fake
32 This option registers the actions into the opam database, without
33 actually performing them. WARNING: This option is dangerous and
34 likely to break your opam environment. You probably want
35 `--dry-run'. You've been warned.
36 --ignore-constraints-on[=PACKAGES] (default=)
38 Forces opam to ignore version constraints on all dependencies to
39 the listed packages. This can be used to test compatibility, but
40 expect builds to break when using this. Note that version
41 constraints on optional dependencies and conflicts are unaffected.
42 This is equivalent to setting $OPAMIGNORECONSTRAINTS.
43 --inplace-build
45 When compiling a package which has its source bound to a local
46 directory, process the build and install actions directly in that
47 directory, rather than in a clean copy handled by opam. This only
48 affects packages that are explicitly listed on the command-line.
49 This is equivalent to setting $OPAMINPLACEBUILD to "true".
50 --locked[=SUFFIX] (default=locked)
52 In commands that use opam files found from pinned sources, if a
53 variant of the file with an added .SUFFIX extension is found (e.g.
54 foo.opam.locked besides foo.opam), that will be used instead. This
55 is typically useful to offer a more specific set of dependencies
56 and reproduce similar build contexts, hence the name. The opam lock
57 plugin can be used to generate such files, based on the versions of
58 the dependencies currently installed on the host. This is
59 equivalent to setting the $OPAMLOCKED environment variable. Note
60 that this option doesn't generally affect already pinned packages.
61 -m MAKE, --make=MAKE
63 Use MAKE as the default 'make' command. Deprecated: use opam config
64 set[-global] make MAKE instead. Has no effect if the make variable
65 is defined.
66 --no-checksums
68 Do not verify the checksum of downloaded archives.This is
69 equivalent to setting $OPAMNOCHECKSUMS to "true".
70 --require-checksums
72 Reject the installation of packages that don't provide a checksum
73 for the upstream archives. This is equivalent to setting
74 $OPAMREQUIRECHECKSUMS to "true".
75 --reuse-build-dir
77 Reuse existing build directories (kept by using --keep-build-dir),
78 instead of compiling from a fresh clone of the source. This can be
79 faster, but also lead to failures if the build systems of the
80 packages don't handle upgrades of dependencies well. This is
81 equivalent to setting $OPAMREUSEBUILDDIR to "true".
82 --show-actions
84 Call the solver and display the actions. Don't perform any changes.
85 This is equivalent to setting $OPAMSHOW.
86 --skip-updates
88 When running an install, upgrade or reinstall on source-pinned
89 packages, they are normally updated from their origin first. This
90 flag disables that behaviour and will keep them to their version in
91 cache. This is equivalent to setting $OPAMSKIPUPDATE.
92 -t, --with-test, --build-test
94 Build and run the package unit-tests. This only affects packages
95 listed on the command-line. The --build-test form is deprecated as
96 this also affects installation. This is equivalent to setting
97 $OPAMWITHTEST (or the deprecated $OPAMBUILDTEST) to "true".
98 --unlock-base
100 Allow changes to the packages set as switch base (typically, the
101 main compiler). Use with caution. This is equivalent to setting the
102 $OPAMUNLOCKBASE environment variable
103
105 --dev-repo
106 Pin to the upstream package source for the latest development
107 version
108 -e, --edit
110 With opam pin add, edit the opam file as with `opam pin edit' after
111 pinning.
112 --help[=FMT] (default=auto)
114 Show this help in format FMT. The value FMT must be one of `auto',
115 `pager', `groff' or `plain'. With `auto', the format is `pager` or
116 `plain' whenever the TERM env var is `dumb' or undefined.
117 -j JOBS, --jobs=JOBS
119 Set the maximal number of concurrent jobs to use. The default value
120 is calculated from the number of cores. You can also set it using
121 the $OPAMJOBS environment variable.
122 -k KIND, --kind=KIND
124 Sets the kind of pinning. Must be one of one of `version', `path',
125 `http', `git', `darcs', `hg', `none' or `auto'. If unset or auto,
126 is inferred from the format of the target, defaulting to the
127 appropriate version control if one is detected in the given
128 directory, or to path otherwise. OPAMPINKINDAUTO can be set to "0"
129 to disable automatic detection of version control.Use none to pin
130 without a target (for virtual packages).
131 -n, --no-action
133 Just record the new pinning status, and don't prompt for
134 (re)installation or removal of affected packages.
135 -s, --short
137 Output raw lists of names, one per line, skipping any details.
138 --version
140 Show version information.
141
143 These options are common to all commands.
144 --best-effort
146 Don't fail if all requested packages can't be installed: try to
147 install as many as possible. Note that not all external solvers may
148 support this option (recent versions of aspcud or mccs should).
149 This is equivalent to setting $OPAMBESTEFFORT environment variable.
150 --color=WHEN
152 Colorize the output. WHEN must be one of `always', `never' or
153 `auto'.
154 --criteria=CRITERIA
156 Specify user preferences for dependency solving for this run.
157 Overrides both $OPAMCRITERIA and $OPAMUPGRADECRITERIA. For details
158 on the supported language, and the external solvers available, see
159 http://opam.ocaml.org/doc/External_solvers.html. A general guide to
160 using solver preferences can be found at
161 http://www.dicosmo.org/Articles/usercriteria.pdf.
162 --cudf=FILENAME
164 Debug option: Save the CUDF requests sent to the solver to
165 FILENAME-<n>.cudf.
166 --debug
168 Print debug message to stderr. This is equivalent to setting
169 $OPAMDEBUG to "true".
170 --debug-level=LEVEL
172 Like --debug, but allows specifying the debug level (--debug sets
173 it to 1). Equivalent to setting $OPAMDEBUG to a positive integer.
174 --git-version
176 Print the git version of opam, if set (i.e. you are using a
177 development version), and exit.
178 --ignore-pin-depends
180 Ignore extra pins required by packages that get pinned, either
181 manually through opam pin or through opam install DIR. This is
182 equivalent to setting IGNOREPINDEPENDS=true.
183 --json=FILENAME
185 Save the results of the opam run in a computer-readable file. If
186 the filename contains the character `%', it will be replaced by an
187 index that doesn't overwrite an existing file. Similar to setting
188 the $OPAMJSON variable.
189 --no-aspcud
191 Deprecated.
192 --no-auto-upgrade
194 When configuring or updating a repository that is written for an
195 earlier opam version (1.2), opam internally converts it to the
196 current format. This disables this behaviour. Note that
197 repositories should define their format version in a 'repo' file at
198 their root, or they will be assumed to be in the older format. It
199 is, in any case, preferable to upgrade the repositories manually
200 using opam admin upgrade [--mirror URL] when possible.
201 --no-self-upgrade
203 Opam will replace itself with a newer binary found at OPAMROOT/opam
204 if present. This disables this behaviour.
205 -q, --quiet
207 Disables --verbose.
208 --root=ROOT
210 Use ROOT as the current root path. This is equivalent to setting
211 $OPAMROOT to ROOT.
212 --safe, --readonly
214 Make sure nothing will be automatically updated or rewritten.
215 Useful for calling from completion scripts, for example. Will fail
216 whenever such an operation is needed ; also avoids waiting for
217 locks, skips interactive questions and overrides the $OPAMDEBUG
218 variable. This is equivalent to set environment variable $OPAMSAFE.
219 --solver=CMD
221 Specify the CUDF solver to use for resolving package installation
222 problems. This is either a predefined solver (this version of opam
223 supports builtin-mccs+lp(), builtin-mccs+glpk, aspcud, mccs,
224 aspcud-old, packup), or a custom command that should contain the
225 variables %{input}%, %{output}%, %{criteria}%, and optionally
226 %{timeout}%. This is equivalent to setting $OPAMEXTERNALSOLVER.
227 --strict
229 Fail whenever an error is found in a package definition or a
230 configuration file. The default is to continue silently if
231 possible.
232 --switch=SWITCH
234 Use SWITCH as the current compiler switch. This is equivalent to
235 setting $OPAMSWITCH to SWITCH.
236 --use-internal-solver
238 Disable any external solver, and use the built-in one (this
239 requires that opam has been compiled with a built-in solver). This
240 is equivalent to setting $OPAMNOASPCUD or $OPAMUSEINTERNALSOLVER.
241 -v, --verbose
243 Be more verbose. One -v shows all package commands, repeat to also
244 display commands called internally (e.g. tar, curl, patch etc.)
245 Repeating n times is equivalent to setting $OPAMVERBOSE to "n".
246 -w, --working-dir
248 Whenever updating packages that are bound to a local,
249 version-controlled directory, update to the current working state
250 of their source instead of the last committed state, or the ref
251 they are pointing to. This only affects packages explicitly listed
252 on the command-line.It can also be set with $OPAMWORKINGDIR.
253 -y, --yes
255 Answer yes to all yes/no questions without prompting. This is
256 equivalent to setting $OPAMYES to "true".
257
259 Opam makes use of the environment variables listed here. Boolean
260 variables should be set to "0", "no", "false" or the empty string to
261 disable, "1", "yes" or "true" to enable.
262 OPAMALLPARENS surround all filters with parenthesis
264 OPAMAUTOREMOVE see remove option `--auto-remove`
266 OPAMBESTEFFORT see option `--best-effort`
268 OPAMBESTEFFORTPREFIXCRITERIA sets the string that must be prepended to
270 the criteria when the `--best-effort` option is set, and is expected to
271 maximise the `opam-query` property in the solution
272 OPAMCOLOR, when set to always or never, sets a default value for the
274 --color option.
275 OPAMCRITERIA specifies user preferences for dependency solving. The
277 default value depends on the solver version, use `config report` to
278 know the current setting. See also option --criteria
279 OPAMCUDFFILE file save the cudf graph to file-actions-explicit.dot
281 OPAMCURL can be used to select a given 'curl' program. See OPAMFETCH
283 for more options.
284 OPAMDEBUG see options `--debug' and `--debug-level'.
286 OPAMDOWNLOADJOBS sets the maximum number of simultaneous downloads.
288 OPAMDRYRUN see option `--dry-run`
290 OPAMEDITOR sets the editor to use for opam file editing, overrides
292 $EDITOR and $VISUAL
293 OPAMERRLOGLEN sets the number of log lines printed when a sub-process
295 fails. 0 to print all.
296 OPAMEXTERNALSOLVER see option `--solver'.
298 OPAMFAKE see option `--fake`
300 OPAMFETCH specifies how to download files: either `wget', `curl' or a
302 custom command where variables %{url}%, %{out}%, %{retry}%,
303 %{compress}% and %{checksum}% will be replaced. Overrides the
304 'download-command' value from the main config file.
305 OPAMFIXUPCRITERIA same as OPAMUPGRADECRITERIA, but specific to fixup
307 OPAMIGNORECONSTRAINTS see install option `--ignore-constraints-on`
309 OPAMIGNOREPINDEPENDS see option `--ignore-pin-depends`
311 OPAMJOBS sets the maximum number of parallel workers to run.
313 OPAMJSON log json output to the given file (use character `%' to index
315 the files)
316 OPAMLOCKED see install option `--locked`
318 OPAMLOGS logdir sets log directory, default is a temporary directory in
320 /tmp
321 OPAMMAKECMD set the system make command to use
323 OPAMNOAUTOUPGRADE disables automatic internal upgrade of repositories
325 in an earlier format to the current one, on 'update' or 'init'.
326 OPAMKEEPLOGS tells opam to not remove some temporary command logs and
328 some backups. This skips some finalisers and may also help to get more
329 reliable backtraces
330 OPAMLOCKRETRIES sets the number of tries after which opam gives up
332 acquiring its lock and fails. <= 0 means infinite wait.
333 OPAMMERGEOUT merge process outputs, stderr on stdout
335 OPAMNO answer no to any question asked.
337 OPAMNOASPCUD Deprecated.
339 OPAMNOCHECKSUMS enables option --no-checksums when available.
341 OPAMNOSELFUPGRADE see option `--no-self-upgrade'.
343 OPAMPINKINDAUTO sets whether version control systems should be detected
345 when pinning to a local path. Enabled by default since 1.3.0.
346 OPAMPRECISETRACKING fine grain tracking of directories
348 OPAMREQUIRECHECKSUMS Enables option `--require-checksums' when
350 available (e.g. for `opam install`).
351 OPAMRETRES sets the number of tries before failing downloads.
353 OPAMROOT see option `--root'. This is automatically set by `opam env
355 --root=DIR --set-root'.
356 OPAMROOTISOK don't complain when running as root.
358 OPAMSAFE see option `--safe'
360 OPAMSHOW see option `--show`
362 OPAMSKIPUPDATE see option `--skip-updates`
364 OPAMSKIPVERSIONCHECKS bypasses some version checks. Unsafe, for
366 compatibility testing only.
367 OPAMSOLVERTIMEOUT change the time allowance of the solver. Default is
369 60.0, set to 0 for unlimited. Note that all solvers may not support
370 this option.
371 OPAMSTATUSLINE display a dynamic status line showing what's currently
373 going on on the terminal. (one of one of `always', `never' or `auto')
374 OPAMSTATS display stats at the end of command
376 OPAMSTRICT fail on inconsistencies (file reading, switch import, etc.)
378 OPAMSWITCH see option `--switch'. Automatically set by `opam env
380 --switch=SWITCH --set-switch'.
381 OPAMUNLOCKBASE see install option `--unlock-base`
383 OPAMUPGRADECRITERIA specifies user preferences for dependency solving
385 when performing an upgrade. Overrides OPAMCRITERIA in upgrades if both
386 are set. See also option --criteria
387 OPAMUSEINTERNALSOLVER see option `--use-internal-solver'.
389 OPAMUSEOPENSSL force openssl use for hash computing
391 OPAMUTF8 use UTF8 characters in output (one of one of `always', `never'
393 or `auto'). By default `auto', which is determined from the locale).
394 OPAMUTF8MSGS use extended UTF8 characters (camels) in opam messages.
396 Implies OPAMUTF8. This is set by default on OSX only.
397 OPAMVALIDATIONHOOK hook if set, uses the `%{hook%}` command to validate
399 an opam repository update
400 OPAMVAR_var overrides the contents of the variable var when
402 substituting `%{var}%` strings in `opam` files.
403 OPAMVAR_package_var overrides the contents of the variable package:var
405 when substituting `%{package:var}%` strings in `opam` files.
406 OPAMVERBOSE see option `--verbose'.
408 OPAMWORKINGDIR see option `--working-dir`
410 OPAMYES see option `--yes'.
412
414 As an exception to the following, the `exec' command returns 127 if the
415 command was not found or couldn't be executed, and the command's exit
416 value otherwise.
417 0 Success, or true for boolean queries.
419 1 False. Returned when a boolean return value is expected, e.g. when
421 running with --check, or for queries like opam lint.
422 2 Bad command-line arguments, or command-line arguments pointing to
424 an invalid context (e.g. file not following the expected format).
425 5 Not found. You requested something (package, version, repository,
427 etc.) that couldn't be found.
428 10 Aborted. The operation required confirmation, which wasn't given.
430 15 Could not acquire the locks required for the operation.
432 20 There is no solution to the user request. This can be caused by
434 asking to install two incompatible packages, for example.
435 30 Error in package definition, or other metadata files. Using
437 --strict raises this error more often.
438 31 Package script error. Some package operations were unsuccessful.
440 This may be an error in the packages or an incompatibility with
441 your system. This can be a partial error.
442 40 Sync error. Could not fetch some remotes from the network. This can
444 be a partial error.
445 50 Configuration error. Opam or system configuration doesn't allow
447 operation, and needs fixing.
448 60 Solver failure. The solver failed to return a sound answer. It can
450 be due to a broken external solver, or an error in solver
451 configuration.
452 99 Internal error. Something went wrong, likely due to a bug in opam
454 itself.
455 130 User interrupt. SIGINT was received, generally due to the user
457 pressing Ctrl-C.
458
460 See https://opam.ocaml.org/doc.
461
463 Vincent Bernardoff <vb@luminar.eu.org>
464 Raja Boujbel <raja.boujbel@ocamlpro.com>
465 Roberto Di Cosmo <roberto@dicosmo.org>
466 Thomas Gazagnaire <thomas@gazagnaire.org>
467 Louis Gesbert <louis.gesbert@ocamlpro.com>
468 Fabrice Le Fessant <Fabrice.Le_fessant@inria.fr>
469 Anil Madhavapeddy <anil@recoil.org>
470 Guillem Rieu <guillem.rieu@ocamlpro.com>
471 Ralf Treinen <ralf.treinen@pps.jussieu.fr>
472 Frederic Tuong <tuong@users.gforge.inria.fr>
473
475 Check bug reports at https://github.com/ocaml/opam/issues.
476Opam 2.0.6 OPAM-UNPIN(1)