1OPAM-OPTION(1) Opam Manual OPAM-OPTION(1)
2
6 opam-option - Global and switch configuration options settings
7
9 opam option [OPTION]... [FIELD[(=|+=|-=)[VALUE]]]
10
12 Without argument, list all configurable fields. If a field name FIELD
13 is given, display its content. Otherwise, sets or updates the given
14 field in the global/switch configuration file. For global
15 configuration, FIELD is reset to its default initial value, as after a
16 fresh init (use `opam init show-default-opamrc` to display it).
17
19 FIELD[(=|+=|-=)[VALUE]]
20 If only FIELD is given, displays its associated value. If VALUE is
21 absent, FIELD's value is reverted. Otherwise, its value is updated:
22 overwrite (=), append (+=), or remove of an element (-=).
23
25 --global
26 Act on global configuration
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 -y, --yes
33 Answer yes to all opam yes/no questions without prompting. See also
34 --confirm-level. This is equivalent to setting $OPAMYES to "true".
35
37 These options are common to all commands.
38 --best-effort
40 Don't fail if all requested packages can't be installed: try to
41 install as many as possible. Note that not all external solvers may
42 support this option (recent versions of aspcud or mccs should).
43 This is equivalent to setting $OPAMBESTEFFORT environment variable.
44 --cli=MAJOR.MINOR (absent=2.1)
46 Use the command-line interface syntax and semantics of MAJOR.MINOR.
47 Intended for any persistent use of opam (scripts, blog posts,
48 etc.), any version of opam in the same MAJOR series will behave as
49 for the specified MINOR release. The flag was not available in opam
50 2.0, so to select the 2.0 CLI, set the OPAMCLI environment variable
51 to 2.0 instead of using this parameter.
52 --color=WHEN
54 Colorize the output. WHEN must be one of `always', `never' or
55 `auto'.
56 --confirm-level=LEVEL
58 Confirmation level, LEVEL must be one of `ask', `no', `yes' or
59 `unsafe-yes'. Can be specified more than once. If --yes or --no are
60 also given, the value of the last --confirm-level is taken into
61 account. This is equivalent to setting $OPAMCONFIRMLEVEL`.
62 --criteria=CRITERIA
64 Specify user preferences for dependency solving for this run.
65 Overrides both $OPAMCRITERIA and $OPAMUPGRADECRITERIA. For details
66 on the supported language, and the external solvers available, see
67 http://opam.ocaml.org/doc/External_solvers.html. A general guide to
68 using solver preferences can be found at
69 http://www.dicosmo.org/Articles/usercriteria.pdf.
70 --cudf=FILENAME
72 Debug option: Save the CUDF requests sent to the solver to
73 FILENAME-<n>.cudf.
74 --debug
76 Print debug message to stderr. This is equivalent to setting
77 $OPAMDEBUG to "true".
78 --debug-level=LEVEL
80 Like --debug, but allows specifying the debug level (--debug sets
81 it to 1). Equivalent to setting $OPAMDEBUG to a positive integer.
82 --git-version
84 Print the git version of opam, if set (i.e. you are using a
85 development version), and exit.
86 --help[=FMT] (default=auto)
88 Show this help in format FMT. The value FMT must be one of `auto',
89 `pager', `groff' or `plain'. With `auto', the format is `pager` or
90 `plain' whenever the TERM env var is `dumb' or undefined.
91 --ignore-pin-depends
93 Ignore extra pins required by packages that get pinned, either
94 manually through opam pin or through opam install DIR. This is
95 equivalent to setting IGNOREPINDEPENDS=true.
96 --json=FILENAME
98 Save the results of the opam run in a computer-readable file. If
99 the filename contains the character `%', it will be replaced by an
100 index that doesn't overwrite an existing file. Similar to setting
101 the $OPAMJSON variable.
102 --no-aspcud
104 Removed in 2.1.
105 --no-auto-upgrade
107 When configuring or updating a repository that is written for an
108 earlier opam version (1.2), opam internally converts it to the
109 current format. This disables this behaviour. Note that
110 repositories should define their format version in a 'repo' file at
111 their root, or they will be assumed to be in the older format. It
112 is, in any case, preferable to upgrade the repositories manually
113 using opam admin upgrade [--mirror URL] when possible.
114 --no-self-upgrade
116 Opam will replace itself with a newer binary found at OPAMROOT/opam
117 if present. This disables this behaviour.
118 -q, --quiet
120 Disables --verbose.
121 --root=ROOT
123 Use ROOT as the current root path. This is equivalent to setting
124 $OPAMROOT to ROOT.
125 --safe, --readonly
127 Make sure nothing will be automatically updated or rewritten.
128 Useful for calling from completion scripts, for example. Will fail
129 whenever such an operation is needed ; also avoids waiting for
130 locks, skips interactive questions and overrides the $OPAMDEBUG
131 variable. This is equivalent to set environment variable $OPAMSAFE.
132 --solver=CMD
134 Specify the CUDF solver to use for resolving package installation
135 problems. This is either a predefined solver (this version of opam
136 supports builtin-mccs+lp(), builtin-mccs+glpk,
137 builtin-dummy-z3-solver, builtin-dummy-0install-solver, aspcud,
138 mccs, aspcud-old, packup), or a custom command that should contain
139 the variables %{input}%, %{output}%, %{criteria}%, and optionally
140 %{timeout}%. This is equivalent to setting $OPAMEXTERNALSOLVER.
141 --strict
143 Fail whenever an error is found in a package definition or a
144 configuration file. The default is to continue silently if
145 possible.
146 --switch=SWITCH
148 Use SWITCH as the current compiler switch. This is equivalent to
149 setting $OPAMSWITCH to SWITCH.
150 --use-internal-solver
152 Disable any external solver, and use the built-in one (this
153 requires that opam has been compiled with a built-in solver). This
154 is equivalent to setting $OPAMNOASPCUD or $OPAMUSEINTERNALSOLVER.
155 -v, --verbose
157 Be more verbose. One -v shows all package commands, repeat to also
158 display commands called internally (e.g. tar, curl, patch etc.)
159 Repeating n times is equivalent to setting $OPAMVERBOSE to "n".
160 --version
162 Show version information.
163 -w, --working-dir
165 Whenever updating packages that are bound to a local,
166 version-controlled directory, update to the current working state
167 of their source instead of the last committed state, or the ref
168 they are pointing to. As source directory is copied as it is, if it
169 isn't clean it may result on a opam build failure.This only affects
170 packages explicitly listed on the command-line.It can also be set
171 with $OPAMWORKINGDIR.
172
174 Opam makes use of the environment variables listed here. Boolean
175 variables should be set to "0", "no", "false" or the empty string to
176 disable, "1", "yes" or "true" to enable.
177 OPAMALLPARENS surround all filters with parenthesis.
179 OPAMASSUMEDEPEXTS see option `--assume-depexts'.
181 OPAMAUTOREMOVE see remove option `--auto-remove'.
183 OPAMBESTEFFORT see option `--best-effort'.
185 OPAMBESTEFFORTPREFIXCRITERIA sets the string that must be prepended to
187 the criteria when the `--best-effort' option is set, and is expected to
188 maximise the `opam-query' property in the solution.
189 OPAMBUILDDOC Removed in 2.1.
191 OPAMBUILDTEST Removed in 2.1.
193 OPAMCLI see option `--cli'.
195 OPAMCOLOR when set to always or never, sets a default value for the
197 `--color' option.
198 OPAMCONFIRMLEVEL see option `--confirm-level`. OPAMCONFIRMLEVEL has
200 priority over OPAMYES and OPAMNO.
201 OPAMCRITERIA specifies user preferences for dependency solving. The
203 default value depends on the solver version, use `config report' to
204 know the current setting. See also option --criteria.
205 OPAMCUDFFILE save the cudf graph to file-actions-explicit.dot.
207 OPAMCUDFTRIM controls the filtering of unrelated packages during CUDF
209 preprocessing.
210 OPAMCURL can be used to select a given 'curl' program. See OPAMFETCH
212 for more options.
213 OPAMDEBUG see options `--debug' and `--debug-level'.
215 OPAMDEBUGSECTIONS if set, limits debug messages to the space-separated
217 list of sections. Sections can optionally have a specific debug level
218 (for example, CLIENT:2 or CLIENT CUDF:2), but otherwise use
219 `--debug-level'.
220 OPAMDIGDEPTH defines how aggressive the lookup for conflicts during
222 CUDF preprocessing is.
223 OPAMDOWNLOADJOBS sets the maximum number of simultaneous downloads.
225 OPAMDROPWORKINGDIR overrides packages previously updated with
227 --working-dir on update. Without this variable set, opam would keep
228 them unchanged unless explicitly named on the command-line.
229 OPAMDRYRUN see option `--dry-run'.
231 OPAMEDITOR sets the editor to use for opam file editing, overrides
233 $EDITOR and $VISUAL.
234 OPAMERRLOGLEN sets the number of log lines printed when a sub-process
236 fails. 0 to print all.
237 OPAMEXTERNALSOLVER see option `--solver'.
239 OPAMFAKE see option `--fake'.
241 OPAMFETCH specifies how to download files: either `wget', `curl' or a
243 custom command where variables %{url}%, %{out}%, %{retry}%,
244 %{compress}% and %{checksum}% will be replaced. Overrides the
245 'download-command' value from the main config file.
246 OPAMFIXUPCRITERIA same as OPAMUPGRADECRITERIA, but specific to fixup.
248 OPAMIGNORECONSTRAINTS see install option `--ignore-constraints-on'.
250 OPAMIGNOREPINDEPENDS see option `--ignore-pin-depends'.
252 OPAMINPLACEBUILD see option `--inplace-build'.
254 OPAMJOBS sets the maximum number of parallel workers to run.
256 OPAMJSON log json output to the given file (use character `%' to index
258 the files).
259 OPAMKEEPBUILDDIR see install option `--keep-build-dir'.
261 OPAMKEEPLOGS tells opam to not remove some temporary command logs and
263 some backups. This skips some finalisers and may also help to get more
264 reliable backtraces.
265 OPAMLOCKED combination of `--locked' and `--lock-suffix' options.
267 OPAMLOGS logdir sets log directory, default is a temporary directory in
269 /tmp
270 OPAMMAKECMD set the system make command to use.
272 OPAMMERGEOUT merge process outputs, stderr on stdout.
274 OPAMNO answer no to any question asked, see options `--no` and
276 `--confirm-level`. OPAMNO is ignored if either OPAMCONFIRMLEVEL or
277 OPAMYES is set.
278 OPAMNOAGGREGATE with `opam admin check', don't aggregate packages.
280 OPAMNOASPCUD Deprecated.
282 OPAMNOAUTOUPGRADE disables automatic internal upgrade of repositories
284 in an earlier format to the current one, on 'update' or 'init'.
285 OPAMNOCHECKSUMS enables option --no-checksums when available.
287 OPAMNODEPEXTS disables system dependencies handling, see option
289 `--no-depexts'.
290 OPAMNOENVNOTICE Internal.
292 OPAMNOSELFUPGRADE see option `--no-self-upgrade'
294 OPAMPINKINDAUTO sets whether version control systems should be detected
296 when pinning to a local path. Enabled by default since 1.3.0.
297 OPAMPRECISETRACKING fine grain tracking of directories.
299 OPAMPREPRO set this to false to disable CUDF preprocessing. Less
301 efficient, but might help debugging solver issue.
302 OPAMREQUIRECHECKSUMS Enables option `--require-checksums' when
304 available (e.g. for `opam install').
305 OPAMRETRIES sets the number of tries before failing downloads.
307 OPAMREUSEBUILDDIR see option `--reuse-build-dir'.
309 OPAMROOT see option `--root'. This is automatically set by `opam env
311 --root=DIR --set-root'.
312 OPAMROOTISOK don't complain when running as root.
314 OPAMSAFE see option `--safe'.
316 OPAMSHOW see option `--show'.
318 OPAMSKIPUPDATE see option `--skip-updates'.
320 OPAMSKIPVERSIONCHECKS bypasses some version checks. Unsafe, for
322 compatibility testing only.
323 OPAMSOLVERALLOWSUBOPTIMAL (default `true') allows some solvers to still
325 return a solution when they reach timeout; while the solution remains
326 assured to be consistent, there is no guarantee in this case that it
327 fits the expected optimisation criteria. If `true', opam willcontinue
328 with a warning, if `false' a timeout is an error. Currently only the
329 builtin-z3 backend handles this degraded case.
330 OPAMSOLVERTIMEOUT change the time allowance of the solver. Default is
332 60.0, set to 0 for unlimited. Note that all solvers may not support
333 this option.
334 OPAMSTATS display stats at the end of command.
336 OPAMSTATUSLINE display a dynamic status line showing what's currently
338 going on on the terminal. (one of one of `always', `never' or `auto')
339 OPAMSTRICT fail on inconsistencies (file reading, switch import, etc.).
341 OPAMSWITCH see option `--switch'. Automatically set by `opam env
343 --switch=SWITCH --set-switch'.
344 OPAMUNLOCKBASE see install option `--unlock-base'.
346 OPAMUPGRADECRITERIA specifies user preferences for dependency solving
348 when performing an upgrade. Overrides OPAMCRITERIA in upgrades if both
349 are set. See also option --criteria.
350 OPAMUSEINTERNALSOLVER see option `--use-internal-solver'.
352 OPAMUSEOPENSSL force openssl use for hash computing.
354 OPAMUTF8 use UTF8 characters in output (one of one of `always', `never'
356 or `auto'). By default `auto', which is determined from the locale).
357 OPAMUTF8MSGS use extended UTF8 characters (camels) in opam messages.
359 Implies OPAMUTF8. This is set by default on OSX only.
360 OPAMVALIDATIONHOOK if set, uses the `%{hook%}' command to validate an
362 opam repository update.
363 OPAMVERBOSE see option `--verbose'.
365 OPAMVERSIONLAGPOWER do not use.
367 OPAMWITHDOC see install option `--with-doc'.
369 OPAMWITHTEST see install option `--with-test.
371 OPAMWORKINGDIR see option `--working-dir'.
373 OPAMYES see options `--yes' and `--confirm-level`. OPAMYES has has
375 priority over OPAMNO and is ignored if OPAMCONFIRMLEVEL is set.
376 OPAMVAR_var overrides the contents of the variable var when
378 substituting `%{var}%` strings in `opam` files.
379 OPAMVAR_package_var overrides the contents of the variable package:var
381 when substituting `%{package:var}%` strings in `opam` files.
382
384 All scripts and programmatic invocations of opam should use `--cli' in
385 order to ensure that they work seamlessly with future versions of the
386 opam client. Additionally, blog posts or other documentation can
387 benefit, as it prevents information from becoming stale.
388 Although opam only supports roots (~/.opam/) for the current version,
390 it does provide backwards compatibility for its command-line interface.
391 Since CLI version support was only added in opam 2.1, use OPAMCLI to
393 select 2.0 support (as opam 2.0 will just ignore it), and `--cli=2.1'
394 for 2.1 (or later) versions, since an environment variable controlling
395 the parsing of syntax is brittle. To this end, opam displays a warning
396 if OPAMCLI specifies a valid version other than 2.0, and also if
397 `--cli=2.0' is specified.
398 The command-line version is selected by using the `--cli' option or the
400 OPAMCLI environment variable. `--cli' may be specified morethan once,
401 where the last instance takes precedence. OPAMCLI is only inspected if
402 `--cli' is not given.
403
405 As an exception to the following, the `exec' command returns 127 if the
406 command was not found or couldn't be executed, and the command's exit
407 value otherwise.
408 0 Success, or true for boolean queries.
410 1 False. Returned when a boolean return value is expected, e.g. when
412 running with --check, or for queries like opam lint.
413 2 Bad command-line arguments, or command-line arguments pointing to
415 an invalid context (e.g. file not following the expected format).
416 5 Not found. You requested something (package, version, repository,
418 etc.) that couldn't be found.
419 10 Aborted. The operation required confirmation, which wasn't given.
421 15 Could not acquire the locks required for the operation.
423 20 There is no solution to the user request. This can be caused by
425 asking to install two incompatible packages, for example.
426 30 Error in package definition, or other metadata files. Using
428 --strict raises this error more often.
429 31 Package script error. Some package operations were unsuccessful.
431 This may be an error in the packages or an incompatibility with
432 your system. This can be a partial error.
433 40 Sync error. Could not fetch some remotes from the network. This can
435 be a partial error.
436 50 Configuration error. Opam or system configuration doesn't allow
438 operation, and needs fixing.
439 60 Solver failure. The solver failed to return a sound answer. It can
441 be due to a broken external solver, or an error in solver
442 configuration.
443 99 Internal error. Something went wrong, likely due to a bug in opam
445 itself.
446 130 User interrupt. SIGINT was received, generally due to the user
448 pressing Ctrl-C.
449
451 See https://opam.ocaml.org/doc.
452
454 Vincent Bernardoff <vb@luminar.eu.org>
455 Raja Boujbel <raja.boujbel@ocamlpro.com>
456 Roberto Di Cosmo <roberto@dicosmo.org>
457 Thomas Gazagnaire <thomas@gazagnaire.org>
458 Louis Gesbert <louis.gesbert@ocamlpro.com>
459 Fabrice Le Fessant <Fabrice.Le_fessant@inria.fr>
460 Anil Madhavapeddy <anil@recoil.org>
461 Guillem Rieu <guillem.rieu@ocamlpro.com>
462 Ralf Treinen <ralf.treinen@pps.jussieu.fr>
463 Frederic Tuong <tuong@users.gforge.inria.fr>
465
467 Check bug reports at https://github.com/ocaml/opam/issues.
468Opam 2.1.2 OPAM-OPTION(1)