OPAM-ADMIN-MIGRATE-EXTRAFILES(1)

📦
version 2.6.1 · 4 versions
, in arch rolling, fedora 44

✨ NAME ✨

opam admin-migrate-extrafiles — Move extra-files to extra-source.

yep that's it, that's the whole job 💅 this one lives in the Opam admin Manual, bestie — page OPAM-ADMIN-MIGRATE-EXTRAFILES(1), and it is such a useful little gremlin.

🌸 SYNOPSIS 🌸

opam admin migrate-extrafiles [--hash=HASH_ALGO] [--packages=PACKAGES]
[OPTION]… DIR URL

🦋 DESCRIPTION 🦋

okay so picture this: this command scans through package definitions, and then it migrates all extra-files fields to extra-source, exactly as requested. no drama, no cap, it just does the thing 💖

🎀 ARGUMENTS 🎀

  • DIR (required) — the name of the local directory where the extra-files are gonna go live. They get put into DIR/patches/<pkgname>/<pkgname.version>/filenameYY 🌈
  • URL (required) — the prefix of the URL to emit into extra-sources. so it's like, the front half of the address, and opam handles the rest ✨

💖 OPTIONS 💖

  • --hash=HASH_ALGO (absent=sha256) — the hash, or the hashes, to be added 🔐
  • -p PACKAGES, --packages= PACKAGES — only add extra files for the given packages, like, keep it to this list bestie 🎯

👑 COMMON OPTIONS 👑

these ones are common to all commands, so they show up literally everywhere. it's giving shared wardrobe 💅

  • --best-effort — don't fail if all the requested packages can't be installed; just try to install as many as possible. heads up tho: not all external solvers may support this option (recent versions of aspcud or mccs should). This is equivalent to setting the $OPAMBESTEFFORT environment variable.
  • --cli= MAJOR.MINOR (absent=2.6) — use the command-line interface syntax and semantics of MAJOR.MINOR. It's intended for any persistent use of opam (scripts, blog posts, etc.), and any version of opam in the same MAJOR series will behave as for the specified MINOR release. The flag was not available in opam 2.0, so to select the 2.0 CLI, set the OPAMCLI environment variable to 2.0 instead of using this parameter. 💀
  • --color= WHEN — colorize the output. WHEN must be one of always, never or auto. 🎨
  • --confirm-level= LEVEL — confirmation level, and LEVEL must be one of ask, no, yes or unsafe-yes. Can be specified more than once. If --yes or --no are also given, the value of the last --confirm-level is taken into account. This is equivalent to setting ``$OPAMCONFIRMLEVEL `` — yup, the manpage really does have a stray backtick hanging off the end of that one, we keep it exactly as written, iconic 🔥
  • --criteria= CRITERIA — specify user preferences for dependency solving for this run. It overrides $OPAMCRITERIA, $OPAMFIXUPCRITERIA and $OPAMUPGRADECRITERIA. For details on the supported language, and the external solvers available, see http://opam.ocaml.org/doc/External_solvers.html. A general guide to using solver preferences can be found at http://www.dicosmo.org/Articles/usercriteria.pdf. 📚
  • --cudf= FILENAME — debug option: save the CUDF requests sent to the solver to FILENAME-<n>.cudf, where <n> is the n-th call to the solver during the opam run. 🔍
  • --debug — print debug message to stderr. This is equivalent to setting $OPAMDEBUG to "true". 🐛
  • --debug-level= LEVEL — like --debug, but it lets you specify the debug level (--debug sets it to 1). Equivalent to setting $OPAMDEBUG to a positive integer.
  • --git-version — print the git version of opam, if it's set (i.e. you're using a development version), and exit. 🏃‍♀️
  • --help[= FMT ] (default=auto) — show this help in format FMT. The value FMT must be one of auto, pager, groff or plain. With auto, the format is pager or plain whenever the TERM env var is dumb or undefined. 🫶
  • --ignore-pin-depends — ignore extra pins required by packages that get pinned, either manually through opam pin or through opam install DIR. This is equivalent to setting IGNOREPINDEPENDS=true. 📌
  • --json= FILENAME — 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 $OPAMJSON variable. 🤖
  • --no — answer no to all opam yes/no questions without prompting. See also --confirm-level. This is equivalent to setting $OPAMNO to "true". 🙅‍♀️
  • --no-aspcud — Removed in 2.1. it's gone bestie, it's in the past 💀
  • --no-auto-upgrade — 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 that 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 opam admin upgrade [--mirror URL] when possible. 📦
  • -q, --quiet — disables --verbose. shhh 🤫
  • --root= ROOT — use ROOT as the current root path. This is equivalent to setting $OPAMROOT to ROOT. 🌳
  • --safe, --readonly — make sure nothing will be automatically updated or rewritten. Super useful for calling from completion scripts, for example. It will fail whenever such an operation is needed; it also avoids waiting for locks, skips interactive questions and overrides the $OPAMDEBUG variable. This is equivalent to set environment variable $OPAMSAFE. > like, nothing is touching your files, periodt. 🔒
  • --solver= CMD — 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, builtin-dummy-z3-solver, builtin-0install, 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 $OPAMEXTERNALSOLVER. 🧠
  • --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 — 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 $OPAMNOASPCUD or $OPAMUSEINTERNALSOLVER. 🏠
  • -v, --verbose — be more verbose. One -v shows all package commands, and repeating it also displays commands called internally (e.g. tar, curl, patch, etc.). Repeating n times is equivalent to setting $OPAMVERBOSE to "n". 🗣️
  • --version — show version information. 🏷️
  • -w, --working-dir — 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. Since the source directory is copied as it is, if it isn't clean it may result on a opam build failure. This only affects packages explicitly listed on the command-line. It can also be set with $OPAMWORKINGDIR. ⚠️
  • -y, --yes — answer yes to all opam yes/no questions without prompting. See also --confirm-level. This is equivalent to setting $OPAMYES to "true". ✅

