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 --assume-depexts
18 Skip the installation step for any missing system packages, and
19 attempt to proceed with compilation of the opam packages anyway. If
20 the installation is successful, opam won't prompt again about these
21 system packages. Only meaningful if external dependency handling is
22 enabled.
23 -b, --keep-build-dir
25 Keep the build directories after compiling packages. This is
26 equivalent to setting $OPAMKEEPBUILDDIR to "true".
27 --build-doc
29 Removed in 2.1, use --with-doc instead.
30 --build-test
32 Removed in 2.1, use --with-test instead.
33 -d, --with-doc
35 Build the package documentation. This only affects packages listed
36 on the command-line. This is equivalent to setting $OPAMWITHDOC (or
37 the deprecated $OPAMBUILDDOC) to "true".
38 --dry-run
40 Simulate the command, but don't actually perform any changes. This
41 also can be set with environment variable $OPAMDEBUG.
42 --fake
44 This option registers the actions into the opam database, without
45 actually performing them. WARNING: This option is dangerous and
46 likely to break your opam environment. You probably want --dry-run.
47 You've been warned.
48 --ignore-constraints-on[=PACKAGES] (default=)
50 Forces opam to ignore version constraints on all dependencies to
51 the listed packages. This can be used to test compatibility, but
52 expect builds to break when using this. Note that version
53 constraints on optional dependencies and conflicts are unaffected.
54 This is equivalent to setting $OPAMIGNORECONSTRAINTS.
55 --inplace-build
57 When compiling a package which has its source bound to a local
58 directory, process the build and install actions directly in that
59 directory, rather than in a clean copy handled by opam. This only
60 affects packages that are explicitly listed on the command-line.
61 This is equivalent to setting $OPAMINPLACEBUILD to "true".
62 --lock-suffix=SUFFIX (absent=locked)
64 Set locked files suffix to SUFFIX.
65 --locked
67 In commands that use opam files found from pinned sources, if a
68 variant of the file with an added .locked extension is found (e.g.
69 foo.opam.locked besides foo.opam), that will be used instead. This
70 is typically useful to offer a more specific set of dependencies
71 and reproduce similar build contexts, hence the name. The
72 lockoption can be used to generate such files, based on the
73 versions of the dependencies currently installed on the host. This
74 is equivalent to setting the $OPAMLOCKED environment variable. Note
75 that this option doesn't generally affect already pinned packages.
76 -m MAKE, --make=MAKE
78 Removed in 2.1, use opam config set[-global] make MAKE instead.
79 --no-checksums
81 Do not verify the checksum of downloaded archives.This is
82 equivalent to setting $OPAMNOCHECKSUMS to "true".
83 --no-depexts
85 Temporarily disables handling of external dependencies. This can be
86 used if a package is not available on your system package manager,
87 but you installed the required dependency by hand. Implies
88 --assume-depexts, and stores the exceptions upon success as well.
89 --require-checksums
91 Reject the installation of packages that don't provide a checksum
92 for the upstream archives. This is equivalent to setting
93 $OPAMREQUIRECHECKSUMS to "true".
94 --reuse-build-dir
96 Reuse existing build directories (kept by using --keep-build-dir),
97 instead of compiling from a fresh clone of the source. This can be
98 faster, but also lead to failures if the build systems of the
99 packages don't handle upgrades of dependencies well. This is
100 equivalent to setting $OPAMREUSEBUILDDIR to "true".
101 --show-actions
103 Call the solver and display the actions. Don't perform any changes.
104 This is equivalent to setting $OPAMSHOW.
105 --skip-updates
107 When running an install, upgrade or reinstall on source-pinned
108 packages, they are normally updated from their origin first. This
109 flag disables that behaviour and will keep them to their version in
110 cache. This is equivalent to setting $OPAMSKIPUPDATE.
111 -t, --with-test
113 Build and run the package unit-tests. This only affects packages
114 listed on the command-line. This is equivalent to setting
115 $OPAMWITHTEST (or the deprecated $OPAMBUILDTEST) to "true".
116 --unlock-base
118 Removed in 2.1, use --update-invariant instead.
119 --update-invariant
121 Allow changes to the packages set as switch base (typically, the
122 main compiler). Use with caution. This is equivalent to setting the
123 $OPAMUNLOCKBASE environment variable
124
126 --dev-repo
127 Pin to the upstream package source for the latest development
128 version
129 -e, --edit
131 With opam pin add, edit the opam file as with `opam pin edit' after
132 pinning.
133 -j JOBS, --jobs=JOBS
135 Set the maximal number of concurrent jobs to use. The default value
136 is calculated from the number of cores. You can also set it using
137 the $OPAMJOBS environment variable.
138 -k KIND, --kind=KIND
140 Sets the kind of pinning. Must be one of one of version, path,
141 http, git, darcs, hg, none or auto. If unset or auto, is inferred
142 from the format of the target, defaulting to the appropriate
143 version control if one is detected in the given directory, or to
144 path otherwise. OPAMPINKINDAUTO can be set to "0" to disable
145 automatic detection of version control.Use none to pin without a
146 target (for virtual packages).
147 -n, --no-action
149 Just record the new pinning status, and don't prompt for
150 (re)installation or removal of affected packages.
151 --no
153 Answer no to all opam yes/no questions without prompting. See also
154 --confirm-level. This is equivalent to setting $OPAMNO to "true".
155 --normalise
157 Print list of available package to pin in format
158 `name.version^url`, that is comprehensible by `opam pin add`.
159 Available only with the scan subcommand. An example of use is `opam
160 pin scan . --normalise | grep foo | xargs opam pin add`
161 -s, --short
163 Output raw lists of names, one per line, skipping any details.
164 --with-version=VERSION
166 Set the pinning version to VERSION for named PACKAGES or packages
167 retrieved from TARGET. It has priority over any other version
168 specification (opam file version field, name.vers argument)). When
169 pinning to a version, the package source from that version is used,
170 but declared as being VERSION to opam. Using --with-version is
171 equivalent to using --edit and adjusting the version in the package
172 definition file.
173 -y, --yes
175 Answer yes to all opam yes/no questions without prompting. See also
176 --confirm-level. This is equivalent to setting $OPAMYES to "true".
177
179 These options are common to all commands.
180 --best-effort
182 Don't fail if all requested packages can't be installed: try to
183 install as many as possible. Note that not all external solvers may
184 support this option (recent versions of aspcud or mccs should).
185 This is equivalent to setting $OPAMBESTEFFORT environment variable.
186 --cli=MAJOR.MINOR (absent=2.1)
188 Use the command-line interface syntax and semantics of MAJOR.MINOR.
189 Intended for any persistent use of opam (scripts, blog posts,
190 etc.), any version of opam in the same MAJOR series will behave as
191 for the specified MINOR release. The flag was not available in opam
192 2.0, so to select the 2.0 CLI, set the OPAMCLI environment variable
193 to 2.0 instead of using this parameter.
194 --color=WHEN
196 Colorize the output. WHEN must be one of always, never or auto.
197 --confirm-level=LEVEL
199 Confirmation level, LEVEL must be one of ask, no, yes or
200 unsafe-yes. Can be specified more than once. If --yes or --no are
201 also given, the value of the last --confirm-level is taken into
202 account. This is equivalent to setting $OPAMCONFIRMLEVEL`.
203 --criteria=CRITERIA
205 Specify user preferences for dependency solving for this run.
206 Overrides both $OPAMCRITERIA and $OPAMUPGRADECRITERIA. For details
207 on the supported language, and the external solvers available, see
208 http://opam.ocaml.org/doc/External_solvers.html. A general guide to
209 using solver preferences can be found at
210 http://www.dicosmo.org/Articles/usercriteria.pdf.
211 --cudf=FILENAME
213 Debug option: Save the CUDF requests sent to the solver to
214 FILENAME-<n>.cudf.
215 --debug
217 Print debug message to stderr. This is equivalent to setting
218 $OPAMDEBUG to "true".
219 --debug-level=LEVEL
221 Like --debug, but allows specifying the debug level (--debug sets
222 it to 1). Equivalent to setting $OPAMDEBUG to a positive integer.
223 --git-version
225 Print the git version of opam, if set (i.e. you are using a
226 development version), and exit.
227 --help[=FMT] (default=auto)
229 Show this help in format FMT. The value FMT must be one of auto,
230 pager, groff or plain. With auto, the format is pager or plain
231 whenever the TERM env var is dumb or undefined.
232 --ignore-pin-depends
234 Ignore extra pins required by packages that get pinned, either
235 manually through opam pin or through opam install DIR. This is
236 equivalent to setting IGNOREPINDEPENDS=true.
237 --json=FILENAME
239 Save the results of the opam run in a computer-readable file. If
240 the filename contains the character `%', it will be replaced by an
241 index that doesn't overwrite an existing file. Similar to setting
242 the $OPAMJSON variable.
243 --no-aspcud
245 Removed in 2.1.
246 --no-auto-upgrade
248 When configuring or updating a repository that is written for an
249 earlier opam version (1.2), opam internally converts it to the
250 current format. This disables this behaviour. Note that
251 repositories should define their format version in a 'repo' file at
252 their root, or they will be assumed to be in the older format. It
253 is, in any case, preferable to upgrade the repositories manually
254 using opam admin upgrade [--mirror URL] when possible.
255 --no-self-upgrade
257 Opam will replace itself with a newer binary found at OPAMROOT/opam
258 if present. This disables this behaviour.
259 -q, --quiet
261 Disables --verbose.
262 --root=ROOT
264 Use ROOT as the current root path. This is equivalent to setting
265 $OPAMROOT to ROOT.
266 --safe, --readonly
268 Make sure nothing will be automatically updated or rewritten.
269 Useful for calling from completion scripts, for example. Will fail
270 whenever such an operation is needed ; also avoids waiting for
271 locks, skips interactive questions and overrides the $OPAMDEBUG
272 variable. This is equivalent to set environment variable $OPAMSAFE.
273 --solver=CMD
275 Specify the CUDF solver to use for resolving package installation
276 problems. This is either a predefined solver (this version of opam
277 supports builtin-mccs+lp(), builtin-mccs+glpk,
278 builtin-dummy-z3-solver, builtin-dummy-0install-solver, aspcud,
279 mccs, aspcud-old, packup), or a custom command that should contain
280 the variables %{input}%, %{output}%, %{criteria}%, and optionally
281 %{timeout}%. This is equivalent to setting $OPAMEXTERNALSOLVER.
282 --strict
284 Fail whenever an error is found in a package definition or a
285 configuration file. The default is to continue silently if
286 possible.
287 --switch=SWITCH
289 Use SWITCH as the current compiler switch. This is equivalent to
290 setting $OPAMSWITCH to SWITCH.
291 --use-internal-solver
293 Disable any external solver, and use the built-in one (this
294 requires that opam has been compiled with a built-in solver). This
295 is equivalent to setting $OPAMNOASPCUD or $OPAMUSEINTERNALSOLVER.
296 -v, --verbose
298 Be more verbose. One -v shows all package commands, repeat to also
299 display commands called internally (e.g. tar, curl, patch etc.)
300 Repeating n times is equivalent to setting $OPAMVERBOSE to "n".
301 --version
303 Show version information.
304 -w, --working-dir
306 Whenever updating packages that are bound to a local,
307 version-controlled directory, update to the current working state
308 of their source instead of the last committed state, or the ref
309 they are pointing to. As source directory is copied as it is, if it
310 isn't clean it may result on a opam build failure.This only affects
311 packages explicitly listed on the command-line.It can also be set
312 with $OPAMWORKINGDIR.
313
315 Opam makes use of the environment variables listed here. Boolean
316 variables should be set to "0", "no", "false" or the empty string to
317 disable, "1", "yes" or "true" to enable.
318 OPAMALLPARENS surround all filters with parenthesis.
320 OPAMASSUMEDEPEXTS see option `--assume-depexts'.
322 OPAMAUTOREMOVE see remove option `--auto-remove'.
324 OPAMBESTEFFORT see option `--best-effort'.
326 OPAMBESTEFFORTPREFIXCRITERIA sets the string that must be prepended to
328 the criteria when the `--best-effort' option is set, and is expected to
329 maximise the `opam-query' property in the solution.
330 OPAMBUILDDOC Removed in 2.1.
332 OPAMBUILDTEST Removed in 2.1.
334 OPAMCLI see option `--cli'.
336 OPAMCOLOR when set to always or never, sets a default value for the
338 `--color' option.
339 OPAMCONFIRMLEVEL see option `--confirm-level`. OPAMCONFIRMLEVEL has
341 priority over OPAMYES and OPAMNO.
342 OPAMCRITERIA specifies user preferences for dependency solving. The
344 default value depends on the solver version, use `config report' to
345 know the current setting. See also option --criteria.
346 OPAMCUDFFILE save the cudf graph to file-actions-explicit.dot.
348 OPAMCUDFTRIM controls the filtering of unrelated packages during CUDF
350 preprocessing.
351 OPAMCURL can be used to select a given 'curl' program. See OPAMFETCH
353 for more options.
354 OPAMDEBUG see options `--debug' and `--debug-level'.
356 OPAMDEBUGSECTIONS if set, limits debug messages to the space-separated
358 list of sections. Sections can optionally have a specific debug level
359 (for example, CLIENT:2 or CLIENT CUDF:2), but otherwise use
360 `--debug-level'.
361 OPAMDIGDEPTH defines how aggressive the lookup for conflicts during
363 CUDF preprocessing is.
364 OPAMDOWNLOADJOBS sets the maximum number of simultaneous downloads.
366 OPAMDROPWORKINGDIR overrides packages previously updated with
368 --working-dir on update. Without this variable set, opam would keep
369 them unchanged unless explicitly named on the command-line.
370 OPAMDRYRUN see option `--dry-run'.
372 OPAMEDITOR sets the editor to use for opam file editing, overrides
374 $EDITOR and $VISUAL.
375 OPAMERRLOGLEN sets the number of log lines printed when a sub-process
377 fails. 0 to print all.
378 OPAMEXTERNALSOLVER see option `--solver'.
380 OPAMFAKE see option `--fake'.
382 OPAMFETCH specifies how to download files: either `wget', `curl' or a
384 custom command where variables %{url}%, %{out}%, %{retry}%,
385 %{compress}% and %{checksum}% will be replaced. Overrides the
386 'download-command' value from the main config file.
387 OPAMFIXUPCRITERIA same as OPAMUPGRADECRITERIA, but specific to fixup.
389 OPAMIGNORECONSTRAINTS see install option `--ignore-constraints-on'.
391 OPAMIGNOREPINDEPENDS see option `--ignore-pin-depends'.
393 OPAMINPLACEBUILD see option `--inplace-build'.
395 OPAMJOBS sets the maximum number of parallel workers to run.
397 OPAMJSON log json output to the given file (use character `%' to index
399 the files).
400 OPAMKEEPBUILDDIR see install option `--keep-build-dir'.
402 OPAMKEEPLOGS tells opam to not remove some temporary command logs and
404 some backups. This skips some finalisers and may also help to get more
405 reliable backtraces.
406 OPAMLOCKED combination of `--locked' and `--lock-suffix' options.
408 OPAMLOGS logdir sets log directory, default is a temporary directory in
410 /tmp
411 OPAMMAKECMD set the system make command to use.
413 OPAMMERGEOUT merge process outputs, stderr on stdout.
415 OPAMNO answer no to any question asked, see options `--no` and
417 `--confirm-level`. OPAMNO is ignored if either OPAMCONFIRMLEVEL or
418 OPAMYES is set.
419 OPAMNOAGGREGATE with `opam admin check', don't aggregate packages.
421 OPAMNOASPCUD Deprecated.
423 OPAMNOAUTOUPGRADE disables automatic internal upgrade of repositories
425 in an earlier format to the current one, on 'update' or 'init'.
426 OPAMNOCHECKSUMS enables option --no-checksums when available.
428 OPAMNODEPEXTS disables system dependencies handling, see option
430 `--no-depexts'.
431 OPAMNOENVNOTICE Internal.
433 OPAMNOSELFUPGRADE see option `--no-self-upgrade'
435 OPAMPINKINDAUTO sets whether version control systems should be detected
437 when pinning to a local path. Enabled by default since 1.3.0.
438 OPAMPRECISETRACKING fine grain tracking of directories.
440 OPAMPREPRO set this to false to disable CUDF preprocessing. Less
442 efficient, but might help debugging solver issue.
443 OPAMREQUIRECHECKSUMS Enables option `--require-checksums' when
445 available (e.g. for `opam install').
446 OPAMRETRIES sets the number of tries before failing downloads.
448 OPAMREUSEBUILDDIR see option `--reuse-build-dir'.
450 OPAMROOT see option `--root'. This is automatically set by `opam env
452 --root=DIR --set-root'.
453 OPAMROOTISOK don't complain when running as root.
455 OPAMSAFE see option `--safe'.
457 OPAMSHOW see option `--show'.
459 OPAMSKIPUPDATE see option `--skip-updates'.
461 OPAMSKIPVERSIONCHECKS bypasses some version checks. Unsafe, for
463 compatibility testing only.
464 OPAMSOLVERALLOWSUBOPTIMAL (default `true') allows some solvers to still
466 return a solution when they reach timeout; while the solution remains
467 assured to be consistent, there is no guarantee in this case that it
468 fits the expected optimisation criteria. If `true', opam willcontinue
469 with a warning, if `false' a timeout is an error. Currently only the
470 builtin-z3 backend handles this degraded case.
471 OPAMSOLVERTIMEOUT change the time allowance of the solver. Default is
473 60.0, set to 0 for unlimited. Note that all solvers may not support
474 this option.
475 OPAMSTATS display stats at the end of command.
477 OPAMSTATUSLINE display a dynamic status line showing what's currently
479 going on on the terminal. (one of one of always, never or auto)
480 OPAMSTRICT fail on inconsistencies (file reading, switch import, etc.).
482 OPAMSWITCH see option `--switch'. Automatically set by `opam env
484 --switch=SWITCH --set-switch'.
485 OPAMUNLOCKBASE see install option `--unlock-base'.
487 OPAMUPGRADECRITERIA specifies user preferences for dependency solving
489 when performing an upgrade. Overrides OPAMCRITERIA in upgrades if both
490 are set. See also option --criteria.
491 OPAMUSEINTERNALSOLVER see option `--use-internal-solver'.
493 OPAMUSEOPENSSL force openssl use for hash computing.
495 OPAMUTF8 use UTF8 characters in output (one of one of always, never or
497 auto). By default `auto', which is determined from the locale).
498 OPAMUTF8MSGS use extended UTF8 characters (camels) in opam messages.
500 Implies OPAMUTF8. This is set by default on OSX only.
501 OPAMVALIDATIONHOOK if set, uses the `%{hook%}' command to validate an
503 opam repository update.
504 OPAMVERBOSE see option `--verbose'.
506 OPAMVERSIONLAGPOWER do not use.
508 OPAMWITHDOC see install option `--with-doc'.
510 OPAMWITHTEST see install option `--with-test.
512 OPAMWORKINGDIR see option `--working-dir'.
514 OPAMYES see options `--yes' and `--confirm-level`. OPAMYES has has
516 priority over OPAMNO and is ignored if OPAMCONFIRMLEVEL is set.
517 OPAMVAR_var overrides the contents of the variable var when
519 substituting `%{var}%` strings in `opam` files.
520 OPAMVAR_package_var overrides the contents of the variable package:var
522 when substituting `%{package:var}%` strings in `opam` files.
523
525 All scripts and programmatic invocations of opam should use `--cli' in
526 order to ensure that they work seamlessly with future versions of the
527 opam client. Additionally, blog posts or other documentation can
528 benefit, as it prevents information from becoming stale.
529 Although opam only supports roots (~/.opam/) for the current version,
531 it does provide backwards compatibility for its command-line interface.
532 Since CLI version support was only added in opam 2.1, use OPAMCLI to
534 select 2.0 support (as opam 2.0 will just ignore it), and `--cli=2.1'
535 for 2.1 (or later) versions, since an environment variable controlling
536 the parsing of syntax is brittle. To this end, opam displays a warning
537 if OPAMCLI specifies a valid version other than 2.0, and also if
538 `--cli=2.0' is specified.
539 The command-line version is selected by using the `--cli' option or the
541 OPAMCLI environment variable. `--cli' may be specified morethan once,
542 where the last instance takes precedence. OPAMCLI is only inspected if
543 `--cli' is not given.
544
546 As an exception to the following, the `exec' command returns 127 if the
547 command was not found or couldn't be executed, and the command's exit
548 value otherwise.
549 0 Success, or true for boolean queries.
551 1 False. Returned when a boolean return value is expected, e.g. when
553 running with --check, or for queries like opam lint.
554 2 Bad command-line arguments, or command-line arguments pointing to
556 an invalid context (e.g. file not following the expected format).
557 5 Not found. You requested something (package, version, repository,
559 etc.) that couldn't be found.
560 10 Aborted. The operation required confirmation, which wasn't given.
562 15 Could not acquire the locks required for the operation.
564 20 There is no solution to the user request. This can be caused by
566 asking to install two incompatible packages, for example.
567 30 Error in package definition, or other metadata files. Using
569 --strict raises this error more often.
570 31 Package script error. Some package operations were unsuccessful.
572 This may be an error in the packages or an incompatibility with
573 your system. This can be a partial error.
574 40 Sync error. Could not fetch some remotes from the network. This can
576 be a partial error.
577 50 Configuration error. Opam or system configuration doesn't allow
579 operation, and needs fixing.
580 60 Solver failure. The solver failed to return a sound answer. It can
582 be due to a broken external solver, or an error in solver
583 configuration.
584 99 Internal error. Something went wrong, likely due to a bug in opam
586 itself.
587 130 User interrupt. SIGINT was received, generally due to the user
589 pressing Ctrl-C.
590
592 See https://opam.ocaml.org/doc.
593
595 Vincent Bernardoff <vb@luminar.eu.org>
596 Raja Boujbel <raja.boujbel@ocamlpro.com>
597 Roberto Di Cosmo <roberto@dicosmo.org>
598 Thomas Gazagnaire <thomas@gazagnaire.org>
599 Louis Gesbert <louis.gesbert@ocamlpro.com>
600 Fabrice Le Fessant <Fabrice.Le_fessant@inria.fr>
601 Anil Madhavapeddy <anil@recoil.org>
602 Guillem Rieu <guillem.rieu@ocamlpro.com>
603 Ralf Treinen <ralf.treinen@pps.jussieu.fr>
604 Frederic Tuong <tuong@users.gforge.inria.fr>
605
607 Check bug reports at https://github.com/ocaml/opam/issues.
608Opam 2.1.5 OPAM-UNPIN(1)