1opam admin-list(1) Opam admin Manual opam admin-list(1)
2
6 opam admin-list - Lists packages from a repository
7
9 opam admin list [OPTION]... [PATTERNS]...
10
12 This command is similar to 'opam list', but allows listing packages
13 directly from a repository instead of what is available in a given opam
14 installation.
15
17 PATTERNS
18 Package patterns with globs. matching against NAME or NAME.VERSION
19
21 --environment=VAL
22 Use the given opam environment, in the form of a list
23 comma-separated 'var=value' bindings, when resolving variables.
24 This is used e.g. when computing available packages: if undefined,
25 availability of packages is not taken into account. Note that,
26 unless overriden, variables like 'root' or 'opam-version' may be
27 taken from the current opam installation. What is defined in
28 ~/.opam/config is always ignored.
29
31 -A, --all
32 Include all, even uninstalled or unavailable packages
33 -a, --available
35 List only packages that are available according to the defined
36 environment. Without --environment, equivalent to --all.
37 --coinstallable-with=PACKAGES
39 Only list packages that are compatible with all of PACKAGES.
40 --conflicts-with=PACKAGES
42 List packages that have declared conflicts with at least one of the
43 given list. This includes conflicts defined from the packages in
44 the list, from the other package, or by a common conflict-class:
45 field.
46 --depends-on=PACKAGES
48 List only packages that depend on one of (comma-separated)
49 PACKAGES.
50 --depopts
52 Include optional dependencies in dependency requests.
53 --dev
55 Include development packages in dependencies.
56 --field-match=FIELD:PATTERN
58 Filter packages with a match for PATTERN on the given FIELD
59 --has-flag=FLAG
61 Only include packages which have the given flag set. Package flags
62 are one of: light-uninstall verbose plugin compiler conf
63 --has-tag=TAG
65 Only includes packages which have the given tag set
66 --installable
68 List only packages that are installable according to the defined
69 environment (this calls the solver and may be more costly; a
70 package depending on an unavailable may be available, but is never
71 installable)
72 --nobuild
74 Exclude build dependencies (they are included by default).
75 --or
77 Instead of selecting packages that match all the criteria, select
78 packages that match any of them
79 --post
81 Include dependencies tagged as post.
82 --recursive
84 With `--depends-on' and `--required-by', display all transitive
85 dependencies rather than just direct dependencies.
86 --required-by=PACKAGES
88 List only the dependencies of (comma-separated) PACKAGES.
89 --resolve=PACKAGES
91 Restrict to a solution to install (comma-separated) PACKAGES, i.e.
92 a consistent set of packages including those. This is subtly
93 different from `--required-by --recursive`, which is more
94 predictable and can't fail, but lists all dependencies
95 independently without ensuring consistency. Without `--installed`,
96 the answer is self-contained and independent of the current
97 installation. With `--installed', it's computed from the set of
98 currently installed packages. `--no-switch` further makes the
99 solution independent from the currently pinned packages,
100 architecture, and compiler version. The combination with
101 `--depopts' is not supported.
102 -t, --with-test, --test
104 Include test-only dependencies.
105 --with-doc, --doc
107 Include doc-only dependencies.
108
110 --columns=COLUMNS
111 Select the columns to display among: name, version, package,
112 synopsis, synopsis-or-target, description, <field>:,
113 installed-version, pin, source-hash, opam-file,
114 all-installed-versions, available-versions, all-versions,
115 repository, installed-files, vc-ref, depexts. The default is name
116 when --short is present and name, installed-version,
117 synopsis-or-target otherwise.
118 --normalise
120 Print the values of opam fields normalised
121 -S, --sort
123 Sort the packages in dependency order (i.e. an order in which they
124 could be individually installed.)
125 -s, --short
127 Don't print a header, and sets the default columns to name only. If
128 you need package versions included, use --columns=package instead
129 --separator=STRING (absent= )
131 Set the column-separator string
132 -V, --all-versions
134 Normally, when multiple versions of a package match, only one is
135 shown in the output (the installed one, the pinned-to one, or,
136 failing that, the highest one available or the highest one). This
137 flag disables this behaviour and shows all matching versions. This
138 also changes the default display format to include package versions
139 instead of just package names (including when --short is set). This
140 is automatically turned on when a single non-pattern package name
141 is provided on the command-line.
142 --wrap
144 Wrap long lines, the default being to truncate when displaying on a
145 terminal, or to keep as is otherwise
146
148 These options are common to all commands.
149 --best-effort
151 Don't fail if all requested packages can't be installed: try to
152 install as many as possible. Note that not all external solvers may
153 support this option (recent versions of aspcud or mccs should).
154 --color=WHEN
156 Colorize the output. WHEN must be one of `always', `never' or
157 `auto'.
158 --criteria=CRITERIA
160 Specify user preferences for dependency solving for this run.
161 Overrides both $OPAMCRITERIA and $OPAMUPGRADECRITERIA. For details
162 on the supported language, and the external solvers available, see
163 http://opam.ocaml.org/doc/Specifying_Solver_Preferences.html. A
164 general guide to using solver preferences can be found at
165 http://www.dicosmo.org/Articles/usercriteria.pdf.
166 --cudf=FILENAME
168 Debug option: Save the CUDF requests sent to the solver to
169 FILENAME-<n>.cudf.
170 --debug
172 Print debug message to stderr. This is equivalent to setting
173 $OPAMDEBUG to "true".
174 --debug-level=LEVEL
176 Like --debug, but allows specifying the debug level (--debug sets
177 it to 1). Equivalent to setting $OPAMDEBUG to a positive integer.
178 --git-version
180 Print the git version of opam, if set (i.e. you are using a
181 development version), and exit.
182 --help[=FMT] (default=auto)
184 Show this help in format FMT. The value FMT must be one of `auto',
185 `pager', `groff' or `plain'. With `auto', the format is `pager` or
186 `plain' whenever the TERM env var is `dumb' or undefined.
187 --ignore-pin-depends
189 Ignore extra pins required by packages that get pinned, either
190 manually through opam pin or through opam install DIR. This is
191 equivalent to setting IGNOREPINDEPENDS=true.
192 --json=FILENAME
194 Save the results of the opam run in a computer-readable file. If
195 the filename contains the character `%', it will be replaced by an
196 index that doesn't overwrite an existing file. Similar to setting
197 the $OPAMJSON variable.
198 --no-auto-upgrade
200 When configuring or updating a repository that is written for an
201 earlier opam version (1.2), opam internally converts it to the
202 current format. This disables this behaviour. Note that
203 repositories should define their format version in a 'repo' file at
204 their root, or they will be assumed to be in the older format. It
205 is, in any case, preferable to upgrade the repositories manually
206 using opam admin upgrade [--mirror URL] when possible.
207 -q, --quiet
209 Disables --verbose.
210 --root=ROOT
212 Use ROOT as the current root path. This is equivalent to setting
213 $OPAMROOT to ROOT.
214 --safe, --readonly
216 Make sure nothing will be automatically updated or rewritten.
217 Useful for calling from completion scripts, for example. Will fail
218 whenever such an operation is needed ; also avoids waiting for
219 locks, skips interactive questions and overrides the $OPAMDEBUG
220 variable.
221 --solver=CMD
223 Specify the CUDF solver to use for resolving package installation
224 problems. This is either a predefined solver (this version of opam
225 supports builtin-mccs+lp(), builtin-mccs+glpk, aspcud, mccs,
226 aspcud-old, packup), or a custom command that should contain the
227 variables %{input}%, %{output}%, %{criteria}%, and optionally
228 %{timeout}%.
229 --strict
231 Fail whenever an error is found in a package definition or a
232 configuration file. The default is to continue silently if
233 possible.
234 --switch=SWITCH
236 Use SWITCH as the current compiler switch. This is equivalent to
237 setting $OPAMSWITCH to SWITCH.
238 --use-internal-solver, --no-aspcud
240 Disable any external solver, and use the built-in one (this
241 requires that opam has been compiled with a built-in solver).
242 -v, --verbose
244 Be more verbose. One -v shows all package commands, repeat to also
245 display commands called internally (e.g. tar, curl, patch etc.)
246 Repeating n times is equivalent to setting $OPAMVERBOSE to "n".
247 --version
249 Show version information.
250 -w, --working-dir
252 Whenever updating packages that are bound to a local,
253 version-controlled directory, update to the current working state
254 of their source instead of the last committed state, or the ref
255 they are pointing to. This only affects packages explicitly listed
256 on the command-line.
257 -y, --yes
259 Answer yes to all yes/no questions without prompting. This is
260 equivalent to setting $OPAMYES to "true".
261
263 Opam makes use of the environment variables listed here. Boolean
264 variables should be set to "0", "no", "false" or the empty string to
265 disable, "1", "yes" or "true" to enable.
266 OPAMCOLOR, when set to always or never, sets a default value for the
268 --color option.
269 OPAMCRITERIA specifies user preferences for dependency solving. The
271 default value depends on the solver version, use `config report` to
272 know the current setting. See also option --criteria
273 OPAMCURL can be used to select a given 'curl' program. See OPAMFETCH
275 for more options.
276 OPAMDEBUG see options `--debug' and `--debug-level'.
278 OPAMDOWNLOADJOBS sets the maximum number of simultaneous downloads.
280 OPAMERRLOGLEN sets the number of log lines printed when a sub-process
282 fails. 0 to print all.
283 OPAMEXTERNALSOLVER see option `--solver'.
285 OPAMFETCH specifies how to download files: either `wget', `curl' or a
287 custom command where variables %{url}%, %{out}%, %{retry}%,
288 %{compress}% and %{checksum}% will be replaced. Overrides the
289 'download-command' value from the main config file.
290 OPAMJOBS sets the maximum number of parallel workers to run.
292 OPAMJSON log json output to the given file (use character `%' to index
294 the files)
295 OPAMLOCK see option `--lock'.
297 OPAMNOAUTOUPGRADE disables automatic internal upgrade of repositories
299 in an earlier format to the current one, on 'update' or 'init'.
300 OPAMKEEPLOGS tells opam to not remove some temporary command logs and
302 some backups. This skips some finalisers and may also help to get more
303 reliable backtraces
304 OPAMLOCKRETRIES sets the number of tries after which OPAM gives up
306 acquiring its lock and fails. <= 0 means infinite wait.
307 OPAMNO answer no to any question asked.
309 OPAMNOASPCUD see option `--no-aspcud'.
311 OPAMNOSELFUPGRADE see option `--no-self-upgrade'.
313 OPAMPINKINDAUTO sets whether version control systems should be detected
315 when pinning to a local path. Enabled by default since 1.3.0.
316 OPAMREQUIRECHECKSUMS Enables option `--require-checksums' when
318 available (e.g. for `opam install`).
319 OPAMRETRY sets the number of tries before failing downloads.
321 OPAMROOT see option `--root'. This is automatically set by `opam env
323 --root=DIR --set-root'.
324 OPAMROOTISOK don't complain when running as root.
326 OPAMSAFE see option `--safe'
328 OPAMSKIPVERSIONCHECKS bypasses some version checks. Unsafe, for
330 compatibility testing only.
331 OPAMSOLVERTIMEOUT change the time allowance of the solver. Default is
333 60.0, set to 0 for unlimited. Note that all solvers may not support
334 this option.
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 OPAMSWITCH see option `--switch'. Automatically set by `opam env
340 --switch=SWITCH --set-switch'.
341 OPAMUPGRADECRITERIA specifies user preferences for dependency solving
343 when performing an upgrade. Overrides OPAMCRITERIA in upgrades if both
344 are set. See also option --criteria
345 OPAMUSEINTERNALSOLVER see option `--use-internal-solver'.
347 OPAMUTF8 use UTF8 characters in output (one of one of `always', `never'
349 or `auto'). By default `auto', which is determined from the locale).
350 OPAMUTF8MSGS use extended UTF8 characters (camels) in opam messages.
352 Implies OPAMUTF8. This is set by default on OSX only.
353 OPAMVAR_var overrides the contents of the variable var when
355 substituting `%{var}%` strings in `opam` files.
356 OPAMVAR_package_var overrides the contents of the variable package:var
358 when substituting `%{package:var}%` strings in `opam` files.
359 OPAMVERBOSE see option `--verbose'.
361 OPAMYES see option `--yes'.
363
365 As an exception to the following, the `exec' command returns 127 if the
366 command was not found or couldn't be executed, and the command's exit
367 value otherwise.
368 0 Success, or true for boolean queries.
370 1 False. Returned when a boolean return value is expected, e.g. when
372 running with --check, or for queries like opam lint.
373 2 Bad command-line arguments, or command-line arguments pointing to
375 an invalid context (e.g. file not following the expected format).
376 5 Not found. You requested something (package, version, repository,
378 etc.) that couldn't be found.
379 10 Aborted. The operation required confirmation, which wasn't given.
381 15 Could not acquire the locks required for the operation.
383 20 There is no solution to the user request. This can be caused by
385 asking to install two incompatible packages, for example.
386 30 Error in package definition, or other metadata files. Using
388 --strict raises this error more often.
389 31 Package script error. Some package operations were unsuccessful.
391 This may be an error in the packages or an incompatibility with
392 your system. This can be a partial error.
393 40 Sync error. Could not fetch some remotes from the network. This can
395 be a partial error.
396 50 Configuration error. Opam or system configuration doesn't allow
398 operation, and needs fixing.
399 60 Solver failure. The solver failed to return a sound answer. It can
401 be due to a broken external solver, or an error in solver
402 configuration.
403 99 Internal error. Something went wrong, likely due to a bug in opam
405 itself.
406 130 User interrupt. SIGINT was received, generally due to the user
408 pressing Ctrl-C.
409
411 See https://opam.ocaml.org/doc.
412
414 Vincent Bernardoff <vb@luminar.eu.org>
415 Raja Boujbel <raja.boujbel@ocamlpro.com>
416 Roberto Di Cosmo <roberto@dicosmo.org>
417 Thomas Gazagnaire <thomas@gazagnaire.org>
418 Louis Gesbert <louis.gesbert@ocamlpro.com>
419 Fabrice Le Fessant <Fabrice.Le_fessant@inria.fr>
420 Anil Madhavapeddy <anil@recoil.org>
421 Guillem Rieu <guillem.rieu@ocamlpro.com>
422 Ralf Treinen <ralf.treinen@pps.jussieu.fr>
423 Frederic Tuong <tuong@users.gforge.inria.fr>
424
426 Check bug reports at https://github.com/ocaml/opam/issues.
427Opam admin 2.0.1 opam admin-list(1)