1OPAM-REMOTE(1)                    Opam Manual                   OPAM-REMOTE(1)
2
3
4

NAME

6       opam-remote - An alias for repository.
7

SYNOPSIS

9       opam remote [OPTION]… [COMMAND] [ARG]…
10

DESCRIPTION

12       opam remote is an alias for opam repository.
13
14       See opam repository --help for details.
15

SCOPE SPECIFICATION OPTIONS

17       -a, --all-switches
18           Act on the selections of all configured switches
19
20       --dont-select
21           Don't update any selections
22
23       --on-switches=SWITCHES
24           Act on the selections of the given list of switches
25
26       --set-default
27           Act on the default repository selection that is used for newly
28           created switches
29
30       --this-switch
31           Act on the selections for the current switch (this is the default)
32

OPTIONS

34       -k KIND, --kind=KIND
35           Specify the kind of the repository to be used (one of http, local,
36           git, darcs or hg).
37
38       --no
39           Answer no to all opam yes/no questions without prompting. See also
40           --confirm-level. This is equivalent to setting $OPAMNO to "true".
41
42       --rank=RANK (absent=1)
43           Set the rank of the repository in the list of configured
44           repositories. Package definitions are looked in the repositories in
45           increasing rank order, therefore 1 is the highest priority.
46           Negative ints can be used to select from the lowest priority, -1
47           being last. set-repos can otherwise be used to explicitly set the
48           repository list at once.
49
50       -s, --short
51           Output raw lists of names, one per line, skipping any details.
52
53       -y, --yes
54           Answer yes to all opam yes/no questions without prompting. See also
55           --confirm-level. This is equivalent to setting $OPAMYES to "true".
56

COMMON OPTIONS

