NAME¶
opam-pin - Pin a given package to a specific version or source.
SYNOPSIS¶
opam pin [
OPTION]... [
COMMAND] [
ARG]...
DESCRIPTION¶
This command allows local customisation of the packages in a given switch. A
package can be pinned to a specific upstream version, to a path containing its
source, to a version-controlled location or to a URL. An `opam' file found at
the root of the pinned source will override the package's opam file from the
repository, and an `opam' directory will override all its metadata.
COMMANDS¶
Without argument, defaults to
list.
- list
- Lists pinned packages.
- add NAME TARGET
- Pins package NAME to TARGET, which may be a version, a path,
or a url. NAME can be omitted if TARGET is a local path
containing a package description with a name. TARGET can be omitted
with `--dev-repo'. Use url syntax or --kind to explicitly set the
kind of pinning. Git pins may target a specific branch or commit using
#branch e.g. git://host/me/pkg#testing. It is possible to
create a new package if NAME does not exist.
- remove NAME
- Unpins package NAME, restoring its definition from the repository,
if any.
- edit NAME
- Opens an editor giving you the opportunity to change the opam file that
OPAM will locally use for pinned package NAME. To simply change the
pinning target, use add. The chosen editor is determined from
environment variables OPAM_EDITOR, VISUAL or EDITOR,
in order.
OPTIONS¶
- --dev-repo
- Pin to the upstream package source for the latest development version
- -e, --edit
- With opam pin add, edit the opam file as with `opam pin edit' after
pinning.
- -k KIND, --kind=KIND
- Set the kind of pinning. Must be one of version, path, git, hg or
darcs.
- -n, --no-action
- Just record the new pinning status, and don't prompt for (re)installation
or removal of affected packages.
- -s, --short
- Output the names separated by one whitespace instead of using the usual
formatting.
COMMON OPTIONS¶
These options are common to all commands.
- --color=WHEN (absent=auto)
- Colorize the output. WHEN must be `always', `never' or `auto'.
- --compat-mode-1.0
- Compatibility mode with OPAM 1.0
- --criteria=CRITERIA
- Specify user preferences for dependency solving for this run.
Overrides both $OPAMCRITERIA and $OPAMUPGRADECRITERIA. For
details on the supported language, and the external solvers available, see
http://opam.ocaml.org/doc/Specifying_Solver_Preferences.html. A
general guide to using solver preferences can be found at
http://www.dicosmo.org/Articles/usercriteria.pdf. The default value is
-count(down),-count(removed),-notuptodate(solution),-count(new) for
upgrades, and
-count(removed),-notuptodate(request),-count(down),-notuptodate(changed),-count(changed),-notuptodate(solution)
otherwise.
- --cudf=FILENAME
- Debug option: Save the CUDF requests sent to the solver to
FILENAME-<n>.cudf.
- --debug
- Print debug message to stderr. This is equivalent to setting
$OPAMDEBUG to "true".
- --debug-level=LEVEL
- Like `--debug', but allows specifying the debug level (`--debug' sets it
to 1). Equivalent to setting $OPAMDEBUG to a positive integer.
- --git-version
- Print the git version if it exists and exit.
- --help[=FMT] (default=pager)
- Show this help in format FMT (pager, plain or groff).
- --no-base-packages
- Do not install base packages (useful for testing purposes). This is
equivalent to setting $OPAMNOBASEPACKAGES to a non-empty
string.
- --no-self-upgrade
- OPAM will replace itself with a newer binary found at OPAMROOT/opam
if present. This disables this behaviour.
- -q, --quiet
- Be quiet when installing a new compiler.
- --root=ROOT (absent=~/.opam)
- Use ROOT as the current root path. This is equivalent to setting
$OPAMROOT to ROOT.
- --safe
- Make sure nothing will be automatically updated or rewritten. Useful for
calling from completion scripts, for example. Will fail whenever such an
operation is needed ; also avoids waiting for locks, skips interactive
questions and overrides the OPAMDEBUG variable.
- --solver=CMD
- Specify the name of the external dependency solver. The default
value is aspcud
- --strict
- Fail whenever an error is found in a package definition or a configuration
file. The default is to continue silently if possible.
- --switch=SWITCH
- Use SWITCH as the current compiler switch. This is equivalent to
setting $OPAMSWITCH to SWITCH.
- --use-internal-solver, --no-aspcud
- Force use of internal heuristics, even if an external solver is
available.
- -v, --verbose
- Be more verbose. Show output of all sub-commands. This is equivalent to
setting $OPAMVERBOSE to "true".
- --version
- Show version information.
- -y, --yes
- Disable interactive mode and answer yes to all questions that would
otherwise be asked to the user. This is equivalent to setting
$OPAMYES to "true".
ENVIRONMENT VARIABLES¶
OPAM makes use of the environment variables listed here. Boolean variables
should be set to "0", "no" of "false" to
disable, "1", "yes" or "true" to enable.
OPAMCOLOR, when set to
always or
never, sets a default
value for the --color option.
OPAMCRITERIA specifies user
preferences for dependency solving.The
default value is
-count(removed),-notuptodate(request),-count(down),-notuptodate(changed),-count(changed),-notuptodate(solution).
See also option --criteria
OPAMCURL can be used to define an alternative for the 'curl' command-line
utility to download files.
OPAMDEBUG see options `--debug' and `--debug-level'.
OPAMEXTERNALSOLVER see option `--solver'.
OPAMJOBS sets the maximum number of parallel workers to run.
OPAMNOASPCUD see option `--no-aspcud'.
OPAMNOSELFUPGRADE see option `--no-self-upgrade'.
OPAMROOT see option `--root'. This is automatically set by `opam config
env --root=DIR' when DIR is non-default.
OPAMSOLVERTIMEOUT change the time allowance of the internal solver.
OPAMSWITCH see option `--switch'. Automatically set by `opam config env
--switch=SWITCH'.
OPAMUPGRADECRITERIA specifies user
preferences for dependency
solving when performing an upgrade. Overrides
OPAMCRITERIA in upgrades
if both are set.The default value is
-count(down),-count(removed),-notuptodate(solution),-count(new). See also
option --criteria
OPAMUTF8MSGS use nice UTF8 characters in OPAM messages.
OPAMVERBOSE see option `--verbose'.
OPAMVAR_var overrides the contents of the variable
var when
substituting `%{var}%` strings in `opam` files.
OPAMVAR_package_var overrides the contents of the variable
package:var when substituting `%{package:var}%` strings in `opam`
files.
OPAMUSEINTERNALSOLVER see option `--use-internal-solver'.
OPAMYES see option `--yes'.
FURTHER DOCUMENTATION¶
See
https://opam.ocaml.org.
AUTHORS¶
Thomas Gazagnaire <thomas@gazagnaire.org>
Anil Madhavapeddy <anil@recoil.org>
Fabrice Le Fessant <Fabrice.Le_fessant@inria.fr>
Frederic Tuong <tuong@users.gforge.inria.fr>
Louis Gesbert <louis.gesbert@ocamlpro.com>
Vincent Bernardoff <vb@luminar.eu.org>
Guillem Rieu <guillem.rieu@ocamlpro.com>
Roberto Di Cosmo <roberto@dicosmo.org>
BUGS¶
Check bug reports at
https://github.com/ocaml/opam/issues.