400 lines
18 KiB
HTML
400 lines
18 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of OPAM-SOURCE</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>OPAM-SOURCE</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-source - Get the source of an opam package.
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
<P>
|
|
|
|
<B>opam source</B> [<I>OPTION</I>]... <I>PACKAGE</I>
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
<P>
|
|
|
|
Downloads the source for a given package to a local directory for development, bug fixing or documentation purposes.
|
|
<A NAME="lbAE"> </A>
|
|
<H2>ARGUMENTS</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="1"><I>PACKAGE</I> (required)<DD>
|
|
A package name with an optional version constraint
|
|
</DL>
|
|
<A NAME="lbAF"> </A>
|
|
<H2>OPTIONS</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="2"><B>--dev-repo</B><DD>
|
|
Get the latest version-controlled source rather than the release archive
|
|
<DT id="3"><B>--dir</B>=<I>DIR</I><DD>
|
|
The directory where to put the source.
|
|
<DT id="4"><B>--pin</B><DD>
|
|
Pin the package to the downloaded source (see `opam pin').
|
|
</DL>
|
|
<A NAME="lbAG"> </A>
|
|
<H2>COMMON OPTIONS</H2>
|
|
|
|
<P>
|
|
|
|
These options are common to all commands.
|
|
<DL COMPACT>
|
|
<DT id="5"><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="6"><B>--color</B>=<I>WHEN</I><DD>
|
|
Colorize the output. <I>WHEN</I> must be one of `always', `never' or `auto'.
|
|
<DT id="7"><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="8"><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="9"><B>--debug</B><DD>
|
|
Print debug message to stderr. This is equivalent to setting <B>$OPAMDEBUG</B> to "true".
|
|
<DT id="10"><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="11"><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="12"><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="13"><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="14"><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="15"><B>--no-aspcud</B><DD>
|
|
Deprecated.
|
|
<DT id="16"><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="17"><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="18"><B>-q</B>, <B>--quiet</B><DD>
|
|
Disables <B>--verbose</B>.
|
|
<DT id="19"><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="20"><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="21"><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="22"><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="23"><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="24"><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="25"><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="26"><B>--version</B><DD>
|
|
Show version information.
|
|
<DT id="27"><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="28"><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="lbAH"> </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="lbAI"> </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="29">0<DD>
|
|
Success, or true for boolean queries.
|
|
<DT id="30">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="31">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="32">5<DD>
|
|
Not found. You requested something (package, version, repository, etc.) that couldn't be found.
|
|
<DT id="33">10<DD>
|
|
Aborted. The operation required confirmation, which wasn't given.
|
|
<DT id="34">15<DD>
|
|
Could not acquire the locks required for the operation.
|
|
<DT id="35">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="36">30<DD>
|
|
Error in package definition, or other metadata files. Using <B>--strict</B> raises this error more often.
|
|
<DT id="37">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="38">40<DD>
|
|
Sync error. Could not fetch some remotes from the network. This can be a partial error.
|
|
<DT id="39">50<DD>
|
|
Configuration error. Opam or system configuration doesn't allow operation, and needs fixing.
|
|
<DT id="40">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="41">99<DD>
|
|
Internal error. Something went wrong, likely due to a bug in opam itself.
|
|
<DT id="42">130<DD>
|
|
User interrupt. SIGINT was received, generally due to the user pressing Ctrl-C.
|
|
</DL>
|
|
<A NAME="lbAJ"> </A>
|
|
<H2>FURTHER DOCUMENTATION</H2>
|
|
|
|
<P>
|
|
|
|
See <A HREF="https://opam">https://opam</A>.ocaml.org/doc.
|
|
<A NAME="lbAK"> </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="lbAL"> </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="43"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="44"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="45"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="46"><A HREF="#lbAE">ARGUMENTS</A><DD>
|
|
<DT id="47"><A HREF="#lbAF">OPTIONS</A><DD>
|
|
<DT id="48"><A HREF="#lbAG">COMMON OPTIONS</A><DD>
|
|
<DT id="49"><A HREF="#lbAH">ENVIRONMENT VARIABLES</A><DD>
|
|
<DT id="50"><A HREF="#lbAI">EXIT STATUS</A><DD>
|
|
<DT id="51"><A HREF="#lbAJ">FURTHER DOCUMENTATION</A><DD>
|
|
<DT id="52"><A HREF="#lbAK">AUTHORS</A><DD>
|
|
<DT id="53"><A HREF="#lbAL">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:21 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|