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 --color=WHEN
77 Colorize the output. WHEN must be one of `always', `never' or
78 `auto'.
79 --criteria=CRITERIA
81 Specify user preferences for dependency solving for this run.
82 Overrides both $OPAMCRITERIA and $OPAMUPGRADECRITERIA. For details
83 on the supported language, and the external solvers available, see
84 http://opam.ocaml.org/doc/Specifying_Solver_Preferences.html. A
85 general guide to using solver preferences can be found at
86 http://www.dicosmo.org/Articles/usercriteria.pdf.
87 --cudf=FILENAME
89 Debug option: Save the CUDF requests sent to the solver to
90 FILENAME-<n>.cudf.
91 --debug
93 Print debug message to stderr. This is equivalent to setting
94 $OPAMDEBUG to "true".
95 --debug-level=LEVEL
97 Like --debug, but allows specifying the debug level (--debug sets
98 it to 1). Equivalent to setting $OPAMDEBUG to a positive integer.
99 --git-version
101 Print the git version of opam, if set (i.e. you are using a
102 development version), and exit.
103 --ignore-pin-depends
105 Ignore extra pins required by packages that get pinned, either
106 manually through opam pin or through opam install DIR. This is
107 equivalent to setting IGNOREPINDEPENDS=true.
108 --json=FILENAME
110 Save the results of the opam run in a computer-readable file. If
111 the filename contains the character `%', it will be replaced by an
112 index that doesn't overwrite an existing file. Similar to setting
113 the $OPAMJSON variable.
114 --no-auto-upgrade
116 When configuring or updating a repository that is written for an
117 earlier opam version (1.2), opam internally converts it to the
118 current format. This disables this behaviour. Note that
119 repositories should define their format version in a 'repo' file at
120 their root, or they will be assumed to be in the older format. It
121 is, in any case, preferable to upgrade the repositories manually
122 using opam admin upgrade [--mirror URL] when possible.
123 --no-self-upgrade
125 Opam will replace itself with a newer binary found at OPAMROOT/opam
126 if present. This disables this behaviour.
127 -q, --quiet
129 Disables --verbose.
130 --root=ROOT
132 Use ROOT as the current root path. This is equivalent to setting
133 $OPAMROOT to ROOT.
134 --safe, --readonly
136 Make sure nothing will be automatically updated or rewritten.
137 Useful for calling from completion scripts, for example. Will fail
138 whenever such an operation is needed ; also avoids waiting for
139 locks, skips interactive questions and overrides the $OPAMDEBUG
140 variable.
141 --solver=CMD
143 Specify the CUDF solver to use for resolving package installation
144 problems. This is either a predefined solver (this version of opam
145 supports builtin-mccs+lp(), builtin-mccs+glpk, aspcud, mccs,
146 aspcud-old, packup), or a custom command that should contain the
147 variables %{input}%, %{output}%, %{criteria}%, and optionally
148 %{timeout}%.
149 --strict
151 Fail whenever an error is found in a package definition or a
152 configuration file. The default is to continue silently if
153 possible.
154 --switch=SWITCH
156 Use SWITCH as the current compiler switch. This is equivalent to
157 setting $OPAMSWITCH to SWITCH.
158 --use-internal-solver, --no-aspcud
160 Disable any external solver, and use the built-in one (this
161 requires that opam has been compiled with a built-in solver).
162 -v, --verbose
164 Be more verbose. One -v shows all package commands, repeat to also
165 display commands called internally (e.g. tar, curl, patch etc.)
166 Repeating n times is equivalent to setting $OPAMVERBOSE to "n".
167 -w, --working-dir
169 Whenever updating packages that are bound to a local,
170 version-controlled directory, update to the current working state
171 of their source instead of the last committed state, or the ref
172 they are pointing to. This only affects packages explicitly listed
173 on the command-line.
174 -y, --yes
176 Answer yes to all yes/no questions without prompting. This is
177 equivalent to setting $OPAMYES to "true".
178
180 Opam makes use of the environment variables listed here. Boolean
181 variables should be set to "0", "no", "false" or the empty string to
182 disable, "1", "yes" or "true" to enable.
183 OPAMCOLOR, when set to always or never, sets a default value for the
185 --color option.
186 OPAMCRITERIA specifies user preferences for dependency solving. The
188 default value depends on the solver version, use `config report` to
189 know the current setting. See also option --criteria
190 OPAMCURL can be used to select a given 'curl' program. See OPAMFETCH
192 for more options.
193 OPAMDEBUG see options `--debug' and `--debug-level'.
195 OPAMDOWNLOADJOBS sets the maximum number of simultaneous downloads.
197 OPAMERRLOGLEN sets the number of log lines printed when a sub-process
199 fails. 0 to print all.
200 OPAMEXTERNALSOLVER see option `--solver'.
202 OPAMFETCH specifies how to download files: either `wget', `curl' or a
204 custom command where variables %{url}%, %{out}%, %{retry}%,
205 %{compress}% and %{checksum}% will be replaced. Overrides the
206 'download-command' value from the main config file.
207 OPAMJOBS sets the maximum number of parallel workers to run.
209 OPAMJSON log json output to the given file (use character `%' to index
211 the files)
212 OPAMLOCK see option `--lock'.
214 OPAMNOAUTOUPGRADE disables automatic internal upgrade of repositories
216 in an earlier format to the current one, on 'update' or 'init'.
217 OPAMKEEPLOGS tells opam to not remove some temporary command logs and
219 some backups. This skips some finalisers and may also help to get more
220 reliable backtraces
221 OPAMLOCKRETRIES sets the number of tries after which OPAM gives up
223 acquiring its lock and fails. <= 0 means infinite wait.
224 OPAMNO answer no to any question asked.
226 OPAMNOASPCUD see option `--no-aspcud'.
228 OPAMNOSELFUPGRADE see option `--no-self-upgrade'.
230 OPAMPINKINDAUTO sets whether version control systems should be detected
232 when pinning to a local path. Enabled by default since 1.3.0.
233 OPAMREQUIRECHECKSUMS Enables option `--require-checksums' when
235 available (e.g. for `opam install`).
236 OPAMRETRY sets the number of tries before failing downloads.
238 OPAMROOT see option `--root'. This is automatically set by `opam env
240 --root=DIR --set-root'.
241 OPAMROOTISOK don't complain when running as root.
243 OPAMSAFE see option `--safe'
245 OPAMSKIPVERSIONCHECKS bypasses some version checks. Unsafe, for
247 compatibility testing only.
248 OPAMSOLVERTIMEOUT change the time allowance of the solver. Default is
250 60.0, set to 0 for unlimited. Note that all solvers may not support
251 this option.
252 OPAMSTATUSLINE display a dynamic status line showing what's currently
254 going on on the terminal. (one of one of `always', `never' or `auto')
255 OPAMSWITCH see option `--switch'. Automatically set by `opam env
257 --switch=SWITCH --set-switch'.
258 OPAMUPGRADECRITERIA specifies user preferences for dependency solving
260 when performing an upgrade. Overrides OPAMCRITERIA in upgrades if both
261 are set. See also option --criteria
262 OPAMUSEINTERNALSOLVER see option `--use-internal-solver'.
264 OPAMUTF8 use UTF8 characters in output (one of one of `always', `never'
266 or `auto'). By default `auto', which is determined from the locale).
267 OPAMUTF8MSGS use extended UTF8 characters (camels) in opam messages.
269 Implies OPAMUTF8. This is set by default on OSX only.
270 OPAMVAR_var overrides the contents of the variable var when
272 substituting `%{var}%` strings in `opam` files.
273 OPAMVAR_package_var overrides the contents of the variable package:var
275 when substituting `%{package:var}%` strings in `opam` files.
276 OPAMVERBOSE see option `--verbose'.
278 OPAMYES see option `--yes'.
280
282 As an exception to the following, the `exec' command returns 127 if the
283 command was not found or couldn't be executed, and the command's exit
284 value otherwise.
285 0 Success, or true for boolean queries.
287 1 False. Returned when a boolean return value is expected, e.g. when
289 running with --check, or for queries like opam lint.
290 2 Bad command-line arguments, or command-line arguments pointing to
292 an invalid context (e.g. file not following the expected format).
293 5 Not found. You requested something (package, version, repository,
295 etc.) that couldn't be found.
296 10 Aborted. The operation required confirmation, which wasn't given.
298 15 Could not acquire the locks required for the operation.
300 20 There is no solution to the user request. This can be caused by
302 asking to install two incompatible packages, for example.
303 30 Error in package definition, or other metadata files. Using
305 --strict raises this error more often.
306 31 Package script error. Some package operations were unsuccessful.
308 This may be an error in the packages or an incompatibility with
309 your system. This can be a partial error.
310 40 Sync error. Could not fetch some remotes from the network. This can
312 be a partial error.
313 50 Configuration error. Opam or system configuration doesn't allow
315 operation, and needs fixing.
316 60 Solver failure. The solver failed to return a sound answer. It can
318 be due to a broken external solver, or an error in solver
319 configuration.
320 99 Internal error. Something went wrong, likely due to a bug in opam
322 itself.
323 130 User interrupt. SIGINT was received, generally due to the user
325 pressing Ctrl-C.
326
328 See https://opam.ocaml.org/doc.
329
331 Vincent Bernardoff <vb@luminar.eu.org>
332 Raja Boujbel <raja.boujbel@ocamlpro.com>
333 Roberto Di Cosmo <roberto@dicosmo.org>
334 Thomas Gazagnaire <thomas@gazagnaire.org>
335 Louis Gesbert <louis.gesbert@ocamlpro.com>
336 Fabrice Le Fessant <Fabrice.Le_fessant@inria.fr>
338 Anil Madhavapeddy <anil@recoil.org>
339 Guillem Rieu <guillem.rieu@ocamlpro.com>
340 Ralf Treinen <ralf.treinen@pps.jussieu.fr>
341 Frederic Tuong <tuong@users.gforge.inria.fr>
342
344 Check bug reports at https://github.com/ocaml/opam/issues.
345Opam 2.0.1 opam-info(1)