1OPAM ADMIN-FILTER(1) Opam admin Manual OPAM ADMIN-FILTER(1)
2
6 opam admin-filter - Filters a repository to only keep selected packages
7
9 opam admin filter [OPTION]… [PATTERNS]…
10
12 This command removes all package definitions that don't match the
13 search criteria (specified similarly to 'opam admin list') from a
14 repository.
15
17 PATTERNS
18 Package patterns with globs. matching against NAME or NAME.VERSION
19
21 --dry-run
22 List the removal commands, without actually performing them
23 --environment=VAR=VALUE[;VAR=VALUE]
25 Use the given opam environment, in the form of a list of
26 comma-separated 'var=value' bindings, when resolving variables.
27 This is used e.g. when computing available packages: if undefined,
28 availability of packages will be assumed as soon as it can not be
29 resolved purely from globally defined variables. Note that, unless
30 overridden, variables like 'root' or 'opam-version' may be taken
31 from the current opam installation. What is defined in
32 ~/.opam/config is always ignored.
33 --no
35 Answer no to all opam yes/no questions without prompting. See also
36 --confirm-level. This is equivalent to setting $OPAMNO to "true".
37 --remove
39 Invert the behaviour and remove the matching packages, keeping the
40 ones that don't match.
41 -y, --yes
43 Answer yes to all opam yes/no questions without prompting. See also
44 --confirm-level. This is equivalent to setting $OPAMYES to "true".
45
47 -a, --available
48 List only packages that are available according to the defined
49 environment. Without --environment, this will include any packages
50 for which availability is not resolvable at this point.
51 -A, --all
53 Include all, even uninstalled or unavailable packages
54 --coinstallable-with=PACKAGES
56 Only list packages that are compatible with all of PACKAGES.
57 --conflicts-with=PACKAGES
59 List packages that have declared conflicts with at least one of the
60 given list. This includes conflicts defined from the packages in
61 the list, from the other package, or by a common conflict-class:
62 field.
63 --depends-on=PACKAGES
65 List only packages that depend on one of (comma-separated)
66 PACKAGES.
67 --depopts
69 Include optional dependencies in dependency requests.
70 --dev
72 Include development packages in dependencies.
73 --field-match=FIELD:PATTERN
75 Filter packages with a match for PATTERN on the given FIELD
76 --has-flag=FLAG
78 Only include packages which have the given flag set. Package flags
79 are one of: light-uninstall verbose plugin compiler conf
80 --has-tag=TAG
82 Only includes packages which have the given tag set
83 --installable
85 List only packages that are installable according to the defined
86 environment (this calls the solver and may be more costly; a
87 package depending on an unavailable one may be available, but is
88 never installable)
89 --nobuild
91 Exclude build dependencies (they are included by default).
92 --or
94 Instead of selecting packages that match all the criteria, select
95 packages that match any of them
96 --post
98 Include dependencies tagged as post.
99 --recursive
101 With `--depends-on' and `--required-by', display all transitive
102 dependencies rather than just direct dependencies.
103 --required-by=PACKAGES
105 List only the dependencies of (comma-separated) PACKAGES.
106 --resolve=PACKAGES
108 Restrict to a solution to install (comma-separated) PACKAGES, i.e.
109 a consistent set of packages including those. This is subtly
110 different from `--required-by --recursive`, which is more
111 predictable and can't fail, but lists all dependencies
112 independently without ensuring consistency. Without `--installed`,
113 the answer is self-contained and independent of the current
114 installation. With `--installed', it's computed from the set of
115 currently installed packages. `--no-switch` further makes the
116 solution independent from the currently pinned packages,
117 architecture, and compiler version. The combination with
118 `--depopts' is not supported.
119 -t, --with-test, --test
121 Include test-only dependencies.
122 --with-doc, --doc
124 Include doc-only dependencies.
125
127 These options are common to all commands.
128 --best-effort
130 Don't fail if all requested packages can't be installed: try to
131 install as many as possible. Note that not all external solvers may
132 support this option (recent versions of aspcud or mccs should).
133 This is equivalent to setting $OPAMBESTEFFORT environment variable.
134 --cli=MAJOR.MINOR (absent=2.1)
136 Use the command-line interface syntax and semantics of MAJOR.MINOR.
137 Intended for any persistent use of opam (scripts, blog posts,
138 etc.), any version of opam in the same MAJOR series will behave as
139 for the specified MINOR release. The flag was not available in opam
140 2.0, so to select the 2.0 CLI, set the OPAMCLI environment variable
141 to 2.0 instead of using this parameter.
142 --color=WHEN
144 Colorize the output. WHEN must be one of always, never or auto.
145 --confirm-level=LEVEL
147 Confirmation level, LEVEL must be one of ask, no, yes or
148 unsafe-yes. Can be specified more than once. If --yes or --no are
149 also given, the value of the last --confirm-level is taken into
150 account. This is equivalent to setting $OPAMCONFIRMLEVEL`.
151 --criteria=CRITERIA
153 Specify user preferences for dependency solving for this run.
154 Overrides both $OPAMCRITERIA and $OPAMUPGRADECRITERIA. For details
155 on the supported language, and the external solvers available, see
156 http://opam.ocaml.org/doc/External_solvers.html. A general guide to
157 using solver preferences can be found at
158 http://www.dicosmo.org/Articles/usercriteria.pdf.
159 --cudf=FILENAME
161 Debug option: Save the CUDF requests sent to the solver to
162 FILENAME-<n>.cudf.
163 --debug
165 Print debug message to stderr. This is equivalent to setting
166 $OPAMDEBUG to "true".
167 --debug-level=LEVEL
169 Like --debug, but allows specifying the debug level (--debug sets
170 it to 1). Equivalent to setting $OPAMDEBUG to a positive integer.
171 --git-version
173 Print the git version of opam, if set (i.e. you are using a
174 development version), and exit.
175 --help[=FMT] (default=auto)
177 Show this help in format FMT. The value FMT must be one of auto,
178 pager, groff or plain. With auto, the format is pager or plain
179 whenever the TERM env var is dumb or undefined.
180 --ignore-pin-depends
182 Ignore extra pins required by packages that get pinned, either
183 manually through opam pin or through opam install DIR. This is
184 equivalent to setting IGNOREPINDEPENDS=true.
185 --json=FILENAME
187 Save the results of the opam run in a computer-readable file. If
188 the filename contains the character `%', it will be replaced by an
189 index that doesn't overwrite an existing file. Similar to setting
190 the $OPAMJSON variable.
191 --no-aspcud
193 Removed in 2.1.
194 --no-auto-upgrade
196 When configuring or updating a repository that is written for an
197 earlier opam version (1.2), opam internally converts it to the
198 current format. This disables this behaviour. Note that
199 repositories should define their format version in a 'repo' file at
200 their root, or they will be assumed to be in the older format. It
201 is, in any case, preferable to upgrade the repositories manually
202 using opam admin upgrade [--mirror URL] when possible.
203 -q, --quiet
205 Disables --verbose.
206 --root=ROOT
208 Use ROOT as the current root path. This is equivalent to setting
209 $OPAMROOT to ROOT.
210 --safe, --readonly
212 Make sure nothing will be automatically updated or rewritten.
213 Useful for calling from completion scripts, for example. Will fail
214 whenever such an operation is needed ; also avoids waiting for
215 locks, skips interactive questions and overrides the $OPAMDEBUG
216 variable. This is equivalent to set environment variable $OPAMSAFE.
217 --solver=CMD
219 Specify the CUDF solver to use for resolving package installation
220 problems. This is either a predefined solver (this version of opam
221 supports builtin-mccs+lp(), builtin-mccs+glpk,
222 builtin-dummy-z3-solver, builtin-dummy-0install-solver, aspcud,
223 mccs, aspcud-old, packup), or a custom command that should contain
224 the variables %{input}%, %{output}%, %{criteria}%, and optionally
225 %{timeout}%. This is equivalent to setting $OPAMEXTERNALSOLVER.
226 --strict
228 Fail whenever an error is found in a package definition or a
229 configuration file. The default is to continue silently if
230 possible.
231 --switch=SWITCH
233 Use SWITCH as the current compiler switch. This is equivalent to
234 setting $OPAMSWITCH to SWITCH.
235 --use-internal-solver
237 Disable any external solver, and use the built-in one (this
238 requires that opam has been compiled with a built-in solver). This
239 is equivalent to setting $OPAMNOASPCUD or $OPAMUSEINTERNALSOLVER.
240 -v, --verbose
242 Be more verbose. One -v shows all package commands, repeat to also
243 display commands called internally (e.g. tar, curl, patch etc.)
244 Repeating n times is equivalent to setting $OPAMVERBOSE to "n".
245 --version
247 Show version information.
248 -w, --working-dir
250 Whenever updating packages that are bound to a local,
251 version-controlled directory, update to the current working state
252 of their source instead of the last committed state, or the ref
253 they are pointing to. As source directory is copied as it is, if it
254 isn't clean it may result on a opam build failure.This only affects
255 packages explicitly listed on the command-line.It can also be set
256 with $OPAMWORKINGDIR.
257
259 Opam makes use of the environment variables listed here. Boolean
260 variables should be set to "0", "no", "false" or the empty string to
261 disable, "1", "yes" or "true" to enable.
262 OPAMALLPARENS surround all filters with parenthesis.
264 OPAMASSUMEDEPEXTS see option `--assume-depexts'.
266 OPAMAUTOREMOVE see remove option `--auto-remove'.
268 OPAMBESTEFFORT see option `--best-effort'.
270 OPAMBESTEFFORTPREFIXCRITERIA sets the string that must be prepended to
272 the criteria when the `--best-effort' option is set, and is expected to
273 maximise the `opam-query' property in the solution.
274 OPAMBUILDDOC Removed in 2.1.
276 OPAMBUILDTEST Removed in 2.1.
278 OPAMCLI see option `--cli'.
280 OPAMCOLOR when set to always or never, sets a default value for the
282 `--color' option.
283 OPAMCONFIRMLEVEL see option `--confirm-level`. OPAMCONFIRMLEVEL has
285 priority over OPAMYES and OPAMNO.
286 OPAMCRITERIA specifies user preferences for dependency solving. The
288 default value depends on the solver version, use `config report' to
289 know the current setting. See also option --criteria.
290 OPAMCUDFFILE save the cudf graph to file-actions-explicit.dot.
292 OPAMCUDFTRIM controls the filtering of unrelated packages during CUDF
294 preprocessing.
295 OPAMCURL can be used to select a given 'curl' program. See OPAMFETCH
297 for more options.
298 OPAMDEBUG see options `--debug' and `--debug-level'.
300 OPAMDEBUGSECTIONS if set, limits debug messages to the space-separated
302 list of sections. Sections can optionally have a specific debug level
303 (for example, CLIENT:2 or CLIENT CUDF:2), but otherwise use
304 `--debug-level'.
305 OPAMDIGDEPTH defines how aggressive the lookup for conflicts during
307 CUDF preprocessing is.
308 OPAMDOWNLOADJOBS sets the maximum number of simultaneous downloads.
310 OPAMDROPWORKINGDIR overrides packages previously updated with
312 --working-dir on update. Without this variable set, opam would keep
313 them unchanged unless explicitly named on the command-line.
314 OPAMDRYRUN see option `--dry-run'.
316 OPAMEDITOR sets the editor to use for opam file editing, overrides
318 $EDITOR and $VISUAL.
319 OPAMERRLOGLEN sets the number of log lines printed when a sub-process
321 fails. 0 to print all.
322 OPAMEXTERNALSOLVER see option `--solver'.
324 OPAMFAKE see option `--fake'.
326 OPAMFETCH specifies how to download files: either `wget', `curl' or a
328 custom command where variables %{url}%, %{out}%, %{retry}%,
329 %{compress}% and %{checksum}% will be replaced. Overrides the
330 'download-command' value from the main config file.
331 OPAMFIXUPCRITERIA same as OPAMUPGRADECRITERIA, but specific to fixup.
333 OPAMIGNORECONSTRAINTS see install option `--ignore-constraints-on'.
335 OPAMIGNOREPINDEPENDS see option `--ignore-pin-depends'.
337 OPAMINPLACEBUILD see option `--inplace-build'.
339 OPAMJOBS sets the maximum number of parallel workers to run.
341 OPAMJSON log json output to the given file (use character `%' to index
343 the files).
344 OPAMKEEPBUILDDIR see install option `--keep-build-dir'.
346 OPAMKEEPLOGS tells opam to not remove some temporary command logs and
348 some backups. This skips some finalisers and may also help to get more
349 reliable backtraces.
350 OPAMLOCKED combination of `--locked' and `--lock-suffix' options.
352 OPAMLOGS logdir sets log directory, default is a temporary directory in
354 /tmp
355 OPAMMAKECMD set the system make command to use.
357 OPAMMERGEOUT merge process outputs, stderr on stdout.
359 OPAMNO answer no to any question asked, see options `--no` and
361 `--confirm-level`. OPAMNO is ignored if either OPAMCONFIRMLEVEL or
362 OPAMYES is set.
363 OPAMNOAGGREGATE with `opam admin check', don't aggregate packages.
365 OPAMNOASPCUD Deprecated.
367 OPAMNOAUTOUPGRADE disables automatic internal upgrade of repositories
369 in an earlier format to the current one, on 'update' or 'init'.
370 OPAMNOCHECKSUMS enables option --no-checksums when available.
372 OPAMNODEPEXTS disables system dependencies handling, see option
374 `--no-depexts'.
375 OPAMNOENVNOTICE Internal.
377 OPAMNOSELFUPGRADE see option `--no-self-upgrade'
379 OPAMPINKINDAUTO sets whether version control systems should be detected
381 when pinning to a local path. Enabled by default since 1.3.0.
382 OPAMPRECISETRACKING fine grain tracking of directories.
384 OPAMPREPRO set this to false to disable CUDF preprocessing. Less
386 efficient, but might help debugging solver issue.
387 OPAMREQUIRECHECKSUMS Enables option `--require-checksums' when
389 available (e.g. for `opam install').
390 OPAMRETRIES sets the number of tries before failing downloads.
392 OPAMREUSEBUILDDIR see option `--reuse-build-dir'.
394 OPAMROOT see option `--root'. This is automatically set by `opam env
396 --root=DIR --set-root'.
397 OPAMROOTISOK don't complain when running as root.
399 OPAMSAFE see option `--safe'.
401 OPAMSHOW see option `--show'.
403 OPAMSKIPUPDATE see option `--skip-updates'.
405 OPAMSKIPVERSIONCHECKS bypasses some version checks. Unsafe, for
407 compatibility testing only.
408 OPAMSOLVERALLOWSUBOPTIMAL (default `true') allows some solvers to still
410 return a solution when they reach timeout; while the solution remains
411 assured to be consistent, there is no guarantee in this case that it
412 fits the expected optimisation criteria. If `true', opam willcontinue
413 with a warning, if `false' a timeout is an error. Currently only the
414 builtin-z3 backend handles this degraded case.
415 OPAMSOLVERTIMEOUT change the time allowance of the solver. Default is
417 60.0, set to 0 for unlimited. Note that all solvers may not support
418 this option.
419 OPAMSTATS display stats at the end of command.
421 OPAMSTATUSLINE display a dynamic status line showing what's currently
423 going on on the terminal. (one of one of always, never or auto)
424 OPAMSTRICT fail on inconsistencies (file reading, switch import, etc.).
426 OPAMSWITCH see option `--switch'. Automatically set by `opam env
428 --switch=SWITCH --set-switch'.
429 OPAMUNLOCKBASE see install option `--unlock-base'.
431 OPAMUPGRADECRITERIA specifies user preferences for dependency solving
433 when performing an upgrade. Overrides OPAMCRITERIA in upgrades if both
434 are set. See also option --criteria.
435 OPAMUSEINTERNALSOLVER see option `--use-internal-solver'.
437 OPAMUSEOPENSSL force openssl use for hash computing.
439 OPAMUTF8 use UTF8 characters in output (one of one of always, never or
441 auto). By default `auto', which is determined from the locale).
442 OPAMUTF8MSGS use extended UTF8 characters (camels) in opam messages.
444 Implies OPAMUTF8. This is set by default on OSX only.
445 OPAMVALIDATIONHOOK if set, uses the `%{hook%}' command to validate an
447 opam repository update.
448 OPAMVERBOSE see option `--verbose'.
450 OPAMVERSIONLAGPOWER do not use.
452 OPAMWITHDOC see install option `--with-doc'.
454 OPAMWITHTEST see install option `--with-test.
456 OPAMWORKINGDIR see option `--working-dir'.
458 OPAMYES see options `--yes' and `--confirm-level`. OPAMYES has has
460 priority over OPAMNO and is ignored if OPAMCONFIRMLEVEL is set.
461 OPAMVAR_var overrides the contents of the variable var when
463 substituting `%{var}%` strings in `opam` files.
464 OPAMVAR_package_var overrides the contents of the variable package:var
466 when substituting `%{package:var}%` strings in `opam` files.
467
469 All scripts and programmatic invocations of opam should use `--cli' in
470 order to ensure that they work seamlessly with future versions of the
471 opam client. Additionally, blog posts or other documentation can
472 benefit, as it prevents information from becoming stale.
473 Although opam only supports roots (~/.opam/) for the current version,
475 it does provide backwards compatibility for its command-line interface.
476 Since CLI version support was only added in opam 2.1, use OPAMCLI to
478 select 2.0 support (as opam 2.0 will just ignore it), and `--cli=2.1'
479 for 2.1 (or later) versions, since an environment variable controlling
480 the parsing of syntax is brittle. To this end, opam displays a warning
481 if OPAMCLI specifies a valid version other than 2.0, and also if
482 `--cli=2.0' is specified.
483 The command-line version is selected by using the `--cli' option or the
485 OPAMCLI environment variable. `--cli' may be specified morethan once,
486 where the last instance takes precedence. OPAMCLI is only inspected if
487 `--cli' is not given.
488
490 As an exception to the following, the `exec' command returns 127 if the
491 command was not found or couldn't be executed, and the command's exit
492 value otherwise.
493 0 Success, or true for boolean queries.
495 1 False. Returned when a boolean return value is expected, e.g. when
497 running with --check, or for queries like opam lint.
498 2 Bad command-line arguments, or command-line arguments pointing to
500 an invalid context (e.g. file not following the expected format).
501 5 Not found. You requested something (package, version, repository,
503 etc.) that couldn't be found.
504 10 Aborted. The operation required confirmation, which wasn't given.
506 15 Could not acquire the locks required for the operation.
508 20 There is no solution to the user request. This can be caused by
510 asking to install two incompatible packages, for example.
511 30 Error in package definition, or other metadata files. Using
513 --strict raises this error more often.
514 31 Package script error. Some package operations were unsuccessful.
516 This may be an error in the packages or an incompatibility with
517 your system. This can be a partial error.
518 40 Sync error. Could not fetch some remotes from the network. This can
520 be a partial error.
521 50 Configuration error. Opam or system configuration doesn't allow
523 operation, and needs fixing.
524 60 Solver failure. The solver failed to return a sound answer. It can
526 be due to a broken external solver, or an error in solver
527 configuration.
528 99 Internal error. Something went wrong, likely due to a bug in opam
530 itself.
531 130 User interrupt. SIGINT was received, generally due to the user
533 pressing Ctrl-C.
534
536 See https://opam.ocaml.org/doc.
537
539 Vincent Bernardoff <vb@luminar.eu.org>
540 Raja Boujbel <raja.boujbel@ocamlpro.com>
541 Roberto Di Cosmo <roberto@dicosmo.org>
542 Thomas Gazagnaire <thomas@gazagnaire.org>
543 Louis Gesbert <louis.gesbert@ocamlpro.com>
544 Fabrice Le Fessant <Fabrice.Le_fessant@inria.fr>
545 Anil Madhavapeddy <anil@recoil.org>
546 Guillem Rieu <guillem.rieu@ocamlpro.com>
547 Ralf Treinen <ralf.treinen@pps.jussieu.fr>
548 Frederic Tuong <tuong@users.gforge.inria.fr>
549
551 Check bug reports at https://github.com/ocaml/opam/issues.
552Opam admin 2.1.5 OPAM ADMIN-FILTER(1)