58       These options are common to all commands.
59
60       --best-effort
61           Don't fail if all requested packages can't be installed: try to
62           install as many as possible. Note that not all external solvers may
63           support this option (recent versions of aspcud or mccs should).
64           This is equivalent to setting $OPAMBESTEFFORT environment variable.
65
66       --cli=MAJOR.MINOR (absent=2.1)
67           Use the command-line interface syntax and semantics of MAJOR.MINOR.
68           Intended for any persistent use of opam (scripts, blog posts,
69           etc.), any version of opam in the same MAJOR series will behave as
70           for the specified MINOR release. The flag was not available in opam
71           2.0, so to select the 2.0 CLI, set the OPAMCLI environment variable
72           to 2.0 instead of using this parameter.
73
74       --color=WHEN
75           Colorize the output. WHEN must be one of always, never or auto.
76
77       --confirm-level=LEVEL
78           Confirmation level, LEVEL must be one of ask, no, yes or
79           unsafe-yes. Can be specified more than once. If --yes or --no are
80           also given, the value of the last --confirm-level is taken into
81           account. This is equivalent to setting  $OPAMCONFIRMLEVEL`.
82
83       --criteria=CRITERIA
84           Specify user preferences for dependency solving for this run.
85           Overrides both $OPAMCRITERIA and $OPAMUPGRADECRITERIA. For details
86           on the supported language, and the external solvers available, see
87           http://opam.ocaml.org/doc/External_solvers.html. A general guide to
88           using solver preferences can be found at
89           http://www.dicosmo.org/Articles/usercriteria.pdf.
90
91       --cudf=FILENAME
92           Debug option: Save the CUDF requests sent to the solver to
93           FILENAME-<n>.cudf.
94
95       --debug
96           Print debug message to stderr. This is equivalent to setting
97           $OPAMDEBUG to "true".
98
99       --debug-level=LEVEL
100           Like --debug, but allows specifying the debug level (--debug sets
101           it to 1). Equivalent to setting $OPAMDEBUG to a positive integer.
102
103       --git-version
104           Print the git version of opam, if set (i.e. you are using a
105           development version), and exit.
106
107       --help[=FMT] (default=auto)
108           Show this help in format FMT. The value FMT must be one of auto,
109           pager, groff or plain. With auto, the format is pager or plain
110           whenever the TERM env var is dumb or undefined.
111
112       --ignore-pin-depends
113           Ignore extra pins required by packages that get pinned, either
114           manually through opam pin or through opam install DIR. This is
115           equivalent to setting IGNOREPINDEPENDS=true.
116
117       --json=FILENAME
118           Save the results of the opam run in a computer-readable file. If
119           the filename contains the character `%', it will be replaced by an
120           index that doesn't overwrite an existing file. Similar to setting
121           the $OPAMJSON variable.
122
123       --no-aspcud
124           Removed in 2.1.
125
126       --no-auto-upgrade
127           When configuring or updating a repository that is written for an
128           earlier opam version (1.2), opam internally converts it to the
129           current format. This disables this behaviour. Note that
130           repositories should define their format version in a 'repo' file at
131           their root, or they will be assumed to be in the older format. It
132           is, in any case, preferable to upgrade the repositories manually
133           using opam admin upgrade [--mirror URL] when possible.
134
135       --no-self-upgrade
136           Opam will replace itself with a newer binary found at OPAMROOT/opam
137           if present. This disables this behaviour.
138
139       -q, --quiet
140           Disables --verbose.
141
142       --root=ROOT
143           Use ROOT as the current root path. This is equivalent to setting
144           $OPAMROOT to ROOT.
145
146       --safe, --readonly
147           Make sure nothing will be automatically updated or rewritten.
148           Useful for calling from completion scripts, for example. Will fail
149           whenever such an operation is needed ; also avoids waiting for
150           locks, skips interactive questions and overrides the $OPAMDEBUG
151           variable. This is equivalent to set environment variable $OPAMSAFE.
152
153       --solver=CMD
154           Specify the CUDF solver to use for resolving package installation
155           problems. This is either a predefined solver (this version of opam
156           supports builtin-mccs+lp(), builtin-mccs+glpk,
157           builtin-dummy-z3-solver, builtin-dummy-0install-solver, aspcud,
158           mccs, aspcud-old, packup), or a custom command that should contain
159           the variables %{input}%, %{output}%, %{criteria}%, and optionally
160           %{timeout}%. This is equivalent to setting $OPAMEXTERNALSOLVER.
161
162       --strict
163           Fail whenever an error is found in a package definition or a
164           configuration file. The default is to continue silently if
165           possible.
166
167       --switch=SWITCH
168           Use SWITCH as the current compiler switch. This is equivalent to
169           setting $OPAMSWITCH to SWITCH.
170
171       --use-internal-solver
172           Disable any external solver, and use the built-in one (this
173           requires that opam has been compiled with a built-in solver). This
174           is equivalent to setting $OPAMNOASPCUD or $OPAMUSEINTERNALSOLVER.
175
176       -v, --verbose
177           Be more verbose. One -v shows all package commands, repeat to also
178           display commands called internally (e.g. tar, curl, patch etc.)
179           Repeating n times is equivalent to setting $OPAMVERBOSE to "n".
180
181       --version
182           Show version information.
183
184       -w, --working-dir
185           Whenever updating packages that are bound to a local,
186           version-controlled directory, update to the current working state
187           of their source instead of the last committed state, or the ref
188           they are pointing to. As source directory is copied as it is, if it
189           isn't clean it may result on a opam build failure.This only affects
190           packages explicitly listed on the command-line.It can also be set
191           with $OPAMWORKINGDIR.
192

ENVIRONMENT

