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 overridden, 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 This is equivalent to setting $OPAMBESTEFFORT environment variable.
155 --color=WHEN
157 Colorize the output. WHEN must be one of `always', `never' or
158 `auto'.
159 --criteria=CRITERIA
161 Specify user preferences for dependency solving for this run.
162 Overrides both $OPAMCRITERIA and $OPAMUPGRADECRITERIA. For details
163 on the supported language, and the external solvers available, see
164 http://opam.ocaml.org/doc/External_solvers.html. A general guide to
165 using solver preferences can be found at
166 http://www.dicosmo.org/Articles/usercriteria.pdf.
167 --cudf=FILENAME
169 Debug option: Save the CUDF requests sent to the solver to
170 FILENAME-<n>.cudf.
171 --debug
173 Print debug message to stderr. This is equivalent to setting
174 $OPAMDEBUG to "true".
175 --debug-level=LEVEL
177 Like --debug, but allows specifying the debug level (--debug sets
178 it to 1). Equivalent to setting $OPAMDEBUG to a positive integer.
179 --git-version
181 Print the git version of opam, if set (i.e. you are using a
182 development version), and exit.
183 --help[=FMT] (default=auto)
185 Show this help in format FMT. The value FMT must be one of `auto',
186 `pager', `groff' or `plain'. With `auto', the format is `pager` or
187 `plain' whenever the TERM env var is `dumb' or undefined.
188 --ignore-pin-depends
190 Ignore extra pins required by packages that get pinned, either
191 manually through opam pin or through opam install DIR. This is
192 equivalent to setting IGNOREPINDEPENDS=true.
193 --json=FILENAME
195 Save the results of the opam run in a computer-readable file. If
196 the filename contains the character `%', it will be replaced by an
197 index that doesn't overwrite an existing file. Similar to setting
198 the $OPAMJSON variable.
199 --no-aspcud
201 Deprecated.
202 --no-auto-upgrade
204 When configuring or updating a repository that is written for an
205 earlier opam version (1.2), opam internally converts it to the
206 current format. This disables this behaviour. Note that
207 repositories should define their format version in a 'repo' file at
208 their root, or they will be assumed to be in the older format. It
209 is, in any case, preferable to upgrade the repositories manually
210 using opam admin upgrade [--mirror URL] when possible.
211 -q, --quiet
213 Disables --verbose.
214 --root=ROOT
216 Use ROOT as the current root path. This is equivalent to setting
217 $OPAMROOT to ROOT.
218 --safe, --readonly
220 Make sure nothing will be automatically updated or rewritten.
221 Useful for calling from completion scripts, for example. Will fail
222 whenever such an operation is needed ; also avoids waiting for
223 locks, skips interactive questions and overrides the $OPAMDEBUG
224 variable. This is equivalent to set environment variable $OPAMSAFE.
225 --solver=CMD
227 Specify the CUDF solver to use for resolving package installation
228 problems. This is either a predefined solver (this version of opam
229 supports builtin-mccs+lp(), builtin-mccs+glpk, aspcud, mccs,
230 aspcud-old, packup), or a custom command that should contain the
231 variables %{input}%, %{output}%, %{criteria}%, and optionally
232 %{timeout}%. This is equivalent to setting $OPAMEXTERNALSOLVER.
233 --strict
235 Fail whenever an error is found in a package definition or a
236 configuration file. The default is to continue silently if
237 possible.
238 --switch=SWITCH
240 Use SWITCH as the current compiler switch. This is equivalent to
241 setting $OPAMSWITCH to SWITCH.
242 --use-internal-solver
244 Disable any external solver, and use the built-in one (this
245 requires that opam has been compiled with a built-in solver). This
246 is equivalent to setting $OPAMNOASPCUD or $OPAMUSEINTERNALSOLVER.
247 -v, --verbose
249 Be more verbose. One -v shows all package commands, repeat to also
250 display commands called internally (e.g. tar, curl, patch etc.)
251 Repeating n times is equivalent to setting $OPAMVERBOSE to "n".
252 --version
254 Show version information.
255 -w, --working-dir
257 Whenever updating packages that are bound to a local,
258 version-controlled directory, update to the current working state
259 of their source instead of the last committed state, or the ref
260 they are pointing to. This only affects packages explicitly listed
261 on the command-line.It can also be set with $OPAMWORKINGDIR.
262 -y, --yes
264 Answer yes to all yes/no questions without prompting. This is
265 equivalent to setting $OPAMYES to "true".
266
268 Opam makes use of the environment variables listed here. Boolean
269 variables should be set to "0", "no", "false" or the empty string to
270 disable, "1", "yes" or "true" to enable.
271 OPAMALLPARENS surround all filters with parenthesis
273 OPAMAUTOREMOVE see remove option `--auto-remove`
275 OPAMBESTEFFORT see option `--best-effort`
277 OPAMBESTEFFORTPREFIXCRITERIA sets the string that must be prepended to
279 the criteria when the `--best-effort` option is set, and is expected to
280 maximise the `opam-query` property in the solution
281 OPAMCOLOR, when set to always or never, sets a default value for the
283 --color option.
284 OPAMCRITERIA specifies user preferences for dependency solving. The
286 default value depends on the solver version, use `config report` to
287 know the current setting. See also option --criteria
288 OPAMCUDFFILE file save the cudf graph to file-actions-explicit.dot
290 OPAMCURL can be used to select a given 'curl' program. See OPAMFETCH
292 for more options.
293 OPAMDEBUG see options `--debug' and `--debug-level'.
295 OPAMDOWNLOADJOBS sets the maximum number of simultaneous downloads.
297 OPAMDRYRUN see option `--dry-run`
299 OPAMEDITOR sets the editor to use for opam file editing, overrides
301 $EDITOR and $VISUAL
302 OPAMERRLOGLEN sets the number of log lines printed when a sub-process
304 fails. 0 to print all.
305 OPAMEXTERNALSOLVER see option `--solver'.
307 OPAMFAKE see option `--fake`
309 OPAMFETCH specifies how to download files: either `wget', `curl' or a
311 custom command where variables %{url}%, %{out}%, %{retry}%,
312 %{compress}% and %{checksum}% will be replaced. Overrides the
313 'download-command' value from the main config file.
314 OPAMFIXUPCRITERIA same as OPAMUPGRADECRITERIA, but specific to fixup
316 OPAMIGNORECONSTRAINTS see install option `--ignore-constraints-on`
318 OPAMIGNOREPINDEPENDS see option `--ignore-pin-depends`
320 OPAMJOBS sets the maximum number of parallel workers to run.
322 OPAMJSON log json output to the given file (use character `%' to index
324 the files)
325 OPAMLOCKED see install option `--locked`
327 OPAMLOGS logdir sets log directory, default is a temporary directory in
329 /tmp
330 OPAMMAKECMD set the system make command to use
332 OPAMNOAUTOUPGRADE disables automatic internal upgrade of repositories
334 in an earlier format to the current one, on 'update' or 'init'.
335 OPAMKEEPLOGS tells opam to not remove some temporary command logs and
337 some backups. This skips some finalisers and may also help to get more
338 reliable backtraces
339 OPAMLOCKRETRIES sets the number of tries after which opam gives up
341 acquiring its lock and fails. <= 0 means infinite wait.
342 OPAMMERGEOUT merge process outputs, stderr on stdout
344 OPAMNO answer no to any question asked.
346 OPAMNOASPCUD Deprecated.
348 OPAMNOCHECKSUMS enables option --no-checksums when available.
350 OPAMNOSELFUPGRADE see option `--no-self-upgrade'.
352 OPAMPINKINDAUTO sets whether version control systems should be detected
354 when pinning to a local path. Enabled by default since 1.3.0.
355 OPAMPRECISETRACKING fine grain tracking of directories
357 OPAMREQUIRECHECKSUMS Enables option `--require-checksums' when
359 available (e.g. for `opam install`).
360 OPAMRETRES sets the number of tries before failing downloads.
362 OPAMROOT see option `--root'. This is automatically set by `opam env
364 --root=DIR --set-root'.
365 OPAMROOTISOK don't complain when running as root.
367 OPAMSAFE see option `--safe'
369 OPAMSHOW see option `--show`
371 OPAMSKIPUPDATE see option `--skip-updates`
373 OPAMSKIPVERSIONCHECKS bypasses some version checks. Unsafe, for
375 compatibility testing only.
376 OPAMSOLVERTIMEOUT change the time allowance of the solver. Default is
378 60.0, set to 0 for unlimited. Note that all solvers may not support
379 this option.
380 OPAMSTATUSLINE display a dynamic status line showing what's currently
382 going on on the terminal. (one of one of `always', `never' or `auto')
383 OPAMSTATS display stats at the end of command
385 OPAMSTRICT fail on inconsistencies (file reading, switch import, etc.)
387 OPAMSWITCH see option `--switch'. Automatically set by `opam env
389 --switch=SWITCH --set-switch'.
390 OPAMUNLOCKBASE see install option `--unlock-base`
392 OPAMUPGRADECRITERIA specifies user preferences for dependency solving
394 when performing an upgrade. Overrides OPAMCRITERIA in upgrades if both
395 are set. See also option --criteria
396 OPAMUSEINTERNALSOLVER see option `--use-internal-solver'.
398 OPAMUSEOPENSSL force openssl use for hash computing
400 OPAMUTF8 use UTF8 characters in output (one of one of `always', `never'
402 or `auto'). By default `auto', which is determined from the locale).
403 OPAMUTF8MSGS use extended UTF8 characters (camels) in opam messages.
405 Implies OPAMUTF8. This is set by default on OSX only.
406 OPAMVALIDATIONHOOK hook if set, uses the `%{hook%}` command to validate
408 an opam repository update
409 OPAMVAR_var overrides the contents of the variable var when
411 substituting `%{var}%` strings in `opam` files.
412 OPAMVAR_package_var overrides the contents of the variable package:var
414 when substituting `%{package:var}%` strings in `opam` files.
415 OPAMVERBOSE see option `--verbose'.
417 OPAMWORKINGDIR see option `--working-dir`
419 OPAMYES see option `--yes'.
421
423 As an exception to the following, the `exec' command returns 127 if the
424 command was not found or couldn't be executed, and the command's exit
425 value otherwise.
426 0 Success, or true for boolean queries.
428 1 False. Returned when a boolean return value is expected, e.g. when
430 running with --check, or for queries like opam lint.
431 2 Bad command-line arguments, or command-line arguments pointing to
433 an invalid context (e.g. file not following the expected format).
434 5 Not found. You requested something (package, version, repository,
436 etc.) that couldn't be found.
437 10 Aborted. The operation required confirmation, which wasn't given.
439 15 Could not acquire the locks required for the operation.
441 20 There is no solution to the user request. This can be caused by
443 asking to install two incompatible packages, for example.
444 30 Error in package definition, or other metadata files. Using
446 --strict raises this error more often.
447 31 Package script error. Some package operations were unsuccessful.
449 This may be an error in the packages or an incompatibility with
450 your system. This can be a partial error.
451 40 Sync error. Could not fetch some remotes from the network. This can
453 be a partial error.
454 50 Configuration error. Opam or system configuration doesn't allow
456 operation, and needs fixing.
457 60 Solver failure. The solver failed to return a sound answer. It can
459 be due to a broken external solver, or an error in solver
460 configuration.
461 99 Internal error. Something went wrong, likely due to a bug in opam
463 itself.
464 130 User interrupt. SIGINT was received, generally due to the user
466 pressing Ctrl-C.
467
469 See https://opam.ocaml.org/doc.
470
472 Vincent Bernardoff <vb@luminar.eu.org>
473 Raja Boujbel <raja.boujbel@ocamlpro.com>
474 Roberto Di Cosmo <roberto@dicosmo.org>
475 Thomas Gazagnaire <thomas@gazagnaire.org>
476 Louis Gesbert <louis.gesbert@ocamlpro.com>
477 Fabrice Le Fessant <Fabrice.Le_fessant@inria.fr>
478 Anil Madhavapeddy <anil@recoil.org>
479 Guillem Rieu <guillem.rieu@ocamlpro.com>
480 Ralf Treinen <ralf.treinen@pps.jussieu.fr>
481 Frederic Tuong <tuong@users.gforge.inria.fr>
482
484 Check bug reports at https://github.com/ocaml/opam/issues.
485Opam admin 2.0.6 OPAM ADMIN-LIST(1)