So here's the deal, bestie: opam reads a whole little wardrobe of environment variables. Bool ones are ✨mood✨ — set them to "0", "no", "false" or just leave them empty to turn the thing off, and set them to "1", "yes" or "true" to turn it on.

  • OPAMALLPARENS — wraps every filter in parenthesis, no exceptions 💅
  • OPAMASSUMEDEPEXTS — the env var twin of the option `--assume-depexts'.
  • OPAMAUTOANSWER — internal use only, don't touch, that's not for us 🙈
  • OPAMAUTOREMOVE — matches the remove option `--auto-remove'.
  • OPAMBESTEFFORT — matches the option `--best-effort'.
  • OPAMBESTEFFORTPREFIXCRITERIA — sets the string that gets prepended onto the criteria whenever the --best-effort' option is on, and it's expected to maximise the opam-query' property in the solution.
  • OPAMBUILDDOC — Removed in 2.1. gone, deceased, no longer with us 💀
  • OPAMBUILDTEST — also Removed in 2.1.
  • OPAMCLI — matches the option `--cli'.
  • OPAMCOLOR — set it to always or never and it sets a default value for the `--color' option.
  • OPAMCONFIRMLEVEL — matches the option --confirm-level. Heads up: OPAMCONFIRMLEVEL outranks both OPAMYES and OPAMNO.
  • OPAMCRITERIA — your ✨personal vibe✨ for dependency solving, aka user preference. The default value depends on the solver version, so run config report' to find out what's currently set. Also peep the option --criteria`.
  • OPAMCUDFFILE — saves the cudf graph out to the file file-actions-explicit.dot.
  • OPAMCUDFTRIM — controls how unrelated packages get filtered out during CUDF preprocessing.
  • OPAMCURL — lets you pick which curl program gets used. See OPAMFETCH for the rest of the options.
  • OPAMDEBUG — matches the options --debug' and --debug-level'.
  • OPAMDEBUGSECTIONS — if you set it, debug messages get limited to that space-separated list of sections. Sections can optionally carry their own specific debug level (like CLIENT:2 or CLIENT CUDF:2), otherwise it falls back to `--debug-level'.
  • OPAMDIGDEPTH — defines how aggressive the lookup for conflicts is during CUDF preprocessing.
  • OPAMDOWNLOADJOBS — sets the maximum number of downloads happening at the same time.
  • OPAMDROPWORKINGDIR — overrides packages that were previously updated with --working-dir on update. Without this variable set, opam would leave them unchanged unless you explicitly name them on the command-line.
  • OPAMDRYRUN — matches the option `--dry-run'.
  • OPAMEDITOR — sets the editor used for editing opam files, and it overrides $EDITOR and $VISUAL. yes it's that bossy 👑
  • OPAMERRLOGLEN — sets how many log lines get printed when a sub-process fails. Set it to 0 to print literally all of them.
  • OPAMEXTERNALSOLVER — matches the option `--solver'.
  • OPAMFAKE — matches the option `--fake'.
  • OPAMFETCH — tells opam how to download files: either wget, curl, or a custom command where the variables %{url}%, %{out}%, %{retry}%, %{compress}% and %{checksum}% all get replaced. This overrides the download-command value from the main config file.
  • OPAMFIXUPCRITERIA — same energy as OPAMUPGRADECRITERIA, but specifically for fixup and reinstall.
  • OPAMIGNOREAVAILABLE — matches the install option `--ignore-available-on'.
  • OPAMIGNORECONSTRAINTS — matches the install option `--ignore-constraints-on'.
  • OPAMIGNOREPINDEPENDS — matches the option `--ignore-pin-depends'.
  • OPAMINPLACEBUILD — matches the option `--inplace-build'.
  • OPAMJOBS — sets the max number of parallel workers to run.
  • OPAMJSON — logs json output into the file you give it (use the character % to index the files).
  • OPAMKEEPBUILDDIR — matches the install option `--keep-build-dir'.
  • OPAMKEEPLOGS — tells opam to not remove some temporary command logs and some backups. It skips some finalisers and it may also help you get more reliable backtraces.
  • OPAMLOCKED — the combination of the --locked' and --lock-suffix' options.
  • OPAMLOGS — logdir — sets the log directory, and the default is a temporary directory inside /tmp.
  • OPAMMAKECMD — sets the system make command to use.
  • OPAMMERGEOUT — merges process outputs, with stderr landing on stdout.
  • OPAMNO — answers no to any question asked, see the options --no and --confirm-level. OPAMNO gets ignored if either OPAMCONFIRMLEVEL or OPAMYES is set. sorry babe, you got overruled 🙈
  • OPAMNOAGGREGATE — with `opam admin check', don't aggregate packages.
  • OPAMNOASPCUD — Deprecated.
  • OPAMNOAUTOUPGRADE — disables the automatic internal upgrade of repositories in an earlier format to the current one, which normally happens on 'update' or 'init'.
  • OPAMNOCHECKSUMS — enables the option --no-checksums whenever it's available.
  • OPAMNODEPEXTS — disables system dependencies handling, see the option `--no-depexts'.
  • OPAMNOENVNOTICE — Internal.
  • OPAMNOSELFUPGRADE — matches the option --no-self-upgrade'.
  • OPAMPINKINDAUTO — sets whether version control systems should get detected when pinning to a local path. Enabled by default since 1.3.0.
  • OPAMPRECISETRACKING — fine grain tracking of directories.
  • OPAMPREPRO — set this to false to disable CUDF preprocessing. It's less efficient, but it might help you debug a solver issue.
  • OPAMREPOSITORYTARRING — internally stores all non-vcs repositories as tar.gz files (by default, http repositories are stored as archive). This can be much faster on filesystems that don't cope well with scanning large trees. All operation are done in-memory, with no I/O for scanning the repository.
  • OPAMREQUIRECHECKSUMS — enables the option --require-checksums' whenever it's available (e.g. for `opam install').
  • OPAMRETRIES — sets the number of tries before downloads just give up and fail.
  • OPAMREUSEBUILDDIR — matches the option `--reuse-build-dir'.
  • OPAMROOT — matches the option --root'. It gets set automatically by opam env --root=DIR --set-root'`.
  • OPAMROOTISOK — don't complain when running as root. living dangerously, love that for you 🔥
  • OPAMSAFE — matches the option `--safe'.
  • OPAMSHOW — matches the option `--show'.
  • OPAMSKIPUPDATE — matches the option `--skip-updates'.
  • OPAMSKIPVERSIONCHECKS — bypasses some version checks. Unsafe, for compatibility testing only.
  • OPAMSOLVERALLOWSUBOPTIMAL — (default true) lets some solvers still return a solution when they hit timeout; and while that solution stays assured to be consistent, there's no guarantee in this case that it fits the expected optimisation criteria. If true, opam will continue with a warning; if false, a timeout is an error. Currently only the builtin-z3 backend handles this degraded case.
  • OPAMSOLVERTIMEOUT — changes the time allowance of the solver. Default is 60.0, and set it to 0 for unlimited. Note that not all solvers may support this option.
  • OPAMSOLVERTOLERANCE — changes the tolerance towards the solver choosing an unoptimized solution (i.e. it might pull outdated packages). Typical values range from 0.0 (best solution known to the solver) all the way to 1.0 (unoptimized solution). Default is 0.0. This one's useful when the solver can't find a solution in a reasonable amount of time (see $OPAMSOLVERTIMEOUT). Note that all solvers may not support this option.
  • OPAMSTATS — Removed in 2.4.
  • OPAMSTATUSLINE — displays a dynamic status line showing what's currently going on on the terminal. (one of always, never or auto)
  • OPAMSTRICT — fail on inconsistencies (file reading, switch import, etc.).
  • OPAMSWITCH — matches the option --switch'. Automatically set by opam env --switch=SWITCH --set-switch'`.
  • OPAMUNLOCKBASE — matches the install option `--unlock-base'.
  • OPAMUPGRADECRITERIA — your user preferences for dependency solving while performing an upgrade. It overrides OPAMCRITERIA in upgrades whenever both are set. See also the option --criteria.
  • OPAMUSEINTERNALSOLVER — matches the option `--use-internal-solver'.
  • OPAMUSEOPENSSL — Removed in 2.2.
  • OPAMUTF8 — use UTF8 characters in output (one of always, never or auto). By default it's auto, which gets determined from the locale 💅
  • OPAMUTF8MSGS — use extended UTF8 characters (camels 🐪) in opam messages. It implies OPAMUTF8. This is set by default on macOS only.
  • OPAMVALIDATIONHOOK — if set, uses the %{hook}% command to validate an opam repository update.
  • OPAMVERBOSE — matches the option `--verbose'.
  • OPAMVERBOSEON — matches the option --verbose-on.
  • OPAMVERSIONLAGPOWER — do not use. not a drill, just don't 💀
  • OPAMWITHDEVSETUP — matches the install option `--with-dev-setup'.
  • OPAMWITHDOC — matches the install option `--with-doc'.
  • OPAMWITHTEST — matches the install option --with-test.
  • OPAMWORKINGDIR — matches the option `--working-dir'.
  • OPAMYES — matches the options --yes' and --confirm-level. OPAMYEShas priority overOPAMNOand it gets ignored ifOPAMCONFIRMLEVEL` is set.
  • 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.

