OPAM ADMIN-INDEX(1) | Opam admin Manual | OPAM ADMIN-INDEX(1) |
opam admin-index - Generate an inclusive index file for serving over HTTP.
opam admin index [OPTION]...
An opam repository can be served over HTTP or HTTPS using any web server. To that purpose, an inclusive index needs to be generated first: this command generates the files the opam client will expect when fetching from an HTTP remote, and should be run after any changes are done to the contents of the repository.
These options are common to all commands.
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.
OPAMALLPARENS surround all filters with parenthesis
OPAMAUTOREMOVE see remove option `--auto-remove`
OPAMBESTEFFORT see option `--best-effort`
OPAMBESTEFFORTPREFIXCRITERIA 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
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 depends on the solver version, use `config report` to know the current setting. See also option --criteria
OPAMCUDFFILE file save the cudf graph to file-actions-explicit.dot
OPAMCURL can be used to select a given 'curl' program. See OPAMFETCH for more options.
OPAMDEBUG see options `--debug' and `--debug-level'.
OPAMDOWNLOADJOBS sets the maximum number of simultaneous downloads.
OPAMDRYRUN see option `--dry-run`
OPAMEDITOR sets the editor to use for opam file editing, overrides $EDITOR and $VISUAL
OPAMERRLOGLEN sets the number of log lines printed when a sub-process fails. 0 to print all.
OPAMEXTERNALSOLVER see option `--solver'.
OPAMFAKE see option `--fake`
OPAMFETCH specifies how to download files: either `wget', `curl' or a custom command where variables %{url}%, %{out}%, %{retry}%, %{compress}% and %{checksum}% will be replaced. Overrides the 'download-command' value from the main config file.
OPAMFIXUPCRITERIA same as OPAMUPGRADECRITERIA, but specific to fixup
OPAMIGNORECONSTRAINTS see install option `--ignore-constraints-on`
OPAMIGNOREPINDEPENDS see option `--ignore-pin-depends`
OPAMJOBS sets the maximum number of parallel workers to run.
OPAMJSON log json output to the given file (use character `%' to index the files)
OPAMLOCKED see install option `--locked`
OPAMLOGS logdir sets log directory, default is a temporary directory in /tmp
OPAMMAKECMD set the system make command to use
OPAMNOAUTOUPGRADE disables automatic internal upgrade of repositories in an earlier format to the current one, on 'update' or 'init'.
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
OPAMLOCKRETRIES sets the number of tries after which opam gives up acquiring its lock and fails. <= 0 means infinite wait.
OPAMMERGEOUT merge process outputs, stderr on stdout
OPAMNO answer no to any question asked.
OPAMNOASPCUD Deprecated.
OPAMNOCHECKSUMS enables option --no-checksums when available.
OPAMNOSELFUPGRADE see 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
OPAMREQUIRECHECKSUMS Enables option `--require-checksums' when available (e.g. for `opam install`).
OPAMRETRES sets the number of tries before failing downloads.
OPAMROOT see option `--root'. This is automatically set by `opam env --root=DIR --set-root'.
OPAMROOTISOK don't complain when running as root.
OPAMSAFE see option `--safe'
OPAMSHOW see option `--show`
OPAMSKIPUPDATE see option `--skip-updates`
OPAMSKIPVERSIONCHECKS bypasses some version checks. Unsafe, for compatibility testing only.
OPAMSOLVERTIMEOUT 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.
OPAMSTATUSLINE display a dynamic status line showing what's currently going on on the terminal. (one of one of `always', `never' or `auto')
OPAMSTATS display stats at the end of command
OPAMSTRICT fail on inconsistencies (file reading, switch import, etc.)
OPAMSWITCH see option `--switch'. Automatically set by `opam env --switch=SWITCH --set-switch'.
OPAMUNLOCKBASE see 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 option --criteria
OPAMUSEINTERNALSOLVER see option `--use-internal-solver'.
OPAMUSEOPENSSL force openssl use for hash computing
OPAMUTF8 use UTF8 characters in output (one of one of `always', `never' or `auto'). By default `auto', which is determined from the locale).
OPAMUTF8MSGS use extended UTF8 characters (camels) in opam messages. Implies OPAMUTF8. This is set by default on OSX only.
OPAMVALIDATIONHOOK hook if set, uses the `%{hook%}` command to validate an opam repository update
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.
OPAMVERBOSE see option `--verbose'.
OPAMWORKINGDIR see option `--working-dir`
OPAMYES see option `--yes'.
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.
See https://opam.ocaml.org/doc.
Vincent Bernardoff <vb@luminar.eu.org>
Raja Boujbel <raja.boujbel@ocamlpro.com>
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>
Check bug reports at https://github.com/ocaml/opam/issues.
Opam admin 2.0.8 |