488 lines
27 KiB
HTML
488 lines
27 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of OPAM-INIT</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>OPAM-INIT</H1>
|
|
Section: Opam Manual (1)<BR>Updated: <BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
|
|
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
<P>
|
|
|
|
opam-init - Initialize opam state, or set init options.
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
<P>
|
|
|
|
<B>opam init</B> [<I>OPTION</I>]... [<I>NAME</I>] [<I>ADDRESS</I>]
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
<P>
|
|
|
|
Initialise the opam state, or update opam init options
|
|
<P>
|
|
|
|
The <B>init</B> command initialises a local "opam root" (by default, <I>~/.opam/</I>) that holds opam's data and packages. This is a necessary step for normal operation of opam. The initial software repositories are fetched, and an initial 'switch' can also be installed, according to the configuration and options. These can be afterwards configured using <B>opam switch</B> and <B>opam repository</B>.
|
|
<P>
|
|
|
|
The initial repository and defaults can be set through a configuration file found at <I>~/.opamrc</I> or <I>/etc/opamrc</I>.
|
|
<P>
|
|
|
|
Additionally, this command allows one to customise some aspects of opam's shell integration, when run initially (avoiding the interactive dialog), but also at any later time.
|
|
<A NAME="lbAE"> </A>
|
|
<H2>ARGUMENTS</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="1"><I>ADDRESS</I><DD>
|
|
Address of the initial package repository, when creating a new opam root.
|
|
<DT id="2"><I>NAME</I> (absent=default)<DD>
|
|
Name of the initial repository, when creating a new opam root.
|
|
</DL>
|
|
<A NAME="lbAF"> </A>
|
|
<H2>OPTIONS</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="3"><B>-a</B>, <B>--auto-setup</B><DD>
|
|
Automatically do a full setup, including adding a line to your shell init files.
|
|
<DT id="4"><B>--bare</B><DD>
|
|
Initialise the opam state, but don't setup any compiler switch yet.
|
|
<DT id="5"><B>--bypass-checks</B><DD>
|
|
Skip checks on required or recommended tools, and assume everything is fine
|
|
<DT id="6"><B>-c</B> <I>PACKAGE</I>, <B>--compiler</B>=<I>PACKAGE</I><DD>
|
|
Set the compiler to install (when creating an initial switch)
|
|
<DT id="7"><B>--config</B>=<I>FILE</I><DD>
|
|
Use the given init config file. If repeated, latest has the highest priority (<B>i.e.</B> each field gets its value from where it was defined last). Specifying a URL pointing to a config file instead is allowed.
|
|
<DT id="8"><B>--disable-completion</B><DD>
|
|
Disable shell completion in opam init scripts.
|
|
<DT id="9"><B>--disable-sandboxing</B><DD>
|
|
Use a default configuration with sandboxing disabled (note that this may be overridden by `opamrc' if <B>--no-opamrc</B> is not specified or <B>--config</B> is used). Use this at your own risk, without sandboxing it is possible for a broken package script to delete all your files.
|
|
<DT id="10"><B>--disable-shell-hook</B><DD>
|
|
Disable registration of a shell hook in opam init scripts.
|
|
<DT id="11"><B>--dot-profile</B>=<I>FILENAME</I><DD>
|
|
Name of the configuration file to update instead of <I>~/.profile</I> or <I>~/.zshrc</I> based on shell detection.
|
|
<DT id="12"><B>--enable-completion</B><DD>
|
|
Setup shell completion in opam init scripts, for supported shells.
|
|
<DT id="13"><B>--enable-shell-hook</B><DD>
|
|
Setup opam init scripts to register a shell hook that will automatically keep the shell environment up-to-date at every prompt.
|
|
<DT id="14"><B>-i</B>, <B>--interactive</B><DD>
|
|
Run the setup interactively (this is the default for an initial run, or when no more specific options are specified)
|
|
<DT id="15"><B>-j</B> <I>JOBS</I>, <B>--jobs</B>=<I>JOBS</I><DD>
|
|
Set the maximal number of concurrent jobs to use. The default value is calculated from the number of cores. You can also set it using the <B>$OPAMJOBS</B> environment variable.
|
|
<DT id="16"><B>-k</B> <I>KIND</I>, <B>--kind</B>=<I>KIND</I><DD>
|
|
Specify the kind of the repository to be used (one of `http', `local', `git', `darcs' or `hg').
|
|
<DT id="17"><B>-n</B>, <B>--no-setup</B><DD>
|
|
Do not update the user shell configuration to setup opam. Also implies <B>--disable-shell-hook</B>, unless <B>--interactive</B> or specified otherwise
|
|
<DT id="18"><B>--no-opamrc</B><DD>
|
|
Don't read `/etc/opamrc' or `~/.opamrc': use the default settings and the files specified through <B>--config</B> only
|
|
<DT id="19"><B>--reinit</B><DD>
|
|
Re-run the initial checks and setup, according to opamrc, even if this is not a new opam root
|
|
<DT id="20"><B>--shell</B>=<I>SHELL</I><DD>
|
|
Sets the configuration mode for opam environment appropriate for <I>SHELL</I>. One of one of `bash', `sh', `csh', `zsh' or `fish'. Guessed from the parent processes and the $SHELL variable by default.
|
|
<DT id="21"><B>--shell-setup</B><DD>
|
|
Automatically setup the user shell configuration for opam, e.g. adding a line to the `~/.profile' file.
|
|
<DT id="22"><B>--show-default-opamrc</B><DD>
|
|
Print the built-in default configuration to stdout and exit
|
|
</DL>
|
|
<A NAME="lbAG"> </A>
|
|
<H2>CONFIGURATION FILE</H2>
|
|
|
|
<P>
|
|
|
|
Any field from the built-in initial configuration can be overridden through <I>~/.opamrc</I>, <I>/etc/opamrc</I>, or a file supplied with <I>--config</I>. The default configuration for this version of opam can be obtained using <B>--show-default-opamrc</B>.
|
|
<A NAME="lbAH"> </A>
|
|
<H2>PACKAGE BUILD OPTIONS</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="23"><B>-b</B>, <B>--keep-build-dir</B><DD>
|
|
Keep the build directories after compiling packages. This is equivalent to setting <B>$OPAMKEEPBUILDDIR</B> to "true".
|
|
<DT id="24"><B>-d</B>, <B>--with-doc</B>, <B>--build-doc</B><DD>
|
|
Build the package documentation. This only affects packages listed on the command-line. The <B>--build-doc</B> form is deprecated as this does also installation. This is equivalent to setting <B>$OPAMWITHDOC</B> (or the deprecated <B>$OPAMBUILDDOC</B>) to "true".
|
|
<DT id="25"><B>--dry-run</B><DD>
|
|
Simulate the command, but don't actually perform any changes. This also can be set with environment variable <B>$OPAMDEBUG</B>.
|
|
<DT id="26"><B>--fake</B><DD>
|
|
This option registers the actions into the opam database, without actually performing them. WARNING: This option is dangerous and likely to break your opam environment. You probably want `--dry-run'. You've been <I>warned</I>.
|
|
<DT id="27"><B>--ignore-constraints-on</B>[=<I>PACKAGES</I>] (default=)<DD>
|
|
Forces opam to ignore version constraints on all dependencies to the listed packages. This can be used to test compatibility, but expect builds to break when using this. Note that version constraints on optional dependencies and conflicts are unaffected. This is equivalent to setting <B>$OPAMIGNORECONSTRAINTS</B>.
|
|
<DT id="28"><B>--inplace-build</B><DD>
|
|
When compiling a package which has its source bound to a local directory, process the build and install actions directly in that directory, rather than in a clean copy handled by opam. This only affects packages that are explicitly listed on the command-line. This is equivalent to setting <B>$OPAMINPLACEBUILD</B> to "true".
|
|
<DT id="29"><B>--locked</B>[=<I>SUFFIX</I>] (default=locked)<DD>
|
|
In commands that use opam files found from pinned sources, if a variant of the file with an added .<I>SUFFIX</I> extension is found (e.g. <B>foo.opam.locked</B> besides <B>foo.opam</B>), that will be used instead. This is typically useful to offer a more specific set of dependencies and reproduce similar build contexts, hence the name. The <I>opam lock</I> plugin can be used to generate such files, based on the versions of the dependencies currently installed on the host. This is equivalent to setting the <B>$OPAMLOCKED</B> environment variable. Note that this option doesn't generally affect already pinned packages.
|
|
<DT id="30"><B>-m</B> <I>MAKE</I>, <B>--make</B>=<I>MAKE</I><DD>
|
|
Use <I>MAKE</I> as the default 'make' command. Deprecated: use <B>opam config set[-global] make MAKE</B> instead. Has no effect if the <I>make</I> variable is defined.
|
|
<DT id="31"><B>--no-checksums</B><DD>
|
|
Do not verify the checksum of downloaded archives.This is equivalent to setting <B>$OPAMNOCHECKSUMS</B> to "true".
|
|
<DT id="32"><B>--require-checksums</B><DD>
|
|
Reject the installation of packages that don't provide a checksum for the upstream archives. This is equivalent to setting <B>$OPAMREQUIRECHECKSUMS</B> to "true".
|
|
<DT id="33"><B>--reuse-build-dir</B><DD>
|
|
Reuse existing build directories (kept by using <B>--keep-build-dir</B>), instead of compiling from a fresh clone of the source. This can be faster, but also lead to failures if the build systems of the packages don't handle upgrades of dependencies well. This is equivalent to setting <B>$OPAMREUSEBUILDDIR</B> to "true".
|
|
<DT id="34"><B>--show-actions</B><DD>
|
|
Call the solver and display the actions. Don't perform any changes. This is equivalent to setting <B>$OPAMSHOW</B>.
|
|
<DT id="35"><B>--skip-updates</B><DD>
|
|
When running an install, upgrade or reinstall on source-pinned packages, they are normally updated from their origin first. This flag disables that behaviour and will keep them to their version in cache. This is equivalent to setting <B>$OPAMSKIPUPDATE</B>.
|
|
<DT id="36"><B>-t</B>, <B>--with-test</B>, <B>--build-test</B><DD>
|
|
Build and <B>run</B> the package unit-tests. This only affects packages listed on the command-line. The <B>--build-test</B> form is deprecated as this also affects installation. This is equivalent to setting <B>$OPAMWITHTEST</B> (or the deprecated <B>$OPAMBUILDTEST</B>) to "true".
|
|
<DT id="37"><B>--unlock-base</B><DD>
|
|
Allow changes to the packages set as switch base (typically, the main compiler). Use with caution. This is equivalent to setting the <B>$OPAMUNLOCKBASE</B> environment variable
|
|
</DL>
|
|
<A NAME="lbAI"> </A>
|
|
<H2>COMMON OPTIONS</H2>
|
|
|
|
<P>
|
|
|
|
These options are common to all commands.
|
|
<DL COMPACT>
|
|
<DT id="38"><B>--best-effort</B><DD>
|
|
Don't fail if all requested packages can't be installed: try to install as many as possible. Note that not all external solvers may support this option (recent versions of <I>aspcud</I> or <I>mccs</I> should). This is equivalent to setting <B>$OPAMBESTEFFORT</B> environment variable.
|
|
<DT id="39"><B>--color</B>=<I>WHEN</I><DD>
|
|
Colorize the output. <I>WHEN</I> must be one of `always', `never' or `auto'.
|
|
<DT id="40"><B>--criteria</B>=<I>CRITERIA</I><DD>
|
|
Specify user <I>preferences</I> for dependency solving for this run. Overrides both <B>$OPAMCRITERIA</B> and <B>$OPAMUPGRADECRITERIA</B>. For details on the supported language, and the external solvers available, see <I> <A HREF="http://opam">http://opam</A>.ocaml.org/doc/External_solvers.html</I>. A general guide to using solver preferences can be found at <I> <A HREF="http://www">http://www</A>.dicosmo.org/Articles/usercriteria.pdf</I>.
|
|
<DT id="41"><B>--cudf</B>=<I>FILENAME</I><DD>
|
|
Debug option: Save the CUDF requests sent to the solver to <I>FILENAME</I>-<n>.cudf.
|
|
<DT id="42"><B>--debug</B><DD>
|
|
Print debug message to stderr. This is equivalent to setting <B>$OPAMDEBUG</B> to "true".
|
|
<DT id="43"><B>--debug-level</B>=<I>LEVEL</I><DD>
|
|
Like <B>--debug</B>, but allows specifying the debug level (<B>--debug</B> sets it to 1). Equivalent to setting <B>$OPAMDEBUG</B> to a positive integer.
|
|
<DT id="44"><B>--git-version</B><DD>
|
|
Print the git version of opam, if set (i.e. you are using a development version), and exit.
|
|
<DT id="45"><B>--help</B>[=<I>FMT</I>] (default=auto)<DD>
|
|
Show this help in format <I>FMT</I>. The value <I>FMT</I> must be one of `auto', `pager', `groff' or `plain'. With `auto', the format is `pager` or `plain' whenever the <B>TERM</B> env var is `dumb' or undefined.
|
|
<DT id="46"><B>--ignore-pin-depends</B><DD>
|
|
Ignore extra pins required by packages that get pinned, either manually through <I>opam pin</I> or through <I>opam install DIR</I>. This is equivalent to setting <B>IGNOREPINDEPENDS=true</B>.
|
|
<DT id="47"><B>--json</B>=<I>FILENAME</I><DD>
|
|
Save the results of the opam run in a computer-readable file. If the filename contains the character `%', it will be replaced by an index that doesn't overwrite an existing file. Similar to setting the <B>$OPAMJSON</B> variable.
|
|
<DT id="48"><B>--no-aspcud</B><DD>
|
|
Deprecated.
|
|
<DT id="49"><B>--no-auto-upgrade</B><DD>
|
|
When configuring or updating a repository that is written for an earlier opam version (1.2), opam internally converts it to the current format. This disables this behaviour. Note that repositories should define their format version in a 'repo' file at their root, or they will be assumed to be in the older format. It is, in any case, preferable to upgrade the repositories manually using <I>opam admin upgrade [--mirror URL]</I> when possible.
|
|
<DT id="50"><B>--no-self-upgrade</B><DD>
|
|
Opam will replace itself with a newer binary found at <B>OPAMROOT/opam</B> if present. This disables this behaviour.
|
|
<DT id="51"><B>-q</B>, <B>--quiet</B><DD>
|
|
Disables <B>--verbose</B>.
|
|
<DT id="52"><B>--root</B>=<I>ROOT</I><DD>
|
|
Use <I>ROOT</I> as the current root path. This is equivalent to setting <B>$OPAMROOT</B> to <I>ROOT</I>.
|
|
<DT id="53"><B>--safe</B>, <B>--readonly</B><DD>
|
|
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 <B>$OPAMDEBUG</B> variable. This is equivalent to set environment variable <B>$OPAMSAFE</B>.
|
|
<DT id="54"><B>--solver</B>=<I>CMD</I><DD>
|
|
Specify the CUDF solver to use for resolving package installation problems. This is either a predefined solver (this version of opam supports builtin-mccs+lp(), builtin-mccs+glpk, aspcud, mccs, aspcud-old, packup), or a custom command that should contain the variables %{input}%, %{output}%, %{criteria}%, and optionally %{timeout}%. This is equivalent to setting <B>$OPAMEXTERNALSOLVER</B>.
|
|
<DT id="55"><B>--strict</B><DD>
|
|
Fail whenever an error is found in a package definition or a configuration file. The default is to continue silently if possible.
|
|
<DT id="56"><B>--switch</B>=<I>SWITCH</I><DD>
|
|
Use <I>SWITCH</I> as the current compiler switch. This is equivalent to setting <B>$OPAMSWITCH</B> to <I>SWITCH</I>.
|
|
<DT id="57"><B>--use-internal-solver</B><DD>
|
|
Disable any external solver, and use the built-in one (this requires that opam has been compiled with a built-in solver). This is equivalent to setting <B>$OPAMNOASPCUD</B> or <B>$OPAMUSEINTERNALSOLVER</B>.
|
|
<DT id="58"><B>-v</B>, <B>--verbose</B><DD>
|
|
Be more verbose. One <B>-v</B> shows all package commands, repeat to also display commands called internally (e.g. <I>tar</I>, <I>curl</I>, <I>patch</I> etc.) Repeating <I>n</I> times is equivalent to setting <B>$OPAMVERBOSE</B> to "<I>n</I>".
|
|
<DT id="59"><B>--version</B><DD>
|
|
Show version information.
|
|
<DT id="60"><B>-w</B>, <B>--working-dir</B><DD>
|
|
Whenever updating packages that are bound to a local, version-controlled directory, update to the current working state of their source instead of the last committed state, or the ref they are pointing to. This only affects packages explicitly listed on the command-line.It can also be set with <B>$OPAMWORKINGDIR</B>.
|
|
<DT id="61"><B>-y</B>, <B>--yes</B><DD>
|
|
Answer yes to all yes/no questions without prompting. This is equivalent to setting <B>$OPAMYES</B> to "true".
|
|
</DL>
|
|
<A NAME="lbAJ"> </A>
|
|
<H2>ENVIRONMENT VARIABLES</H2>
|
|
|
|
<P>
|
|
|
|
Opam makes use of the environment variables listed here. Boolean variables should be set to "0", "no", "false" or the empty string to disable, "1", "yes" or "true" to enable.
|
|
<P>
|
|
|
|
<I>OPAMALLPARENS</I> surround all filters with parenthesis
|
|
<P>
|
|
|
|
<I>OPAMAUTOREMOVE</I> see remove option `--auto-remove`
|
|
<P>
|
|
|
|
<I>OPAMBESTEFFORT</I> see option `--best-effort`
|
|
<P>
|
|
|
|
<I>OPAMBESTEFFORTPREFIXCRITERIA</I> sets the string that must be prepended to the criteria when the `--best-effort` option is set, and is expected to maximise the `opam-query` property in the solution
|
|
<P>
|
|
|
|
<I>OPAMCOLOR</I>, when set to <I>always</I> or <I>never</I>, sets a default value for the --color option.
|
|
<P>
|
|
|
|
<I>OPAMCRITERIA</I> specifies user <I>preferences</I> for dependency solving. The default value depends on the solver version, use `config report` to know the current setting. See also option --criteria
|
|
<P>
|
|
|
|
<I>OPAMCUDFFILE file</I> save the cudf graph to <I>file</I>-actions-explicit.dot
|
|
<P>
|
|
|
|
<I>OPAMCURL</I> can be used to select a given 'curl' program. See <I>OPAMFETCH</I> for more options.
|
|
<P>
|
|
|
|
<I>OPAMDEBUG</I> see options `--debug' and `--debug-level'.
|
|
<P>
|
|
|
|
<I>OPAMDOWNLOADJOBS</I> sets the maximum number of simultaneous downloads.
|
|
<P>
|
|
|
|
<I>OPAMDRYRUN</I> see option `--dry-run`
|
|
<P>
|
|
|
|
<I>OPAMEDITOR</I> sets the editor to use for opam file editing, overrides <I>$EDITOR</I> and <I>$VISUAL</I>
|
|
<P>
|
|
|
|
<I>OPAMERRLOGLEN</I> sets the number of log lines printed when a sub-process fails. 0 to print all.
|
|
<P>
|
|
|
|
<I>OPAMEXTERNALSOLVER</I> see option `--solver'.
|
|
<P>
|
|
|
|
<I>OPAMFAKE</I> see option `--fake`
|
|
<P>
|
|
|
|
<I>OPAMFETCH</I> specifies how to download files: either `wget', `curl' or a custom command where variables <B>%{url}%</B>, <B>%{out}%</B>, <B>%{retry}%</B>, <B>%{compress}%</B> and <B>%{checksum}%</B> will be replaced. Overrides the 'download-command' value from the main config file.
|
|
<P>
|
|
|
|
<I>OPAMFIXUPCRITERIA</I> same as <I>OPAMUPGRADECRITERIA</I>, but specific to fixup
|
|
<P>
|
|
|
|
<I>OPAMIGNORECONSTRAINTS</I> see install option `--ignore-constraints-on`
|
|
<P>
|
|
|
|
<I>OPAMIGNOREPINDEPENDS</I> see option `--ignore-pin-depends`
|
|
<P>
|
|
|
|
<I>OPAMJOBS</I> sets the maximum number of parallel workers to run.
|
|
<P>
|
|
|
|
<I>OPAMJSON</I> log json output to the given file (use character `%' to index the files)
|
|
<P>
|
|
|
|
<I>OPAMLOCKED</I> see install option `--locked`
|
|
<P>
|
|
|
|
<I>OPAMLOGS logdir</I> sets log directory, default is a temporary directory in /tmp
|
|
<P>
|
|
|
|
<I>OPAMMAKECMD</I> set the system make command to use
|
|
<P>
|
|
|
|
<I>OPAMNOAUTOUPGRADE</I> disables automatic internal upgrade of repositories in an earlier format to the current one, on 'update' or 'init'.
|
|
<P>
|
|
|
|
<I>OPAMKEEPLOGS</I> tells opam to not remove some temporary command logs and some backups. This skips some finalisers and may also help to get more reliable backtraces
|
|
<P>
|
|
|
|
<I>OPAMLOCKRETRIES</I> sets the number of tries after which opam gives up acquiring its lock and fails. <= 0 means infinite wait.
|
|
<P>
|
|
|
|
<I>OPAMMERGEOUT</I> merge process outputs, stderr on stdout
|
|
<P>
|
|
|
|
<I>OPAMNO</I> answer no to any question asked.
|
|
<P>
|
|
|
|
<I>OPAMNOASPCUD</I> Deprecated.
|
|
<P>
|
|
|
|
<I>OPAMNOCHECKSUMS</I> enables option --no-checksums when available.
|
|
<P>
|
|
|
|
<I>OPAMNOSELFUPGRADE</I> see option `--no-self-upgrade'.
|
|
<P>
|
|
|
|
<I>OPAMPINKINDAUTO</I> sets whether version control systems should be detected when pinning to a local path. Enabled by default since 1.3.0.
|
|
<P>
|
|
|
|
<I>OPAMPRECISETRACKING</I> fine grain tracking of directories
|
|
<P>
|
|
|
|
<I>OPAMREQUIRECHECKSUMS</I> Enables option `--require-checksums' when available (e.g. for `opam install`).
|
|
<P>
|
|
|
|
<I>OPAMRETRES</I> sets the number of tries before failing downloads.
|
|
<P>
|
|
|
|
<I>OPAMROOT</I> see option `--root'. This is automatically set by `opam env --root=DIR --set-root'.
|
|
<P>
|
|
|
|
<I>OPAMROOTISOK</I> don't complain when running as root.
|
|
<P>
|
|
|
|
<I>OPAMSAFE</I> see option `--safe'
|
|
<P>
|
|
|
|
<I>OPAMSHOW</I> see option `--show`
|
|
<P>
|
|
|
|
<I>OPAMSKIPUPDATE</I> see option `--skip-updates`
|
|
<P>
|
|
|
|
<I>OPAMSKIPVERSIONCHECKS</I> bypasses some version checks. Unsafe, for compatibility testing only.
|
|
<P>
|
|
|
|
<I>OPAMSOLVERTIMEOUT</I> change the time allowance of the solver. Default is 60.0, set to 0 for unlimited. Note that all solvers may not support this option.
|
|
<P>
|
|
|
|
<I>OPAMSTATUSLINE</I> display a dynamic status line showing what's currently going on on the terminal. (one of one of `always', `never' or `auto')
|
|
<P>
|
|
|
|
<I>OPAMSTATS</I> display stats at the end of command
|
|
<P>
|
|
|
|
<I>OPAMSTRICT</I> fail on inconsistencies (file reading, switch import, etc.)
|
|
<P>
|
|
|
|
<I>OPAMSWITCH</I> see option `--switch'. Automatically set by `opam env --switch=SWITCH --set-switch'.
|
|
<P>
|
|
|
|
<I>OPAMUNLOCKBASE</I> see install option `--unlock-base`
|
|
<P>
|
|
|
|
<I>OPAMUPGRADECRITERIA</I> specifies user <I>preferences</I> for dependency solving when performing an upgrade. Overrides <I>OPAMCRITERIA</I> in upgrades if both are set. See also option --criteria
|
|
<P>
|
|
|
|
<I>OPAMUSEINTERNALSOLVER</I> see option `--use-internal-solver'.
|
|
<P>
|
|
|
|
<I>OPAMUSEOPENSSL</I> force openssl use for hash computing
|
|
<P>
|
|
|
|
<I>OPAMUTF8</I> use UTF8 characters in output (one of one of `always', `never' or `auto'). By default `auto', which is determined from the locale).
|
|
<P>
|
|
|
|
<I>OPAMUTF8MSGS</I> use extended UTF8 characters (camels) in opam messages. Implies <I>OPAMUTF8</I>. This is set by default on OSX only.
|
|
<P>
|
|
|
|
<I>OPAMVALIDATIONHOOK hook</I> if set, uses the `%{hook%}` command to validate an opam repository update
|
|
<P>
|
|
|
|
<I>OPAMVAR_var</I> overrides the contents of the variable <I>var</I> when substituting `%{var}%` strings in `opam` files.
|
|
<P>
|
|
|
|
<I>OPAMVAR_package_var</I> overrides the contents of the variable <I>package:var</I> when substituting `%{package:var}%` strings in `opam` files.
|
|
<P>
|
|
|
|
<I>OPAMVERBOSE</I> see option `--verbose'.
|
|
<P>
|
|
|
|
<I>OPAMWORKINGDIR</I> see option `--working-dir`
|
|
<P>
|
|
|
|
<I>OPAMYES</I> see option `--yes'.
|
|
<A NAME="lbAK"> </A>
|
|
<H2>EXIT STATUS</H2>
|
|
|
|
<P>
|
|
|
|
As an exception to the following, the `exec' command returns 127 if the command was not found or couldn't be executed, and the command's exit value otherwise.
|
|
<DL COMPACT>
|
|
<DT id="62">0<DD>
|
|
Success, or true for boolean queries.
|
|
<DT id="63">1<DD>
|
|
False. Returned when a boolean return value is expected, e.g. when running with <B>--check</B>, or for queries like <B>opam lint</B>.
|
|
<DT id="64">2<DD>
|
|
Bad command-line arguments, or command-line arguments pointing to an invalid context (e.g. file not following the expected format).
|
|
<DT id="65">5<DD>
|
|
Not found. You requested something (package, version, repository, etc.) that couldn't be found.
|
|
<DT id="66">10<DD>
|
|
Aborted. The operation required confirmation, which wasn't given.
|
|
<DT id="67">15<DD>
|
|
Could not acquire the locks required for the operation.
|
|
<DT id="68">20<DD>
|
|
There is no solution to the user request. This can be caused by asking to install two incompatible packages, for example.
|
|
<DT id="69">30<DD>
|
|
Error in package definition, or other metadata files. Using <B>--strict</B> raises this error more often.
|
|
<DT id="70">31<DD>
|
|
Package script error. Some package operations were unsuccessful. This may be an error in the packages or an incompatibility with your system. This can be a partial error.
|
|
<DT id="71">40<DD>
|
|
Sync error. Could not fetch some remotes from the network. This can be a partial error.
|
|
<DT id="72">50<DD>
|
|
Configuration error. Opam or system configuration doesn't allow operation, and needs fixing.
|
|
<DT id="73">60<DD>
|
|
Solver failure. The solver failed to return a sound answer. It can be due to a broken external solver, or an error in solver configuration.
|
|
<DT id="74">99<DD>
|
|
Internal error. Something went wrong, likely due to a bug in opam itself.
|
|
<DT id="75">130<DD>
|
|
User interrupt. SIGINT was received, generally due to the user pressing Ctrl-C.
|
|
</DL>
|
|
<A NAME="lbAL"> </A>
|
|
<H2>FURTHER DOCUMENTATION</H2>
|
|
|
|
<P>
|
|
|
|
See <A HREF="https://opam">https://opam</A>.ocaml.org/doc.
|
|
<A NAME="lbAM"> </A>
|
|
<H2>AUTHORS</H2>
|
|
|
|
<P>
|
|
|
|
Vincent Bernardoff <<A HREF="mailto:vb@luminar">vb@luminar</A>.eu.org>
|
|
<P>
|
|
<P>
|
|
|
|
Raja Boujbel <raja.<A HREF="mailto:boujbel@ocamlpro">boujbel@ocamlpro</A>.com>
|
|
<P>
|
|
<P>
|
|
|
|
Roberto Di Cosmo <<A HREF="mailto:roberto@dicosmo">roberto@dicosmo</A>.org>
|
|
<P>
|
|
<P>
|
|
|
|
Thomas Gazagnaire <<A HREF="mailto:thomas@gazagnaire">thomas@gazagnaire</A>.org>
|
|
<P>
|
|
<P>
|
|
|
|
Louis Gesbert <louis.<A HREF="mailto:gesbert@ocamlpro">gesbert@ocamlpro</A>.com>
|
|
<P>
|
|
<P>
|
|
|
|
Fabrice Le Fessant <Fabrice.<A HREF="mailto:Le_fessant@inria">Le_fessant@inria</A>.fr>
|
|
<P>
|
|
<P>
|
|
|
|
Anil Madhavapeddy <<A HREF="mailto:anil@recoil">anil@recoil</A>.org>
|
|
<P>
|
|
<P>
|
|
|
|
Guillem Rieu <guillem.<A HREF="mailto:rieu@ocamlpro">rieu@ocamlpro</A>.com>
|
|
<P>
|
|
<P>
|
|
|
|
Ralf Treinen <ralf.treinen@pps.jussieu.fr>
|
|
<P>
|
|
<P>
|
|
|
|
Frederic Tuong <<A HREF="mailto:tuong@users">tuong@users</A>.gforge.inria.fr>
|
|
<A NAME="lbAN"> </A>
|
|
<H2>BUGS</H2>
|
|
|
|
<P>
|
|
|
|
Check bug reports at <A HREF="https://github">https://github</A>.com/ocaml/opam/issues.
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="76"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="77"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="78"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="79"><A HREF="#lbAE">ARGUMENTS</A><DD>
|
|
<DT id="80"><A HREF="#lbAF">OPTIONS</A><DD>
|
|
<DT id="81"><A HREF="#lbAG">CONFIGURATION FILE</A><DD>
|
|
<DT id="82"><A HREF="#lbAH">PACKAGE BUILD OPTIONS</A><DD>
|
|
<DT id="83"><A HREF="#lbAI">COMMON OPTIONS</A><DD>
|
|
<DT id="84"><A HREF="#lbAJ">ENVIRONMENT VARIABLES</A><DD>
|
|
<DT id="85"><A HREF="#lbAK">EXIT STATUS</A><DD>
|
|
<DT id="86"><A HREF="#lbAL">FURTHER DOCUMENTATION</A><DD>
|
|
<DT id="87"><A HREF="#lbAM">AUTHORS</A><DD>
|
|
<DT id="88"><A HREF="#lbAN">BUGS</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:05:20 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|