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 --color=WHEN
66 Colorize the output. WHEN must be one of `always', `never' or
67 `auto'.
68 --criteria=CRITERIA
70 Specify user preferences for dependency solving for this run.
71 Overrides both $OPAMCRITERIA and $OPAMUPGRADECRITERIA. For details
72 on the supported language, and the external solvers available, see
73 http://opam.ocaml.org/doc/Specifying_Solver_Preferences.html. A
74 general guide to using solver preferences can be found at
75 http://www.dicosmo.org/Articles/usercriteria.pdf.
76 --cudf=FILENAME
78 Debug option: Save the CUDF requests sent to the solver to
79 FILENAME-<n>.cudf.
80 --debug
82 Print debug message to stderr. This is equivalent to setting
83 $OPAMDEBUG to "true".
84 --debug-level=LEVEL
86 Like --debug, but allows specifying the debug level (--debug sets
87 it to 1). Equivalent to setting $OPAMDEBUG to a positive integer.
88 --git-version
90 Print the git version of opam, if set (i.e. you are using a
91 development version), and exit.
92 --ignore-pin-depends
94 Ignore extra pins required by packages that get pinned, either
95 manually through opam pin or through opam install DIR. This is
96 equivalent to setting IGNOREPINDEPENDS=true.
97 --json=FILENAME
99 Save the results of the opam run in a computer-readable file. If
100 the filename contains the character `%', it will be replaced by an
101 index that doesn't overwrite an existing file. Similar to setting
102 the $OPAMJSON variable.
103 --no-auto-upgrade
105 When configuring or updating a repository that is written for an
106 earlier opam version (1.2), opam internally converts it to the
107 current format. This disables this behaviour. Note that
108 repositories should define their format version in a 'repo' file at
109 their root, or they will be assumed to be in the older format. It
110 is, in any case, preferable to upgrade the repositories manually
111 using opam admin upgrade [--mirror URL] when possible.
112 --no-self-upgrade
114 Opam will replace itself with a newer binary found at OPAMROOT/opam
115 if present. This disables this behaviour.
116 -q, --quiet
118 Disables --verbose.
119 --root=ROOT
121 Use ROOT as the current root path. This is equivalent to setting
122 $OPAMROOT to ROOT.
123 --safe, --readonly
125 Make sure nothing will be automatically updated or rewritten.
126 Useful for calling from completion scripts, for example. Will fail
127 whenever such an operation is needed ; also avoids waiting for
128 locks, skips interactive questions and overrides the $OPAMDEBUG
129 variable.
130 --solver=CMD
132 Specify the CUDF solver to use for resolving package installation
133 problems. This is either a predefined solver (this version of opam
134 supports builtin-mccs+lp(), builtin-mccs+glpk, aspcud, mccs,
135 aspcud-old, packup), or a custom command that should contain the
136 variables %{input}%, %{output}%, %{criteria}%, and optionally
137 %{timeout}%.
138 --strict
140 Fail whenever an error is found in a package definition or a
141 configuration file. The default is to continue silently if
142 possible.
143 --switch=SWITCH
145 Use SWITCH as the current compiler switch. This is equivalent to
146 setting $OPAMSWITCH to SWITCH.
147 --use-internal-solver, --no-aspcud
149 Disable any external solver, and use the built-in one (this
150 requires that opam has been compiled with a built-in solver).
151 -v, --verbose
153 Be more verbose. One -v shows all package commands, repeat to also
154 display commands called internally (e.g. tar, curl, patch etc.)
155 Repeating n times is equivalent to setting $OPAMVERBOSE to "n".
156 -w, --working-dir
158 Whenever updating packages that are bound to a local,
159 version-controlled directory, update to the current working state
160 of their source instead of the last committed state, or the ref
161 they are pointing to. This only affects packages explicitly listed
162 on the command-line.
163 -y, --yes
165 Answer yes to all yes/no questions without prompting. This is
166 equivalent to setting $OPAMYES to "true".
167
169 Opam makes use of the environment variables listed here. Boolean
170 variables should be set to "0", "no", "false" or the empty string to
171 disable, "1", "yes" or "true" to enable.
172 OPAMCOLOR, when set to always or never, sets a default value for the
174 --color option.
175 OPAMCRITERIA specifies user preferences for dependency solving. The
177 default value depends on the solver version, use `config report` to
178 know the current setting. See also option --criteria
179 OPAMCURL can be used to select a given 'curl' program. See OPAMFETCH
181 for more options.
182 OPAMDEBUG see options `--debug' and `--debug-level'.
184 OPAMDOWNLOADJOBS sets the maximum number of simultaneous downloads.
186 OPAMERRLOGLEN sets the number of log lines printed when a sub-process
188 fails. 0 to print all.
189 OPAMEXTERNALSOLVER see option `--solver'.
191 OPAMFETCH specifies how to download files: either `wget', `curl' or a
193 custom command where variables %{url}%, %{out}%, %{retry}%,
194 %{compress}% and %{checksum}% will be replaced. Overrides the
195 'download-command' value from the main config file.
196 OPAMJOBS sets the maximum number of parallel workers to run.
198 OPAMJSON log json output to the given file (use character `%' to index
200 the files)
201 OPAMLOCK see option `--lock'.
203 OPAMNOAUTOUPGRADE disables automatic internal upgrade of repositories
205 in an earlier format to the current one, on 'update' or 'init'.
206 OPAMKEEPLOGS tells opam to not remove some temporary command logs and
208 some backups. This skips some finalisers and may also help to get more
209 reliable backtraces
210 OPAMLOCKRETRIES sets the number of tries after which OPAM gives up
212 acquiring its lock and fails. <= 0 means infinite wait.
213 OPAMNO answer no to any question asked.
215 OPAMNOASPCUD see option `--no-aspcud'.
217 OPAMNOSELFUPGRADE see option `--no-self-upgrade'.
219 OPAMPINKINDAUTO sets whether version control systems should be detected
221 when pinning to a local path. Enabled by default since 1.3.0.
222 OPAMREQUIRECHECKSUMS Enables option `--require-checksums' when
224 available (e.g. for `opam install`).
225 OPAMRETRY sets the number of tries before failing downloads.
227 OPAMROOT see option `--root'. This is automatically set by `opam env
229 --root=DIR --set-root'.
230 OPAMROOTISOK don't complain when running as root.
232 OPAMSAFE see option `--safe'
234 OPAMSKIPVERSIONCHECKS bypasses some version checks. Unsafe, for
236 compatibility testing only.
237 OPAMSOLVERTIMEOUT change the time allowance of the solver. Default is
239 60.0, set to 0 for unlimited. Note that all solvers may not support
240 this option.
241 OPAMSTATUSLINE display a dynamic status line showing what's currently
243 going on on the terminal. (one of one of `always', `never' or `auto')
244 OPAMSWITCH see option `--switch'. Automatically set by `opam env
246 --switch=SWITCH --set-switch'.
247 OPAMUPGRADECRITERIA specifies user preferences for dependency solving
249 when performing an upgrade. Overrides OPAMCRITERIA in upgrades if both
250 are set. See also option --criteria
251 OPAMUSEINTERNALSOLVER see option `--use-internal-solver'.
253 OPAMUTF8 use UTF8 characters in output (one of one of `always', `never'
255 or `auto'). By default `auto', which is determined from the locale).
256 OPAMUTF8MSGS use extended UTF8 characters (camels) in opam messages.
258 Implies OPAMUTF8. This is set by default on OSX only.
259 OPAMVAR_var overrides the contents of the variable var when
261 substituting `%{var}%` strings in `opam` files.
262 OPAMVAR_package_var overrides the contents of the variable package:var
264 when substituting `%{package:var}%` strings in `opam` files.
265 OPAMVERBOSE see option `--verbose'.
267 OPAMYES see option `--yes'.
269
271 As an exception to the following, the `exec' command returns 127 if the
272 command was not found or couldn't be executed, and the command's exit
273 value otherwise.
274 0 Success, or true for boolean queries.
276 1 False. Returned when a boolean return value is expected, e.g. when
278 running with --check, or for queries like opam lint.
279 2 Bad command-line arguments, or command-line arguments pointing to
281 an invalid context (e.g. file not following the expected format).
282 5 Not found. You requested something (package, version, repository,
284 etc.) that couldn't be found.
285 10 Aborted. The operation required confirmation, which wasn't given.
287 15 Could not acquire the locks required for the operation.
289 20 There is no solution to the user request. This can be caused by
291 asking to install two incompatible packages, for example.
292 30 Error in package definition, or other metadata files. Using
294 --strict raises this error more often.
295 31 Package script error. Some package operations were unsuccessful.
297 This may be an error in the packages or an incompatibility with
298 your system. This can be a partial error.
299 40 Sync error. Could not fetch some remotes from the network. This can
301 be a partial error.
302 50 Configuration error. Opam or system configuration doesn't allow
304 operation, and needs fixing.
305 60 Solver failure. The solver failed to return a sound answer. It can
307 be due to a broken external solver, or an error in solver
308 configuration.
309 99 Internal error. Something went wrong, likely due to a bug in opam
311 itself.
312 130 User interrupt. SIGINT was received, generally due to the user
314 pressing Ctrl-C.
315
317 See https://opam.ocaml.org/doc.
318
320 Vincent Bernardoff <vb@luminar.eu.org>
321 Raja Boujbel <raja.boujbel@ocamlpro.com>
322 Roberto Di Cosmo <roberto@dicosmo.org>
323 Thomas Gazagnaire <thomas@gazagnaire.org>
324 Louis Gesbert <louis.gesbert@ocamlpro.com>
325 Fabrice Le Fessant <Fabrice.Le_fessant@inria.fr>
326 Anil Madhavapeddy <anil@recoil.org>
327 Guillem Rieu <guillem.rieu@ocamlpro.com>
328 Ralf Treinen <ralf.treinen@pps.jussieu.fr>
329 Frederic Tuong <tuong@users.gforge.inria.fr>
330
332 Check bug reports at https://github.com/ocaml/opam/issues.
333Opam 2.0.1 opam-remote(1)