1OPAM-INFO(1) Opam Manual OPAM-INFO(1)
2
6 opam-info - An alias for show.
7
9 opam info [OPTION]... [PACKAGES]...
10
12 opam info is an alias for opam show.
13 See opam show --help for details.
15
17 PACKAGES
18 List of package names, with an optional version or constraint, e.g
19 `pkg', `pkg.1.0' or `pkg>=0.5' ; or files or directory names
20 containing package description, with explicit directory (e.g.
21 `./foo.opam' or `.')
22
24 --empty-fields
25 Show fields that are empty. This is implied when --field is given.
26 -f FIELDS, --field=FIELDS
28 Only display the values of these fields. Fields can be selected
29 among name, version, package, synopsis, synopsis-or-target,
30 description, <field>:, installed-version, pin, source-hash,
31 opam-file, all-installed-versions, available-versions,
32 all-versions, repository, installed-files, vc-ref, depexts.
33 Multiple fields can be separated with commas, in which case field
34 titles will be printed; the raw value of any opam-file field can be
35 queried by suffixing a colon character (:), e.g. --field=depopts:.
36 --file=FILE
38 DEPRECATED: use an explicit path argument as package instead. Get
39 package information from the given FILE instead of from known
40 packages. This implies --raw unless --fields is used. Only raw
41 opam-file fields can be queried.
42 --help[=FMT] (default=auto)
44 Show this help in format FMT. The value FMT must be one of `auto',
45 `pager', `groff' or `plain'. With `auto', the format is `pager` or
46 `plain' whenever the TERM env var is `dumb' or undefined.
47 --list-files
49 List the files installed by the package. Equivalent to
50 --field=installed-files, and only available for installed packages
51 --no-lint
53 Don't output linting warnings or errors when reading from files
54 --normalise
56 Print the values of opam fields normalised (no newlines, no
57 implicit brackets)
58 --raw
60 Print the raw opam file for this package
61 --version
63 Show version information.
64 --where
66 Print the location of the opam file used for this package
67
69 These options are common to all commands.
70 --best-effort
72 Don't fail if all requested packages can't be installed: try to
73 install as many as possible. Note that not all external solvers may
74 support this option (recent versions of aspcud or mccs should).
75 This is equivalent to setting $OPAMBESTEFFORT environment variable.
76 --color=WHEN
78 Colorize the output. WHEN must be one of `always', `never' or
79 `auto'.
80 --criteria=CRITERIA
82 Specify user preferences for dependency solving for this run.
83 Overrides both $OPAMCRITERIA and $OPAMUPGRADECRITERIA. For details
84 on the supported language, and the external solvers available, see
85 http://opam.ocaml.org/doc/External_solvers.html. A general guide to
86 using solver preferences can be found at
87 http://www.dicosmo.org/Articles/usercriteria.pdf.
88 --cudf=FILENAME
90 Debug option: Save the CUDF requests sent to the solver to
91 FILENAME-<n>.cudf.
92 --debug
94 Print debug message to stderr. This is equivalent to setting
95 $OPAMDEBUG to "true".
96 --debug-level=LEVEL
98 Like --debug, but allows specifying the debug level (--debug sets
99 it to 1). Equivalent to setting $OPAMDEBUG to a positive integer.
100 --git-version
102 Print the git version of opam, if set (i.e. you are using a
103 development version), and exit.
104 --ignore-pin-depends
106 Ignore extra pins required by packages that get pinned, either
107 manually through opam pin or through opam install DIR. This is
108 equivalent to setting IGNOREPINDEPENDS=true.
109 --json=FILENAME
111 Save the results of the opam run in a computer-readable file. If
112 the filename contains the character `%', it will be replaced by an
113 index that doesn't overwrite an existing file. Similar to setting
114 the $OPAMJSON variable.
115 --no-aspcud
117 Deprecated.
118 --no-auto-upgrade
120 When configuring or updating a repository that is written for an
121 earlier opam version (1.2), opam internally converts it to the
122 current format. This disables this behaviour. Note that
123 repositories should define their format version in a 'repo' file at
124 their root, or they will be assumed to be in the older format. It
125 is, in any case, preferable to upgrade the repositories manually
126 using opam admin upgrade [--mirror URL] when possible.
127 --no-self-upgrade
129 Opam will replace itself with a newer binary found at OPAMROOT/opam
130 if present. This disables this behaviour.
131 -q, --quiet
133 Disables --verbose.
134 --root=ROOT
136 Use ROOT as the current root path. This is equivalent to setting
137 $OPAMROOT to ROOT.
138 --safe, --readonly
140 Make sure nothing will be automatically updated or rewritten.
141 Useful for calling from completion scripts, for example. Will fail
142 whenever such an operation is needed ; also avoids waiting for
143 locks, skips interactive questions and overrides the $OPAMDEBUG
144 variable. This is equivalent to set environment variable $OPAMSAFE.
145 --solver=CMD
147 Specify the CUDF solver to use for resolving package installation
148 problems. This is either a predefined solver (this version of opam
149 supports builtin-mccs+lp(), builtin-mccs+glpk, aspcud, mccs,
150 aspcud-old, packup), or a custom command that should contain the
151 variables %{input}%, %{output}%, %{criteria}%, and optionally
152 %{timeout}%. This is equivalent to setting $OPAMEXTERNALSOLVER.
153 --strict
155 Fail whenever an error is found in a package definition or a
156 configuration file. The default is to continue silently if
157 possible.
158 --switch=SWITCH
160 Use SWITCH as the current compiler switch. This is equivalent to
161 setting $OPAMSWITCH to SWITCH.
162 --use-internal-solver
164 Disable any external solver, and use the built-in one (this
165 requires that opam has been compiled with a built-in solver). This
166 is equivalent to setting $OPAMNOASPCUD or $OPAMUSEINTERNALSOLVER.
167 -v, --verbose
169 Be more verbose. One -v shows all package commands, repeat to also
170 display commands called internally (e.g. tar, curl, patch etc.)
171 Repeating n times is equivalent to setting $OPAMVERBOSE to "n".
172 -w, --working-dir
174 Whenever updating packages that are bound to a local,
175 version-controlled directory, update to the current working state
176 of their source instead of the last committed state, or the ref
177 they are pointing to. This only affects packages explicitly listed
178 on the command-line.It can also be set with $OPAMWORKINGDIR.
179 -y, --yes
181 Answer yes to all yes/no questions without prompting. This is
182 equivalent to setting $OPAMYES to "true".
183
185 Opam makes use of the environment variables listed here. Boolean
186 variables should be set to "0", "no", "false" or the empty string to
187 disable, "1", "yes" or "true" to enable.
188 OPAMALLPARENS surround all filters with parenthesis
190 OPAMAUTOREMOVE see remove option `--auto-remove`
192 OPAMBESTEFFORT see option `--best-effort`
194 OPAMBESTEFFORTPREFIXCRITERIA sets the string that must be prepended to
196 the criteria when the `--best-effort` option is set, and is expected to
197 maximise the `opam-query` property in the solution
198 OPAMCOLOR, when set to always or never, sets a default value for the
200 --color option.
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 file save the cudf graph to file-actions-explicit.dot
207 OPAMCURL can be used to select a given 'curl' program. See OPAMFETCH
209 for more options.
210 OPAMDEBUG see options `--debug' and `--debug-level'.
212 OPAMDOWNLOADJOBS sets the maximum number of simultaneous downloads.
214 OPAMDRYRUN see option `--dry-run`
216 OPAMEDITOR sets the editor to use for opam file editing, overrides
218 $EDITOR and $VISUAL
219 OPAMERRLOGLEN sets the number of log lines printed when a sub-process
221 fails. 0 to print all.
222 OPAMEXTERNALSOLVER see option `--solver'.
224 OPAMFAKE see option `--fake`
226 OPAMFETCH specifies how to download files: either `wget', `curl' or a
228 custom command where variables %{url}%, %{out}%, %{retry}%,
229 %{compress}% and %{checksum}% will be replaced. Overrides the
230 'download-command' value from the main config file.
231 OPAMFIXUPCRITERIA same as OPAMUPGRADECRITERIA, but specific to fixup
233 OPAMIGNORECONSTRAINTS see install option `--ignore-constraints-on`
235 OPAMIGNOREPINDEPENDS see option `--ignore-pin-depends`
237 OPAMJOBS sets the maximum number of parallel workers to run.
239 OPAMJSON log json output to the given file (use character `%' to index
241 the files)
242 OPAMLOCKED see install option `--locked`
244 OPAMLOGS logdir sets log directory, default is a temporary directory in
246 /tmp
247 OPAMMAKECMD set the system make command to use
249 OPAMNOAUTOUPGRADE disables automatic internal upgrade of repositories
251 in an earlier format to the current one, on 'update' or 'init'.
252 OPAMKEEPLOGS tells opam to not remove some temporary command logs and
254 some backups. This skips some finalisers and may also help to get more
255 reliable backtraces
256 OPAMLOCKRETRIES sets the number of tries after which opam gives up
258 acquiring its lock and fails. <= 0 means infinite wait.
259 OPAMMERGEOUT merge process outputs, stderr on stdout
261 OPAMNO answer no to any question asked.
263 OPAMNOASPCUD Deprecated.
265 OPAMNOCHECKSUMS enables option --no-checksums when available.
267 OPAMNOSELFUPGRADE see option `--no-self-upgrade'.
269 OPAMPINKINDAUTO sets whether version control systems should be detected
271 when pinning to a local path. Enabled by default since 1.3.0.
272 OPAMPRECISETRACKING fine grain tracking of directories
274 OPAMREQUIRECHECKSUMS Enables option `--require-checksums' when
276 available (e.g. for `opam install`).
277 OPAMRETRES sets the number of tries before failing downloads.
279 OPAMROOT see option `--root'. This is automatically set by `opam env
281 --root=DIR --set-root'.
282 OPAMROOTISOK don't complain when running as root.
284 OPAMSAFE see option `--safe'
286 OPAMSHOW see option `--show`
288 OPAMSKIPUPDATE see option `--skip-updates`
290 OPAMSKIPVERSIONCHECKS bypasses some version checks. Unsafe, for
292 compatibility testing only.
293 OPAMSOLVERTIMEOUT change the time allowance of the solver. Default is
295 60.0, set to 0 for unlimited. Note that all solvers may not support
296 this option.
297 OPAMSTATUSLINE display a dynamic status line showing what's currently
299 going on on the terminal. (one of one of `always', `never' or `auto')
300 OPAMSTATS display stats at the end of command
302 OPAMSTRICT fail on inconsistencies (file reading, switch import, etc.)
304 OPAMSWITCH see option `--switch'. Automatically set by `opam env
306 --switch=SWITCH --set-switch'.
307 OPAMUNLOCKBASE see install option `--unlock-base`
309 OPAMUPGRADECRITERIA specifies user preferences for dependency solving
311 when performing an upgrade. Overrides OPAMCRITERIA in upgrades if both
312 are set. See also option --criteria
313 OPAMUSEINTERNALSOLVER see option `--use-internal-solver'.
315 OPAMUSEOPENSSL force openssl use for hash computing
317 OPAMUTF8 use UTF8 characters in output (one of one of `always', `never'
319 or `auto'). By default `auto', which is determined from the locale).
320 OPAMUTF8MSGS use extended UTF8 characters (camels) in opam messages.
322 Implies OPAMUTF8. This is set by default on OSX only.
323 OPAMVALIDATIONHOOK hook if set, uses the `%{hook%}` command to validate
325 an opam repository update
326 OPAMVAR_var overrides the contents of the variable var when
328 substituting `%{var}%` strings in `opam` files.
329 OPAMVAR_package_var overrides the contents of the variable package:var
331 when substituting `%{package:var}%` strings in `opam` files.
332 OPAMVERBOSE see option `--verbose'.
334 OPAMWORKINGDIR see option `--working-dir`
336 OPAMYES see option `--yes'.
338
340 As an exception to the following, the `exec' command returns 127 if the
341 command was not found or couldn't be executed, and the command's exit
342 value otherwise.
343 0 Success, or true for boolean queries.
345 1 False. Returned when a boolean return value is expected, e.g. when
347 running with --check, or for queries like opam lint.
348 2 Bad command-line arguments, or command-line arguments pointing to
350 an invalid context (e.g. file not following the expected format).
351 5 Not found. You requested something (package, version, repository,
353 etc.) that couldn't be found.
354 10 Aborted. The operation required confirmation, which wasn't given.
356 15 Could not acquire the locks required for the operation.
358 20 There is no solution to the user request. This can be caused by
360 asking to install two incompatible packages, for example.
361 30 Error in package definition, or other metadata files. Using
363 --strict raises this error more often.
364 31 Package script error. Some package operations were unsuccessful.
366 This may be an error in the packages or an incompatibility with
367 your system. This can be a partial error.
368 40 Sync error. Could not fetch some remotes from the network. This can
370 be a partial error.
371 50 Configuration error. Opam or system configuration doesn't allow
373 operation, and needs fixing.
374 60 Solver failure. The solver failed to return a sound answer. It can
376 be due to a broken external solver, or an error in solver
377 configuration.
378 99 Internal error. Something went wrong, likely due to a bug in opam
380 itself.
381 130 User interrupt. SIGINT was received, generally due to the user
383 pressing Ctrl-C.
384
386 See https://opam.ocaml.org/doc.
387
389 Vincent Bernardoff <vb@luminar.eu.org>
390 Raja Boujbel <raja.boujbel@ocamlpro.com>
391 Roberto Di Cosmo <roberto@dicosmo.org>
392 Thomas Gazagnaire <thomas@gazagnaire.org>
393 Louis Gesbert <louis.gesbert@ocamlpro.com>
394 Fabrice Le Fessant <Fabrice.Le_fessant@inria.fr>
395 Anil Madhavapeddy <anil@recoil.org>
396 Guillem Rieu <guillem.rieu@ocamlpro.com>
397 Ralf Treinen <ralf.treinen@pps.jussieu.fr>
398 Frederic Tuong <tuong@users.gforge.inria.fr>
399
401 Check bug reports at https://github.com/ocaml/opam/issues.
402Opam 2.0.6 OPAM-INFO(1)