OPAM-ADMIN-UPDATE-EXTRAFILES(1)

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

👑 OPAM-ADMIN-UPDATE-EXTRAFILES(1) 👑

okay so before anything else: this is from the Opam admin Manual, it's the page for opam admin update-extrafiles, and it is long, so we're doing this in parts. This is part 1. Buckle in, bestie 🎀

✨ NAME ✨

opam admin-update-extrafiles — adds extra-files to an opam repository. that's the whole vibe. short, sweet, does exactly what it says on the tin 💖

🦋 SYNOPSIS 🦋

so the way you actually call this is:

opam admin update-extrafiles [--hash=HASH_ALGO] [--packages=PACKAGES]
[OPTION]…

like yes, there's an [OPTION]… at the end, there are so many options, we'll get to them, breathe 💅

🌸 DESCRIPTION 🌸

so picture this: the command scans through package definitions, and then adds the extrafiles field as requested. that's it. that's the job. it goes looking, it writes the field, it moves on. main character energy, honestly 🦋

🎀 OPTIONS 🎀

these are the ones that belong to this command specifically, not the shared girlies:

  • --hash=HASH_ALGO — the hash, or hashes, that are gonna be added. plural hashes, because why be normal 🍓
  • -p PACKAGES, --packages=PACKAGES — only add extra files for the packages you name here. so if you only care about some of them, this is your girl ✨

🌈 COMMON OPTIONS 🌈