🌈 CLI VERSION 🌈

okay so bestie, listen — all your scripts and programmatic invocations of opam should be using --cli. Not optional, not a suggestion, it's the move ✨. Why? Because it makes sure they keep working seamlessly with future versions of the opam client. And bonus: blog posts and other documentation benefit too, since it stops the info from going stale. obsessed with the foresight ngl.

So even though opam only supports roots (~/.opam/) for the current version, it does provide backwards compatibility for its command-line interface. iconic behaviour honestly 👑

Here's the thing though — CLI version support was only added in opam 2.1. So if you want 2.0 support, use OPAMCLI (since opam 2.0 will just ignore it, no drama), and for 2.1 (or later) versions, use --cli=2.1. Because lowkey, an environment variable that controls the parsing of syntax is brittle. To this end, opam displays a warning if OPAMCLI specifies a valid version other than 2.0, and it also warns if --cli=2.0 is specified. 🫶

So how do you pick the command-line version? You use the --cli option, or the OPAMCLI environment variable. And heads up: --cli may be specified more than once, and in that case the last instance takes precedence. OPAMCLI only gets inspected if --cli is not given, periodt.

💀 EXIT STATUS 💀

okay bestie, here's the tea on how this thing tells you what happened when it's done. 👑

One exception first, and it's a big one: the exec command breaks the pattern. It returns 127 if the command was not found or couldn't be executed, and otherwise it returns the command's own exit value. So if you're script-checking exec, don't be surprised. 🙈

  • 0 — Success ✨ (or true, for boolean queries).
  • 1 — False. You get this when a boolean return value is expected, like when you're running with --check, or for queries like opam lint.
  • 2 — Bad command-line arguments, or arguments that point at an invalid context (like a file that doesn't follow the expected format). That's a you-typed-it-wrong situation fr.
  • 5 — Not found. You asked for something (package, version, repository, etc.) that just… doesn't exist. It's giving ghosted. 👻
  • 10 — Aborted. The operation needed confirmation and you didn't give it. No consent, no command.
  • 15 — Could not acquire the locks required for the operation. Somebody else is holding the vibe hostage. 🔒
  • 20 — There is no solution to the user request. Classic cause: asking to install two incompatible packages. Math said no. 🧮
  • 30 — Error in package definition, or other metadata files. And heads up: using --strict raises this error more often. ⚠️
  • 31 — Package script error. Some package operations were unsuccessful. Could be a bug in the packages, could be an incompatibility with your system — and it can be a partial error. 😭
  • 40 — Sync error. Couldn't fetch some remotes from the network. Also can be a partial error. 🌐
  • 50 — Configuration error. Opam or your system config doesn't allow the operation and needs fixing. ✋
  • 60 — Solver failure. The solver failed to return a sound answer. Maybe a broken external solver, maybe an error in solver configuration. It really said "idk." 💀
  • 99 — Internal error. Something went wrong, likely due to a bug in opam itself. Not you, bestie, it's them. 🙈
  • 130 — User interrupt. SIGINT was received, generally because the user pressed Ctrl+C. That was you. That was literally you. 🫶

and then there's this second little crew of codes that shows up too:

  • 0 — on success. ✅
  • 123 — on indiscriminate errors reported on standard error.
  • 124 — on command line parsing errors.
  • 125 — on unexpected internal errors (bugs).

📚 FURTHER DOCUMENTATION 📚

See https://opam.ocaml.org/doc — that's the homework, bestie, go read it. 🎀

👑 AUTHORS 👑

Look at this lineup. Absolute icons, every single one of them. 🫶

  • David Allsopp <david@tarides.com>
  • Vincent Bernardoff <vb@luminar.eu.org>
  • Raja Boujbel <raja.boujbel@ocamlpro.com>
  • Kate Deplaix <kit-ty-kate@exn.st>
  • Roberto Di Cosmo <roberto@dicosmo.org>
  • Thomas Gazagnaire <thomas@gazagnaire.org>
  • Louis Gesbert <louis.gesbert@ocamlpro.com>
  • Fabrice Le Fessant <Fabrice.Le_fessant@inria.fr>

and more legends:

  • Anil Madhavapeddy <anil@recoil.org>
  • Guillem Rieu <guillem.rieu@ocamlpro.com>
  • Ralf Treinen <ralf.treinen@pps.jussieu.fr>
  • Frederic Tuong <tuong@users.gforge.inria.fr>

🌈 SEE ALSO 🌈

  • opam admin(1) — iykyk, it's the whole family. 💜

🐛 BUGS 🐛

Check bug reports at https://github.com/ocaml/opam/issues. Found something cursed? Tell them, don't suffer in silence. 💅

and that's the whole page, bestie!! 🎀 this was Opam admin version 2.6.1, of the OPAM ADMIN-...E-EXTRAFILES(1) manual page — go forth and administer your opam, you absolute main character. slay ✨🦋🌸

📦 where this page comes from