1OPAM-UNPIN(1)                     Opam Manual                    OPAM-UNPIN(1)
2
3
4

NAME

6       opam-unpin - An alias for pin remove.
7

SYNOPSIS

9       opam unpin [OPTION]... [ARG]...
10

DESCRIPTION

12       opam unpin is an alias for opam pin remove.
13
14       See opam pin --help for details.
15

PACKAGE BUILD OPTIONS

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
24       -b, --keep-build-dir
25           Keep the build directories after compiling packages. This is
26           equivalent to setting $OPAMKEEPBUILDDIR to "true".
27
28       --build-doc
29           Removed in 2.1, use --with-doc instead.
30
31       --build-test
32           Removed in 2.1, use --with-test instead.
33
34       -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
39       --dry-run
40           Simulate the command, but don't actually perform any changes. This
41           also can be set with environment variable $OPAMDEBUG.
42
43       --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
49       --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
56       --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
63       --lock-suffix=SUFFIX (absent=locked)
64           Set locked files suffix to SUFFIX.
65
66       --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
77       -m MAKE, --make=MAKE
78           Removed in 2.1, use opam config set[-global] make MAKE instead.
79
80       --no-checksums
81           Do not verify the checksum of downloaded archives.This is
82           equivalent to setting $OPAMNOCHECKSUMS to "true".
83
84       --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
90       --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
95       --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
102       --show-actions
103           Call the solver and display the actions. Don't perform any changes.
104           This is equivalent to setting $OPAMSHOW.
105
106       --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
112       -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
117       --unlock-base
118           Removed in 2.1, use --update-invariant instead.
119
120       --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

OPTIONS