okay so these are common to all commands, not just this one. every single one of them, in order, no skips, no cap:

  • --best-effort — don't fail just because all the requested packages can't be installed: try to install as many as possible instead. but heads up — not all external solvers support this (recent versions of aspcud or mccs should, tho). 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. this is for any persistent use of opam (scripts, blog posts, etc.) — any version of opam in the same MAJOR series will behave as for the specified MINOR release. and here's the tea: the flag wasn't even available in opam 2.0, so if you wanna select the 2.0 CLI, set the OPAMCLI environment variable to 2.0 instead of using this parameter. iykyk 😭
  • --color=WHEN — colorize the output. WHEN must be one of always, never or auto. give me the rainbow or give me nothing 🌈
  • --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 ✨
  • --criteria=CRITERIA — specify user preferences for dependency solving for this run. overrides $OPAMCRITERIA, $OPAMFIXUPCRITERIA and $OPAMUPGRADECRITERIA. for the 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 set (i.e. you are 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. she's gone, bestie, don't reach for her 💀
  • --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. the shush button 🤫
  • --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. 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. this is equivalent to set environment variable $OPAMSAFE 🔒
  • --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. (so by default she's chill. with --strict she is NOT chill.) 😤
  • --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, repeat to also display 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. as 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" ✅

okay that's the options situation handled, and there's still more page coming 🦋 don't go anywhere 💖

✨ ENVIRONMENT ✨

okay bestie so opam is very into environment variables, and here's the whole roster of them 🫶. Quick rule first tho: any variable that's a boolean? set it to "0", "no", "false" or just the empty string to turn it off, and to "1", "yes" or "true" to turn it on. slay.

  • OPAMALLPARENS — surrounds all filters with parenthesis. cute and tidy 💅
  • OPAMASSUMEDEPEXTS — see the option --assume-depexts.
  • OPAMAUTOANSWER — internal use only. not for you, bestie 🙈
  • OPAMAUTOREMOVE — see the remove option --auto-remove.
  • OPAMBESTEFFORT — see the option --best-effort.
  • OPAMBESTEFFORTPREFIXCRITERIA — sets the string that must be prepended to the criteria when the --best-effort option is set, and it's expected to maximise the opam-query property in the solution.
  • OPAMBUILDDOC — Removed in 2.1. rip 💀
  • OPAMBUILDTEST — Removed in 2.1. also rip 💀
  • OPAMCLI — see the option --cli.
  • OPAMCOLOR — when set to always or never, it sets a default value for the --color option.
  • OPAMCONFIRMLEVEL — see the option --confirm-level. heads up: OPAMCONFIRMLEVEL has priority over OPAMYES and OPAMNO.
  • OPAMCRITERIA — specifies user preferences for dependency solving. the default value depends on the solver version, so run config report to know the current setting. see also the option --criteria.
  • OPAMCUDFFILE — saves the cudf graph to file-actions-explicit.dot.
  • OPAMCUDFTRIM — controls the filtering of unrelated packages during CUDF preprocessing.
  • OPAMCURL — can be used to select a given curl program. see OPAMFETCH for more options.
  • OPAMDEBUG — see the options --debug and --debug-level.
  • OPAMDEBUGSECTIONS — if set, it limits debug messages to that space-separated list of sections. sections can optionally have a specific debug level (like CLIENT:2 or CLIENT CUDF:2), but otherwise use --debug-level.
  • OPAMDIGDEPTH — defines how aggressive the lookup for conflicts during CUDF preprocessing is.
  • OPAMDOWNLOADJOBS — sets the maximum number of simultaneous downloads.
  • OPAMDROPWORKINGDIR — overrides packages previously updated with --working-dir on update. without this variable set, opam would keep them unchanged unless they were explicitly named on the command-line.
  • OPAMDRYRUN — see the option --dry-run.
  • OPAMEDITOR — sets the editor to use for opam file editing, and it overrides $EDITOR and $VISUAL.
  • OPAMERRLOGLEN — sets the number of log lines printed when a sub-process fails. 0 prints all of them.
  • OPAMEXTERNALSOLVER — see the option --solver.
  • OPAMFAKE — see the option --fake.
  • OPAMFETCH — specifies how to download files: either wget, curl, or a custom command where the variables %{url}%, %{out}%, %{retry}%, %{compress}% and %{checksum}% will be replaced. this overrides the download-command value from the main config file.
  • OPAMFIXUPCRITERIA — same as OPAMUPGRADECRITERIA, but specific to fixup and reinstall.
  • OPAMIGNOREAVAILABLE — see the install option --ignore-available-on.
  • OPAMIGNORECONSTRAINTS — see the install option --ignore-constraints-on.
  • OPAMIGNOREPINDEPENDS — see the option --ignore-pin-depends.
  • OPAMINPLACEBUILD — see the option --inplace-build.
  • OPAMJOBS — sets the maximum number of parallel workers to run.
  • OPAMJSON — logs json output to the given file (use the character % to index the files).
  • OPAMKEEPBUILDDIR — see the install option --keep-build-dir.
  • OPAMKEEPLOGS — 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.
  • OPAMLOCKED — a combination of the --locked and --lock-suffix options.
  • OPAMLOGS — logdir sets the log directory, and the default is a temporary directory in /tmp.
  • OPAMMAKECMD — sets the system make command to use.
  • OPAMMERGEOUT — merges process outputs, so stderr goes on stdout.
  • OPAMNO — answers no to any question asked, see the options --no and --confirm-level. OPAMNO is ignored if either OPAMCONFIRMLEVEL or OPAMYES is set.
  • 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, on update or init.
  • OPAMNOCHECKSUMS — enables the option --no-checksums when available.
  • OPAMNODEPEXTS — disables system dependencies handling, see the option --no-depexts.
  • OPAMNOENVNOTICE — Internal.
  • OPAMNOSELFUPGRADE — see the option --no-self-upgrade.
  • OPAMPINKINDAUTO — sets whether version control systems should be 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. less efficient, but it might help when you're debugging 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 operations are done in-memory, so there's no I/O for scanning the repository. obsessed 🔥
  • OPAMREQUIRECHECKSUMS — enables the option --require-checksums when available (e.g. for opam install).
  • OPAMRETRIES — sets the number of tries before failing downloads.
  • OPAMREUSEBUILDDIR — see the option --reuse-build-dir.
  • OPAMROOT — see the option --root. this is automatically set by opam env --root=DIR --set-root.
  • OPAMROOTISOK — don't complain when running as root.
  • OPAMSAFE — see the option --safe.
  • OPAMSHOW — see the option --show.
  • OPAMSKIPUPDATE — see the option --skip-updates.
  • OPAMSKIPVERSIONCHECKS — bypasses some version checks. Unsafe, for compatibility testing only ⚠️.
  • OPAMSOLVERALLOWSUBOPTIMAL — (default true) allows some solvers to still return a solution when they reach timeout; while the solution remains 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 — change 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) to 1.0 (unoptimized solution). default is 0.0. this option is useful in case the solver can't find a solution in a reasonable time (see $OPAMSOLVERTIMEOUT). note that not all solvers may support this option.
  • OPAMSTATS — Removed in 2.4. gone gone 💀
  • 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 — see the option --switch. automatically set by opam env --switch=SWITCH --set-switch.
  • OPAMUNLOCKBASE — see the install option --unlock-base.
  • OPAMUPGRADECRITERIA — specifies user preferences for dependency solving when performing an upgrade. overrides OPAMCRITERIA in upgrades if both are set. see also the option --criteria.
  • OPAMUSEINTERNALSOLVER — see the option --use-internal-solver.
  • OPAMUSEOPENSSL — Removed in 2.2. bye 💀
  • OPAMUTF8 — use UTF8 characters in output (one of always, never or auto). by default it's auto, which is determined from the locale.
  • OPAMUTF8MSGS — use extended UTF8 characters (camels 🐪) in opam messages. implies OPAMUTF8. this is set by default on macOS only.
  • OPAMVALIDATIONHOOK — if set, uses the %{hook}% command to validate an opam repository update.
  • OPAMVERBOSE — see the option --verbose.
  • OPAMVERBOSEON — see the option --verbose-on.
  • OPAMVERSIONLAGPOWER — do not use. like literally don't 🚫
  • OPAMWITHDEVSETUP — see the install option --with-dev-setup.
  • OPAMWITHDOC — see the install option --with-doc.
  • OPAMWITHTEST — see the install option --with-test.
  • OPAMWORKINGDIR — see the option --working-dir.
  • OPAMYES — see the options --yes and --confirm-level. OPAMYES has priority over OPAMNO and is ignored if OPAMCONFIRMLEVEL 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 listen, this part is lowkey the most important glow-up in opam's whole story ✨. all scripts and programmatic invocations of opam should use --cli so that they keep working seamlessly with future versions of the opam client. and it's not just for scripts either — blog posts and other documentation benefit too, because it stops information from going stale. main character energy for your docs, fr fr 📝.

although opam only supports roots (~/.opam/) for the current version, it does provide backwards compatibility for its command-line interface. bestie is looking out for you 🫶.

since CLI version support was only added in opam 2.1, you use OPAMCLI to select 2.0 support (as opam 2.0 will just ignore it), and --cli=2.1 for 2.1 (or later) versions — because an environment variable controlling the parsing of syntax is brittle. to this end, opam displays a warning if OPAMCLI specifies a valid version other than 2.0, and also if --cli=2.0 is specified. so yeah, you'll know 👀.

the command-line version is selected by using the --cli option or the OPAMCLI environment variable. --cli may be specified morethan once, where the last instance takes precedence. OPAMCLI is only inspected if --cli is not given.

💀 EXIT STATUS 💀

Okay bestie, listen up — this part is important because exit codes are how scripts know if you're slaying or spiraling. 🙈

EXCEPTION ALERT: the exec command is not like the others. It returns 127 if the command wasn't found or couldn't be executed, and otherwise it just returns the command's own exit value. No cap, that's the one exception to everything below.
  • 0 — Success! Or true for boolean queries. We love a win. ✨
  • 1 — False. Comes back when a boolean return value is expected, like when you run with --check, or for queries like opam lint.
  • 2 — Bad command-line arguments, or args that point at an invalid context (e.g. a file that isn't following the expected format). Rookie move, respectfully. 🫶
  • 5 — Not found. You asked for something (package, version, repository, etc.) and it literally could not be found. It's giving missing.
  • 10 — Aborted. The operation needed confirmation and you didn't give it. You ghosted it. 👻
  • 15 — Could not acquire the locks required for the operation. Someone else has the vibe checked out, bestie.
  • 20 — There is no solution to the user request. Like, this can happen when you ask to install two incompatible packages. The math isn't mathing. 💀
  • 30 — Error in package definition, or other metadata files. Using --strict raises this error more often. (Strict mode is that friend who notices everything.)
  • 31 — Package script error. Some package operations were unsuccessful. Could be an error in the packages, could be an incompatibility with your system. This can be a partial error — so not everything died, just some of it. 😭
  • 40 — Sync error. Could not fetch some remotes from the network. Also can be a partial error. Wifi said no. 📡
  • 50 — Configuration error. Opam or your system configuration doesn't allow this operation and it needs fixing. It's not you, it's the setup.
  • 60 — Solver failure. The solver failed to return a sound answer. Could be a broken external solver, or an error in solver configuration. Not its fault, but also not your problem to fix at 3am.
  • 99 — Internal error. Something went wrong, likely due to a bug in opam itself. Not you. Never you. Report it. 🐛
  • 130 — User interrupt. SIGINT was received, generally because the user pressed Ctrl+C. You did this. We all do this.
  • 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 lore drop. Go read it. 🦋

👑 AUTHORS 👑

These are the icons who built this. Show some respect, bestie. 💅

  • 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>
  • 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) — the main character. Go read that one too, fr fr.

🐛 BUGS 🐛

Check bug reports at https://github.com/ocaml/opam/issues.

Found something cursed? Say it with your chest, in the issue tracker. ✨

And that's a wrap on the whole page, mwah 💖 — this was Opam admin 2.6.1, page OPAM ADMIN-U…E-EXTRAFILES(1), and now you're officially educated. Go forth and update those extra-files, diva. 🎀🫶

📦 where this page comes from