1OPAM ADMIN-MAKE(1) Opam admin Manual OPAM ADMIN-MAKE(1)
2
6 opam admin-make - An alias for index.
7
9 opam admin make [OPTION]…
10
12 opam admin make is an alias for opam admin index.
13 See opam admin index --help for details.
15
17 --full-urls-txt
18 Generate an inclusive 'urls.txt', for a repository that will be
19 used by opam versions earlier than 2.0.
20 --minimal-urls-txt
22 Generate a minimal 'urls.txt' file, that only includes the 'repo'
23 file. This allows opam versions earlier than 2.0 to read that file,
24 and be properly redirected to a repository dedicated to their
25 version, assuming a suitable 'redirect:' field is defined, instead
26 of failing. This is the default.
27 --no
29 Answer no to all opam yes/no questions without prompting. See also
30 --confirm-level. This is equivalent to setting $OPAMNO to "true".
31 --no-urls-txt
33 Don't generate a 'urls.txt' file. That index file is no longer
34 needed from opam 2.0 on, but is still used by older versions.
35 -y, --yes
37 Answer yes to all opam yes/no questions without prompting. See also
38 --confirm-level. This is equivalent to setting $OPAMYES to "true".
39
41 These options are common to all commands.
42 --best-effort
44 Don't fail if all requested packages can't be installed: try to
45 install as many as possible. Note that not all external solvers may
46 support this option (recent versions of aspcud or mccs should).
47 This is equivalent to setting $OPAMBESTEFFORT environment variable.
48 --cli=MAJOR.MINOR (absent=2.1)
50 Use the command-line interface syntax and semantics of MAJOR.MINOR.
51 Intended for any persistent use of opam (scripts, blog posts,
52 etc.), any version of opam in the same MAJOR series will behave as
53 for the specified MINOR release. The flag was not available in opam
54 2.0, so to select the 2.0 CLI, set the OPAMCLI environment variable
55 to 2.0 instead of using this parameter.
56 --color=WHEN
58 Colorize the output. WHEN must be one of always, never or auto.
59 --confirm-level=LEVEL
61 Confirmation level, LEVEL must be one of ask, no, yes or
62 unsafe-yes. Can be specified more than once. If --yes or --no are
63 also given, the value of the last --confirm-level is taken into
64 account. This is equivalent to setting $OPAMCONFIRMLEVEL`.
65 --criteria=CRITERIA
67 Specify user preferences for dependency solving for this run.
68 Overrides both $OPAMCRITERIA and $OPAMUPGRADECRITERIA. For details
69 on the supported language, and the external solvers available, see
70 http://opam.ocaml.org/doc/External_solvers.html. A general guide to
71 using solver preferences can be found at
72 http://www.dicosmo.org/Articles/usercriteria.pdf.
73 --cudf=FILENAME
75 Debug option: Save the CUDF requests sent to the solver to
76 FILENAME-<n>.cudf.
77 --debug
79 Print debug message to stderr. This is equivalent to setting
80 $OPAMDEBUG to "true".
81 --debug-level=LEVEL
83 Like --debug, but allows specifying the debug level (--debug sets
84 it to 1). Equivalent to setting $OPAMDEBUG to a positive integer.
85 --git-version
87 Print the git version of opam, if set (i.e. you are using a
88 development version), and exit.
89 --help[=FMT] (default=auto)
91 Show this help in format FMT. The value FMT must be one of auto,
92 pager, groff or plain. With auto, the format is pager or plain
93 whenever the TERM env var is dumb or undefined.
94 --ignore-pin-depends
96 Ignore extra pins required by packages that get pinned, either
97 manually through opam pin or through opam install DIR. This is
98 equivalent to setting IGNOREPINDEPENDS=true.
99 --json=FILENAME
101 Save the results of the opam run in a computer-readable file. If
102 the filename contains the character `%', it will be replaced by an
103 index that doesn't overwrite an existing file. Similar to setting
104 the $OPAMJSON variable.
105 --no-aspcud
107 Removed in 2.1.
108 --no-auto-upgrade
110 When configuring or updating a repository that is written for an
111 earlier opam version (1.2), opam internally converts it to the
112 current format. This disables this behaviour. Note that
113 repositories should define their format version in a 'repo' file at
114 their root, or they will be assumed to be in the older format. It
115 is, in any case, preferable to upgrade the repositories manually
116 using opam admin upgrade [--mirror URL] when possible.
117 -q, --quiet
119 Disables --verbose.
120 --root=ROOT
122 Use ROOT as the current root path. This is equivalent to setting
123 $OPAMROOT to ROOT.
124 --safe, --readonly
126 Make sure nothing will be automatically updated or rewritten.
127 Useful for calling from completion scripts, for example. Will fail
128 whenever such an operation is needed ; also avoids waiting for
129 locks, skips interactive questions and overrides the $OPAMDEBUG
130 variable. This is equivalent to set environment variable $OPAMSAFE.
131 --solver=CMD
133 Specify the CUDF solver to use for resolving package installation
134 problems. This is either a predefined solver (this version of opam
135 supports builtin-mccs+lp(), builtin-mccs+glpk,
136 builtin-dummy-z3-solver, builtin-dummy-0install-solver, aspcud,
137 mccs, aspcud-old, packup), or a custom command that should contain
138 the variables %{input}%, %{output}%, %{criteria}%, and optionally
139 %{timeout}%. This is equivalent to setting $OPAMEXTERNALSOLVER.
140 --strict
142 Fail whenever an error is found in a package definition or a
143 configuration file. The default is to continue silently if
144 possible.
145 --switch=SWITCH
147 Use SWITCH as the current compiler switch. This is equivalent to
148 setting $OPAMSWITCH to SWITCH.
149 --use-internal-solver
151 Disable any external solver, and use the built-in one (this
152 requires that opam has been compiled with a built-in solver). This
153 is equivalent to setting $OPAMNOASPCUD or $OPAMUSEINTERNALSOLVER.
154 -v, --verbose
156 Be more verbose. One -v shows all package commands, repeat to also
157 display commands called internally (e.g. tar, curl, patch etc.)
158 Repeating n times is equivalent to setting $OPAMVERBOSE to "n".
159 --version
161 Show version information.
162 -w, --working-dir
164 Whenever updating packages that are bound to a local,
165 version-controlled directory, update to the current working state
166 of their source instead of the last committed state, or the ref
167 they are pointing to. As source directory is copied as it is, if it
168 isn't clean it may result on a opam build failure.This only affects
169 packages explicitly listed on the command-line.It can also be set
170 with $OPAMWORKINGDIR.
171
173 Opam makes use of the environment variables listed here. Boolean
174 variables should be set to "0", "no", "false" or the empty string to
175 disable, "1", "yes" or "true" to enable.
176 OPAMALLPARENS surround all filters with parenthesis.
178 OPAMASSUMEDEPEXTS see option `--assume-depexts'.
180 OPAMAUTOREMOVE see remove option `--auto-remove'.
182 OPAMBESTEFFORT see option `--best-effort'.
184 OPAMBESTEFFORTPREFIXCRITERIA sets the string that must be prepended to
186 the criteria when the `--best-effort' option is set, and is expected to
187 maximise the `opam-query' property in the solution.
188 OPAMBUILDDOC Removed in 2.1.
190 OPAMBUILDTEST Removed in 2.1.
192 OPAMCLI see option `--cli'.
194 OPAMCOLOR when set to always or never, sets a default value for the
196 `--color' option.
197 OPAMCONFIRMLEVEL see option `--confirm-level`. OPAMCONFIRMLEVEL has
199 priority over OPAMYES and OPAMNO.
200 OPAMCRITERIA specifies user preferences for dependency solving. The
202 default value depends on the solver version, use `config report' to
203 know the current setting. See also option --criteria.
204 OPAMCUDFFILE save the cudf graph to file-actions-explicit.dot.
206 OPAMCUDFTRIM controls the filtering of unrelated packages during CUDF
208 preprocessing.
209 OPAMCURL can be used to select a given 'curl' program. See OPAMFETCH
211 for more options.
212 OPAMDEBUG see options `--debug' and `--debug-level'.
214 OPAMDEBUGSECTIONS if set, limits debug messages to the space-separated
216 list of sections. Sections can optionally have a specific debug level
217 (for example, CLIENT:2 or CLIENT CUDF:2), but otherwise use
218 `--debug-level'.
219 OPAMDIGDEPTH defines how aggressive the lookup for conflicts during
221 CUDF preprocessing is.
222 OPAMDOWNLOADJOBS sets the maximum number of simultaneous downloads.
224 OPAMDROPWORKINGDIR overrides packages previously updated with
226 --working-dir on update. Without this variable set, opam would keep
227 them unchanged unless explicitly named on the command-line.
228 OPAMDRYRUN see option `--dry-run'.
230 OPAMEDITOR sets the editor to use for opam file editing, overrides
232 $EDITOR and $VISUAL.
233 OPAMERRLOGLEN sets the number of log lines printed when a sub-process
235 fails. 0 to print all.
236 OPAMEXTERNALSOLVER see option `--solver'.
238 OPAMFAKE see option `--fake'.
240 OPAMFETCH specifies how to download files: either `wget', `curl' or a
242 custom command where variables %{url}%, %{out}%, %{retry}%,
243 %{compress}% and %{checksum}% will be replaced. Overrides the
244 'download-command' value from the main config file.
245 OPAMFIXUPCRITERIA same as OPAMUPGRADECRITERIA, but specific to fixup.
247 OPAMIGNORECONSTRAINTS see install option `--ignore-constraints-on'.
249 OPAMIGNOREPINDEPENDS see option `--ignore-pin-depends'.
251 OPAMINPLACEBUILD see option `--inplace-build'.
253 OPAMJOBS sets the maximum number of parallel workers to run.
255 OPAMJSON log json output to the given file (use character `%' to index
257 the files).
258 OPAMKEEPBUILDDIR see install option `--keep-build-dir'.
260 OPAMKEEPLOGS tells opam to not remove some temporary command logs and
262 some backups. This skips some finalisers and may also help to get more
263 reliable backtraces.
264 OPAMLOCKED combination of `--locked' and `--lock-suffix' options.
266 OPAMLOGS logdir sets log directory, default is a temporary directory in
268 /tmp
269 OPAMMAKECMD set the system make command to use.
271 OPAMMERGEOUT merge process outputs, stderr on stdout.
273 OPAMNO answer no to any question asked, see options `--no` and
275 `--confirm-level`. OPAMNO is ignored if either OPAMCONFIRMLEVEL or
276 OPAMYES is set.
277 OPAMNOAGGREGATE with `opam admin check', don't aggregate packages.
279 OPAMNOASPCUD Deprecated.
281 OPAMNOAUTOUPGRADE disables automatic internal upgrade of repositories
283 in an earlier format to the current one, on 'update' or 'init'.
284 OPAMNOCHECKSUMS enables option --no-checksums when available.
286 OPAMNODEPEXTS disables system dependencies handling, see option
288 `--no-depexts'.
289 OPAMNOENVNOTICE Internal.
291 OPAMNOSELFUPGRADE see option `--no-self-upgrade'
293 OPAMPINKINDAUTO sets whether version control systems should be detected
295 when pinning to a local path. Enabled by default since 1.3.0.
296 OPAMPRECISETRACKING fine grain tracking of directories.
298 OPAMPREPRO set this to false to disable CUDF preprocessing. Less
300 efficient, but might help debugging solver issue.
301 OPAMREQUIRECHECKSUMS Enables option `--require-checksums' when
303 available (e.g. for `opam install').
304 OPAMRETRIES sets the number of tries before failing downloads.
306 OPAMREUSEBUILDDIR see option `--reuse-build-dir'.
308 OPAMROOT see option `--root'. This is automatically set by `opam env
310 --root=DIR --set-root'.
311 OPAMROOTISOK don't complain when running as root.
313 OPAMSAFE see option `--safe'.
315 OPAMSHOW see option `--show'.
317 OPAMSKIPUPDATE see option `--skip-updates'.
319 OPAMSKIPVERSIONCHECKS bypasses some version checks. Unsafe, for
321 compatibility testing only.
322 OPAMSOLVERALLOWSUBOPTIMAL (default `true') allows some solvers to still
324 return a solution when they reach timeout; while the solution remains
325 assured to be consistent, there is no guarantee in this case that it
326 fits the expected optimisation criteria. If `true', opam willcontinue
327 with a warning, if `false' a timeout is an error. Currently only the
328 builtin-z3 backend handles this degraded case.
329 OPAMSOLVERTIMEOUT change the time allowance of the solver. Default is
331 60.0, set to 0 for unlimited. Note that all solvers may not support
332 this option.
333 OPAMSTATS display stats at the end of command.
335 OPAMSTATUSLINE display a dynamic status line showing what's currently
337 going on on the terminal. (one of one of always, never or auto)
338 OPAMSTRICT fail on inconsistencies (file reading, switch import, etc.).
340 OPAMSWITCH see option `--switch'. Automatically set by `opam env
342 --switch=SWITCH --set-switch'.
343 OPAMUNLOCKBASE see install option `--unlock-base'.
345 OPAMUPGRADECRITERIA specifies user preferences for dependency solving
347 when performing an upgrade. Overrides OPAMCRITERIA in upgrades if both
348 are set. See also option --criteria.
349 OPAMUSEINTERNALSOLVER see option `--use-internal-solver'.
351 OPAMUSEOPENSSL force openssl use for hash computing.
353 OPAMUTF8 use UTF8 characters in output (one of one of always, never or
355 auto). By default `auto', which is determined from the locale).
356 OPAMUTF8MSGS use extended UTF8 characters (camels) in opam messages.
358 Implies OPAMUTF8. This is set by default on OSX only.
359 OPAMVALIDATIONHOOK if set, uses the `%{hook%}' command to validate an
361 opam repository update.
362 OPAMVERBOSE see option `--verbose'.
364 OPAMVERSIONLAGPOWER do not use.
366 OPAMWITHDOC see install option `--with-doc'.
368 OPAMWITHTEST see install option `--with-test.
370 OPAMWORKINGDIR see option `--working-dir'.
372 OPAMYES see options `--yes' and `--confirm-level`. OPAMYES has has
374 priority over OPAMNO and is ignored if OPAMCONFIRMLEVEL is set.
375 OPAMVAR_var overrides the contents of the variable var when
377 substituting `%{var}%` strings in `opam` files.
378 OPAMVAR_package_var overrides the contents of the variable package:var
380 when substituting `%{package:var}%` strings in `opam` files.
381
383 All scripts and programmatic invocations of opam should use `--cli' in
384 order to ensure that they work seamlessly with future versions of the
385 opam client. Additionally, blog posts or other documentation can
386 benefit, as it prevents information from becoming stale.
387 Although opam only supports roots (~/.opam/) for the current version,
389 it does provide backwards compatibility for its command-line interface.
390 Since CLI version support was only added in opam 2.1, use OPAMCLI to
392 select 2.0 support (as opam 2.0 will just ignore it), and `--cli=2.1'
393 for 2.1 (or later) versions, since an environment variable controlling
394 the parsing of syntax is brittle. To this end, opam displays a warning
395 if OPAMCLI specifies a valid version other than 2.0, and also if
396 `--cli=2.0' is specified.
397 The command-line version is selected by using the `--cli' option or the
399 OPAMCLI environment variable. `--cli' may be specified morethan once,
400 where the last instance takes precedence. OPAMCLI is only inspected if
401 `--cli' is not given.
402
404 As an exception to the following, the `exec' command returns 127 if the
405 command was not found or couldn't be executed, and the command's exit
406 value otherwise.
407 0 Success, or true for boolean queries.
409 1 False. Returned when a boolean return value is expected, e.g. when
411 running with --check, or for queries like opam lint.
412 2 Bad command-line arguments, or command-line arguments pointing to
414 an invalid context (e.g. file not following the expected format).
415 5 Not found. You requested something (package, version, repository,
417 etc.) that couldn't be found.
418 10 Aborted. The operation required confirmation, which wasn't given.
420 15 Could not acquire the locks required for the operation.
422 20 There is no solution to the user request. This can be caused by
424 asking to install two incompatible packages, for example.
425 30 Error in package definition, or other metadata files. Using
427 --strict raises this error more often.
428 31 Package script error. Some package operations were unsuccessful.
430 This may be an error in the packages or an incompatibility with
431 your system. This can be a partial error.
432 40 Sync error. Could not fetch some remotes from the network. This can
434 be a partial error.
435 50 Configuration error. Opam or system configuration doesn't allow
437 operation, and needs fixing.
438 60 Solver failure. The solver failed to return a sound answer. It can
440 be due to a broken external solver, or an error in solver
441 configuration.
442 99 Internal error. Something went wrong, likely due to a bug in opam
444 itself.
445 130 User interrupt. SIGINT was received, generally due to the user
447 pressing Ctrl-C.
448
450 See https://opam.ocaml.org/doc.
451
453 Vincent Bernardoff <vb@luminar.eu.org>
454 Raja Boujbel <raja.boujbel@ocamlpro.com>
455 Roberto Di Cosmo <roberto@dicosmo.org>
456 Thomas Gazagnaire <thomas@gazagnaire.org>
457 Louis Gesbert <louis.gesbert@ocamlpro.com>
458 Fabrice Le Fessant <Fabrice.Le_fessant@inria.fr>
459 Anil Madhavapeddy <anil@recoil.org>
460 Guillem Rieu <guillem.rieu@ocamlpro.com>
461 Ralf Treinen <ralf.treinen@pps.jussieu.fr>
462 Frederic Tuong <tuong@users.gforge.inria.fr>
463
465 Check bug reports at https://github.com/ocaml/opam/issues.
466Opam admin 2.1.3 OPAM ADMIN-MAKE(1)