194       Opam makes use of the environment variables listed here. Boolean
195       variables should be set to "0", "no", "false" or the empty string to
196       disable, "1", "yes" or "true" to enable.
197
198       OPAMALLPARENS surround all filters with parenthesis.
199
200       OPAMASSUMEDEPEXTS see option `--assume-depexts'.
201
202       OPAMAUTOREMOVE see remove option `--auto-remove'.
203
204       OPAMBESTEFFORT see option `--best-effort'.
205
206       OPAMBESTEFFORTPREFIXCRITERIA sets the string that must be prepended to
207       the criteria when the `--best-effort' option is set, and is expected to
208       maximise the `opam-query' property in the solution.
209
210       OPAMBUILDDOC Removed in 2.1.
211
212       OPAMBUILDTEST Removed in 2.1.
213
214       OPAMCLI see option `--cli'.
215
216       OPAMCOLOR when set to always or never, sets a default value for the
217       `--color' option.
218
219       OPAMCONFIRMLEVEL see option `--confirm-level`. OPAMCONFIRMLEVEL has
220       priority over OPAMYES and OPAMNO.
221
222       OPAMCRITERIA specifies user preferences for dependency solving. The
223       default value depends on the solver version, use `config report' to
224       know the current setting. See also option --criteria.
225
226       OPAMCUDFFILE save the cudf graph to file-actions-explicit.dot.
227
228       OPAMCUDFTRIM controls the filtering of unrelated packages during CUDF
229       preprocessing.
230
231       OPAMCURL can be used to select a given 'curl' program. See OPAMFETCH
232       for more options.
233
234       OPAMDEBUG see options `--debug' and `--debug-level'.
235
236       OPAMDEBUGSECTIONS if set, limits debug messages to the space-separated
237       list of sections. Sections can optionally have a specific debug level
238       (for example, CLIENT:2 or CLIENT CUDF:2), but otherwise use
239       `--debug-level'.
240
241       OPAMDIGDEPTH defines how aggressive the lookup for conflicts during
242       CUDF preprocessing is.
243
244       OPAMDOWNLOADJOBS sets the maximum number of simultaneous downloads.
245
246       OPAMDROPWORKINGDIR overrides packages previously updated with
247       --working-dir on update. Without this variable set, opam would keep
248       them unchanged unless explicitly named on the command-line.
249
250       OPAMDRYRUN see option `--dry-run'.
251
252       OPAMEDITOR sets the editor to use for opam file editing, overrides
253       $EDITOR and $VISUAL.
254
255       OPAMERRLOGLEN sets the number of log lines printed when a sub-process
256       fails. 0 to print all.
257
258       OPAMEXTERNALSOLVER see option `--solver'.
259
260       OPAMFAKE see option `--fake'.
261
262       OPAMFETCH specifies how to download files: either `wget', `curl' or a
263       custom command where variables %{url}%, %{out}%, %{retry}%,
264       %{compress}% and %{checksum}% will be replaced. Overrides the
265       'download-command' value from the main config file.
266
267       OPAMFIXUPCRITERIA same as OPAMUPGRADECRITERIA, but specific to fixup.
268
269       OPAMIGNORECONSTRAINTS see install option `--ignore-constraints-on'.
270
271       OPAMIGNOREPINDEPENDS see option `--ignore-pin-depends'.
272
273       OPAMINPLACEBUILD see option `--inplace-build'.
274
275       OPAMJOBS sets the maximum number of parallel workers to run.
276
277       OPAMJSON log json output to the given file (use character `%' to index
278       the files).
279
280       OPAMKEEPBUILDDIR see install option `--keep-build-dir'.
281
282       OPAMKEEPLOGS tells opam to not remove some temporary command logs and
283       some backups. This skips some finalisers and may also help to get more
284       reliable backtraces.
285
286       OPAMLOCKED combination of `--locked' and `--lock-suffix' options.
287
288       OPAMLOGS logdir sets log directory, default is a temporary directory in
289       /tmp
290
291       OPAMMAKECMD set the system make command to use.
292
293       OPAMMERGEOUT merge process outputs, stderr on stdout.
294
295       OPAMNO answer no to any question asked, see options `--no` and
296       `--confirm-level`. OPAMNO is ignored if either OPAMCONFIRMLEVEL or
297       OPAMYES is set.
298
299       OPAMNOAGGREGATE with `opam admin check', don't aggregate packages.
300
301       OPAMNOASPCUD Deprecated.
302
303       OPAMNOAUTOUPGRADE disables automatic internal upgrade of repositories
304       in an earlier format to the current one, on 'update' or 'init'.
305
306       OPAMNOCHECKSUMS enables option --no-checksums when available.
307
308       OPAMNODEPEXTS disables system dependencies handling, see option
309       `--no-depexts'.
310
311       OPAMNOENVNOTICE Internal.
312
313       OPAMNOSELFUPGRADE see option `--no-self-upgrade'
314
315       OPAMPINKINDAUTO sets whether version control systems should be detected
316       when pinning to a local path. Enabled by default since 1.3.0.
317
318       OPAMPRECISETRACKING fine grain tracking of directories.
319
320       OPAMPREPRO set this to false to disable CUDF preprocessing. Less
321       efficient, but might help debugging solver issue.
322
323       OPAMREQUIRECHECKSUMS Enables option `--require-checksums' when
324       available (e.g. for `opam install').
325
326       OPAMRETRIES sets the number of tries before failing downloads.
327
328       OPAMREUSEBUILDDIR see option `--reuse-build-dir'.
329
330       OPAMROOT see option `--root'. This is automatically set by `opam env
331       --root=DIR --set-root'.
332
333       OPAMROOTISOK don't complain when running as root.
334
335       OPAMSAFE see option `--safe'.
336
337       OPAMSHOW see option `--show'.
338
339       OPAMSKIPUPDATE see option `--skip-updates'.
340
341       OPAMSKIPVERSIONCHECKS bypasses some version checks. Unsafe, for
342       compatibility testing only.
343
344       OPAMSOLVERALLOWSUBOPTIMAL (default `true') allows some solvers to still
345       return a solution when they reach timeout; while the solution remains
346       assured to be consistent, there is no guarantee in this case that it
347       fits the expected optimisation criteria. If `true', opam willcontinue
348       with a warning, if `false' a timeout is an error. Currently only the
349       builtin-z3 backend handles this degraded case.
350
351       OPAMSOLVERTIMEOUT change the time allowance of the solver. Default is
352       60.0, set to 0 for unlimited. Note that all solvers may not support
353       this option.
354
355       OPAMSTATS display stats at the end of command.
356
357       OPAMSTATUSLINE display a dynamic status line showing what's currently
358       going on on the terminal. (one of one of always, never or auto)
359
360       OPAMSTRICT fail on inconsistencies (file reading, switch import, etc.).
361
362       OPAMSWITCH see option `--switch'. Automatically set by `opam env
363       --switch=SWITCH --set-switch'.
364
365       OPAMUNLOCKBASE see install option `--unlock-base'.
366
367       OPAMUPGRADECRITERIA specifies user preferences for dependency solving
368       when performing an upgrade. Overrides OPAMCRITERIA in upgrades if both
369       are set. See also option --criteria.
370
371       OPAMUSEINTERNALSOLVER see option `--use-internal-solver'.
372
373       OPAMUSEOPENSSL force openssl use for hash computing.
374
375       OPAMUTF8 use UTF8 characters in output (one of one of always, never or
376       auto). By default `auto', which is determined from the locale).
377
378       OPAMUTF8MSGS use extended UTF8 characters (camels) in opam messages.
379       Implies OPAMUTF8. This is set by default on OSX only.
380
381       OPAMVALIDATIONHOOK if set, uses the `%{hook%}' command to validate an
382       opam repository update.
383
384       OPAMVERBOSE see option `--verbose'.
385
386       OPAMVERSIONLAGPOWER do not use.
387
388       OPAMWITHDOC see install option `--with-doc'.
389
390       OPAMWITHTEST see install option `--with-test.
391
392       OPAMWORKINGDIR see option `--working-dir'.
393
394       OPAMYES see options `--yes' and `--confirm-level`. OPAMYES has has
395       priority over OPAMNO and is ignored if OPAMCONFIRMLEVEL is set.
396
397       OPAMVAR_var overrides the contents of the variable var when
398       substituting `%{var}%` strings in `opam` files.
399
400       OPAMVAR_package_var overrides the contents of the variable package:var
401       when substituting `%{package:var}%` strings in `opam` files.
402

CLI VERSION

404       All scripts and programmatic invocations of opam should use `--cli' in
405       order to ensure that they work seamlessly with future versions of the
406       opam client. Additionally, blog posts or other documentation can
407       benefit, as it prevents information from becoming stale.
408
409       Although opam only supports roots (~/.opam/) for the current version,
410       it does provide backwards compatibility for its command-line interface.
411
412       Since CLI version support was only added in opam 2.1, use OPAMCLI to
413       select 2.0 support (as opam 2.0 will just ignore it), and `--cli=2.1'
414       for 2.1 (or later) versions, since an environment variable controlling
415       the parsing of syntax is brittle. To this end, opam displays a warning
416       if OPAMCLI specifies a valid version other than 2.0, and also if
417       `--cli=2.0' is specified.
418
419       The command-line version is selected by using the `--cli' option or the
420       OPAMCLI environment variable. `--cli' may be specified morethan once,
421       where the last instance takes precedence. OPAMCLI is only inspected if
422       `--cli' is not given.
423

EXIT STATUS

425       As an exception to the following, the `exec' command returns 127 if the
426       command was not found or couldn't be executed, and the command's exit
427       value otherwise.
428
429       0   Success, or true for boolean queries.
430
431       1   False. Returned when a boolean return value is expected, e.g. when
432           running with --check, or for queries like opam lint.
433
434       2   Bad command-line arguments, or command-line arguments pointing to
435           an invalid context (e.g. file not following the expected format).
436
437       5   Not found. You requested something (package, version, repository,
438           etc.) that couldn't be found.
439
440       10  Aborted. The operation required confirmation, which wasn't given.
441
442       15  Could not acquire the locks required for the operation.
443
444       20  There is no solution to the user request. This can be caused by
445           asking to install two incompatible packages, for example.
446
447       30  Error in package definition, or other metadata files. Using
448           --strict raises this error more often.
449
450       31  Package script error. Some package operations were unsuccessful.
451           This may be an error in the packages or an incompatibility with
452           your system. This can be a partial error.
453
454       40  Sync error. Could not fetch some remotes from the network. This can
455           be a partial error.
456
457       50  Configuration error. Opam or system configuration doesn't allow
458           operation, and needs fixing.
459
460       60  Solver failure. The solver failed to return a sound answer. It can
461           be due to a broken external solver, or an error in solver
462           configuration.
463
464       99  Internal error. Something went wrong, likely due to a bug in opam
465           itself.
466
467       130 User interrupt. SIGINT was received, generally due to the user
468           pressing Ctrl-C.
469

FURTHER DOCUMENTATION

471       See https://opam.ocaml.org/doc.
472

AUTHORS

474       Vincent Bernardoff <vb@luminar.eu.org>
475       Raja Boujbel <raja.boujbel@ocamlpro.com>
476       Roberto Di Cosmo <roberto@dicosmo.org>
477       Thomas Gazagnaire <thomas@gazagnaire.org>
478       Louis Gesbert <louis.gesbert@ocamlpro.com>
479       Fabrice Le Fessant <Fabrice.Le_fessant@inria.fr>
480       Anil Madhavapeddy <anil@recoil.org>
481       Guillem Rieu <guillem.rieu@ocamlpro.com>
482       Ralf Treinen <ralf.treinen@pps.jussieu.fr>
483
484       Frederic Tuong <tuong@users.gforge.inria.fr>
485

BUGS

487       Check bug reports at https://github.com/ocaml/opam/issues.
488
489
490
491Opam 2.1.5                                                      OPAM-REMOTE(1)
Impressum