126       --dev-repo
127           Pin to the upstream package source for the latest development
128           version
129
130       -e, --edit
131           With opam pin add, edit the opam file as with `opam pin edit' after
132           pinning.
133
134       -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
139       -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,
142           is inferred from the format of the target, defaulting to the
143           appropriate version control if one is detected in the given
144           directory, or to path otherwise. OPAMPINKINDAUTO can be set to "0"
145           to disable automatic detection of version control.Use none to pin
146           without a target (for virtual packages).
147
148       -n, --no-action
149           Just record the new pinning status, and don't prompt for
150           (re)installation or removal of affected packages.
151
152       --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
156       --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
162       -s, --short
163           Output raw lists of names, one per line, skipping any details.
164
165       --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
174       -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

COMMON OPTIONS

179       These options are common to all commands.
180
181       --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
187       --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
195       --color=WHEN
196           Colorize the output. WHEN must be one of `always', `never' or
197           `auto'.
198
199       --confirm-level=LEVEL
200           Confirmation level, LEVEL must be one of `ask', `no', `yes' or
201           `unsafe-yes'. Can be specified more than once. If --yes or --no are
202           also given, the value of the last --confirm-level is taken into
203           account. This is equivalent to setting  $OPAMCONFIRMLEVEL`.
204
205       --criteria=CRITERIA
206           Specify user preferences for dependency solving for this run.
207           Overrides both $OPAMCRITERIA and $OPAMUPGRADECRITERIA. For details
208           on the supported language, and the external solvers available, see
209           http://opam.ocaml.org/doc/External_solvers.html. A general guide to
210           using solver preferences can be found at
211           http://www.dicosmo.org/Articles/usercriteria.pdf.
212
213       --cudf=FILENAME
214           Debug option: Save the CUDF requests sent to the solver to
215           FILENAME-<n>.cudf.
216
217       --debug
218           Print debug message to stderr. This is equivalent to setting
219           $OPAMDEBUG to "true".
220
221       --debug-level=LEVEL
222           Like --debug, but allows specifying the debug level (--debug sets
223           it to 1). Equivalent to setting $OPAMDEBUG to a positive integer.
224
225       --git-version
226           Print the git version of opam, if set (i.e. you are using a
227           development version), and exit.
228
229       --help[=FMT] (default=auto)
230           Show this help in format FMT. The value FMT must be one of `auto',
231           `pager', `groff' or `plain'. With `auto', the format is `pager` or
232           `plain' whenever the TERM env var is `dumb' or undefined.
233
234       --ignore-pin-depends
235           Ignore extra pins required by packages that get pinned, either
236           manually through opam pin or through opam install DIR. This is
237           equivalent to setting IGNOREPINDEPENDS=true.
238
239       --json=FILENAME
240           Save the results of the opam run in a computer-readable file. If
241           the filename contains the character `%', it will be replaced by an
242           index that doesn't overwrite an existing file. Similar to setting
243           the $OPAMJSON variable.
244
245       --no-aspcud
246           Removed in 2.1.
247
248       --no-auto-upgrade
249           When configuring or updating a repository that is written for an
250           earlier opam version (1.2), opam internally converts it to the
251           current format. This disables this behaviour. Note that
252           repositories should define their format version in a 'repo' file at
253           their root, or they will be assumed to be in the older format. It
254           is, in any case, preferable to upgrade the repositories manually
255           using opam admin upgrade [--mirror URL] when possible.
256
257       --no-self-upgrade
258           Opam will replace itself with a newer binary found at OPAMROOT/opam
259           if present. This disables this behaviour.
260
261       -q, --quiet
262           Disables --verbose.
263
264       --root=ROOT
265           Use ROOT as the current root path. This is equivalent to setting
266           $OPAMROOT to ROOT.
267
268       --safe, --readonly
269           Make sure nothing will be automatically updated or rewritten.
270           Useful for calling from completion scripts, for example. Will fail
271           whenever such an operation is needed ; also avoids waiting for
272           locks, skips interactive questions and overrides the $OPAMDEBUG
273           variable. This is equivalent to set environment variable $OPAMSAFE.
274
275       --solver=CMD
276           Specify the CUDF solver to use for resolving package installation
277           problems. This is either a predefined solver (this version of opam
278           supports builtin-mccs+lp(), builtin-mccs+glpk,
279           builtin-dummy-z3-solver, builtin-dummy-0install-solver, aspcud,
280           mccs, aspcud-old, packup), or a custom command that should contain
281           the variables %{input}%, %{output}%, %{criteria}%, and optionally
282           %{timeout}%. This is equivalent to setting $OPAMEXTERNALSOLVER.
283
284       --strict
285           Fail whenever an error is found in a package definition or a
286           configuration file. The default is to continue silently if
287           possible.
288
289       --switch=SWITCH
290           Use SWITCH as the current compiler switch. This is equivalent to
291           setting $OPAMSWITCH to SWITCH.
292
293       --use-internal-solver
294           Disable any external solver, and use the built-in one (this
295           requires that opam has been compiled with a built-in solver). This
296           is equivalent to setting $OPAMNOASPCUD or $OPAMUSEINTERNALSOLVER.
297
298       -v, --verbose
299           Be more verbose. One -v shows all package commands, repeat to also
300           display commands called internally (e.g. tar, curl, patch etc.)
301           Repeating n times is equivalent to setting $OPAMVERBOSE to "n".
302
303       --version
304           Show version information.
305
306       -w, --working-dir
307           Whenever updating packages that are bound to a local,
308           version-controlled directory, update to the current working state
309           of their source instead of the last committed state, or the ref
310           they are pointing to. As source directory is copied as it is, if it
311           isn't clean it may result on a opam build failure.This only affects
312           packages explicitly listed on the command-line.It can also be set
313           with $OPAMWORKINGDIR.
314

ENVIRONMENT

316       Opam makes use of the environment variables listed here. Boolean
317       variables should be set to "0", "no", "false" or the empty string to
318       disable, "1", "yes" or "true" to enable.
319
320       OPAMALLPARENS surround all filters with parenthesis.
321
322       OPAMASSUMEDEPEXTS see option `--assume-depexts'.
323
324       OPAMAUTOREMOVE see remove option `--auto-remove'.
325
326       OPAMBESTEFFORT see option `--best-effort'.
327
328       OPAMBESTEFFORTPREFIXCRITERIA sets the string that must be prepended to
329       the criteria when the `--best-effort' option is set, and is expected to
330       maximise the `opam-query' property in the solution.
331
332       OPAMBUILDDOC Removed in 2.1.
333
334       OPAMBUILDTEST Removed in 2.1.
335
336       OPAMCLI see option `--cli'.
337
338       OPAMCOLOR when set to always or never, sets a default value for the
339       `--color' option.
340
341       OPAMCONFIRMLEVEL see option `--confirm-level`. OPAMCONFIRMLEVEL has
342       priority over OPAMYES and OPAMNO.
343
344       OPAMCRITERIA specifies user preferences for dependency solving. The
345       default value depends on the solver version, use `config report' to
346       know the current setting. See also option --criteria.
347
348       OPAMCUDFFILE save the cudf graph to file-actions-explicit.dot.
349
350       OPAMCUDFTRIM controls the filtering of unrelated packages during CUDF
351       preprocessing.
352
353       OPAMCURL can be used to select a given 'curl' program. See OPAMFETCH
354       for more options.
355
356       OPAMDEBUG see options `--debug' and `--debug-level'.
357
358       OPAMDEBUGSECTIONS if set, limits debug messages to the space-separated
359       list of sections. Sections can optionally have a specific debug level
360       (for example, CLIENT:2 or CLIENT CUDF:2), but otherwise use
361       `--debug-level'.
362
363       OPAMDIGDEPTH defines how aggressive the lookup for conflicts during
364       CUDF preprocessing is.
365
366       OPAMDOWNLOADJOBS sets the maximum number of simultaneous downloads.
367
368       OPAMDROPWORKINGDIR overrides packages previously updated with
369       --working-dir on update. Without this variable set, opam would keep
370       them unchanged unless explicitly named on the command-line.
371
372       OPAMDRYRUN see option `--dry-run'.
373
374       OPAMEDITOR sets the editor to use for opam file editing, overrides
375       $EDITOR and $VISUAL.
376
377       OPAMERRLOGLEN sets the number of log lines printed when a sub-process
378       fails. 0 to print all.
379
380       OPAMEXTERNALSOLVER see option `--solver'.
381
382       OPAMFAKE see option `--fake'.
383
384       OPAMFETCH specifies how to download files: either `wget', `curl' or a
385       custom command where variables %{url}%, %{out}%, %{retry}%,
386       %{compress}% and %{checksum}% will be replaced. Overrides the
387       'download-command' value from the main config file.
388
389       OPAMFIXUPCRITERIA same as OPAMUPGRADECRITERIA, but specific to fixup.
390
391       OPAMIGNORECONSTRAINTS see install option `--ignore-constraints-on'.
392
393       OPAMIGNOREPINDEPENDS see option `--ignore-pin-depends'.
394
395       OPAMINPLACEBUILD see option `--inplace-build'.
396
397       OPAMJOBS sets the maximum number of parallel workers to run.
398
399       OPAMJSON log json output to the given file (use character `%' to index
400       the files).
401
402       OPAMKEEPBUILDDIR see install option `--keep-build-dir'.
403
404       OPAMKEEPLOGS tells opam to not remove some temporary command logs and
405       some backups. This skips some finalisers and may also help to get more
406       reliable backtraces.
407
408       OPAMLOCKED combination of `--locked' and `--lock-suffix' options.
409
410       OPAMLOGS logdir sets log directory, default is a temporary directory in
411       /tmp
412
413       OPAMMAKECMD set the system make command to use.
414
415       OPAMMERGEOUT merge process outputs, stderr on stdout.
416
417       OPAMNO answer no to any question asked, see options `--no` and
418       `--confirm-level`. OPAMNO is ignored if either OPAMCONFIRMLEVEL or
419       OPAMYES is set.
420
421       OPAMNOAGGREGATE with `opam admin check', don't aggregate packages.
422
423       OPAMNOASPCUD Deprecated.
424
425       OPAMNOAUTOUPGRADE disables automatic internal upgrade of repositories
426       in an earlier format to the current one, on 'update' or 'init'.
427
428       OPAMNOCHECKSUMS enables option --no-checksums when available.
429
430       OPAMNODEPEXTS disables system dependencies handling, see option
431       `--no-depexts'.
432
433       OPAMNOENVNOTICE Internal.
434
435       OPAMNOSELFUPGRADE see option `--no-self-upgrade'
436
437       OPAMPINKINDAUTO sets whether version control systems should be detected
438       when pinning to a local path. Enabled by default since 1.3.0.
439
440       OPAMPRECISETRACKING fine grain tracking of directories.
441
442       OPAMPREPRO set this to false to disable CUDF preprocessing. Less
443       efficient, but might help debugging solver issue.
444
445       OPAMREQUIRECHECKSUMS Enables option `--require-checksums' when
446       available (e.g. for `opam install').
447
448       OPAMRETRIES sets the number of tries before failing downloads.
449
450       OPAMREUSEBUILDDIR see option `--reuse-build-dir'.
451
452       OPAMROOT see option `--root'. This is automatically set by `opam env
453       --root=DIR --set-root'.
454
455       OPAMROOTISOK don't complain when running as root.
456
457       OPAMSAFE see option `--safe'.
458
459       OPAMSHOW see option `--show'.
460
461       OPAMSKIPUPDATE see option `--skip-updates'.
462
463       OPAMSKIPVERSIONCHECKS bypasses some version checks. Unsafe, for
464       compatibility testing only.
465
466       OPAMSOLVERALLOWSUBOPTIMAL (default `true') allows some solvers to still
467       return a solution when they reach timeout; while the solution remains
468       assured to be consistent, there is no guarantee in this case that it
469       fits the expected optimisation criteria. If `true', opam willcontinue
470       with a warning, if `false' a timeout is an error. Currently only the
471       builtin-z3 backend handles this degraded case.
472
473       OPAMSOLVERTIMEOUT change the time allowance of the solver. Default is
474       60.0, set to 0 for unlimited. Note that all solvers may not support
475       this option.
476
477       OPAMSTATS display stats at the end of command.
478
479       OPAMSTATUSLINE display a dynamic status line showing what's currently
480       going on on the terminal. (one of one of `always', `never' or `auto')
481
482       OPAMSTRICT fail on inconsistencies (file reading, switch import, etc.).
483
484       OPAMSWITCH see option `--switch'. Automatically set by `opam env
485       --switch=SWITCH --set-switch'.
486
487       OPAMUNLOCKBASE see install option `--unlock-base'.
488
489       OPAMUPGRADECRITERIA specifies user preferences for dependency solving
490       when performing an upgrade. Overrides OPAMCRITERIA in upgrades if both
491       are set. See also option --criteria.
492
493       OPAMUSEINTERNALSOLVER see option `--use-internal-solver'.
494
495       OPAMUSEOPENSSL force openssl use for hash computing.
496
497       OPAMUTF8 use UTF8 characters in output (one of one of `always', `never'
498       or `auto'). By default `auto', which is determined from the locale).
499
500       OPAMUTF8MSGS use extended UTF8 characters (camels) in opam messages.
501       Implies OPAMUTF8. This is set by default on OSX only.
502
503       OPAMVALIDATIONHOOK if set, uses the `%{hook%}' command to validate an
504       opam repository update.
505
506       OPAMVERBOSE see option `--verbose'.
507
508       OPAMVERSIONLAGPOWER do not use.
509
510       OPAMWITHDOC see install option `--with-doc'.
511
512       OPAMWITHTEST see install option `--with-test.
513
514       OPAMWORKINGDIR see option `--working-dir'.
515
516       OPAMYES see options `--yes' and `--confirm-level`. OPAMYES has has
517       priority over OPAMNO and is ignored if OPAMCONFIRMLEVEL is set.
518
519       OPAMVAR_var overrides the contents of the variable var when
520       substituting `%{var}%` strings in `opam` files.
521
522       OPAMVAR_package_var overrides the contents of the variable package:var
523       when substituting `%{package:var}%` strings in `opam` files.
524

CLI VERSION

526       All scripts and programmatic invocations of opam should use `--cli' in
527       order to ensure that they work seamlessly with future versions of the
528       opam client. Additionally, blog posts or other documentation can
529       benefit, as it prevents information from becoming stale.
530
531       Although opam only supports roots (~/.opam/) for the current version,
532       it does provide backwards compatibility for its command-line interface.
533
534       Since CLI version support was only added in opam 2.1, use OPAMCLI to
535       select 2.0 support (as opam 2.0 will just ignore it), and `--cli=2.1'
536       for 2.1 (or later) versions, since an environment variable controlling
537       the parsing of syntax is brittle. To this end, opam displays a warning
538       if OPAMCLI specifies a valid version other than 2.0, and also if
539       `--cli=2.0' is specified.
540
541       The command-line version is selected by using the `--cli' option or the
542       OPAMCLI environment variable. `--cli' may be specified morethan once,
543       where the last instance takes precedence. OPAMCLI is only inspected if
544       `--cli' is not given.
545

EXIT STATUS

547       As an exception to the following, the `exec' command returns 127 if the
548       command was not found or couldn't be executed, and the command's exit
549       value otherwise.
550
551       0   Success, or true for boolean queries.
552
553       1   False. Returned when a boolean return value is expected, e.g. when
554           running with --check, or for queries like opam lint.
555
556       2   Bad command-line arguments, or command-line arguments pointing to
557           an invalid context (e.g. file not following the expected format).
558
559       5   Not found. You requested something (package, version, repository,
560           etc.) that couldn't be found.
561
562       10  Aborted. The operation required confirmation, which wasn't given.
563
564       15  Could not acquire the locks required for the operation.
565
566       20  There is no solution to the user request. This can be caused by
567           asking to install two incompatible packages, for example.
568
569       30  Error in package definition, or other metadata files. Using
570           --strict raises this error more often.
571
572       31  Package script error. Some package operations were unsuccessful.
573           This may be an error in the packages or an incompatibility with
574           your system. This can be a partial error.
575
576       40  Sync error. Could not fetch some remotes from the network. This can
577           be a partial error.
578
579       50  Configuration error. Opam or system configuration doesn't allow
580           operation, and needs fixing.
581
582       60  Solver failure. The solver failed to return a sound answer. It can
583           be due to a broken external solver, or an error in solver
584           configuration.
585
586       99  Internal error. Something went wrong, likely due to a bug in opam
587           itself.
588
589       130 User interrupt. SIGINT was received, generally due to the user
590           pressing Ctrl-C.
591

FURTHER DOCUMENTATION

593       See https://opam.ocaml.org/doc.
594

AUTHORS

596       Vincent Bernardoff <vb@luminar.eu.org>
597       Raja Boujbel <raja.boujbel@ocamlpro.com>
598       Roberto Di Cosmo <roberto@dicosmo.org>
599       Thomas Gazagnaire <thomas@gazagnaire.org>
600       Louis Gesbert <louis.gesbert@ocamlpro.com>
601       Fabrice Le Fessant <Fabrice.Le_fessant@inria.fr>
602       Anil Madhavapeddy <anil@recoil.org>
603       Guillem Rieu <guillem.rieu@ocamlpro.com>
604       Ralf Treinen <ralf.treinen@pps.jussieu.fr>
605       Frederic Tuong <tuong@users.gforge.inria.fr>
606

BUGS

608       Check bug reports at https://github.com/ocaml/opam/issues.
609
610
611
612Opam 2.1.1                                                       OPAM-UNPIN(1)
Impressum