1OPAM ADMIN-MAKE(1) Opam admin Manual OPAM ADMIN-MAKE(1)
2
6 opam admin-make - An alias for index.
7
9 opam admin make [OPTION]...
10
12 opam admin make is an alias for opam admin index.
13 See opam admin index --help for details.
15
17 --full-urls-txt
18 Generate an inclusive 'urls.txt', for a repository that will be
19 used by opam versions earlier than 2.0.
20 --help[=FMT] (default=auto)
22 Show this help in format FMT. The value FMT must be one of `auto',
23 `pager', `groff' or `plain'. With `auto', the format is `pager` or
24 `plain' whenever the TERM env var is `dumb' or undefined.
25 --minimal-urls-txt
27 Generate a minimal 'urls.txt' file, that only includes the 'repo'
28 file. This allows opam versions earlier than 2.0 to read that file,
29 and be properly redirected to a repository dedicated to their
30 version, assuming a suitable 'redirect:' field is defined, instead
31 of failing. This is the default.
32 --no-urls-txt
34 Don't generate a 'urls.txt' file. That index file is no longer
35 needed from opam 2.0 on, but is still used by older versions.
36 --version
38 Show version information.
39
41 These options are common to all commands.
42 --best-effort
44 Don't fail if all requested packages can't be installed: try to
45 install as many as possible. Note that not all external solvers may
46 support this option (recent versions of aspcud or mccs should).
47 This is equivalent to setting $OPAMBESTEFFORT environment variable.
48 --color=WHEN
50 Colorize the output. WHEN must be one of `always', `never' or
51 `auto'.
52 --criteria=CRITERIA
54 Specify user preferences for dependency solving for this run.
55 Overrides both $OPAMCRITERIA and $OPAMUPGRADECRITERIA. For details
56 on the supported language, and the external solvers available, see
57 http://opam.ocaml.org/doc/External_solvers.html. A general guide to
58 using solver preferences can be found at
59 http://www.dicosmo.org/Articles/usercriteria.pdf.
60 --cudf=FILENAME
62 Debug option: Save the CUDF requests sent to the solver to
63 FILENAME-<n>.cudf.
64 --debug
66 Print debug message to stderr. This is equivalent to setting
67 $OPAMDEBUG to "true".
68 --debug-level=LEVEL
70 Like --debug, but allows specifying the debug level (--debug sets
71 it to 1). Equivalent to setting $OPAMDEBUG to a positive integer.
72 --git-version
74 Print the git version of opam, if set (i.e. you are using a
75 development version), and exit.
76 --ignore-pin-depends
78 Ignore extra pins required by packages that get pinned, either
79 manually through opam pin or through opam install DIR. This is
80 equivalent to setting IGNOREPINDEPENDS=true.
81 --json=FILENAME
83 Save the results of the opam run in a computer-readable file. If
84 the filename contains the character `%', it will be replaced by an
85 index that doesn't overwrite an existing file. Similar to setting
86 the $OPAMJSON variable.
87 --no-aspcud
89 Deprecated.
90 --no-auto-upgrade
92 When configuring or updating a repository that is written for an
93 earlier opam version (1.2), opam internally converts it to the
94 current format. This disables this behaviour. Note that
95 repositories should define their format version in a 'repo' file at
96 their root, or they will be assumed to be in the older format. It
97 is, in any case, preferable to upgrade the repositories manually
98 using opam admin upgrade [--mirror URL] when possible.
99 -q, --quiet
101 Disables --verbose.
102 --root=ROOT
104 Use ROOT as the current root path. This is equivalent to setting
105 $OPAMROOT to ROOT.
106 --safe, --readonly
108 Make sure nothing will be automatically updated or rewritten.
109 Useful for calling from completion scripts, for example. Will fail
110 whenever such an operation is needed ; also avoids waiting for
111 locks, skips interactive questions and overrides the $OPAMDEBUG
112 variable. This is equivalent to set environment variable $OPAMSAFE.
113 --solver=CMD
115 Specify the CUDF solver to use for resolving package installation
116 problems. This is either a predefined solver (this version of opam
117 supports builtin-mccs+lp(), builtin-mccs+glpk, aspcud, mccs,
118 aspcud-old, packup), or a custom command that should contain the
119 variables %{input}%, %{output}%, %{criteria}%, and optionally
120 %{timeout}%. This is equivalent to setting $OPAMEXTERNALSOLVER.
121 --strict
123 Fail whenever an error is found in a package definition or a
124 configuration file. The default is to continue silently if
125 possible.
126 --switch=SWITCH
128 Use SWITCH as the current compiler switch. This is equivalent to
129 setting $OPAMSWITCH to SWITCH.
130 --use-internal-solver
132 Disable any external solver, and use the built-in one (this
133 requires that opam has been compiled with a built-in solver). This
134 is equivalent to setting $OPAMNOASPCUD or $OPAMUSEINTERNALSOLVER.
135 -v, --verbose
137 Be more verbose. One -v shows all package commands, repeat to also
138 display commands called internally (e.g. tar, curl, patch etc.)
139 Repeating n times is equivalent to setting $OPAMVERBOSE to "n".
140 -w, --working-dir
142 Whenever updating packages that are bound to a local,
143 version-controlled directory, update to the current working state
144 of their source instead of the last committed state, or the ref
145 they are pointing to. This only affects packages explicitly listed
146 on the command-line.It can also be set with $OPAMWORKINGDIR.
147 -y, --yes
149 Answer yes to all yes/no questions without prompting. This is
150 equivalent to setting $OPAMYES to "true".
151
153 Opam makes use of the environment variables listed here. Boolean
154 variables should be set to "0", "no", "false" or the empty string to
155 disable, "1", "yes" or "true" to enable.
156 OPAMALLPARENS surround all filters with parenthesis
158 OPAMAUTOREMOVE see remove option `--auto-remove`
160 OPAMBESTEFFORT see option `--best-effort`
162 OPAMBESTEFFORTPREFIXCRITERIA sets the string that must be prepended to
164 the criteria when the `--best-effort` option is set, and is expected to
165 maximise the `opam-query` property in the solution
166 OPAMCOLOR, when set to always or never, sets a default value for the
168 --color option.
169 OPAMCRITERIA specifies user preferences for dependency solving. The
171 default value depends on the solver version, use `config report` to
172 know the current setting. See also option --criteria
173 OPAMCUDFFILE file save the cudf graph to file-actions-explicit.dot
175 OPAMCURL can be used to select a given 'curl' program. See OPAMFETCH
177 for more options.
178 OPAMDEBUG see options `--debug' and `--debug-level'.
180 OPAMDOWNLOADJOBS sets the maximum number of simultaneous downloads.
182 OPAMDRYRUN see option `--dry-run`
184 OPAMEDITOR sets the editor to use for opam file editing, overrides
186 $EDITOR and $VISUAL
187 OPAMERRLOGLEN sets the number of log lines printed when a sub-process
189 fails. 0 to print all.
190 OPAMEXTERNALSOLVER see option `--solver'.
192 OPAMFAKE see option `--fake`
194 OPAMFETCH specifies how to download files: either `wget', `curl' or a
196 custom command where variables %{url}%, %{out}%, %{retry}%,
197 %{compress}% and %{checksum}% will be replaced. Overrides the
198 'download-command' value from the main config file.
199 OPAMFIXUPCRITERIA same as OPAMUPGRADECRITERIA, but specific to fixup
201 OPAMIGNORECONSTRAINTS see install option `--ignore-constraints-on`
203 OPAMIGNOREPINDEPENDS see option `--ignore-pin-depends`
205 OPAMJOBS sets the maximum number of parallel workers to run.
207 OPAMJSON log json output to the given file (use character `%' to index
209 the files)
210 OPAMLOCKED see install option `--locked`
212 OPAMLOGS logdir sets log directory, default is a temporary directory in
214 /tmp
215 OPAMMAKECMD set the system make command to use
217 OPAMNOAUTOUPGRADE disables automatic internal upgrade of repositories
219 in an earlier format to the current one, on 'update' or 'init'.
220 OPAMKEEPLOGS tells opam to not remove some temporary command logs and
222 some backups. This skips some finalisers and may also help to get more
223 reliable backtraces
224 OPAMLOCKRETRIES sets the number of tries after which opam gives up
226 acquiring its lock and fails. <= 0 means infinite wait.
227 OPAMMERGEOUT merge process outputs, stderr on stdout
229 OPAMNO answer no to any question asked.
231 OPAMNOASPCUD Deprecated.
233 OPAMNOCHECKSUMS enables option --no-checksums when available.
235 OPAMNOSELFUPGRADE see option `--no-self-upgrade'.
237 OPAMPINKINDAUTO sets whether version control systems should be detected
239 when pinning to a local path. Enabled by default since 1.3.0.
240 OPAMPRECISETRACKING fine grain tracking of directories
242 OPAMREQUIRECHECKSUMS Enables option `--require-checksums' when
244 available (e.g. for `opam install`).
245 OPAMRETRES sets the number of tries before failing downloads.
247 OPAMROOT see option `--root'. This is automatically set by `opam env
249 --root=DIR --set-root'.
250 OPAMROOTISOK don't complain when running as root.
252 OPAMSAFE see option `--safe'
254 OPAMSHOW see option `--show`
256 OPAMSKIPUPDATE see option `--skip-updates`
258 OPAMSKIPVERSIONCHECKS bypasses some version checks. Unsafe, for
260 compatibility testing only.
261 OPAMSOLVERTIMEOUT change the time allowance of the solver. Default is
263 60.0, set to 0 for unlimited. Note that all solvers may not support
264 this option.
265 OPAMSTATUSLINE display a dynamic status line showing what's currently
267 going on on the terminal. (one of one of `always', `never' or `auto')
268 OPAMSTATS display stats at the end of command
270 OPAMSTRICT fail on inconsistencies (file reading, switch import, etc.)
272 OPAMSWITCH see option `--switch'. Automatically set by `opam env
274 --switch=SWITCH --set-switch'.
275 OPAMUNLOCKBASE see install option `--unlock-base`
277 OPAMUPGRADECRITERIA specifies user preferences for dependency solving
279 when performing an upgrade. Overrides OPAMCRITERIA in upgrades if both
280 are set. See also option --criteria
281 OPAMUSEINTERNALSOLVER see option `--use-internal-solver'.
283 OPAMUSEOPENSSL force openssl use for hash computing
285 OPAMUTF8 use UTF8 characters in output (one of one of `always', `never'
287 or `auto'). By default `auto', which is determined from the locale).
288 OPAMUTF8MSGS use extended UTF8 characters (camels) in opam messages.
290 Implies OPAMUTF8. This is set by default on OSX only.
291 OPAMVALIDATIONHOOK hook if set, uses the `%{hook%}` command to validate
293 an opam repository update
294 OPAMVAR_var overrides the contents of the variable var when
296 substituting `%{var}%` strings in `opam` files.
297 OPAMVAR_package_var overrides the contents of the variable package:var
299 when substituting `%{package:var}%` strings in `opam` files.
300 OPAMVERBOSE see option `--verbose'.
302 OPAMWORKINGDIR see option `--working-dir`
304 OPAMYES see option `--yes'.
306
308 As an exception to the following, the `exec' command returns 127 if the
309 command was not found or couldn't be executed, and the command's exit
310 value otherwise.
311 0 Success, or true for boolean queries.
313 1 False. Returned when a boolean return value is expected, e.g. when
315 running with --check, or for queries like opam lint.
316 2 Bad command-line arguments, or command-line arguments pointing to
318 an invalid context (e.g. file not following the expected format).
319 5 Not found. You requested something (package, version, repository,
321 etc.) that couldn't be found.
322 10 Aborted. The operation required confirmation, which wasn't given.
324 15 Could not acquire the locks required for the operation.
326 20 There is no solution to the user request. This can be caused by
328 asking to install two incompatible packages, for example.
329 30 Error in package definition, or other metadata files. Using
331 --strict raises this error more often.
332 31 Package script error. Some package operations were unsuccessful.
334 This may be an error in the packages or an incompatibility with
335 your system. This can be a partial error.
336 40 Sync error. Could not fetch some remotes from the network. This can
338 be a partial error.
339 50 Configuration error. Opam or system configuration doesn't allow
341 operation, and needs fixing.
342 60 Solver failure. The solver failed to return a sound answer. It can
344 be due to a broken external solver, or an error in solver
345 configuration.
346 99 Internal error. Something went wrong, likely due to a bug in opam
348 itself.
349 130 User interrupt. SIGINT was received, generally due to the user
351 pressing Ctrl-C.
352
354 See https://opam.ocaml.org/doc.
355
357 Vincent Bernardoff <vb@luminar.eu.org>
358 Raja Boujbel <raja.boujbel@ocamlpro.com>
359 Roberto Di Cosmo <roberto@dicosmo.org>
360 Thomas Gazagnaire <thomas@gazagnaire.org>
361 Louis Gesbert <louis.gesbert@ocamlpro.com>
362 Fabrice Le Fessant <Fabrice.Le_fessant@inria.fr>
363 Anil Madhavapeddy <anil@recoil.org>
364 Guillem Rieu <guillem.rieu@ocamlpro.com>
365 Ralf Treinen <ralf.treinen@pps.jussieu.fr>
366 Frederic Tuong <tuong@users.gforge.inria.fr>
367
369 Check bug reports at https://github.com/ocaml/opam/issues.
370Opam admin 2.0.6 OPAM ADMIN-MAKE(1)