1OPAM-REMOTE(1) Opam Manual OPAM-REMOTE(1)
2
6 opam-remote - An alias for repository.
7
9 opam remote [OPTION]... [COMMAND] [ARG]...
10
12 opam remote is an alias for opam repository.
13 See opam repository --help for details.
15
17 -a, --all-switches
18 Act on the selections of all configured switches
19 --dont-select
21 Don't update any selections
22 --on-switches=SWITCHES
24 Act on the selections of the given list of switches
25 --set-default
27 Act on the default repository selection that is used for newly
28 created switches
29 --this-switch
31 Act on the selections for the current switch (this is the default)
32
34 --help[=FMT] (default=auto)
35 Show this help in format FMT. The value FMT must be one of `auto',
36 `pager', `groff' or `plain'. With `auto', the format is `pager` or
37 `plain' whenever the TERM env var is `dumb' or undefined.
38 -k KIND, --kind=KIND
40 Specify the kind of the repository to be used (one of `http',
41 `local', `git', `darcs' or `hg').
42 --rank=RANK (absent=1)
44 Set the rank of the repository in the list of configured
45 repositories. Package definitions are looked in the repositories in
46 increasing rank order, therefore 1 is the highest priority.
47 Negative ints can be used to select from the lowest priority, -1
48 being last. set-repos can otherwise be used to explicitly set the
49 repository list at once.
50 -s, --short
52 Output raw lists of names, one per line, skipping any details.
53 --version
55 Show version information.
56
58 These options are common to all commands.
59 --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 --color=WHEN
67 Colorize the output. WHEN must be one of `always', `never' or
68 `auto'.
69 --criteria=CRITERIA
71 Specify user preferences for dependency solving for this run.
72 Overrides both $OPAMCRITERIA and $OPAMUPGRADECRITERIA. For details
73 on the supported language, and the external solvers available, see
74 http://opam.ocaml.org/doc/External_solvers.html. A general guide to
75 using solver preferences can be found at
76 http://www.dicosmo.org/Articles/usercriteria.pdf.
77 --cudf=FILENAME
79 Debug option: Save the CUDF requests sent to the solver to
80 FILENAME-<n>.cudf.
81 --debug
83 Print debug message to stderr. This is equivalent to setting
84 $OPAMDEBUG to "true".
85 --debug-level=LEVEL
87 Like --debug, but allows specifying the debug level (--debug sets
88 it to 1). Equivalent to setting $OPAMDEBUG to a positive integer.
89 --git-version
91 Print the git version of opam, if set (i.e. you are using a
92 development version), and exit.
93 --ignore-pin-depends
95 Ignore extra pins required by packages that get pinned, either
96 manually through opam pin or through opam install DIR. This is
97 equivalent to setting IGNOREPINDEPENDS=true.
98 --json=FILENAME
100 Save the results of the opam run in a computer-readable file. If
101 the filename contains the character `%', it will be replaced by an
102 index that doesn't overwrite an existing file. Similar to setting
103 the $OPAMJSON variable.
104 --no-aspcud
106 Deprecated.
107 --no-auto-upgrade
109 When configuring or updating a repository that is written for an
110 earlier opam version (1.2), opam internally converts it to the
111 current format. This disables this behaviour. Note that
112 repositories should define their format version in a 'repo' file at
113 their root, or they will be assumed to be in the older format. It
114 is, in any case, preferable to upgrade the repositories manually
115 using opam admin upgrade [--mirror URL] when possible.
116 --no-self-upgrade
118 Opam will replace itself with a newer binary found at OPAMROOT/opam
119 if present. This disables this behaviour.
120 -q, --quiet
122 Disables --verbose.
123 --root=ROOT
125 Use ROOT as the current root path. This is equivalent to setting
126 $OPAMROOT to ROOT.
127 --safe, --readonly
129 Make sure nothing will be automatically updated or rewritten.
130 Useful for calling from completion scripts, for example. Will fail
131 whenever such an operation is needed ; also avoids waiting for
132 locks, skips interactive questions and overrides the $OPAMDEBUG
133 variable. This is equivalent to set environment variable $OPAMSAFE.
134 --solver=CMD
136 Specify the CUDF solver to use for resolving package installation
137 problems. This is either a predefined solver (this version of opam
138 supports builtin-mccs+lp(), builtin-mccs+glpk, aspcud, mccs,
139 aspcud-old, packup), or a custom command that should contain the
140 variables %{input}%, %{output}%, %{criteria}%, and optionally
141 %{timeout}%. This is equivalent to setting $OPAMEXTERNALSOLVER.
142 --strict
144 Fail whenever an error is found in a package definition or a
145 configuration file. The default is to continue silently if
146 possible.
147 --switch=SWITCH
149 Use SWITCH as the current compiler switch. This is equivalent to
150 setting $OPAMSWITCH to SWITCH.
151 --use-internal-solver
153 Disable any external solver, and use the built-in one (this
154 requires that opam has been compiled with a built-in solver). This
155 is equivalent to setting $OPAMNOASPCUD or $OPAMUSEINTERNALSOLVER.
156 -v, --verbose
158 Be more verbose. One -v shows all package commands, repeat to also
159 display commands called internally (e.g. tar, curl, patch etc.)
160 Repeating n times is equivalent to setting $OPAMVERBOSE to "n".
161 -w, --working-dir
163 Whenever updating packages that are bound to a local,
164 version-controlled directory, update to the current working state
165 of their source instead of the last committed state, or the ref
166 they are pointing to. This only affects packages explicitly listed
167 on the command-line.It can also be set with $OPAMWORKINGDIR.
168 -y, --yes
170 Answer yes to all yes/no questions without prompting. This is
171 equivalent to setting $OPAMYES to "true".
172
174 Opam makes use of the environment variables listed here. Boolean
175 variables should be set to "0", "no", "false" or the empty string to
176 disable, "1", "yes" or "true" to enable.
177 OPAMALLPARENS surround all filters with parenthesis
179 OPAMAUTOREMOVE see remove option `--auto-remove`
181 OPAMBESTEFFORT see option `--best-effort`
183 OPAMBESTEFFORTPREFIXCRITERIA sets the string that must be prepended to
185 the criteria when the `--best-effort` option is set, and is expected to
186 maximise the `opam-query` property in the solution
187 OPAMCOLOR, when set to always or never, sets a default value for the
189 --color option.
190 OPAMCRITERIA specifies user preferences for dependency solving. The
192 default value depends on the solver version, use `config report` to
193 know the current setting. See also option --criteria
194 OPAMCUDFFILE file save the cudf graph to file-actions-explicit.dot
196 OPAMCURL can be used to select a given 'curl' program. See OPAMFETCH
198 for more options.
199 OPAMDEBUG see options `--debug' and `--debug-level'.
201 OPAMDOWNLOADJOBS sets the maximum number of simultaneous downloads.
203 OPAMDRYRUN see option `--dry-run`
205 OPAMEDITOR sets the editor to use for opam file editing, overrides
207 $EDITOR and $VISUAL
208 OPAMERRLOGLEN sets the number of log lines printed when a sub-process
210 fails. 0 to print all.
211 OPAMEXTERNALSOLVER see option `--solver'.
213 OPAMFAKE see option `--fake`
215 OPAMFETCH specifies how to download files: either `wget', `curl' or a
217 custom command where variables %{url}%, %{out}%, %{retry}%,
218 %{compress}% and %{checksum}% will be replaced. Overrides the
219 'download-command' value from the main config file.
220 OPAMFIXUPCRITERIA same as OPAMUPGRADECRITERIA, but specific to fixup
222 OPAMIGNORECONSTRAINTS see install option `--ignore-constraints-on`
224 OPAMIGNOREPINDEPENDS see option `--ignore-pin-depends`
226 OPAMJOBS sets the maximum number of parallel workers to run.
228 OPAMJSON log json output to the given file (use character `%' to index
230 the files)
231 OPAMLOCKED see install option `--locked`
233 OPAMLOGS logdir sets log directory, default is a temporary directory in
235 /tmp
236 OPAMMAKECMD set the system make command to use
238 OPAMNOAUTOUPGRADE disables automatic internal upgrade of repositories
240 in an earlier format to the current one, on 'update' or 'init'.
241 OPAMKEEPLOGS tells opam to not remove some temporary command logs and
243 some backups. This skips some finalisers and may also help to get more
244 reliable backtraces
245 OPAMLOCKRETRIES sets the number of tries after which opam gives up
247 acquiring its lock and fails. <= 0 means infinite wait.
248 OPAMMERGEOUT merge process outputs, stderr on stdout
250 OPAMNO answer no to any question asked.
252 OPAMNOASPCUD Deprecated.
254 OPAMNOCHECKSUMS enables option --no-checksums when available.
256 OPAMNOSELFUPGRADE see option `--no-self-upgrade'.
258 OPAMPINKINDAUTO sets whether version control systems should be detected
260 when pinning to a local path. Enabled by default since 1.3.0.
261 OPAMPRECISETRACKING fine grain tracking of directories
263 OPAMREQUIRECHECKSUMS Enables option `--require-checksums' when
265 available (e.g. for `opam install`).
266 OPAMRETRES sets the number of tries before failing downloads.
268 OPAMROOT see option `--root'. This is automatically set by `opam env
270 --root=DIR --set-root'.
271 OPAMROOTISOK don't complain when running as root.
273 OPAMSAFE see option `--safe'
275 OPAMSHOW see option `--show`
277 OPAMSKIPUPDATE see option `--skip-updates`
279 OPAMSKIPVERSIONCHECKS bypasses some version checks. Unsafe, for
281 compatibility testing only.
282 OPAMSOLVERTIMEOUT change the time allowance of the solver. Default is
284 60.0, set to 0 for unlimited. Note that all solvers may not support
285 this option.
286 OPAMSTATUSLINE display a dynamic status line showing what's currently
288 going on on the terminal. (one of one of `always', `never' or `auto')
289 OPAMSTATS display stats at the end of command
291 OPAMSTRICT fail on inconsistencies (file reading, switch import, etc.)
293 OPAMSWITCH see option `--switch'. Automatically set by `opam env
295 --switch=SWITCH --set-switch'.
296 OPAMUNLOCKBASE see install option `--unlock-base`
298 OPAMUPGRADECRITERIA specifies user preferences for dependency solving
300 when performing an upgrade. Overrides OPAMCRITERIA in upgrades if both
301 are set. See also option --criteria
302 OPAMUSEINTERNALSOLVER see option `--use-internal-solver'.
304 OPAMUSEOPENSSL force openssl use for hash computing
306 OPAMUTF8 use UTF8 characters in output (one of one of `always', `never'
308 or `auto'). By default `auto', which is determined from the locale).
309 OPAMUTF8MSGS use extended UTF8 characters (camels) in opam messages.
311 Implies OPAMUTF8. This is set by default on OSX only.
312 OPAMVALIDATIONHOOK hook if set, uses the `%{hook%}` command to validate
314 an opam repository update
315 OPAMVAR_var overrides the contents of the variable var when
317 substituting `%{var}%` strings in `opam` files.
318 OPAMVAR_package_var overrides the contents of the variable package:var
320 when substituting `%{package:var}%` strings in `opam` files.
321 OPAMVERBOSE see option `--verbose'.
323 OPAMWORKINGDIR see option `--working-dir`
325 OPAMYES see option `--yes'.
327
329 As an exception to the following, the `exec' command returns 127 if the
330 command was not found or couldn't be executed, and the command's exit
331 value otherwise.
332 0 Success, or true for boolean queries.
334 1 False. Returned when a boolean return value is expected, e.g. when
336 running with --check, or for queries like opam lint.
337 2 Bad command-line arguments, or command-line arguments pointing to
339 an invalid context (e.g. file not following the expected format).
340 5 Not found. You requested something (package, version, repository,
342 etc.) that couldn't be found.
343 10 Aborted. The operation required confirmation, which wasn't given.
345 15 Could not acquire the locks required for the operation.
347 20 There is no solution to the user request. This can be caused by
349 asking to install two incompatible packages, for example.
350 30 Error in package definition, or other metadata files. Using
352 --strict raises this error more often.
353 31 Package script error. Some package operations were unsuccessful.
355 This may be an error in the packages or an incompatibility with
356 your system. This can be a partial error.
357 40 Sync error. Could not fetch some remotes from the network. This can
359 be a partial error.
360 50 Configuration error. Opam or system configuration doesn't allow
362 operation, and needs fixing.
363 60 Solver failure. The solver failed to return a sound answer. It can
365 be due to a broken external solver, or an error in solver
366 configuration.
367 99 Internal error. Something went wrong, likely due to a bug in opam
369 itself.
370 130 User interrupt. SIGINT was received, generally due to the user
372 pressing Ctrl-C.
373
375 See https://opam.ocaml.org/doc.
376
378 Vincent Bernardoff <vb@luminar.eu.org>
379 Raja Boujbel <raja.boujbel@ocamlpro.com>
380 Roberto Di Cosmo <roberto@dicosmo.org>
381 Thomas Gazagnaire <thomas@gazagnaire.org>
382 Louis Gesbert <louis.gesbert@ocamlpro.com>
383 Fabrice Le Fessant <Fabrice.Le_fessant@inria.fr>
384 Anil Madhavapeddy <anil@recoil.org>
385 Guillem Rieu <guillem.rieu@ocamlpro.com>
386 Ralf Treinen <ralf.treinen@pps.jussieu.fr>
387 Frederic Tuong <tuong@users.gforge.inria.fr>
388
390 Check bug reports at https://github.com/ocaml/opam/issues.
391Opam 2.0.6 OPAM-REMOTE(1)